4 Star 14 Fork 5

水晶萧竹 / RoubSite

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
Apache-2.0

RoubSite

如果你喜欢这个项目,请给它一个star
GitHub license GitHub stars Javadocs Maven Central Build Status 水晶萧竹/RoubSite

介绍

RoubSite是一个简单、轻量、易上手的java web开发框架,项目研发的初衷是写一个可以让刚入行的程序猿快速掌握java web开发的这么一个框架。
🎉🎉🎉RoubSiteAdmin是基于RoubSite开发的一套后台权限管理框架,用户、角色、权限、菜单一整套都写好了,结合代码生成机,简单增删改查,通过配置就可以搞定。
官网https://www.roubsite.com

RoubSiteAdmin演示地址

🔥🔥RoubSiteAdmin后台管理框架
账号:admin 密码:admin
不要修改密码,测试用户功能可以新建用户,admin用户不要修改密码!!

RoubSite框架使用Demo

🎉🎉🎉RoubSite框架Demo:https://gitee.com/lonesafe/roubsite-demo

软件架构

整个框架分为Action(前端控制器)、Dao(数据访问层)、Bean(实体类)这三层;
页面模板实现了类似PHP中的smarty框架的一个模板引擎,使用起来十分方便。

快速开始

添加maven依赖

Smarty是框架的依赖项,会自动引入。
引入框架(必须):

<dependency>
  <groupId>com.roubsite</groupId>
  <artifactId>RoubSiteFramework</artifactId>
  <version>4.0.0</version>
  <type>jar</type>
</dependency>

引入权限管理(可选):

<dependency>
  <groupId>com.roubsite</groupId>
  <artifactId>RoubSiteSecurity</artifactId>
  <version>4.0.0</version>
  <type>jar</type>
</dependency>

引入代码生成机(可选):

<dependency>
  <groupId>com.roubsite</groupId>
  <artifactId>RoubSiteCodeSign</artifactId>
  <version>4.0.0</version>
  <type>jar</type>
</dependency>

配置web.xml

<!-- log4j配置 -->
<context-param>
    <param-name>log4jConfigLocation</param-name>
    <param-value>classpath:log4j.properties</param-value>
</context-param>
<!-- 引入RoubSite框架监听器 -->
<listener>
    <listener-class>com.roubsite.web.listener.RSConfigListenerContext</listener-class>
</listener>

配置文件(V4.0.0及以上版本推荐使用YML方式)

强烈推荐使用此方式! 配置文件放置在resources中,名字可以随便起,框架会自动扫描所有的配置文件。

RoubSite:
  #代码生成机配置
  codeSign:
    #代码输出路径
    outputPath: d:/demo
  #是否开启防注入拦截器
  injection: true
  global:
    #默认分组
    defaultGroup: admin
    #分组
    group:
      #分组:对应的包
      codeSign: com.roubsite.code
      index: com.roubsite.site
      admin: com.roubsite.admin
      sso: com.roubsite.sso
    #静态资源后缀
    static_suffix: "*.jpg,*.css,*.png,*.js,*.gif,*.swf,*.ico,*.rar,*.woff,*.ttf,*.eot"
    #错误页文件路径
    errorPage:
    #成功页文件路径
    successPage:
  #权限管理框架配置
  security:
    #框架拦截器
    class: "com.roubsite.security.filter.SecurityFilter"
    #不进行拦截的资源
    missing: "*.jpg,*.css,*.png,*.js,*.gif,*.swf,*.ico,*.rar,*.woff,*.ttf,*.eot"
    #登陆地址
    loginUrl: "/admin/login"
  #模板设置
  smarty:
    #调试模式
    debug: true
    #启用cache,如果遇到变量无法刷新的问题,请关闭缓存(cache=off)
    cache: off
    #模板文件编码集
    encoding: UTF-8
    #左边界定界符
    left.delimiter: "{"
    #右边界定界符
    right.delimiter: "}"
    #函数扩展包的名称,以:分隔
    package:
      function: com.roubsite.smarty4j.statement.function
      #变量调节器扩展包的名称,以:分隔
      modifier: com.roubsite.smarty4j.statement.modifier

  #数据源配置
  DataSourcePool:
    #是否开启druid控制台
    console: true
    #默认数据源
    default: dataSource
    #数据源列表
    dataSources:
      #数据源DataSource
      dataSource:
        #数据源类型(1:mysql,2:oracle)用于代码生成使用
        type: 1
        driverClassName: com.mysql.jdbc.Driver
        url: "jdbc:mysql://127.0.0.1:3306/roubsite_dev?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&autoReconnect=true"
        username: root
        password: root
        #数据库池大小
        poolSize: 12
        #是否保持连接
        keepAlive: true
        #最大等待时间
        maxWaitMillis: 100000
        #最大线程等待时间
        maxWaithThreadCount: 12
      #数据源DataSource2
#      dataSource2:
#        type: 2
#        driverClassName: com.mysql.jdbc.Driver
#        url=jdbc: mysql://127.0.0.1:3306/ls_srr?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull
#        username: root
#        password: root
#        poolSize: 12

