碼上歡樂
相關內容    簡體    繁體

深入淺出Mybatis-sql自動生成

本文轉載自   查看原文   2017-05-05 08:48   4025 
原

深入淺出Mybatis-sql自動生成

本文提供了一種自動生成sql語句的方法，它針對的對象是有主鍵或唯一索引的單表，提供的操作有增、刪、改、查4種。理解本文和本文的提供的代碼需要有java注解的知識，因為本文是基於注解生成sql的。本文適配的mybatis版本是3.2.2。

准備

為什么在StatementHandler攔截

在深入淺出MyBatis-Sqlsession章節介紹了一次sqlsession的完整執行過程，從中可以知道sql的解析是在StatementHandler里完成的，所以為了自動生成sql需要攔截StatementHandler。

MetaObject簡介

在我的實現里大量使用了MetaObject這個對象，因此有必要先介紹下它。MetaObject是Mybatis提供的一個的工具類，通過它包裝一個對象后可以獲取或設置該對象的原本不可訪問的屬性（比如那些私有屬性）。它有個三個重要方法經常用到：

1)       MetaObject forObject(Object object,ObjectFactory objectFactory, ObjectWrapperFactory objectWrapperFactory)

2)       Object getValue(String name)

3)       void setValue(String name, Object value)

方法1)用於包裝對象；方法2)用於獲取屬性的值（支持OGNL的方法）；方法3)用於設置屬性的值（支持OGNL的方法）；

插件的原理

參見深入淺出Mybatis-插件原理。

 

有了上面這些基礎知識的准備后，就可以我們的主題了。

攔截器簽名

[java] view plain copy
  1. @Intercepts({@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class})})  
  2. public class AutoMapperInterceptor implements Interceptor {  
  3. ...  
  4. }  
[java] view plain copy
  1. @Intercepts({@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class})})  
  2. public class AutoMapperInterceptor implements Interceptor {  
  3. ...  
  4. }  

從簽名里可以看出，要攔截的目標類型是StatementHandler（注意：type只能配置成接口類型），攔截的方法是名稱為prepare參數為Connection類型的方法。

intercept的實現

