# Mybatis3 通过 provider 注解结合动态 sql 实现 CRUD
特别提示
实际项目中推荐使用Mybatis-Plus,此篇文章重点在于它的架构思路，并且它的实现方式也借鉴了Mybatis-Plus。
# 注解
# @TableName (opens new window)
- 描述：表名注解
| 属性 | 类型 | 必须指定 | 默认值 | 描述 |
|---|---|---|---|---|
| value | String | 否 | "" | 表名 |
# @TableId (opens new window)
- 描述：主键注解
| 属性 | 类型 | 必须指定 | 默认值 | 描述 |
|---|---|---|---|---|
| value | String | 否 | "" | 主键字段名 |
| type | Enum | 否 | IdType.NONE | 主键类型 |
# @TableField (opens new window)
- 描述：字段注解(非主键)
| 属性 | 类型 | 必须指定 | 默认值 | 描述 |
|---|---|---|---|---|
| value | String | 否 | "" | 表名 |
| exist | boolean | 否 | true | 是否为数据库表字段 |
| select | boolean | 否 | true | 是否进行 select 查询 |
# CRUD 接口
说明:
- 通用 CRUD 封装BaseMapper (opens new window)接口，为
zc-Mybatis启动时自动解析实体表关系映射转换为Mybatis内部对象注入容器 - 泛型
T为任意实体对象 - 参数
Serializable为任意类型主键zc-Mybatis不推荐使用复合主键约定每一张表都有自己的唯一id主键
# Insert
/**
* 插入一条记录
*
* @param entity 实体对象
* @return 新增的记录个数
*/
@InsertProvider(type = DefaultSqlProvider.class, method = "insert")
@Options(useGeneratedKeys = true, keyProperty = "id")
int insert(T entity);
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# 参数说明
| 类型 | 参数名 | 描述 |
|---|---|---|
| T | entity | 实体对象 |
# Delete
/**
* 根据 ID 删除
*
* @param id 主键ID
* @return 被删除记录个数
*/
@DeleteProvider(type = DefaultSqlProvider.class, method = "deleteById")
int deleteById(Serializable id);
/**
* 根据 ID列表 批量删除
*
* @param id 主键ID列表
* @return 被删除记录个数
*/
@DeleteProvider(type = DefaultSqlProvider.class, method = "deleteBatchIds")
int deleteBatchIds(@Param("id") Collection<? extends Serializable> id);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 参数说明
| 类型 | 参数名 | 描述 |
|---|---|---|
| Collection<? extends Serializable> | idList | 主键ID列表(不能为 null 以及 empty) |
| Serializable | id | 主键ID |
# Update
/**
* 根据 ID 修改
*
* @param entity 实体对象
* @return 被修改记录个数
*/
@UpdateProvider(type = DefaultSqlProvider.class, method = "updateById")
int updateById(T entity);
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
# 参数说明
| 类型 | 参数名 | 描述 |
|---|---|---|
| T | entity | 实体对象 (set 条件值,可为 null) |
# Select
/**
* 根据 ID 查询
*
* @param id 主键ID
* @return 实体
*/
@SelectProvider(type = DefaultSqlProvider.class, method = "selectById")
T selectById(Serializable id);
/**
* 查询（根据ID 批量查询）
*
* @param id 主键ID列表(不能为 null 以及 empty)
* @return 实体
*/
@SelectProvider(type = DefaultSqlProvider.class, method = "selectBatchIds")
List<T> selectBatchIds(@Param("id") Collection<? extends Serializable> id);
/**
* 查询所有
*
* @return 实体
*/
@SelectProvider(type = DefaultSqlProvider.class, method = "list")
List<T> list();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# 参数说明
| 类型 | 参数名 | 描述 |
|---|---|---|
| Serializable | id | 主键ID |
| Collection<? extends Serializable> | idList | 主键ID列表(不能为 null 以及 empty) |
# DefaultSqlProvider
import cn.hutool.core.text.StrBuilder;
import cn.hutool.core.util.StrUtil;
import com.zhengcheng.mybatis.mapper.BaseMapper;
import com.zhengcheng.mybatis.metadata.TableInfo;
import com.zhengcheng.mybatis.metadata.TableInfoHelper;
import com.zhengcheng.mybatis.model.BaseEntity;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.builder.annotation.ProviderContext;
import org.apache.ibatis.jdbc.SQL;
import org.springframework.core.ResolvableType;
import java.io.Serializable;
import java.lang.reflect.Type;
import java.text.MessageFormat;
import java.time.LocalDateTime;
import java.util.Collection;
import java.util.Objects;
/**
* 默认 SQL 提供者
*
* @author : zhangquansheng
* @date : 2020/3/28 14:45
*/
@Slf4j
public class DefaultSqlProvider<T extends BaseEntity> {
private final static int MAX_SIZE = 1000;
public String insert(BaseEntity baseEntity) {
baseEntity.setGmtCreate(LocalDateTime.now());
baseEntity.setGmtModified(LocalDateTime.now());
TableInfo tableInfo = getTableInfo(baseEntity.getClass());
SQL sql = new SQL();
sql.INSERT_INTO(tableInfo.getTableName());
tableInfo.getFieldList().forEach(tableFieldInfo -> {
if (StrUtil.equals(tableFieldInfo.getColumn(), tableInfo.getKeyColumn())) {
return;
}
sql.VALUES(String.format("`%s`", tableFieldInfo.getColumn()), String.format("#{%s}", tableFieldInfo.getProperty()));
});
return getSql(sql);
}
public String deleteById(ProviderContext context) {
TableInfo tableInfo = getTableInfo(getEntityClass(context));
SQL sql = new SQL();
sql.DELETE_FROM(tableInfo.getTableName());
sql.WHERE(String.format("`%s` = #{%s}", tableInfo.getKeyColumn(), tableInfo.getKeyProperty()));
return getSql(sql);
}
public String deleteBatchIds(ProviderContext context, Collection<? extends Serializable> id) {
TableInfo tableInfo = getTableInfo(getEntityClass(context));
SQL sql = new SQL();
sql.DELETE_FROM(tableInfo.getTableName());
sql.WHERE(String.format("`%s` IN %s", tableInfo.getKeyColumn(), inExpression(tableInfo.getKeyProperty(), id.size())));
return getSql(sql);
}
public String selectById(ProviderContext context) {
TableInfo tableInfo = getTableInfo(getEntityClass(context));
SQL sql = new SQL();
sql.SELECT(tableInfo.getAllFieldString());
sql.FROM(tableInfo.getTableName());
sql.WHERE(String.format("`%s` = #{%s}", tableInfo.getKeyColumn(), tableInfo.getKeyProperty()));
return sql.toString();
}
public String selectBatchIds(ProviderContext context, Collection<? extends Serializable> id) {
SQL sql = new SQL();
TableInfo tableInfo = getTableInfo(getEntityClass(context));
sql.SELECT(tableInfo.getAllFieldString());
sql.FROM(tableInfo.getTableName());
sql.WHERE(String.format("`%s` IN %s", tableInfo.getKeyColumn(), inExpression(tableInfo.getKeyProperty(), id.size())));
return getSql(sql);
}
public String updateById(BaseEntity baseEntity) {
baseEntity.setGmtModified(LocalDateTime.now());
TableInfo tableInfo = getTableInfo(baseEntity.getClass());
SQL sql = new SQL();
sql.UPDATE(tableInfo.getTableName());
tableInfo.getFieldList().forEach(tableFieldInfo -> {
if (StrUtil.equals(tableFieldInfo.getColumn(), tableInfo.getKeyColumn())) {
return;
}
sql.SET(String.format("%s = #{%s}", tableFieldInfo.getColumn(), tableFieldInfo.getProperty()));
});
sql.WHERE(String.format("`%s` = #{%s}", tableInfo.getKeyColumn(), tableInfo.getKeyProperty()));
return getSql(sql);
}
public String list(ProviderContext context) {
SQL sql = new SQL();
TableInfo tableInfo = getTableInfo(getEntityClass(context));
sql.SELECT(tableInfo.getAllFieldString());
sql.FROM(tableInfo.getTableName());
sql.LIMIT(MAX_SIZE);
return getSql(sql);
}
private String getSql(SQL sql) {
String sqlStr = sql.toString();
if (log.isDebugEnabled()) {
log.debug("sql:[{}]", sqlStr);
}
return sqlStr;
}
private String inExpression(String property, int size) {
MessageFormat messageFormat = new MessageFormat("#'{'" + property + "[{0}]}");
StrBuilder sb = StrBuilder.create(" (");
for (int i = 0; i < size; i++) {
sb.append(messageFormat.format(new Object[]{i}));
if (i != size - 1) {
sb.append(", ");
}
}
return sb.append(")").toString();
}
private Class<?> getEntityClass(ProviderContext context) {
Class<?> mapperType = context.getMapperType();
for (Type parent : mapperType.getGenericInterfaces()) {
ResolvableType parentType = ResolvableType.forType(parent);
if (parentType.getRawClass() == BaseMapper.class) {
return parentType.getGeneric(0).getRawClass();
}
}
return null;
}
private TableInfo getTableInfo(Class<?> clazz) {
TableInfo tableInfo = TableInfoHelper.getTableInfo(clazz);
if (Objects.isNull(tableInfo)) {
tableInfo = TableInfoHelper.initTableInfo(clazz);
}
return tableInfo;
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144