ssm-easy-template

介绍

Ssm-Easy-Template 是一个J2Ee项目快速开发脚手架，集成了最常用的框架,适用于Restfull 架构风格Web Service接口开发。

组成

主要框架

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 :

./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>，单表操作的逻辑不需要再实现，BaseService实现的接口如下:

package com.github.ichenkaihua.service;

import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.session.RowBounds;
import org.springframework.beans.factory.annotation.Autowired;
import tk.mybatis.mapper.common.Mapper;

import java.util.List;

/**
 * Created by chenkaihua on 15-12-23.
 */
public class BaseService<Mapp extends Mapper<M>,M> implements  Mapper<M>{


    @Autowired
    Mapp mapper;


    @Override
    public int deleteByExample(Object example) {
        return mapper.deleteByExample(example);
    }

    @Override
    public int deleteByPrimaryKey(Object key) {
        return mapper.deleteByPrimaryKey(key);
    }

    @Override
    public int delete(M record) {
        return mapper.delete(record);
    }

    @Override
    public int insert(M record) {
        return mapper.insert(record);
    }

    @Override
    public int insertSelective(M record) {
        return mapper.insertSelective(record);
    }

    @Override
    public List<M> selectAll() {
        return mapper.selectAll();
    }

    @Override
    public List<M> selectByExample(Object example) {
        return mapper.selectByExample(example);
    }

    @Override
    public List<M> selectByExampleAndRowBounds(Object example, RowBounds rowBounds) {
        return mapper.selectByExampleAndRowBounds(example,rowBounds);
    }

    @Override
    public M selectByPrimaryKey(Object key) {
        return mapper.selectByPrimaryKey(key);
    }

    @Override
    public int selectCountByExample(Object example) {
        return mapper.selectCountByExample(example);
    }

    @Override
    public int selectCount(M record) {
        return mapper.selectCount(record);
    }

    @Override
    public List<M> select(M record) {
        return mapper.select(record);
    }

    @Override
    public M selectOne(M record) {
        return mapper.selectOne(record);
    }

    @Override
    public List<M> selectByRowBounds(M record, RowBounds rowBounds) {
        return mapper.selectByRowBounds(record,rowBounds);
    }

    @Override
    public int updateByExample(@Param("record") M record, @Param("example") Object example) {
        return mapper.updateByExample(record,example);
    }

    @Override
    public int updateByExampleSelective(@Param("record") M record, @Param("example") Object example) {
        return mapper.updateByExampleSelective(record,example);
    }

    @Override
    public int updateByPrimaryKey(M record) {
        return mapper.updateByPrimaryKey(record);
    }

    @Override
    public int updateByPrimaryKeySelective(M record) {
        return mapper.updateByPrimaryKeySelective(record);
    }
}

部署

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

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

#关闭jetty
./gradlew jettyStop

修改记录

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

关于我

博客链接:陈开华的博客

Email: [email protected]

luowei98 / ssm-easy-template Goto Github PK