[java] view plain copy
  1. @Intercepts({@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class})})  
  2. public class AutoMapperInterceptor implements Interceptor {  
  3.     private static final Log logger = LogFactory.getLog(AutoMapperInterceptor.class);  
  4.     private static final ObjectFactory DEFAULT_OBJECT_FACTORY = new DefaultObjectFactory();  
  5.     private static final ObjectWrapperFactory DEFAULT_OBJECT_WRAPPER_FACTORY = new DefaultObjectWrapperFactory();  
  6.   
  7.     @Override  
  8.     public Object intercept(Invocation invocation) throws Throwable {  
  9.         StatementHandler statementHandler = (StatementHandler) invocation.getTarget();  
  10.         MetaObject metaStatementHandler = MetaObject.forObject(statementHandler, DEFAULT_OBJECT_FACTORY,  
  11.                 DEFAULT_OBJECT_WRAPPER_FACTORY);  
  12.         // 分離代理對象鏈  
  13.         while (metaStatementHandler.hasGetter("h")) {  
  14.             Object object = metaStatementHandler.getValue("h");  
  15.             metaStatementHandler = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY);  
  16.         }  
  17.         // 分離最后一個代理對象的目標類  
  18.         while (metaStatementHandler.hasGetter("target")) {  
  19.             Object object = metaStatementHandler.getValue("target");  
  20.             metaStatementHandler = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY);  
  21.         }  
  22.         String originalSql = (String) metaStatementHandler.getValue("delegate.boundSql.sql");  
  23.         Configuration configuration = (Configuration) metaStatementHandler.getValue("delegate.configuration");  
  24.         Object parameterObject = metaStatementHandler.getValue("delegate.boundSql.parameterObject");  
  25.         if (null == originalSql || "".equals(originalSql)) {  
  26.             String newSql = "";  
  27.             MappedStatement mappedStatement = (MappedStatement) metaStatementHandler  
  28.                     .getValue("delegate.mappedStatement");  
  29.             // 根據ID生成相應類型的sql語句（id需剔除namespace信息）  
  30.             String id = mappedStatement.getId();  
  31.             id = id.substring(id.lastIndexOf(".") + 1);  
  32.             if ("insert".equals(id)) {  
  33.                 newSql = SqlBuilder.buildInsertSql(parameterObject);  
  34.             } else if ("update".equals(id)) {  
  35.                 newSql = SqlBuilder.buildUpdateSql(parameterObject);  
  36.             } else if ("delete".equals(id)) {  
  37.                 newSql = SqlBuilder.buildDeleteSql(parameterObject);  
  38.             } else if ("select".equals(id)) {  
  39.                 newSql = SqlBuilder.buildSelectSql(parameterObject);  
  40.             }  
  41.             logger.debug("Auto generated sql:" + newSql);  
  42.             //  
  43.             SqlSource sqlSource = buildSqlSource(configuration, newSql, parameterObject.getClass());  
  44.             List<ParameterMapping> parameterMappings = sqlSource.getBoundSql(parameterObject).getParameterMappings();  
  45.             metaStatementHandler.setValue("delegate.boundSql.sql", sqlSource.getBoundSql(parameterObject).getSql());  
  46.             metaStatementHandler.setValue("delegate.boundSql.parameterMappings", parameterMappings);  
  47.         }  
  48.         // 調用原始statementHandler的prepare方法  
  49.         statementHandler = (StatementHandler) metaStatementHandler.getOriginalObject();  
  50.         statementHandler.prepare((Connection) invocation.getArgs()[0]);  
  51.         // 傳遞給下一個攔截器處理  
  52.         return invocation.proceed();  
  53.     }  
  54.   
  55.     @Override  
  56.     public Object plugin(Object target) {  
  57.         if (target instanceof StatementHandler) {  
  58.             return Plugin.wrap(target, this);  
  59.         } else {  
  60.             return target;  
  61.         }  
  62.     }  
  63.   
  64.     @Override  
  65.     public void setProperties(Properties properties) {  
  66.   
  67.     }  
  68.   
  69.     private SqlSource buildSqlSource(Configuration configuration, String originalSql,   
  70.     Class<?> parameterType) {  
  71.         SqlSourceBuilder builder = new SqlSourceBuilder(configuration);  
  72.         return builder.parse(originalSql, parameterType, null);  
  73.     }  
  74. }  
