關於mybatis攔截器，對結果集進行攔截

　　因業務需要，需將結果集序列化為json返回，於是，網上找了好久資料，都是關於攔截參數的處理，攔截Sql語法構建的處理，就是很少關於對攔截結果集的處理，於是自己簡單的寫了一個對結果集的處理，

記錄下。

 

一、MyBatis的框架設計圖                                            

  

  參考：http://blog.csdn.net/luanlouis/article/details/40422941

1.如何將結果集改成我們想要的格式呢？                                 

　　1.1  由原理圖我們可知，ResultSetHandler負責將resultSet轉換為list，那么我們能不能在轉換的時候加上自己的邏輯，我想應該是可以的，但是因為源碼看不太懂，想想還是算了。

public List<Object> handleResultSets(Statement stmt) throws SQLException {  
  final List<Object> multipleResults = new ArrayList<Object>();  
  
  int resultSetCount = 0;  
  ResultSetWrapper rsw = getFirstResultSet(stmt);  
  
  List<ResultMap> resultMaps = mappedStatement.getResultMaps();  
  int resultMapCount = resultMaps.size();  
  validateResultMapsCount(rsw, resultMapCount);  
    
  while (rsw != null && resultMapCount > resultSetCount) {  
    ResultMap resultMap = resultMaps.get(resultSetCount);  
      
    //將resultSet  
    handleResultSet(rsw, resultMap, multipleResults, null);  
    rsw = getNextResultSet(stmt);  
    cleanUpAfterHandlingResultSet();  
    resultSetCount++;  
  }  
  
  String[] resultSets = mappedStatement.getResulSets();  
  if (resultSets != null) {  
    while (rsw != null && resultSetCount < resultSets.length) {  
      ResultMapping parentMapping = nextResultMaps.get(resultSets[resultSetCount]);  
      if (parentMapping != null) {  
        String nestedResultMapId = parentMapping.getNestedResultMapId();  
        ResultMap resultMap = configuration.getResultMap(nestedResultMapId);  
        handleResultSet(rsw, resultMap, null, parentMapping);  
      }  
      rsw = getNextResultSet(stmt);  
      cleanUpAfterHandlingResultSet();  
      resultSetCount++;  
    }  
  }  
  
  return collapseSingleResultList(multipleResults);  
}  

 

　　1.2 排除第一種方案，那么能不能跳過這個方法執行我們的自己的邏輯，答案是可以的，接下來我們會用到mybatis的攔截器。

 

 2.定義mybatis攔截器，用來攔截handleResultSets                

        2.1 我們需要拿到MappedStatement（維護了一條<select|update|delete|insert>節點的封裝）這個對象，才能獲得resultType是什么類型，用於判斷，那我們該怎么獲取這個對象呢？ 首先我們到方法handleResultSets所屬類中的源碼里面看看 。

　　(1)   MappedStatement 是怎么生成的呢？由源碼我們可知，是用過構造函數賦值的 

  public DefaultResultSetHandler(Executor executor, MappedStatement mappedStatement, ParameterHandler parameterHandler, ResultHandler resultHandler, BoundSql boundSql,
      RowBounds rowBounds) {
    this.executor = executor;
    this.configuration = mappedStatement.getConfiguration();
    this.mappedStatement = mappedStatement;
    this.rowBounds = rowBounds;
    this.parameterHandler = parameterHandler;
    this.boundSql = boundSql;
    this.typeHandlerRegistry = configuration.getTypeHandlerRegistry();
    this.objectFactory = configuration.getObjectFactory();
    this.resultHandler = resultHandler;
  }

 

         (2)  那么既然存在這個屬性，就能獲取到這個對象么，可是，當我嘗試去找獲得 MappedStatement這個對象的方法時，並未找到，所以我只能自己加上去了！

  public MappedStatement getMappedStatement() {
        return mappedStatement;
 }

 

       2.1   我們在攔截器中就能使用MappedStatement 對象，從而獲得resultType的類型，為什么要這樣做呢？因為我只想實現當resultType為String的時候，才執行我自己的邏輯。

@Intercepts({ @Signature(type = ResultSetHandler.class, method = "handleResultSets", args = { Statement.class }) })
public class JsonPlugin implements Interceptor {

    public Object intercept(Invocation invocation) throws Throwable {
        List<String> resList = new ArrayList<String>();
        
        DefaultResultSetHandler defaultResultSetHandler = (DefaultResultSetHandler) invocation.getTarget();
        //MappedStatement維護了一條<select|update|delete|insert>節點的封裝
        MappedStatement mappedStatement = defaultResultSetHandler.getMappedStatement();
        //獲取節點屬性的集合
        List<ResultMap> resultMaps = mappedStatement.getResultMaps();
        int resultMapCount = resultMaps.size();
        //獲取當前resutType的類型
        Class<?> resultType = resultMaps.get(0).getType();
        if (resultMapCount > 0 && resultType.getName().equals("java.lang.String")) {
            Object[] obj = invocation.getArgs();
            Statement statement = (Statement) invocation.getArgs()[0];
            //獲得結果集
            ResultSet resultSet = statement.getResultSet();

            if (resultSet != null) {
                //獲得對應列名
                ResultSetMetaData rsmd = resultSet.getMetaData();
                List<String> columnList = new ArrayList<String>();

                for (int i = 1; i <= rsmd.getColumnCount(); i++) {
                    columnList.add(rsmd.getColumnName(i));
                }
                while (resultSet.next()) {
                    LinkedHashMap<String, Object> map = new LinkedHashMap<String, Object>();
                    for (String colName : columnList) {
                        map.put(colName, resultSet.getObject(colName));
                    }
                    JSONObject.DEFFAULT_DATE_FORMAT = "yyyy-MM-dd hh:mm:ss";// 設置日期格式
                    resList.add(JSON.toJSONString(map, SerializerFeature.WriteMapNullValue,
                            SerializerFeature.DisableCircularReferenceDetect,
                            SerializerFeature.WriteDateUseDateFormat));
                }
                return resList;
            }
        } 
        return invocation.proceed();
    }

    public Object plugin(Object target) {
        // 讀取@Signature中的配置，判斷是否需要生成代理類
        if (target instanceof ResultSetHandler) {
            return Plugin.wrap(target, this);
        } else {
            return target;
        }
    }

    public void setProperties(Properties properties) {

    }

　　2.2 加入攔截器配置

    <!-- 攔截器配置開始 -->
    <plugins>
        <plugin interceptor="com.smallhan.base.interceptor.JsonPlugin" />
    </plugins>

 

3.測試結果                                                                               

       3.1 ResultType為String的時候，如下圖所示，並且繞過handleResultSets

　　　

 

　　 3.2 ResultType為其他類型的時候，跳過我們自己寫的邏輯,執行invocation.proceed，調用下一個攔截器攔截目標方法。