spring4+SpringMVC4+Mybatis+Gradle j2ee快速开发脚手架ssm-easy-template发布

2016-04-06

这篇教程在半年前发表过，后来博客迁移的原因，忘记备份，因此重写一篇。前段时间把ssm-easy-template放到了github上，在没有任何宣传的情况下，目前已经有36个star和fork，这是我更新项目的最大动力。
项目简介:Ssm-Easy-Template 是一个J2EE项目快速开发脚手架，集成了最常用的框架,适用于Restfull 架构风格Web Service接口开发。项目使用最灵活的构建工具-gradle，加入了常用的gradle插件(gretty,flywaydb，mybatis generator)。

项目源码

项目托管在github:https://github.com/ichenkaihua/ssm-easy-template
欢迎大家star或fork,后期更新将不在本页说明，请到github上关注最新动态。

组成

主要框架

  • Spring4.2: 不多说，貌似J2EE离不开他了。
  • Springmvc4.2: 与Spring无缝集成，简单灵活，支持Restful风格。
  • Mybatis3.3.0 :个人认为比Hibernate好控制，毕竟是自己写的Sql语句。
  • Shiro: Apache的权限管理框架，扩展性好，使用简单，个人认为比Spring-Security框架容易入手。
  • tomcat连接池 : 稳定，性能好。
  • sf4j ：支持多种日志系统，使用的是log4j。

工具框架

  • Spring-Test :包括了常用单元测试、集成测试、Web测试，Src/Test/Java下有几个简单的测试类。使用测试框架的好处就是节省时间，无需启动Server就能测试程序。
  • Mybatis-Pagehelper :Mybatis的分页排序插件，由国人开发，用起来非常方便，Mybatis-Pagehelperp 项目主页。
  • Mybatis通用Mapper3 也是有上面作者开发，极其方便的使用Mybatis单表的增删改查，如果是单表操作，基本不用写Mapper文件,Mybatis通用Mapper3 项目主页。
  • Spring-Mail： 可修改/src/main/resource/mail-config.properties配置文件，这个配置文件配置的是主邮箱。
  • commons fileupload:spring mvc中集成了appache-commons-fileupload上传组件。上传处理更便捷。

开发工具

IDE

Eclipse确实强大，但 Intellij Idea 更智能，强烈推荐 Idea

依赖管理工具

Maven可能更容易上手，但我更喜欢Gradle的简洁

使用

下载

Download Zip或者git clone

	git clone https://github.com/ichenkaihua/ssm-easy-template.git

快速开始

新建或者配置一个mysql数据库，根据数据库信息修改src/main/resources/db-mysql.properties文件。
修改build.properties相关属性(mysql配置),然后进入命令行:

# 进入项目目录
cd ssm-easy-template/

# 初始化数据库,将db/migration目录下sql迁移到本地数据库
./gradlew flywayMigrate

# jetty启动项目
./gradlew  appStart

# 获取所有用户 
curl  http://localhost:8080/users

# 其他操作...

# 关闭jetty
./gradlew appStop

导入

建议使用IDEA，eclipse也没问题

详细修改

利用mybatis-generator(MBG) 生成model/mapper/mapper.xml文件

Mybatis考虑到手写XML文件的繁琐，因此开发了MBG工具，通用Mapper这个项目再次简化了mybatis的生成代码数量。ssm-easy-template把mybatis generator放在build.gradle中，封装成一个Gradle Task。

  • 修改generator配置文件: 打开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
  • 执行 mybatisGenerate task :
    shell ./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.properties

ssm-easy-template把项目配置分离，便于后期扩展或替换组件。根据项目需要更改配置文件

实现项目逻辑

为了方便后期扩展与重用，ssm-easy-template封装出BaseService<Mapper<M>,M>,通常service继承BaseService<Mapper<M>,M>，单表操作的逻辑不需要再实现

部署

SSM-Easy-Template集成了gretty插件,更多使用方法前往gretty官网

# jetty启动项目，http://locaohost:8080/
./gradlew  jettyStart

#关闭jetty
./gradlew jettyStop

Debug

可以参考IntelliJ IDEA +gradle+gretty debug j2ee web-application

修改记录

  • 2015-12-24 –v2.0
    • 集成 flyway到gradle中，用于数据库迁移
    • 修改 数据库配置全部读取src/main/resources/db-mysql.properties
    • 集成 mybatis generator在gradle中，用于生成mybatis mapper等java类
    • 更新 mybatis分页插件(com.github.pagehelper:pagehelper)到4.0.0版本
    • 更新 mybatis通用插件(tk.mybatis:mapper:3.3.1)到3.3.1 版本
    • 添加 HomController首页映射至WEB-INF/index.jsp

changelog

相关文档