[java] view plain copy
  1. @Intercepts({@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class})})  
  2. public class AutoMapperInterceptor implements Interceptor {  
  3.     private static final Log logger = LogFactory.getLog(AutoMapperInterceptor.class);  
  4.     private static final ObjectFactory DEFAULT_OBJECT_FACTORY = new DefaultObjectFactory();  
  5.     private static final ObjectWrapperFactory DEFAULT_OBJECT_WRAPPER_FACTORY = new DefaultObjectWrapperFactory();  
  6.   
  7.     @Override  
  8.     public Object intercept(Invocation invocation) throws Throwable {  
  9.         StatementHandler statementHandler = (StatementHandler) invocation.getTarget();  
  10.         MetaObject metaStatementHandler = MetaObject.forObject(statementHandler, DEFAULT_OBJECT_FACTORY,  
  11.                 DEFAULT_OBJECT_WRAPPER_FACTORY);  
  12.         // 分離代理對象鏈  
  13.         while (metaStatementHandler.hasGetter("h")) {  
  14.             Object object = metaStatementHandler.getValue("h");  
  15.             metaStatementHandler = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY);  
  16.         }  
  17.         // 分離最后一個代理對象的目標類  
  18.         while (metaStatementHandler.hasGetter("target")) {  
  19.             Object object = metaStatementHandler.getValue("target");  
  20.             metaStatementHandler = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY);  
  21.         }  
  22.         String originalSql = (String) metaStatementHandler.getValue("delegate.boundSql.sql");  
  23.         Configuration configuration = (Configuration) metaStatementHandler.getValue("delegate.configuration");  
  24.         Object parameterObject = metaStatementHandler.getValue("delegate.boundSql.parameterObject");  
  25.         if (null == originalSql || "".equals(originalSql)) {  
  26.             String newSql = "";  
  27.             MappedStatement mappedStatement = (MappedStatement) metaStatementHandler  
  28.                     .getValue("delegate.mappedStatement");  
  29.             // 根據ID生成相應類型的sql語句（id需剔除namespace信息）  
  30.             String id = mappedStatement.getId();  
  31.             id = id.substring(id.lastIndexOf(".") + 1);  
  32.             if ("insert".equals(id)) {  
  33.                 newSql = SqlBuilder.buildInsertSql(parameterObject);  
  34.             } else if ("update".equals(id)) {  
  35.                 newSql = SqlBuilder.buildUpdateSql(parameterObject);  
  36.             } else if ("delete".equals(id)) {  
  37.                 newSql = SqlBuilder.buildDeleteSql(parameterObject);  
  38.             } else if ("select".equals(id)) {  
  39.                 newSql = SqlBuilder.buildSelectSql(parameterObject);  
  40.             }  
  41.             logger.debug("Auto generated sql:" + newSql);  
  42.             //  
  43.             SqlSource sqlSource = buildSqlSource(configuration, newSql, parameterObject.getClass());  
  44.             List<ParameterMapping> parameterMappings = sqlSource.getBoundSql(parameterObject).getParameterMappings();  
  45.             metaStatementHandler.setValue("delegate.boundSql.sql", sqlSource.getBoundSql(parameterObject).getSql());  
  46.             metaStatementHandler.setValue("delegate.boundSql.parameterMappings", parameterMappings);  
  47.         }  
  48.         // 調用原始statementHandler的prepare方法  
  49.         statementHandler = (StatementHandler) metaStatementHandler.getOriginalObject();  
  50.         statementHandler.prepare((Connection) invocation.getArgs()[0]);  
  51.         // 傳遞給下一個攔截器處理  
  52.         return invocation.proceed();  
  53.     }  
  54.   
  55.     @Override  
  56.     public Object plugin(Object target) {  
  57.         if (target instanceof StatementHandler) {  
  58.             return Plugin.wrap(target, this);  
  59.         } else {  
  60.             return target;  
  61.         }  
  62.     }  
  63.   
  64.     @Override  
  65.     public void setProperties(Properties properties) {  
  66.   
  67.     }  
  68.   
  69.     private SqlSource buildSqlSource(Configuration configuration, String originalSql,   
  70.     Class<?> parameterType) {  
  71.         SqlSourceBuilder builder = new SqlSourceBuilder(configuration);  
  72.         return builder.parse(originalSql, parameterType, null);  
  73.     }  
  74. }  

StatementHandler的默認實現類是RoutingStatementHandler，因此攔截的實際對象是它。RoutingStatementHandler的主要功能是分發，它根據配置Statement類型創建真正執行數據庫操作的StatementHandler，並將其保存到delegate屬性里。由於delegate是一個私有屬性並且沒有提供訪問它的方法，因此需要借助MetaObject的幫忙。通過MetaObject的封裝后我們可以輕易的獲得想要的屬性。

在上面的方法里有個兩個循環，通過他們可以分離出原始的RoutingStatementHandler（而不是代理對象）。

有了插件幫你生成sql語句后，mapper配置文件里單表的增刪改查部分就不需要再配置sql代碼了，但由於插件需要通過id來生成不同類型的sql語句，因此必要的配置還是需要的，而且相應的id必須是下面的這幾個（區分大小寫）：

[html] view plain copy
  1. <update id="update" parameterType="UserDto"></update>  
  2. <insert id="insert" parameterType="UserDto"></insert>  
  3. <delete id="delete" parameterType="UserDto"></delete>  
  4. <select id="select" parameterType="UserDto" resultType="UserDto""></select>  
