springboot中如何通过整合Mapper实现单表操作

1. 框架Maven部署安装

下载框架源码后，在项目根路径下执行mvn clean install可安装到本地maven库。如果需要共享，且搭了Nexus私服，则在根路径pom.xml文件中添加distributionManagement配置，指定Nexus仓库分发地址，使用mvn clean deploy安装到远程maven仓库，如

nexus-releases

http://ip:port/repository/maven-releases/



nexus-snapshots

http://ip:port/repository/maven-snapshots/

上述指定的repository需要在maven的全部配置文件settings.xml中有对应账号配置(id需要一一对应)，如

nexus-snapshots
admin
xxx


nexus-releases
admin
xxx

2. pom.xml配置

项目中引入该数据库框架有三种方式：

1. 直接引入 cn.jboost.springboot:tkmapper-spring-boot-starter（没有连接池）

2. 直接引入 cn.jboost.springboot:druid-spring-boot-starter（druid连接池支持）

3. 项目继承 cn.jboost.springboot:spring-boot-parent（使用的是druid连接池）

三种方式的pom.xml配置如下

#第一种方式

cn.jboost.springboot
tkmapper-spring-boot-starter
1.2-SNAPSHOT


#第二种方式

cn.jboost.springboot
druid-spring-boot-starter
1.2-SNAPSHOT


#第三种方式

cn.jboost.springboot
spring-boot-parent
1.2-SNAPSHOT
 

根据情况引入mysql或postgresql的驱动依赖（其它数据库暂未做类型转换支持，未作测试）

3. 配置数据源

如果使用druid连接池，则在application.yml配置文件中，加入如下数据源配置（推荐）

spring:
datasource:
druid:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/test?autoReconnect=true&useUnicode=true&characterEncoding=utf-8
username: root
password:
# 自定义配置
initialSize: 2 # 初始化大小
minIdle: 1 # 最小连接
maxActive: 5 # 最大连接
druidServletSettings:
allow: 127.0.0.1
deny:
loginUsername: admin
loginPassword: Passw0rd
resetEnable: true
druidFilterSettings:
exclusions: '*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*'
maxWait: 60000 # 配置获取连接等待超时的时间
timeBetweenEvictionRunsMillis: 60000 # 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒
minEvictableIdleTimeMillis: 300000 # 配置一个连接在池中最小生存的时间，单位是毫秒
validationQuery: SELECT 'x'
testWhileIdle: true
testOnBorrow: false
testOnReturn: false
poolPreparedStatements: true # 打开PSCache，并且指定每个连接上PSCache的大小
maxPoolPreparedStatementPerConnectionSize: 20
filters: stat #,wall（添加wall代码里不能直接拼接sql，druid有sql注入校验） # 配置监控统计拦截的filters，去掉后监控界面sql无法统计，'wall'用于防火墙
connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000 # 通过connectProperties属性来打开mergeSql功能；慢SQL记录
useGlobalDataSourceStat: true # 合并多个DruidDataSource的监控数据

如果不使用连接池，则配置相对简单，如下

spring:
datasource:
url: jdbc:mysql://localhost:3306/test?autoReconnect=true&useUnicode=true&characterEncoding=utf-8
username: root
password:
driver-class-name: com.mysql.jdbc.Driver

4. 定义相应domain，mapper，service，controller各层对象

以demo为例（demo数据库脚本见resources/schema.sql），domain定义一个User类,

@Table(name = "user")
@Getter
@Setter
@ToString
public class User extends AutoIncrementKeyBaseDomain {
private String name;
@ColumnType(jdbcType = JdbcType.CHAR)
private Gender gender;
private List favor;
private Map address;
public enum Gender{
M,
F
}
}

需要添加@Table注解指定数据库表名，可通过继承AutoIncrementKeyBaseDomain来实现自增主键，或UUIDKeyBaseDomain来实现UUID主键，如果自定义其它类型主键，则继承BaseDomain。

该框架Service层通用方法实现BaseService只支持单列主键，不支持组合主键（也不建议使用组合主键）

框架默认对List、Map等复杂类型属性会映射到mysql的json类型或postgresql的jsonb类型，如果某个属性不需要映射，可添加@Transient注解；枚举类型需添加@ColumnType指定jdbcType。

dao层定义UserMapper，

@Repository
public interface UserMapper extends BaseMapper {
}

BaseMapper默认实现了单表的增删改查及批量插入等功能，如需定义复杂查询，可在该接口中定义，然后通过mapper xml文件编写实现。

service层定义 UserService，继承了BaseService的通用功能（具体可查看源码），同样可在该类中自定义方法

@Service
public class UserService extends BaseService {
@Transactional
public void createWithTransaction(User user){
create(user);
//用于测试事务
throw new RuntimeException("抛出异常，让前面的数据库操作回滚");
}
}

controller层定义 UserController，继承了BaseController的通用接口（具体可查看源码）

@RestController
@RequestMapping("/user")
public class UserController extends BaseController {
}

如上，只需要定义各层对应的接口或类，继承基础接口或类，便完成了用户基本的增删改查功能，不需要写一行具体的实现代码。

5. 测试、运行

示例中提供了两个新建用户的单元测试，参考SpringbootTkmapperApplicationTests类

运行，在主类上直接运行，然后浏览器里打开http://localhost:8080/user 则可列出单元测试中创建的用户（其它接口参考BaseController实现）