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

从上面定义的这个参数类我们可以看到，我们定义了使用哪个字段作为返回结果的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. /* (non-Javadoc)
  4. * @see org.apache.ibatis.plugin.Interceptor#intercept(org.apache.ibatis.plugin.Invocation)
  5. */
  6. public Object intercept(Invocation invocation) throws Throwable {
  7. //通过invocation获取代理的目标对象
  8. Object target = invocation.getTarget();
  9. //暂时ResultSetHandler只有FastResultSetHandler这一种实现
  10. if (target instanceof FastResultSetHandler) {
  11. FastResultSetHandler resultSetHandler = (FastResultSetHandler) target;
  12. //利用反射获取到FastResultSetHandler的ParameterHandler属性，从而获取到ParameterObject；
  13. ParameterHandler parameterHandler = ReflectUtil.getFieldValue(resultSetHandler, "parameterHandler");
  14. Object parameterObj = parameterHandler.getParameterObject();
  15. //判断ParameterObj是否是我们定义的MapParam，如果是则进行自己的处理逻辑
  16. if (parameterObj instanceof MapParam) {//拦截到了
  17. MapParam mapParam = (MapParam) parameterObj;
  18. //获取到当前的Statement
  19. Statement stmt = (Statement) invocation.getArgs()[0];
  20. //通过Statement获取到当前的结果集，对其进行处理，并返回对应的处理结果
  21. return handleResultSet(stmt.getResultSet(), mapParam);
  22. }
  23. }
  24. //如果没有进行拦截处理，则执行默认逻辑
  25. return invocation.proceed();
  26. }
  27. /**
  28. * 处理结果集
  29. * @param resultSet
  30. * @param mapParam
  31. * @return
  32. */
  33. private Object handleResultSet(ResultSet resultSet, MapParam mapParam) {
  34. // TODO Auto-generated method stub
  35. if (resultSet != null) {
  36. //拿到Key对应的字段
  37. String keyField = (String) mapParam.get(MapParam.KEY_FIELD);
  38. //拿到Value对应的字段
  39. String valueField = (String) mapParam.get(MapParam.VALUE_FIELD);
  40. //定义用于存放Key-Value的Map
  41. Map<Object, Object> map = new HashMap<Object, Object>();
  42. //handleResultSets的结果一定是一个List，当我们的对应的Mapper接口定义的是返回一个单一的元素，并且handleResultSets返回的列表
  43. //的size为1时，Mybatis会取返回的第一个元素作为对应Mapper接口方法的返回值。
  44. List<Object> resultList = new ArrayList<Object>();
  45. try {
  46. //把每一行对应的Key和Value存放到Map中
  47. while (resultSet.next()) {
  48. Object key = resultSet.getObject(keyField);
  49. Object value = resultSet.getObject(valueField);
  50. map.put(key, value);
  51. }
  52. } catch (SQLException e) {
  53. e.printStackTrace();
  54. } finally {
  55. closeResultSet(resultSet);
  56. }
  57. //把封装好的Map存放到List中并进行返回
  58. resultList.add(map);
  59. return resultList;
  60. }
  61. return null;
  62. }
  63. /**
  64. * 关闭ResultSet
  65. * @param resultSet 需要关闭的ResultSet
  66. */
  67. private void closeResultSet(ResultSet resultSet) {
  68. try {
  69. if (resultSet != null) {
  70. resultSet.close();
  71. }
  72. } catch (SQLException e) {
  73. }
  74. }
  75. /* (non-Javadoc)
  76. * @see org.apache.ibatis.plugin.Interceptor#plugin(java.lang.Object)
  77. */
  78. public Object plugin(Object obj) {
  79. return Plugin.wrap(obj, this);
  80. }
  81. /* (non-Javadoc)
  82. * @see org.apache.ibatis.plugin.Interceptor#setProperties(java.util.Properties)
  83. */
  84. public void setProperties(Properties props) {
  85. }
  86. }

拦截器的实现这一块就没什么好讲的了，就是简单的把Statement对应的结果集封装成一个Map，再把用于返回的Map封装成一个List进行返回。里面的代码很简单，相信大伙都看得懂。而对于Mybatis拦截器不懂的可以看这篇文章。