[html] view plain copy
  1. <update id="update" parameterType="UserDto"></update>  
  2. <insert id="insert" parameterType="UserDto"></insert>  
  3. <delete id="delete" parameterType="UserDto"></delete>  
  4. <select id="select" parameterType="UserDto" resultType="UserDto""></select>  

SqlBuilder

SqlBuilder的相應方法接受一個dto對象作為參數，它們根據這個對象的屬性值和配置的注解生成相應的sql。

[java] view plain copy
  1. @TableMapperAnnotation(tableName = "t_user", uniqueKeyType = UniqueKeyType.Single, uniqueKey = " userid ")  
  2. public class UserDto {  
  3.     @FieldMapperAnnotation(dbFieldName = "userid", jdbcType = JdbcType.INTEGER)  
  4.     private Integer userid;  
  5.     @FieldMapperAnnotation(dbFieldName = "username", jdbcType = JdbcType.VARCHAR)  
  6.     private String username;  
  7.     ...  
  8. }  
[java] view plain copy
  1. @TableMapperAnnotation(tableName = "t_user", uniqueKeyType = UniqueKeyType.Single, uniqueKey = " userid ")  
  2. public class UserDto {  
  3.     @FieldMapperAnnotation(dbFieldName = "userid", jdbcType = JdbcType.INTEGER)  
  4.     private Integer userid;  
  5.     @FieldMapperAnnotation(dbFieldName = "username", jdbcType = JdbcType.VARCHAR)  
  6.     private String username;  
  7.     ...  
  8. }  

這個對象包含了兩種注解，一個是TableMapperAnnotation注解，它保存了表名、唯一鍵類型和構成唯一鍵的字段；另一個是FieldMapperAnnotation注解，它保存了數據庫字段名和字段類型信息。這兩個注解都是必須的。SqlBuilder生成sql時會用到他們，下面以生成insert語句的方法為例，其他方法類似：

[java] view plain copy
  1. public static String buildInsertSql(Object object) throws Exception {  
  2.     if (null == object) {  
  3.         throw new RuntimeException("Sorry,I refuse to build sql for a null object!");  
  4.     }  
  5.     Map dtoFieldMap = PropertyUtils.describe(object);  
  6.     // 從參數對象里提取注解信息  
  7.     TableMapper tableMapper = buildTableMapper(object.getClass());  
  8.     // 從表注解里獲取表名等信息  
  9.     TableMapperAnnotation tma = (TableMapperAnnotation) tableMapper.getTableMapperAnnotation();  
  10.     String tableName = tma.tableName();  
  11.     StringBuffer tableSql = new StringBuffer();  
  12.     StringBuffer valueSql = new StringBuffer();  
  13.   
  14.     tableSql.append("insert into ").append(tableName).append("(");  
  15.     valueSql.append("values(");  
  16.   
  17.     boolean allFieldNull = true;  
  18.     // 根據字段注解和屬性值聯合生成sql語句  
  19.     for (String dbFieldName : tableMapper.getFieldMapperCache().keySet()) {  
  20.         FieldMapper fieldMapper = tableMapper.getFieldMapperCache().get(dbFieldName);  
  21.         String fieldName = fieldMapper.getFieldName();  
  22.         Object value = dtoFieldMap.get(fieldName);  
  23.         // 由於要根據字段對象值是否為空來判斷是否將字段加入到sql語句中，因此DTO對象的屬性不能是簡單類型，反而必須是封裝類型  
  24.         if (value == null) {  
  25.             continue;  
  26.         }  
  27.         allFieldNull = false;  
  28.         tableSql.append(dbFieldName).append(",");  
  29.         valueSql.append("#{").append(fieldName).append(",").append("jdbcType=")  
  30.                 .append(fieldMapper.getJdbcType().toString()).append("},");  
  31.     }  
  32.     if (allFieldNull) {  
  33.         throw new RuntimeException("Are you joking? Object " + object.getClass().getName()  
  34.                 + "'s all fields are null, how can i build sql for it?!");  
  35.     }  
  36.     tableSql.delete(tableSql.lastIndexOf(","), tableSql.lastIndexOf(",") + 1);  
  37.     valueSql.delete(valueSql.lastIndexOf(","), valueSql.lastIndexOf(",") + 1);  
  38.     return tableSql.append(") ").append(valueSql).append(")").toString();  
  39. }  