log4j2.yml(可选,没有该配置影响log4j打印日志)

Configuration:
   status: DEBUG
   Properties: # 定义全局变量  
      Property:
      -  name: log.path
         value: D:/RoubSite-log
   Loggers:
      Root:
         level: DEBUG
         AppenderRef:
         -  ref: CONSOLE
         -  ref: ROOT_LOG
      Logger:
      -  name: com.roubsite.web
         additivity: true
         level: DEBUG
         AppenderRef:
         -  ref: ROUBSITE_FRAMEWORK
      -  name: com.roubsite.database
         additivity: true
         level: DEBUG
         AppenderRef:
         -  ref: ROUBSITE_DATABASE
      -  name: com.roubsite.security
         additivity: true
         level: DEBUG
         AppenderRef:
         -  ref: ROUBSITE_SECURITY
      -  name: org.activiti
         additivity: true
         level: DEBUG
         AppenderRef:
         -  ref: ROUBSITE_ACTIVITI
   Appenders:
      Console: #输出到控制台  
         name: CONSOLE
         target: SYSTEM_OUT
         follow: true
         PatternLayout:
            pattern: '%n%m%n'
      RollingFile: # 输出到文件,超过128MB归档  
      -  name: ROOT_LOG
         ignoreExceptions: false
         fileName: ${log.path}/root.log
         filePattern: ${log.path}/%d{yyyy-MM-dd}-%i-root.log.gz
         PatternLayout:
            pattern: '[%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n '
         Policies:
            SizeBasedTriggeringPolicy:
               size: 128 MB
         DefaultRolloverStrategy:
            max: 1000
      -  name: ROUBSITE_FRAMEWORK
         ignoreExceptions: false
         fileName: ${log.path}/roubsite_framework.log
         filePattern: ${log.path}/%d{yyyy-MM-dd}-%i-roubsite_framework.log.gz
         PatternLayout:
            pattern: '[%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n '
         Policies:
            SizeBasedTriggeringPolicy:
               size: 128 MB
         DefaultRolloverStrategy:
            max: 1000
      -  name: ROUBSITE_SECURITY
         ignoreExceptions: false
         fileName: ${log.path}/roubsite_security.log
         filePattern: ${log.path}/%d{yyyy-MM-dd}-%i-roubsite_security.log.gz
         PatternLayout:
            pattern: '[%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n '
         Policies:
            SizeBasedTriggeringPolicy:
               size: 128 MB
         DefaultRolloverStrategy:
            max: 1000
      -  name: ROUBSITE_DATABASE
         ignoreExceptions: false
         fileName: ${log.path}/roubsite_database.log
         filePattern: ${log.path}/%d{yyyy-MM-dd}-%i-roubsite_database.log.gz
         PatternLayout:
            pattern: '[%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n '
         Policies:
            SizeBasedTriggeringPolicy:
               size: 128 MB
         DefaultRolloverStrategy:
            max: 1000
      -  name: ROUBSITE_ACTIVITI
         ignoreExceptions: false
         fileName: ${log.path}/roubsite_activiti.log
         filePattern: ${log.path}/%d{yyyy-MM-dd}-%i-roubsite_activiti.log.gz
         PatternLayout:
            pattern: '[%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n '
         Policies:
            SizeBasedTriggeringPolicy:
               size: 128 MB
         DefaultRolloverStrategy:
            max: 1000 

hello world

复制上面的配置文件后,我们已经创建了一个模块“index”,根据配置文件我们知道“index”对应的包名 是“com.roubsite.site”,根据这个包名我们新建三个包“com.roubsite.site.action”、“com.roubsite.site.bean”、“com.roubsite.site.dao”, 这三个包名分别对应“控制器”、“数据库实体”、“数据库操作”。 我们在“com.roubsite.site.action”下创建一个继承“RSAction”的得类“IndexAction”,并且实现“execute”方法:
img.png
然后在“src/webapp/templates/index”下面再添加一个模板文件“index.html”:
img_1.png
然后启动tomcat访问即可看到效果(具体控制器和模板的对应关系、url和控制器的对应关系可以查看操作手册

RoubSite都包含那些模块

  1. RoubSiteFramework RoubSite框架,Action、Dao的代码实现都在里面。
  2. RoubSiteSecurity 权限管理,在Action中使用注解方式对方法进行权限控制,自己写权限管理可以不用它。
  3. RoubSiteSmarty4j 模板解释器,参考了github上的代码,原作者实在是没找到。
  4. RoubSiteCodeSign 代码生成机,这可是一个重头戏,它可以直接将数据库的表生成对应的增删改查的代码,页面也同时生成,减少工作量的首选。(可以通过https://gitee.com/lonesafe/roub-site-admin 项目使用)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

RoubSite是一个简单、轻量、易上手的java web开发框架 expand collapse
Java and 2 more languages
Apache-2.0
Cancel

Releases (11)

All

Contributors

All

Activities

Load More
can not load any more
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/lonesafe/RoubSite.git
git@gitee.com:lonesafe/RoubSite.git
lonesafe
RoubSite
RoubSite
master

Search

344bd9b3 5694891 D2dac590 5694891