Mybatis返回Map的一种实现

Mybatis返回Map的一种实现

前言

       在使用Mybatis进行系统开发的时候，有时候我们会有这么一种需求：我们希望通过Mybatis查询某一个表返回的结果是一个Map，而这个Map的Key是表的一个字段，Value是另一个字段。然而当我们按照Mybatis的做法，指定查询Mapper语句的resultType为map时返回的结果是一个Map列表（表中有多条记录时），而且每个元素Map对应的是表的一行记录（Key为每个字段的名称，Value为对应的值），这跟我们的需求是不相符合的。那有什么方法可以让Mybatis查询出来的结果是一个Key为表中某一列的值，Value为表中另一列的值的Map呢？今天将跟大伙介绍一种使用Mybatis拦截器来实现查询返回Map的方法。关于Mybatis拦截器的介绍可以查看我的这篇博客。

实现

       返回结果是由ResultSetHandler的handleResultSets方法对当前的Statement处理后的返回结果，所以我们如果要改变返回结果的话就需要使用Mybatis的拦截器对ResultSetHandler接口的handleResultSets方法进行拦截。

我们不可能把所有的ResultSet都拦截，然后返回对应的Map，所以我们需要在拦截到handleResultSets方法之后进行筛选，对于不需要拦截的调用Invocation的proceed()方法，而需要拦截的则实现我们自己的逻辑，返回对应的结果。对于这种筛选条件一般都是通过ParameterObject来进行的。这里我自定义了一个类，叫MapParam，当某一个语句需要返回一个Map时，就指定其参数类型为MapParam。

这个参数类型MapParam一定需要有三个作用：

• （1）    可以指定哪个字段为返回Map的Key；
• （2）    可以指定哪个字段为返回Map的Value；
• （3）    可以附带其他参数；

综合以上三点考虑，我觉得比较合适的MapParam应该是一个Map，当然这个Map是特用的，或者其包含一个用于存放参数的Map的引用。这里我选择使用第一种方式，定义一个继承自HashMap的类。 

Java代码 

1. public class MapParam extends HashMap {  
2.   
3.     /** 
4.      *  
5.      */  
6.     private static final long serialVersionUID = 1L;  
7.   
8.     /** 
9.      * 作为Key的字段对应MapParam的Key 
10.      */  
11.     public static final String  KEY_FIELD = "mapKeyField";  
12.     /** 
13.      * 作为Value的字段对应MapParam的Key 
14.      */  
15.     public static final String VALUE_FIELD = "mapValueField";  
16.       
17.     public MapParam() {  
18.           
19.     }  
20.       
21.     /** 
22.      * 指定keyField和valueField 
23.      * @param keyField Map中key对应的字段 
24.      * @param valueField Map中value对应的字段 
25.      */  
26.     public MapParam(String keyField, String valueField) {  
27.         this.put(KEY_FIELD, keyField);  
28.         this.put(VALUE_FIELD, valueField);  
29.     }  
30.       
31. }  

  

       从上面定义的这个参数类我们可以看到，我们定义了使用哪个字段作为返回结果的Key，哪个字段作为返回结果的Value，同时我们还可以往里面put其他参数供SQL使用。

       接着就是来实现我们的拦截器了。这里我们定义一个MapInterceptor用于拦截对应的结果集返回一个Map。其代码如下所示：

Java代码 

1. @Intercepts(@Signature(method="handleResultSets", type=ResultSetHandler.class, args={Statement.class}))  
2. public class MapInterceptor implements Interceptor {  
3.   
4.     /* (non-Javadoc) 
5.      * @see org.apache.ibatis.plugin.Interceptor#intercept(org.apache.ibatis.plugin.Invocation) 
6.      */  
7.     public Object intercept(Invocation invocation) throws Throwable {  
8.         //通过invocation获取代理的目标对象  
9.         Object target = invocation.getTarget();  
10.         //暂时ResultSetHandler只有FastResultSetHandler这一种实现  
11.         if (target instanceof FastResultSetHandler) {  
12.             FastResultSetHandler resultSetHandler = (FastResultSetHandler) target;  
13.             //利用反射获取到FastResultSetHandler的ParameterHandler属性，从而获取到ParameterObject；  
14.             ParameterHandler parameterHandler = ReflectUtil.getFieldValue(resultSetHandler, "parameterHandler");  
15.             Object parameterObj = parameterHandler.getParameterObject();  
16.             //判断ParameterObj是否是我们定义的MapParam，如果是则进行自己的处理逻辑  
17.             if (parameterObj instanceof MapParam) {//拦截到了  
18.                 MapParam mapParam = (MapParam) parameterObj;  
19.                 //获取到当前的Statement  
20.                 Statement stmt = (Statement) invocation.getArgs()[0];  
21.                 //通过Statement获取到当前的结果集，对其进行处理，并返回对应的处理结果  
22.                 return handleResultSet(stmt.getResultSet(), mapParam);  
23.             }  
24.         }  
25.         //如果没有进行拦截处理，则执行默认逻辑  
26.         return invocation.proceed();  
27.     }  
28.   
29.     /** 
30.      * 处理结果集 
31.      * @param resultSet 
32.      * @param mapParam 
33.      * @return 
34.      */  
35.     private Object handleResultSet(ResultSet resultSet, MapParam mapParam) {  
36.         // TODO Auto-generated method stub  
37.         if (resultSet != null) {  
38.             //拿到Key对应的字段  
39.             String keyField = (String) mapParam.get(MapParam.KEY_FIELD);  
40.             //拿到Value对应的字段  
41.             String valueField = (String) mapParam.get(MapParam.VALUE_FIELD);  
42.             //定义用于存放Key-Value的Map  
43.             Map map = new HashMap();  
44.             //handleResultSets的结果一定是一个List，当我们的对应的Mapper接口定义的是返回一个单一的元素，并且handleResultSets返回的列表  
45.             //的size为1时，Mybatis会取返回的第一个元素作为对应Mapper接口方法的返回值。  
46.             List