Mybatis单表自动生成SQL
2016-09-26 本文已影响2223人
dayspring
1. 为什么要写单表SQL自动生成呢？
我们在使用Mybatis做dao层开发时，对单表的操作大部分都是一样的，每次都写着一样的代码既浪费时间也得不到任何乐趣，我们为何不通过程序解决这个问题呢？
2. Mybatis中Provider介绍
在使用Mybatis开发过程中，可以通过Mybatis定义的xml文件进行SQL的配置，我们比较少使用其提供的Provider进行SQL编写。Mybatis提供了InsertProvider、DeleteProvider、UpdateProvider、SelectProvider四个注解来进行SQL的配置，以及提供了Results、ResultMap、ResultType几个注解进行结果映射。至于这几个注解该如何使用我这边就不做详细介绍了，可以参考这篇博客，该文章有比较详细的例子介绍Provider如何使用。下面我们就来介绍如何通过Mybatis提供的Provider来编写SQL自动生成。
3. 通过Provider进行SQL自动生成
3.1. 总体思路
通过定义一个基础接口，在基础接口中定义一系列CRUD操作，在调用的过程中通过反射获取数据库实体（Entity）上定义的表名、列名等元数据，然后根据表名、列名生成要操作的SQL。
3.2 代码实现
- BaseMapper
public interface BaseMapper<T> {
@SelectProvider(type = SQLProvider.class, method = "selectById")
T selectById(T item);
@SelectProvider(type = SQLProvider.class, method = "selectOne")
T selectOne(T item);
@SelectProvider(type = SQLProvider.class, method = "select")
List<T> select(T item);
@InsertProvider(type = SQLProvider.class, method = "insert")
int insert(T item);
@DeleteProvider(type = SQLProvider.class, method = "delete")
int delete(T item);
@DeleteProvider(type = SQLProvider.class, method = "deleteById")
int deleteById(T item);
@UpdateProvider(type = SQLProvider.class, method = "updateById")
int updateById(T item);
@UpdateProvider(type = SQLProvider.class, method = "updateSelectiveById")
int updateSelectiveById(T item);
}
- SQLProvider
public class SQLProvider {
private static final Logger LOGGER = LoggerFactory.getLogger(SQLProvider.class);
private SQLBuilderHelper sqlHelper = SQLBuilderHelper.getInstance();
public <T> String selectById(T item) throws AutoSQLException {
String table = sqlHelper.getTableName(item.getClass());
ColumnMapping columnMapping = getIdColumn(item.getClass());
if (columnMapping == null) {
throw new AutoSQLException(String.format("There is no identity column in table[%s]", table));
}
SelectSQLBuilder sqlBuilder = new SelectSQLBuilder(); sqlBuilder.table(table) .condition(columnMapping.getColumnName(), columnMapping.getField().getName(), "=");
return sqlBuilder.toSqlString();
}
public <T> String selectOne(T item) throws AutoSQLException {
String table = sqlHelper.getTableName(item.getClass());
List<ColumnValue> values = sqlHelper.getColumnValue(item);
SelectSQLBuilder sqlBuilder = new SelectSQLBuilder();
sqlBuilder.table(table);
for (ColumnValue value : values) {
if (!value.isValueNull()) {
sqlBuilder.condition(value.getColumnName(), value.getFieldName(), "=");
}
}
return sqlBuilder.toSqlString();
}
public <T> String select(T item) throws AutoSQLException {
return selectOne(item);
}
public <T> String delete(T item) throws AutoSQLException {
String table = sqlHelper.getTableName(item.getClass());
List<ColumnValue> values = sqlHelper.getColumnValue(item);
DeleteSQLBuilder sqlBuilder = new DeleteSQLBuilder();
sqlBuilder.table(table);
for (ColumnValue value : values) {
if (!value.isValueNull()) {
sqlBuilder.condition(value.getColumnName(), value.getFieldName(), "=");
}
}
return sqlBuilder.toSqlString();
}
public <T> String deleteById(T item) throws AutoSQLException {
ColumnMapping mapping = getIdColumn(item.getClass());
String table = sqlHelper.getTableName(item.getClass());
if (mapping == null) {
throw new AutoSQLException(String.format("There is no identity column in table[%s]", table));
}
DeleteSQLBuilder sqlBuilder = new DeleteSQLBuilder();
sqlBuilder.table(table).condition(mapping.getColumnName(), mapping.getFieldName(), "=");
return sqlBuilder.toSqlString();
}
public <T> String updateById(T item) throws AutoSQLException {
String table = sqlHelper.getTableName(item.getClass());
List<ColumnValue> values = sqlHelper.getColumnValue(item);
UpdateSQLBuilder sqlBuilder = new UpdateSQLBuilder();
sqlBuilder.table(table);
for (ColumnValue value : values) {
if (!value.getColumnMapping().isId()) {
sqlBuilder.set(value.getColumnName(), value.getFieldName());
}
if (value.getColumnMapping().isId()) {
sqlBuilder.condition(value.getColumnName(), value.getFieldName(), "=");
}
}
return sqlBuilder.toSqlString();
}
public <T> String updateSelectiveById(T item) throws AutoSQLException {
String table = sqlHelper.getTableName(item.getClass());
List<ColumnValue> values = sqlHelper.getColumnValue(item);
UpdateSQLBuilder sqlBuilder = new UpdateSQLBuilder();
sqlBuilder.table(table);
for (ColumnValue value : values) {
if (!value.isValueNull() && !value.getColumnMapping().isId()) {
sqlBuilder.set(value.getColumnName(), value.getFieldName());
}
if (value.getColumnMapping().isId()) {
sqlBuilder.condition(value.getColumnName(), value.getFieldName(), "=");
}
}
return sqlBuilder.toSqlString();
}
private ColumnMapping getIdColumn(Class<?> clazz) {
List<ColumnMapping> mappings = sqlHelper.getColumnMapping(clazz);
for (ColumnMapping mapping : mappings) {
if (mapping.isId()) {
return mapping;
}
}
return null;
}
public <T> String insert(T item) throws AutoSQLException {
String tableName = sqlHelper.getTableName(item.getClass());
List<ColumnMapping> values =
sqlHelper.getColumnMapping(item.getClass());
if (values.isEmpty()) {
throw new AutoSQLException(String.format("Table[%s] has no column"));
}
InsertSQLBuilder sqlBuilder =new InsertSQLBuilder();
sqlBuilder.table(tableName);
for (ColumnMapping mapping : values) {
sqlBuilder.column(mapping.getColumnName());
sqlBuilder.field(mapping.getField().getName());
}
return sqlBuilder.toSqlString();
}
- SQLBuilderHelper
SQLBuilderHelper主要是通过反射获取实体中的注解，这里采用javax.persistence Api，表名通过Table注解定义，默认采用实体类的简单名称，主键通过Id注解定义，通过Column注解定义列名，默认使用实例变量名称作为列名，对于不需要映射的字段在示例变量上标注Transient注解。这里要吐槽一下简书的书写代码功能是在太弱，贴个代码好麻烦，这里我就贴出完整代码了。 - SQLBuilder
SQLBuilder主要负责根据获取到的表元数据生成SQL，其有四个子类InsertSQLBuilder、DeleteSQLBuilder、UpdateSQLBuilder、UpdateSQLBuilder，这四个子类分别生成增、删、改、查SQL。
3.3 如何使用呢？
我们以对用户的操作为例。
- 首先定义一个
User实体，如下：
@Table(name = "t_user")
@Getter @Setter
public class User {
@Id
private Integer id;
private String name;
private String password;
}
为了追求极简代码，这里使用lombok中定义的注解。
- 然后定义对
User操作的Mapper，如下：
public interface UserRepository extends BaseMapper<User> {}
这样我们就可以对User进行增删改查操作了。
4. 总结
在我们了解如何使用Provider定义SQL时，编写一个单表自动生成的组件就比较容易了。对于跨表操作我们还是老老实实写SQL吧，或者使用Hibernate。