[java] view plain copy
  1. public static String buildInsertSql(Object object) throws Exception {  
  2.     if (null == object) {  
  3.         throw new RuntimeException("Sorry,I refuse to build sql for a null object!");  
  4.     }  
  5.     Map dtoFieldMap = PropertyUtils.describe(object);  
  6.     // 從參數對象里提取注解信息  
  7.     TableMapper tableMapper = buildTableMapper(object.getClass());  
  8.     // 從表注解里獲取表名等信息  
  9.     TableMapperAnnotation tma = (TableMapperAnnotation) tableMapper.getTableMapperAnnotation();  
  10.     String tableName = tma.tableName();  
  11.     StringBuffer tableSql = new StringBuffer();  
  12.     StringBuffer valueSql = new StringBuffer();  
  13.   
  14.     tableSql.append("insert into ").append(tableName).append("(");  
  15.     valueSql.append("values(");  
  16.   
  17.     boolean allFieldNull = true;  
  18.     // 根據字段注解和屬性值聯合生成sql語句  
  19.     for (String dbFieldName : tableMapper.getFieldMapperCache().keySet()) {  
  20.         FieldMapper fieldMapper = tableMapper.getFieldMapperCache().get(dbFieldName);  
  21.         String fieldName = fieldMapper.getFieldName();  
  22.         Object value = dtoFieldMap.get(fieldName);  
  23.         // 由於要根據字段對象值是否為空來判斷是否將字段加入到sql語句中，因此DTO對象的屬性不能是簡單類型，反而必須是封裝類型  
  24.         if (value == null) {  
  25.             continue;  
  26.         }  
  27.         allFieldNull = false;  
  28.         tableSql.append(dbFieldName).append(",");  
  29.         valueSql.append("#{").append(fieldName).append(",").append("jdbcType=")  
  30.                 .append(fieldMapper.getJdbcType().toString()).append("},");  
  31.     }  
  32.     if (allFieldNull) {  
  33.         throw new RuntimeException("Are you joking? Object " + object.getClass().getName()  
  34.                 + "'s all fields are null, how can i build sql for it?!");  
  35.     }  
  36.     tableSql.delete(tableSql.lastIndexOf(","), tableSql.lastIndexOf(",") + 1);  
  37.     valueSql.delete(valueSql.lastIndexOf(","), valueSql.lastIndexOf(",") + 1);  
  38.     return tableSql.append(") ").append(valueSql).append(")").toString();  
  39. }  

plugin的實現

[java] view plain copy
  1. public Object plugin(Object target) {  
  2.     // 當目標類是StatementHandler類型時，才包裝目標類，否者直接返回目標本身,減少目標被代理的  
  3.     // 次數  
  4.     if (target instanceof StatementHandler) {  
  5.         return Plugin.wrap(target, this);  
  6.     } else {  
  7.         return target;  
  8.     }  
  9. }  
[java] view plain copy
  1. public Object plugin(Object target) {  
  2.     // 當目標類是StatementHandler類型時，才包裝目標類，否者直接返回目標本身,減少目標被代理的  
  3.     // 次數  
  4.     if (target instanceof StatementHandler) {  
  5.         return Plugin.wrap(target, this);  
  6.     } else {  
  7.         return target;  
  8.     }  
  9. } 


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 深入淺出Mybatis系列（一）---Mybatis入門 深入淺出mybatis之映射器 深入淺出列生成算法 深入淺出SQL Server中的死鎖 深入淺出Mybatis系列（十）---SQL執行流程分析（源碼篇） mybatis-sql語句傳參 深入淺出-多租戶 深入淺出 Spring 深入淺出 SpringMVC - 1 Nacos深入淺出（八）
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM