1. 為什么要寫(xiě)單表SQL自動(dòng)生成呢？
我們?cè)谑褂肕ybatis做dao層開(kāi)發(fā)時(shí)，對(duì)單表的操作大部分都是一樣的，每次都寫(xiě)著一樣的代碼既浪費(fèi)時(shí)間也得不到任何樂(lè)趣，我們?yōu)楹尾煌ㄟ^(guò)程序解決這個(gè)問(wèn)題呢？
2. Mybatis中Provider介紹
在使用Mybatis開(kāi)發(fā)過(guò)程中，可以通過(guò)Mybatis定義的xml文件進(jìn)行SQL的配置，我們比較少使用其提供的Provider進(jìn)行SQL編寫(xiě)。Mybatis提供了InsertProvider、DeleteProvider、UpdateProvider、SelectProvider四個(gè)注解來(lái)進(jìn)行SQL的配置，以及提供了Results、ResultMap、ResultType幾個(gè)注解進(jìn)行結(jié)果映射。至于這幾個(gè)注解該如何使用我這邊就不做詳細(xì)介紹了，可以參考這篇博客，該文章有比較詳細(xì)的例子介紹Provider如何使用。下面我們就來(lái)介紹如何通過(guò)Mybatis提供的Provider來(lái)編寫(xiě)SQL自動(dòng)生成。
3. 通過(guò)Provider進(jìn)行SQL自動(dòng)生成
3.1. 總體思路
通過(guò)定義一個(gè)基礎(chǔ)接口，在基礎(chǔ)接口中定義一系列CRUD操作，在調(diào)用的過(guò)程中通過(guò)反射獲取數(shù)據(jù)庫(kù)實(shí)體（Entity）上定義的表名、列名等元數(shù)據(jù)，然后根據(jù)表名、列名生成要操作的SQL。
3.2 代碼實(shí)現(xiàn)
- 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主要是通過(guò)反射獲取實(shí)體中的注解，這里采用javax.persistence Api，表名通過(guò)Table注解定義，默認(rèn)采用實(shí)體類的簡(jiǎn)單名稱，主鍵通過(guò)Id注解定義，通過(guò)Column注解定義列名，默認(rèn)使用實(shí)例變量名稱作為列名，對(duì)于不需要映射的字段在示例變量上標(biāo)注Transient注解。這里要吐槽一下簡(jiǎn)書(shū)的書(shū)寫(xiě)代碼功能是在太弱，貼個(gè)代碼好麻煩，這里我就貼出完整代碼了。 - SQLBuilder
SQLBuilder主要負(fù)責(zé)根據(jù)獲取到的表元數(shù)據(jù)生成SQL，其有四個(gè)子類InsertSQLBuilder、DeleteSQLBuilder、UpdateSQLBuilder、UpdateSQLBuilder，這四個(gè)子類分別生成增、刪、改、查SQL。
3.3 如何使用呢？
我們以對(duì)用戶的操作為例。
- 首先定義一個(gè)
User實(shí)體，如下：
@Table(name = "t_user")
@Getter @Setter
public class User {
@Id
private Integer id;
private String name;
private String password;
}
為了追求極簡(jiǎn)代碼，這里使用lombok中定義的注解。
- 然后定義對(duì)
User操作的Mapper，如下：
public interface UserRepository extends BaseMapper<User> {}
這樣我們就可以對(duì)User進(jìn)行增刪改查操作了。
4. 總結(jié)
在我們了解如何使用Provider定義SQL時(shí)，編寫(xiě)一個(gè)單表自動(dòng)生成的組件就比較容易了。對(duì)于跨表操作我們還是老老實(shí)實(shí)寫(xiě)SQL吧，或者使用Hibernate。
