经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » 数据库/运维 » MyBatis » 查看文章
Mybatis 查询语句条件为枚举类型时报错的解决
来源:jb51  时间:2022/1/19 19:15:05  对本文有异议

Mybatis查询语句条件为枚举类型报错

通常我们对于数据库中一些枚举字段使用tinyInt类型,而java对象对应的字段很多时候会为了方便定义成short或者int。但这样显然不美观方便,让后面维护的人抠破脑袋找你的常量定义在哪儿,要是没有注释简直让人崩溃。时间久后,没有人知道这里面的值。只能一行行读源码。

优雅的程序员当然想到了优雅的枚举,而mybatis“强大”的枚举类型处理器EnumOrdinalTypeHandler相信都不陌生。

然而配置枚举处理器花了九牛二虎之力改好原来的mapper运行测试用例全在报错。而插入、部分查询却没报错。这时进程进行到一半让人崩溃想要放弃。

通常这个错误是

"failed to invoke constructor for handler class org.apache.ibatis.type.EnumOrdinalTypeHandler”

原因是因为该死的查询条件使用枚举对象作为条件,无论你用selectExample还是其他的select,当条件where enum = #{enum}时就会报错。不要怀疑自己是不是EnumOrdinalTypeHandler没配对,如果没配对那一定会是所有的查询接口都会报错。

stackoverflow上只有一条相关问题。为什么这么少?这不是很常见的错误吗?jpa或hibernate就能很优雅的使用枚举啊。原因嘛,老外们很少用半自动的mybatis框架。只有国内奉为圭臬,原因嘛当然是听说人家阿里就用mybatis,所以一定是好的。也不看自己的业务到底是否真正触及到要提升sql性能的地步。

话说回来,目前给出来的答案似乎是mybatis的bug,但对于mybatis这种半自动框架这不一定是bug。

解决办法很简单粗暴,把where enum = #{enum}条件换成where enum in (***)万事大吉。但熟悉的同学已经发现了。这样的性能显然不如=。用short和int的同学肯定又开心了。看吧我就说数据库什么类型就用什么类型,枚举就是垃圾。说这话的同学显然还不习惯封装、规范这一套,更喜欢随心所欲的感觉。

今天的教训就到这。

Mybatis处理枚举类型

1、枚举

  1. package com.ahut.core.enums;
  2. import java.util.HashMap;
  3. import java.util.Map;
  4. /**
  5. *
  6. * @ClassName: SexEnum
  7. * @Description: 性别枚举
  8. * @author cheng
  9. * @date 2017年11月20日 下午8:32:27
  10. */
  11. public enum SexEnum {
  12. MAN("1", "男"), WOMAN("2", "女");
  13. private String key;
  14. private String value;
  15. private static Map<String, SexEnum> sexEnumMap = new HashMap<>();
  16. static {
  17. for (SexEnum sexEnum : SexEnum.values()) {
  18. sexEnumMap.put(sexEnum.getKey(), sexEnum);
  19. }
  20. }
  21. /**
  22. * 私有化构造函数
  23. *
  24. * @param key
  25. * @param value
  26. */
  27. private SexEnum(String key, String value) {
  28. this.key = key;
  29. this.value = value;
  30. }
  31. /**
  32. *
  33. * @Title: getSexEnumByKey
  34. * @Description: 依据key获取枚举
  35. * @param key
  36. * @return
  37. */
  38. public static SexEnum getSexEnumByKey(String key) {
  39. return sexEnumMap.get(key);
  40. }
  41. public String getKey() {
  42. return key;
  43. }
  44. public void setKey(String key) {
  45. this.key = key;
  46. }
  47. public String getValue() {
  48. return value;
  49. }
  50. public void setValue(String value) {
  51. this.value = value;
  52. }
  53. }

2、包含枚举的实体类

  1. package com.ahut.entity;
  2. import java.io.Serializable;
  3. import java.util.Date;
  4. import com.ahut.core.enums.SexEnum;
  5. /**
  6. *
  7. * @ClassName: Demo
  8. * @Description:
  9. * @author cheng
  10. * @date 2017年11月21日 下午8:32:59
  11. */
  12. public class Demo implements Serializable {
  13. /**
  14. *
  15. */
  16. private static final long serialVersionUID = 4122974131420281791L;
  17. private Date birthDay;
  18. private String userName;
  19. private int age;
  20. private String id;
  21. private SexEnum sex;
  22. public Demo() {
  23. super();
  24. // TODO Auto-generated constructor stub
  25. }
  26. @Override
  27. public String toString() {
  28. return "Demo [id=" + id + ", userName=" + userName + ", age=" + age + ", birthDay=" + birthDay + ", sex=" + sex
  29. + "]";
  30. }
  31. public String getId() {
  32. return id;
  33. }
  34. public void setId(String id) {
  35. this.id = id;
  36. }
  37. public String getUserName() {
  38. return userName;
  39. }
  40. public void setUserName(String userName) {
  41. this.userName = userName;
  42. }
  43. public int getAge() {
  44. return age;
  45. }
  46. public void setAge(int age) {
  47. this.age = age;
  48. }
  49. public Date getBirthDay() {
  50. return birthDay;
  51. }
  52. public void setBirthDay(Date birthDay) {
  53. this.birthDay = birthDay;
  54. }
  55. public SexEnum getSex() {
  56. return sex;
  57. }
  58. public void setSex(SexEnum sex) {
  59. this.sex = sex;
  60. }
  61. }

3、书写枚举处理器

  1. package com.ahut.handler;
  2. import java.sql.CallableStatement;
  3. import java.sql.PreparedStatement;
  4. import java.sql.ResultSet;
  5. import java.sql.SQLException;
  6. import org.apache.ibatis.type.BaseTypeHandler;
  7. import org.apache.ibatis.type.JdbcType;
  8. import com.ahut.core.enums.SexEnum;
  9. /**
  10. *
  11. * @ClassName: EnumHandler
  12. * @Description:
  13. * @author cheng
  14. * @date 2017年11月20日 下午8:41:12
  15. */
  16. public class SexEnumHandler extends BaseTypeHandler<SexEnum> {
  17. /**
  18. * 用于定义设置参数时,该如何把Java类型的参数转换为对应的数据库类型
  19. */
  20. @Override
  21. public void setNonNullParameter(PreparedStatement ps, int i, SexEnum parameter, JdbcType jdbcType)
  22. throws SQLException {
  23. // baseTypeHandler已经帮我们做了parameter的null判断
  24. // 第二个参数 : 存入到数据库中的值
  25. ps.setString(i, parameter.getKey());
  26. }
  27. /**
  28. * 用于定义通过字段名称获取字段数据时,如何把数据库类型转换为对应的Java类型
  29. */
  30. @Override
  31. public SexEnum getNullableResult(ResultSet rs, String columnName) throws SQLException {
  32. System.out.println("columnName执行我");
  33. // 根据数据库存储类型决定获取类型,本例子中数据库中存放String类型
  34. String key = rs.getString(columnName);
  35. if (rs.wasNull()) {
  36. return null;
  37. } else {
  38. // 根据数据库中的key值,定位SexEnum子类
  39. return SexEnum.getSexEnumByKey(key);
  40. }
  41. }
  42. /**
  43. * 用于定义通过字段索引获取字段数据时,如何把数据库类型转换为对应的Java类型
  44. */
  45. @Override
  46. public SexEnum getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
  47. System.out.println("columnIndex执行我");
  48. // 根据数据库存储类型决定获取类型,本例子中数据库中存放String类型
  49. String key = rs.getString(columnIndex);
  50. if (rs.wasNull()) {
  51. return null;
  52. } else {
  53. // 根据数据库中的key值,定位SexEnum子类
  54. return SexEnum.getSexEnumByKey(key);
  55. }
  56. }
  57. /**
  58. * 用定义调用存储过程后,如何把数据库类型转换为对应的Java类型
  59. */
  60. @Override
  61. public SexEnum getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
  62. // 根据数据库存储类型决定获取类型,本例子中数据库中存放String类型
  63. String key = cs.getString(columnIndex);
  64. if (cs.wasNull()) {
  65. return null;
  66. } else {
  67. // 根据数据库中的key值,定位SexEnum子类
  68. return SexEnum.getSexEnumByKey(key);
  69. }
  70. }
  71. }

4、配置枚举处理器

mybatis配置

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  3. "http://mybatis.org/dtd/mybatis-3-config.dtd">
  4. <configuration>
  5. <settings>
  6. <!-- 打印sql语句 -->
  7. <setting name="logImpl" value="STDOUT_LOGGING" />
  8. </settings>
  9. <typeHandlers>
  10. <typeHandler handler="com.ahut.handler.SexEnumHandler"
  11. javaType="com.ahut.core.enums.SexEnum" jdbcType="CHAR" />
  12. </typeHandlers>
  13. </configuration>

5、dao层

  1. package com.ahut.mapper;
  2. import java.util.List;
  3. import java.util.Map;
  4. import com.ahut.entity.Demo;
  5. /**
  6. *
  7. * @ClassName: DemoMapper
  8. * @Description:
  9. * @author cheng
  10. * @date 2017年11月16日 下午9:10:38
  11. */
  12. public interface DemoMapper {
  13. /**
  14. *
  15. * @Title: saveDemo
  16. * @Description: 保存
  17. * @param map
  18. * @throws Exception
  19. */
  20. void saveDemo(Map<String, Object> map) throws Exception;
  21. /**
  22. *
  23. * @Title: selectDemoList
  24. * @Description: 查询
  25. * @return
  26. * @throws Exception
  27. */
  28. List<Map<String, Object>> selectDemoList() throws Exception;
  29. /**
  30. *
  31. * @Title: selectDemoList1
  32. * @Description: 查询
  33. * @return
  34. * @throws Exception
  35. */
  36. List<Demo> selectDemoList1() throws Exception;
  37. }

6、mapper文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  3. <mapper namespace="com.ahut.mapper.DemoMapper">
  4. <!-- 保存 -->
  5. <insert id="saveDemo" parameterType="map">
  6. INSERT INTO DEMO
  7. VALUES(replace(UUID(),'-',''),#{USER_NAME},#{AGE},#{BIRTH_DAY},#{SEX})
  8. </insert>
  9. <!-- 查询 -->
  10. <select id="selectDemoList" resultType="map">
  11. SELECT
  12. ID,
  13. USER_NAME,
  14. AGE,
  15. BIRTH_DAY,
  16. SEX
  17. FROM DEMO
  18. </select>
  19. <!-- 查询 -->
  20. <select id="selectDemoList1" resultType="com.ahut.entity.Demo">
  21. SELECT
  22. ID,
  23. USER_NAME USERNAME,
  24. AGE,
  25. BIRTH_DAY BIRTHDAY,
  26. SEX
  27. FROM DEMO
  28. </select>
  29. </mapper>

7、测试

  1. package com.ahut.service;
  2. import java.util.Date;
  3. import java.util.HashMap;
  4. import java.util.List;
  5. import java.util.Map;
  6. import org.junit.Test;
  7. import org.junit.runner.RunWith;
  8. import org.springframework.beans.factory.annotation.Autowired;
  9. import org.springframework.boot.test.context.SpringBootTest;
  10. import org.springframework.test.context.junit4.SpringRunner;
  11. import com.ahut.core.enums.SexEnum;
  12. import com.ahut.entity.Demo;
  13. /**
  14. *
  15. * @ClassName: DemoServiceTest
  16. * @Description:
  17. * @author cheng
  18. * @date 2017年11月16日 下午9:28:56
  19. */
  20. @SpringBootTest
  21. @RunWith(SpringRunner.class)
  22. public class DemoServiceTest {
  23. @Autowired
  24. private DemoService demoService;
  25. /**
  26. *
  27. * @Title: testSelectDemoList1
  28. * @Description:
  29. * @throws Exception
  30. */
  31. @Test
  32. public void testSelectDemoList1() throws Exception {
  33. List<Demo> demoList = demoService.selectDemoList1();
  34. for (Demo demo : demoList) {
  35. System.out.println(demo);
  36. }
  37. }
  38. /**
  39. *
  40. * @Title: testSelectDemoList
  41. * @Description:
  42. * @throws Exception
  43. */
  44. @Test
  45. public void testSelectDemoList() throws Exception {
  46. List<Map<String, Object>> demoList = demoService.selectDemoList();
  47. for (Map<String, Object> map : demoList) {
  48. for (String key : map.keySet()) {
  49. if (key.equals("BIRTH_DAY")) {
  50. Date birthDay = (Date) map.get(key);
  51. System.out.println(key + ":" + birthDay);
  52. } else if (key.equals("AGE")) {
  53. int age = (int) map.get(key);
  54. System.out.println(key + ":" + age);
  55. } else if (key.equals("SEX")) {
  56. SexEnum sex = (SexEnum) map.get(key);
  57. System.out.println(key + ":" + sex);
  58. } else {
  59. String value = (String) map.get(key);
  60. System.out.println(key + ":" + value);
  61. }
  62. }
  63. }
  64. }
  65. /**
  66. *
  67. * @Title: testSaveDemo
  68. * @Description:
  69. * @throws Exception
  70. */
  71. @Test
  72. public void testSaveDemo() throws Exception {
  73. Map<String, Object> map = new HashMap<>();
  74. map.put("USER_NAME", "rick11");
  75. map.put("AGE", 22);
  76. map.put("BIRTH_DAY", new Date());
  77. map.put("SEX", SexEnum.WOMAN);
  78. demoService.saveDemo(map);
  79. }
  80. }

执行testSaveDemo方法:

SexEnum.WOMAN被转换成了2存入到数据库中

这里写图片描述

执行testSelectDemoList1方法:

数据库中的1、2成功被转换成了枚举

当resultType为包含枚举的实体类时,mybatis调用了枚举处理器

这里写图片描述

这里写图片描述

执行testSelectDemoList方法:

报错

由下图可知,resultType为map时,并没有调用枚举处理器

这里写图片描述

这里写图片描述

以上为个人经验,希望能给大家一个参考,也希望大家多多支持w3xue。

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号