|
| 1 | +#Guns V2.2 |
| 2 | +新版Guns基于SpringBoot全面升级,完美整合springmvc + shiro + mybatis-plus + beetl! |
| 3 | + |
| 4 | +在不用写xml配置(V1.0)的基础上进一步简化项目配置,让您更专注于业务开发!抛弃传统spring xml的配置方式,利用springboot + javabean方式配置spring,极大简化了pom.xml配置和spring配置. |
| 5 | + |
| 6 | +Guns项目代码简洁,注释丰富,上手容易,同时Guns包含许多基础模块(用户管理,角色管理,部门管理,字典管理等10个模块),可以直接作为一个后台管理系统的脚手架. |
| 7 | + |
| 8 | +## 鸣谢 |
| 9 | +1.[SpringBlade](http://git.oschina.net/smallc/SpringBlade) |
| 10 | +2.[beetl](http://ibeetl.com/) |
| 11 | +3.[mybatis-plus](http://git.oschina.net/baomidou/mybatis-plus) |
| 12 | + |
| 13 | +##技术讨论 |
| 14 | +如果对项目有任何疑问或者建议,欢迎加入Guns技术交流群:254550081(加之前请先看一遍readme文档) |
| 15 | + |
| 16 | +## V2.2更新日志 |
| 17 | +1. 菜单树由最多二级菜单拓展为三级菜单 |
| 18 | +2. 用户管理页面新增部门树，方便查询部门人员信息 |
| 19 | +3. 完善系统的session机制，增加session失效时间的跳转 |
| 20 | +4. 完善Guns代码生成功能,新增Dao和Service，并且所有的生成都是可选的 |
| 21 | +5. 删除信息增加提示框 |
| 22 | +6. 删除父菜单可以删除所有子菜单 |
| 23 | +7. 新增对页面的js验证，所用框架为bootstrap validator |
| 24 | +8. 完善druid监控，新增Web应用监控，URI监控，session监控 |
| 25 | +9. 修复新增含有0值的字典，查询会出现多条的bug |
| 26 | +10. 修复没有角色的用户登录报错的bug |
| 27 | + |
| 28 | +### 如果不喜欢SpringBoot? |
| 29 | +如果您不喜欢用SpringBoot,或者您是一个spring初学者,您可以切换到[Guns V1.0(点击这里)](http://git.oschina.net/naan1993/guns/tree/v1.0/)分支, |
| 30 | +Guns V1.0基于spring的java bean方式配置项目,同样简洁易上手. |
| 31 | + |
| 32 | +注:SpringBoot强大的Auto Config和统一的依赖管理极大的简化了spring配置和maven依赖,在不了解其都配置了哪些东西的基础上可能会对初学者有一定困扰,所以建议初学者先看Guns V1.0 |
| 33 | + |
| 34 | +##功能简介 |
| 35 | +1. 用户管理 |
| 36 | +2. 角色管理 |
| 37 | +3. 部门管理 |
| 38 | +4. 菜单管理 |
| 39 | +5. 字典管理 |
| 40 | +6. 业务日志 |
| 41 | +7. 登录日志 |
| 42 | +8. 监控管理 |
| 43 | +9. 通知管理 |
| 44 | +10. 代码生成 |
| 45 | + |
| 46 | +##使用说明 |
| 47 | +1. 导入sql/guns.sql文件到mysql数据库 |
| 48 | +2. 以maven方式导入项目到ide |
| 49 | +3. 修改application.yml中的数据库相关的配置,改为您本机的数据库配置 |
| 50 | +4. 启动项目,管理员账号admin/密码111111 |
| 51 | + |
| 52 | +###如何启动项目 |
| 53 | +Guns目前支持三种启动方式: |
| 54 | +1. 在IDE里运行GunsApplication类中的main方法启动 |
| 55 | +2. 执行如下maven命令 |
| 56 | +``` |
| 57 | +clean package -Dmaven.test.skip=true |
| 58 | +``` |
| 59 | +并从target目录中找到guns-1.0.0-SNAPSHOT.jar,并在jar包的目录下执行如下java命令 |
| 60 | +``` |
| 61 | +java -jar guns-1.0.0-SNAPSHOT.jar |
| 62 | +``` |
| 63 | +3. 修改pom.xml中如下片段 |
| 64 | +``` |
| 65 | +<packaging>jar</packaging> |
| 66 | +``` |
| 67 | +改为 |
| 68 | +``` |
| 69 | +<packaging>war</packaging> |
| 70 | +``` |
| 71 | +并打包放入到tomcat中执行 |
| 72 | + |
| 73 | +###注意 |
| 74 | +建议本项目用jdk1.8,经测试jdk1.7登录页面会导致css丢失 |
| 75 | + |
| 76 | +##所用框架 |
| 77 | +###前端 |
| 78 | +1. Bootstrap v3.3.6 |
| 79 | +2. jQuery v2.1.4 |
| 80 | +3. bootstrap-table v1.11.1 |
| 81 | +4. layer v2.1 |
| 82 | +5. zTree core v3.5.28 |
| 83 | +6. WebUploader 0.1.5 |
| 84 | + |
| 85 | +###后端 |
| 86 | +1. SpringBoot 1.5.3.RELEASE |
| 87 | +2. MyBatis-Plus 2.0.8 |
| 88 | +3. MyBatis 3.4.4 |
| 89 | +4. Spring 4.3.8.RELEASE |
| 90 | +5. Beetl 2.7.15 |
| 91 | +6. hibernate-validator 5.3.5.Final |
| 92 | +7. Ehcache 3.3.1 |
| 93 | +8. Kaptcha 2.3.2 |
| 94 | +9. Fastjson 1.2.31 |
| 95 | +10. Shiro 1.4.0 |
| 96 | +11. Druid 1.0.31 |
| 97 | + |
| 98 | +##项目包结构说明 |
| 99 | +``` |
| 100 | +├─main |
| 101 | +│ │ |
| 102 | +│ ├─java |
| 103 | +│ │ │ |
| 104 | +│ │ ├─com.stylefeng.guns----------------项目主代码 |
| 105 | +│ │ │ │ |
| 106 | +│ │ │ ├─common----------------项目公用的部分(业务中经常调用的类,例如常量,异常,实体,注解,分页类,节点类) |
| 107 | +│ │ │ │ |
| 108 | +│ │ │ ├─config----------------项目配置代码(例如mybtais-plus配置,ehcache配置等) |
| 109 | +│ │ │ │ |
| 110 | +│ │ │ ├─core----------------项目运行的核心依靠(例如aop日志记录,拦截器,监听器,guns模板引擎,shiro权限检查等) |
| 111 | +│ │ │ │ |
| 112 | +│ │ │ ├─modular----------------项目业务代码 |
| 113 | +│ │ │ │ |
| 114 | +│ │ │ ├─GunsApplication类----------------以main方法启动springboot的类 |
| 115 | +│ │ │ │ |
| 116 | +│ │ │ └─GunsServletInitializer类----------------用servlet容器启动springboot的核心类 |
| 117 | +│ │ │ |
| 118 | +│ │ └─generator----------------mybatis-plus Entity生成器 |
| 119 | +│ │ |
| 120 | +│ ├─resources----------------项目资源文件 |
| 121 | +│ │ │ |
| 122 | +│ │ ├─gunsTemplate----------------guns代码生成模板 |
| 123 | +│ │ │ |
| 124 | +│ │ ├─application.yml----------------springboot项目配置 |
| 125 | +│ │ │ |
| 126 | +│ │ └─ehcache.xml----------------ehcache缓存配置 |
| 127 | +│ │ |
| 128 | +│ └─webapp----------------web页面和静态资源存放的目录 |
| 129 | +│ |
| 130 | +``` |
| 131 | +注:SpringBoot项目默认不支持将静态资源和模板(web页面)放到webapp目录,但是个人感觉resources目录只放项目的配置更加简洁,所以就将web页面继续放到webapp目录了. |
| 132 | + |
| 133 | +##项目特点 |
| 134 | +1. 基于SpringBoot,简化了大量项目配置和maven依赖,让您更专注于业务开发,独特的分包方式,代码多而不乱。 |
| 135 | +2. 完善的日志记录体系，可记录登录日志，业务操作日志(可记录操作前和操作后的数据)，异常日志到数据库，通过@BussinessLog注解和LogObjectHolder.me().set()方法，业务操作日志可具体记录哪个用户，执行了哪些业务，修改了哪些数据，并且日志记录为异步执行，详情请见@BussinessLog注解和LogObjectHolder,LogManager,LogAop类。 |
| 136 | +3. 利用beetl模板引擎对前台页面进行封装和拆分，使臃肿的html代码变得简洁，更加易维护。 |
| 137 | +4. 对常用js插件进行二次封装，使js代码变得简洁，更加易维护，具体请见webapp/static/js/common文件夹内js代码。 |
| 138 | +5. 利用ehcache框架对经常调用的查询进行缓存，提升运行速度，具体请见ConstantFactory类中@Cacheable标记的方法。 |
| 139 | +6. controller层采用map + warpper方式的返回结果，返回给前端更为灵活的数据，具体参见com.stylefeng.guns.modular.system.warpper包中具体类。 |
| 140 | +7. 防止XSS攻击,通过XssFilter类对所有的输入的非法字符串进行过滤以及替换。 |
| 141 | +8. 简单可用的代码生成体系，通过SimpleTemplateEngine可生成带有主页跳转和增删改查的通用控制器、html页面以及相关的js，还可以生成Service和Dao，并且这些生成项都为可选的，通过ContextConfig下的一些列xxxSwitch开关,可灵活控制生成模板代码，让您把时间放在真正的业务上。 |
| 142 | +9. 控制器层统一的异常拦截机制,利用@ControllerAdvice统一对异常拦截,具体见com.stylefeng.guns.core.aop.GlobalExceptionHandler类。 |
| 143 | +10. 页面统一的js key-value单例模式写法，每个页面生成一个唯一的全局变量，提高js的利用效率，并且有效防止多个人员开发引起的函数名/类名冲突，并且可以更好地去维护代码。 |
| 144 | + |
| 145 | +##基于javabean方式的spring配置 |
| 146 | +Guns以简洁为核心,抛弃了传统的易错,臃肿xml配置,采用javabean的方式配置spring,简化了项目的配置,如下示例为配置mybatis-plus和数据源: |
| 147 | +``` |
| 148 | +@Configuration |
| 149 | +@MapperScan(basePackages = {"com.stylefeng.guns.modular.*.dao", "com.stylefeng.guns.common.persistence.dao"}) |
| 150 | +public class MybatisPlusConfig { |
| 151 | +
|
| 152 | + @Autowired |
| 153 | + DruidProperties druidProperties; |
| 154 | +
|
| 155 | + /** |
| 156 | + * mybatis-plus分页插件 |
| 157 | + */ |
| 158 | + @Bean |
| 159 | + public PaginationInterceptor paginationInterceptor() { |
| 160 | + PaginationInterceptor paginationInterceptor = new PaginationInterceptor(); |
| 161 | + paginationInterceptor.setDialectType(DBType.MYSQL.getDb()); |
| 162 | + return paginationInterceptor; |
| 163 | + } |
| 164 | +
|
| 165 | + /** |
| 166 | + * druid数据库连接池 |
| 167 | + */ |
| 168 | + @Bean(initMethod = "init") |
| 169 | + public DruidDataSource dataSource() { |
| 170 | + DruidDataSource dataSource = new DruidDataSource(); |
| 171 | + druidProperties.coinfig(dataSource); |
| 172 | + return dataSource; |
| 173 | + } |
| 174 | +} |
| 175 | +``` |
| 176 | + |
| 177 | +##业务日志记录原理 |
| 178 | +日志记录采用aop(LogAop类)方式对所有包含@BussinessLog注解的方法进行aop切入，会记录下当前用户执行了哪些操作（即@BussinessLog value属性的内容），如果涉及到数据修改，会取当前http请求的所有requestParameters与LogObjectHolder类中缓存的Object对象的所有字段作比较（所以在编辑之前的获取详情接口中需要缓存被修改对象之前的字段信息），日志内容会异步存入数据库中（通过ScheduledThreadPoolExecutor类）。 |
| 179 | + |
| 180 | +##beetl对前台页面的拆分与包装 |
| 181 | +例如，把主页拆分成三部分，每个部分单独一个页面，更加便于维护 |
| 182 | +``` |
| 183 | +<!--左侧导航开始--> |
| 184 | + @include("/common/_tab.html"){} |
| 185 | +<!--左侧导航结束--> |
| 186 | +
|
| 187 | +<!--右侧部分开始--> |
| 188 | + @include("/common/_right.html"){} |
| 189 | +<!--右侧部分结束--> |
| 190 | +
|
| 191 | +<!--右侧边栏开始--> |
| 192 | + @include("/common/_theme.html"){} |
| 193 | +<!--右侧边栏结束--> |
| 194 | +``` |
| 195 | +以及对重复的html进行包装，使前端页面更加专注于业务实现，例如,把所有页面引用包进行提取 |
| 196 | +``` |
| 197 | +<!DOCTYPE html> |
| 198 | +<html> |
| 199 | +<head> |
| 200 | +<meta charset="utf-8"> |
| 201 | +<meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 202 | +<meta name="renderer" content="webkit" /><!-- 让360浏览器默认选择webkit内核 --> |
| 203 | +
|
| 204 | +<!-- 全局css --> |
| 205 | +<link rel="shortcut icon" href="${ctxPath}/static/favicon.ico"> |
| 206 | +<!-- 全局js --> |
| 207 | +<script src="${ctxPath}/static/js/jquery.min.js?v=2.1.4"></script> |
| 208 | +<body class="gray-bg"> |
| 209 | + <div class="wrapper wrapper-content animated fadeInRight"> |
| 210 | + ${layoutContent} |
| 211 | + </div> |
| 212 | + <script src="${ctxPath}/static/js/content.js?v=1.0.0"></script> |
| 213 | +</body> |
| 214 | +</html> |
| 215 | +``` |
| 216 | +开发页面时，只需编写如下代码即可 |
| 217 | +``` |
| 218 | +@layout("/common/_container.html"){ |
| 219 | +<div class="row"> |
| 220 | + <div class="col-sm-12"> |
| 221 | + <div class="ibox float-e-margins"> |
| 222 | + <div class="ibox-title"> |
| 223 | + <h5>部门管理</h5> |
| 224 | + </div> |
| 225 | + <div class="ibox-content"> |
| 226 | + //自定义内容 |
| 227 | + </div> |
| 228 | + </div> |
| 229 | + </div> |
| 230 | +</div> |
| 231 | +<script src="${ctxPath}/static/modular/system/dept/dept.js"></script> |
| 232 | +@} |
| 233 | +``` |
| 234 | +以上beetl的用法请参考beetl说明文档。 |
| 235 | + |
| 236 | +##对js常用代码的封装 |
| 237 | +在webapp/static/js/common目录中，有对常用js代码的封装，例如Feng.js,其中Feng.info(),Feng.success(),Feng.error()三个方法，分别封装了普通提示，成功提示，错误提示的代码，简化了layer提示层插件的使用。 |
| 238 | + |
| 239 | +##极简的图片上传方法 |
| 240 | +guns对web-upload进行二次封装,让图片的上传功能呢只用2行代码即可实现,如下 |
| 241 | +``` |
| 242 | +var avatarUp = new $WebUpload("avatar"); |
| 243 | +avatarUp.init(); |
| 244 | +``` |
| 245 | +具体实现请参考static/js/common/web-upload-object.js |
| 246 | + |
| 247 | +##独创controller层，map+warpper返回方式 |
| 248 | +map+warpper方式即为把controller层的返回结果使用BeanKit工具类把原有bean转化为Map的的形式(或者原有bean直接是map的形式)，再用单独写的一个包装类再包装一次这个map，使里面的参数更加具体，更加有含义，下面举一个例子，例如，在返回给前台一个性别时，数据库查出来1是男2是女，假如直接返回给前台，那么前台显示的时候还需要增加一次判断，并且前后端分离开发时又增加了一次交流和文档的成本，但是采用warpper包装的形式，可以直接把返回结果包装一下，例如动态增加一个字段sexName直接返回给前台性别的中文名称即可。 |
| 249 | + |
| 250 | +##swagger api管理使用说明 |
| 251 | +swagger会管理所有包含@ApiOperation注解的控制器方法，同时，可利用@ApiImplicitParams注解标记接口中的参数，具体用法请参考CodeController类中的用法。 |
| 252 | +``` |
| 253 | + @ApiOperation("生成代码") |
| 254 | + @ApiImplicitParams({ |
| 255 | + @ApiImplicitParam(name = "moduleName", value = "模块名称", required = true, dataType = "String"), |
| 256 | + @ApiImplicitParam(name = "bizChName", value = "业务名称", required = true, dataType = "String"), |
| 257 | + @ApiImplicitParam(name = "bizEnName", value = "业务英文名称", required = true, dataType = "String"), |
| 258 | + @ApiImplicitParam(name = "path", value = "项目生成类路径", required = true, dataType = "String") |
| 259 | + }) |
| 260 | + @RequestMapping(value = "/generate", method = RequestMethod.POST) |
| 261 | +``` |
| 262 | + |
| 263 | +##常见问题答疑 |
| 264 | +1. 为何有的业务没有service层: 部分业务比较简单,所以就没写service层,写service是为了让复杂业务更有条理,更清晰. |
| 265 | +2. 为何既有dao,又有mapper: mapper是mybatis-plus自动生成的,里边有许多mybatis-plus增强的方法,dao是自己写的业务,mybatis-plus自动生成代码时会覆盖mapper,所以就把自己写的dao分开了,生成代码的时候不影响 |
| 266 | +3. 为何分页是前端实现:部分页面因为数据量比较少,就直接用客户端分页了,日志页面的分页是采用服务端分页的,如果其他业务有特别需要,可以参考日志的写法 |
| 267 | + |
| 268 | +##效果图 |
| 269 | + |
| 270 | + |
| 271 | + |
| 272 | + |
| 273 | + |
| 274 | + |
| 275 | + |
| 276 | + |
| 277 | + |
| 278 | + |
| 279 | + |
| 280 | + |
| 281 | + |
| 282 | + |
| 283 | + |
0 commit comments