在上面拦截器的实现中用到了一个工具类ReflectUtil，其代码如下所示：

Java代码 

  1. public class ReflectUtil {
  2. /**
  3. * 利用反射获取指定对象的指定属性
  4. * @param obj 目标对象
  5. * @param fieldName 目标属性
  6. * @return 目标属性的值
  7. */
  8. @SuppressWarnings("unchecked")
  9. public static <T> T getFieldValue(Object obj, String fieldName) {
  10. Object result = null;
  11. Field field = ReflectUtil.getField(obj, fieldName);
  12. if (field != null) {
  13. field.setAccessible(true);
  14. try {
  15. result = field.get(obj);
  16. } catch (IllegalArgumentException e) {
  17. // TODO Auto-generated catch block
  18. e.printStackTrace();
  19. } catch (IllegalAccessException e) {
  20. // TODO Auto-generated catch block
  21. e.printStackTrace();
  22. }
  23. }
  24. return (T)result;
  25. }
  26. /**
  27. * 利用反射获取指定对象里面的指定属性
  28. * @param obj 目标对象
  29. * @param fieldName 目标属性
  30. * @return 目标字段
  31. */
  32. private static Field getField(Object obj, String fieldName) {
  33. Field field = null;
  34. for (Class<?> clazz=obj.getClass(); clazz != Object.class; clazz=clazz.getSuperclass()) {
  35. try {
  36. field = clazz.getDeclaredField(fieldName);
  37. break;
  38. } catch (NoSuchFieldException e) {
  39. //这里不用做处理，子类没有该字段可能对应的父类有，都没有就返回null。
  40. }
  41. }
  42. return field;
  43. }
  44. /**
  45. * 利用反射设置指定对象的指定属性为指定的值
  46. * @param obj 目标对象
  47. * @param fieldName 目标属性
  48. * @param fieldValue 目标值
  49. */
  50. public static void setFieldValue(Object obj, String fieldName,
  51. String fieldValue) {
  52. Field field = ReflectUtil.getField(obj, fieldName);
  53. if (field != null) {
  54. try {
  55. field.setAccessible(true);
  56. field.set(obj, fieldValue);
  57. } catch (IllegalArgumentException e) {
  58. // TODO Auto-generated catch block
  59. e.printStackTrace();
  60. } catch (IllegalAccessException e) {
  61. // TODO Auto-generated catch block
  62. e.printStackTrace();
  63. }
  64. }
  65. }
  66. }

至此，使用Mybatis拦截器实现Mybatis返回Map的方法就介绍的差不多了，接下来我们举一个例子来说一下它的应用。

应用

首先，我们需要把它配置起来，让Mybatis能够对它进行注册。配置的方法很简单，就是在Mybatis的配置文件中利用plugins元素下面的plugin进行注册。

Xml代码 

  1. <plugins>
  2. <plugin interceptor="com.tiantian.mybatis.interceptor.MapInterceptor"/>
  3. </plugins>

而对于使用Spring整合Mybatis的用户来说，如果你在整合的时候是把Mybatis的配置都放在Mybatis的配置文件中，然后通过Spring配置文件中的bean SqlSessionFactoryBean的configLocation来指定这个配置文件的位置的话你的配置依然可以像上面那样写在Mybatis的配置文件中；但如果你是通过SqlSessionFactoryBean的属性来指定Mybatis配置文件中的一些内容的话，那么你的拦截器应该是通过SqlSessionFactoryBean的plugins属性来指定的，你的配置文件看起来大概是这样子：

Xml代码 

  1. <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  2. ……
  3. <property name="plugins">
  4. <array>
  5. <bean class="com.tiantian.mybatis.interceptor.MapInterceptor"/>
  6. </array>
  7. </property>
  8. ……
  9. </bean>

配置好以后我们就可以使用该拦截器进行相应的拦截了。

这里假设我们有一个表t_city，该表一共有三个字段，id、code和name。现在我们希望通过Mybatis来查询该表时返回结果是一个Map，其中key为每行字段code的值，value为对应字段name的值。这个时候我们的Mapper语句大概是这样：

Xml代码 

  1. <select id="find" resultType="map" parameterType="MapParam">
  2. select code, name from t_city
  3. </select>

其对应的Mapper接口方法大概是这样：

