spring+springmvc+mybatis+shiro+gradle简单集成框架
Ssm-Easy-Template 是一个J2Ee项目快速开发脚手架,集成了最常用的框架,适用于Restfull 架构风格Web Service接口开发。项目使用最灵活的构建工具-gradle,加入了常用的gradle插件(gretty,flydb,mybatis generator),集成swagger2,asciidoctor,自动生成rest api文档。
Spring-Security框架容易入手。Src/Test/Java下有几个简单的测试类。使用测试框架的好处就是节省时间,无需启动Server就能测试程序。/src/main/resource/mail-config.properties配置文件,这个配置文件配置的是主邮箱。spring mvc中集成了appache-commons-fileupload上传组件。上传处理更便捷。Eclipse确实强大,但 Intellij Idea 更智能,强烈推荐 Idea
Maven可能更容易上手,但我更喜欢Gradle的简洁
Download Zip或者git clone
git clone https://github.com/ichenkaihua/ssm-easy-template.git新建或者配置一个mysql数据库,根据数据库信息修改src/main/resources-dev/jdbc-mysql.properties文件。
然后进入命令行:
# 进入项目目录
cd ssm-easy-template/
# 初始化数据库,将db/migration目录下sql迁移到本地数据库
./gradlew flywayMigrate
# jetty启动项目
./gradlew appStart
# 获取所有用户
curl http://localhost:8080/users
# 其他操作...
# 关闭jetty
./gradlew appStop建议使用IDEA,eclipse也没问题
model/mapper/mapper.xml文件Mybatis考虑到手写XML文件的繁琐,因此开发了MBG工具,通用Mapper这个项目再次简化了mybatis的生成代码数量。ssm-easy-template把mybatis generator放在build.gradle中,封装成一个Gradle Task。
gradle.propertis文件,修改生成信息(数据库信息在src/main/resources/db-mysql.properties),默认如下#生成的model类所在包
modelPackage=com.github.ichenkaihua.model
#生成的mapper接口类所在包
mapperPackage=com.github.ichenkaihua.mapper
#生成的mapper xml文件所在包,默认存储在resources目录下
sqlMapperPackage=mybatis_mapper
./gradlew mybatisGenerate在src/main/resources目录下,有下列文件:
#项目运行的数据库配置
jdbc-mysql.properties
#log4j配置
log4j.properties
#mail
mail-config.properties
#spring Application root Context
spring-config.xml
# spirng-mail
spring-mail.xml
#springMVC context
spring-mvc-config.xml
#springMVC shiro
spring-mvc-shiro.xml
#spring-mybatis
spring-mybatis.xml
#spring-shiro
spring-shiro.xml
#spring-tomcatl-pool 连接池
spring-tomcat-pool.xml
#连接池配置
tomcat-pool-config.propertiesssm-easy-template把项目配置分离,便于后期扩展或替换组件。根据项目需要更改配置文件
项目开发中,通常有多个环境,一个是用于本地调试的开发环境,另一个是用于对外发布的生产环境。 在本地开发环境中,使用本地安装的数据库,在生产环境中使用生产环境的数据库。这样就能避免本地调试不当导致对生产环境数据造成破坏。本项目用gradle简单实现了此功能
如何使用
src/main/resources-dev/jdbc-mysql.properties,这个文件是开发环境下数据库配置,通常配置的本地数据库环境src/main/resources-prod/jdbc-mysql.properties,这个文件是开发环境下数据库配置,通常配置的是外网数据库环境gradle.properties配置文件的属性env=dev,有两个选项:dev--本地环境,prod--生产环境需要注意的是:
resources-dev/jdbc-mysql.properties和resources-prod/jdbc-mysql.properties两个文件的字段名要一致,因为spring会读取这两个文件中的一个,字段不一致会导致出错
项目集成了spring-fox,asccidotor,能够在线浏览restapi,并生成html,pdf格式的硬文档
项目启动后,打开http://localhost:8080/swagger-ui.html即可查看api文档
# 生成html和pdf文档
gradle asccidoctor之后在build/asccidoc目录下可以找到生成的html5和pdf文件.
生成的pdf文件有中文显示不全的问题,这是asciidoctor的官方bug,现在已经有方案解决,建议使用
asciidoctor-pdf工具,使用自定义主题解决这问题.请参考 这里
为了方便后期扩展与重用,ssm-easy-template封装出BaseService,M>,通常service继承BaseService,M>,单表操作的逻辑不需要再实现
SSM-Easy-Template集成了gretty插件,更多使用方法前往gretty官网
# jetty启动项目,http://locaohost:8080/
./gradlew jettyStart
#关闭jetty
./gradlew jettyStop
可以参考IntelliJ IDEA +gradle+gretty debug j2ee web-application
spring版本到最新4.3.7.releasemysql-connector-java版本到6.0.6博客链接:陈开华的博客
Email: [email protected]
暂无开放 Issues,或尚未同步最近议题。