Java代码 

  1. public interface CityMapper extends SuperMapper {
  2. public Map<Object, Object> find(MapParam param);
  3. }

那么，当我们去调用的时候大概是这样调用的，准备好一个参数对象MapParam，赋好对应的属性之后把它传递给对应的Mapper接口方法：

Java代码 

  1. @Test
  2. public void testMap() {
  3. MapParam param = new MapParam("code", "name");
  4. Map<Object, Object> result = cityMapper.find(param);
  5. System.out.println(result);
  6. }

说明

在这篇博客中，我只是介绍使用Mybatis拦截器实现Mybatis查询返回Map的这么一种方法，里面的代码考虑是比较粗糙的，想要在使用Mybatis拦截器拦截到ResultSetHandler的handleResultSets方法，对ResultSet做更加严谨的处理的话，推荐参考Mybatis ResultSetHandler接口的实现类FastResultSetHandler关于handleResultSets(Statement stmt)的实现。

时间： 2024-10-08 06:12:40

Mybatis返回Map的一种实现的相关文章

MyBatis 返回Map&lt;String,Object&gt;类型

<resultMap type="map" id="stringMap"> <result property="contentIntr" column="contentIntr" javaType="string" /> </resultMap> <!-- 导出所有数据 --> <select id="exportAll" resul

mybatis返回map类型数据空值字段不显示的解决方法

在日常开发中,查询数据返回类型为map,数据库中有些自动值为null,则返回的结果中没有值为空的字段,则如何显示值为空的字段呢? Spring boot + MyBatis返回map中null值默认不显示,如要调整为null值显示需要在配置文件中添加属性,如下图红框中所示: 2.Mybatis使用IFNULL(P1,P2)函数 原文地址:https://www.cnblogs.com/panchanggui/p/10919421.html

Mybatis,返回Map的时候,将Map内的Key转换为驼峰的命名

每次使用mybatis的时候,简单的连表查询,用Map接收的时候,都是像DB定义的字段一样,类似以下 student_name,student_id,没有转换为驼峰,但是又不能因为这一个定义一个javabean来映射数据库字段集合,这样,会有无穷无尽的javabean,完全不是办法. 然后我看了下mybatis-spring-boot的配置文档http://www.mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure/

用Mybatis返回Map,List&lt;Map&gt;

返回Map,Mybatis配置如下 : <select id="getCountyHashMap" resultType="java.util.HashMap"> select name,id from tsql_test_region where id=#{id} </select> ServiceImpl如下 : public Map<String, Long> getCountyHashMap(long id) { Map&

springboot中处理mybatis返回Map时key值的大小写

为了统一不同数据库返回key值大小写不一致的问题,特自定义ObjectWrapperFactory来做统一的处理 1,首先自定义MapWrapper /** * 将Map的key全部转换为小写 * */ public class MapKeyLowerWrapper extends MapWrapper { public MapKeyLowerWrapper(MetaObject metaObject, Map<String, Object> map) { super(metaObject,

springboot+MyBatis返回Map时值为null的字段会丢失

多数据源中,在的数据源配置里加上以下代码: public SqlSessionFactory firstSqlSessionFactory(@Qualifier("firstDataSource") DataSource datasource) throws Exception { SqlSessionFactoryBean bean = new SqlSessionFactoryBean(); bean.setDataSource(datasource); //-----------

Mybatis返回map集合

<resultMap id="pieMap" type="HashMap"> <result property="value" column="VALUE" /> <result property="name" column="NAME" /> </resultMap> <select id="queryPieParam&q

mybatis返回List&lt;Map&gt;

mapperl.xml中: <select id="getAmount" parameterType="int" resultType="java.util.HashMap"> <![CDATA[ select count(*) as amount, estate_type as type, status from estate where status=#{status} group by estate_type ]]>

处理Mybatis返回的结果集为Map类型

最有用到mybatis返回一个map结果集,然后就针对性的在网上找了一些相关大牛的总结:1.https://www.cnblogs.com/jwdd/p/10046270.html2.https://www.codercto.com/a/33475.html 然后经过自己的测试终于可以应用实际业务中1.如果你确定返回的数据只有一条,你可以这样整 xml中: <select id="searchncomedateByInvestID" resultMap="java.ut