Mybatis 查詢語句條件為枚舉類型時報錯的解決
Mybatis查詢語句條件為枚舉類型報錯
通常我們對于數據庫中一些枚舉字段使用tinyInt類型,而java對象對應的字段很多時候會為了方便定義成short或者int。但這樣顯然不美觀方便,讓后面維護的人摳破腦袋找你的常量定義在哪兒,要是沒有注釋簡直讓人崩潰。時間久后,沒有人知道這里面的值。只能一行行讀源碼。
優(yōu)雅的程序員當然想到了優(yōu)雅的枚舉,而mybatis“強大”的枚舉類型處理器EnumOrdinalTypeHandler相信都不陌生。
然而配置枚舉處理器花了九牛二虎之力改好原來的mapper運行測試用例全在報錯。而插入、部分查詢卻沒報錯。這時進程進行到一半讓人崩潰想要放棄。
通常這個錯誤是
"failed to invoke constructor for handler class org.apache.ibatis.type.EnumOrdinalTypeHandler”
原因是因為該死的查詢條件使用枚舉對象作為條件,無論你用selectExample還是其他的select,當條件where enum = #{enum}時就會報錯。不要懷疑自己是不是EnumOrdinalTypeHandler沒配對,如果沒配對那一定會是所有的查詢接口都會報錯。
stackoverflow上只有一條相關問題。為什么這么少?這不是很常見的錯誤嗎?jpa或hibernate就能很優(yōu)雅的使用枚舉啊。原因嘛,老外們很少用半自動的mybatis框架。只有國內奉為圭臬,原因嘛當然是聽說人家阿里就用mybatis,所以一定是好的。也不看自己的業(yè)務到底是否真正觸及到要提升sql性能的地步。
話說回來,目前給出來的答案似乎是mybatis的bug,但對于mybatis這種半自動框架這不一定是bug。
解決辦法很簡單粗暴,把where enum = #{enum}條件換成where enum in (***)萬事大吉。但熟悉的同學已經發(fā)現(xiàn)了。這樣的性能顯然不如=。用short和int的同學肯定又開心了??窗晌揖驼f數據庫什么類型就用什么類型,枚舉就是垃圾。說這話的同學顯然還不習慣封裝、規(guī)范這一套,更喜歡隨心所欲的感覺。
今天的教訓就到這。
Mybatis處理枚舉類型
1、枚舉
package com.ahut.core.enums;
import java.util.HashMap;
import java.util.Map;
/**
*
* @ClassName: SexEnum
* @Description: 性別枚舉
* @author cheng
* @date 2017年11月20日 下午8:32:27
*/
public enum SexEnum {
MAN("1", "男"), WOMAN("2", "女");
private String key;
private String value;
private static Map<String, SexEnum> sexEnumMap = new HashMap<>();
static {
for (SexEnum sexEnum : SexEnum.values()) {
sexEnumMap.put(sexEnum.getKey(), sexEnum);
}
}
/**
* 私有化構造函數
*
* @param key
* @param value
*/
private SexEnum(String key, String value) {
this.key = key;
this.value = value;
}
/**
*
* @Title: getSexEnumByKey
* @Description: 依據key獲取枚舉
* @param key
* @return
*/
public static SexEnum getSexEnumByKey(String key) {
return sexEnumMap.get(key);
}
public String getKey() {
return key;
}
public void setKey(String key) {
this.key = key;
}
public String getValue() {
return value;
}
public void setValue(String value) {
this.value = value;
}
}2、包含枚舉的實體類
package com.ahut.entity;
import java.io.Serializable;
import java.util.Date;
import com.ahut.core.enums.SexEnum;
/**
*
* @ClassName: Demo
* @Description:
* @author cheng
* @date 2017年11月21日 下午8:32:59
*/
public class Demo implements Serializable {
/**
*
*/
private static final long serialVersionUID = 4122974131420281791L;
private Date birthDay;
private String userName;
private int age;
private String id;
private SexEnum sex;
public Demo() {
super();
// TODO Auto-generated constructor stub
}
@Override
public String toString() {
return "Demo [id=" + id + ", userName=" + userName + ", age=" + age + ", birthDay=" + birthDay + ", sex=" + sex
+ "]";
}
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public Date getBirthDay() {
return birthDay;
}
public void setBirthDay(Date birthDay) {
this.birthDay = birthDay;
}
public SexEnum getSex() {
return sex;
}
public void setSex(SexEnum sex) {
this.sex = sex;
}
}3、書寫枚舉處理器
package com.ahut.handler;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import com.ahut.core.enums.SexEnum;
/**
*
* @ClassName: EnumHandler
* @Description:
* @author cheng
* @date 2017年11月20日 下午8:41:12
*/
public class SexEnumHandler extends BaseTypeHandler<SexEnum> {
/**
* 用于定義設置參數時,該如何把Java類型的參數轉換為對應的數據庫類型
*/
@Override
public void setNonNullParameter(PreparedStatement ps, int i, SexEnum parameter, JdbcType jdbcType)
throws SQLException {
// baseTypeHandler已經幫我們做了parameter的null判斷
// 第二個參數 : 存入到數據庫中的值
ps.setString(i, parameter.getKey());
}
/**
* 用于定義通過字段名稱獲取字段數據時,如何把數據庫類型轉換為對應的Java類型
*/
@Override
public SexEnum getNullableResult(ResultSet rs, String columnName) throws SQLException {
System.out.println("columnName執(zhí)行我");
// 根據數據庫存儲類型決定獲取類型,本例子中數據庫中存放String類型
String key = rs.getString(columnName);
if (rs.wasNull()) {
return null;
} else {
// 根據數據庫中的key值,定位SexEnum子類
return SexEnum.getSexEnumByKey(key);
}
}
/**
* 用于定義通過字段索引獲取字段數據時,如何把數據庫類型轉換為對應的Java類型
*/
@Override
public SexEnum getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
System.out.println("columnIndex執(zhí)行我");
// 根據數據庫存儲類型決定獲取類型,本例子中數據庫中存放String類型
String key = rs.getString(columnIndex);
if (rs.wasNull()) {
return null;
} else {
// 根據數據庫中的key值,定位SexEnum子類
return SexEnum.getSexEnumByKey(key);
}
}
/**
* 用定義調用存儲過程后,如何把數據庫類型轉換為對應的Java類型
*/
@Override
public SexEnum getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
// 根據數據庫存儲類型決定獲取類型,本例子中數據庫中存放String類型
String key = cs.getString(columnIndex);
if (cs.wasNull()) {
return null;
} else {
// 根據數據庫中的key值,定位SexEnum子類
return SexEnum.getSexEnumByKey(key);
}
}
}4、配置枚舉處理器
mybatis配置
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<settings>
<!-- 打印sql語句 -->
<setting name="logImpl" value="STDOUT_LOGGING" />
</settings>
<typeHandlers>
<typeHandler handler="com.ahut.handler.SexEnumHandler"
javaType="com.ahut.core.enums.SexEnum" jdbcType="CHAR" />
</typeHandlers>
</configuration>5、dao層
package com.ahut.mapper;
import java.util.List;
import java.util.Map;
import com.ahut.entity.Demo;
/**
*
* @ClassName: DemoMapper
* @Description:
* @author cheng
* @date 2017年11月16日 下午9:10:38
*/
public interface DemoMapper {
/**
*
* @Title: saveDemo
* @Description: 保存
* @param map
* @throws Exception
*/
void saveDemo(Map<String, Object> map) throws Exception;
/**
*
* @Title: selectDemoList
* @Description: 查詢
* @return
* @throws Exception
*/
List<Map<String, Object>> selectDemoList() throws Exception;
/**
*
* @Title: selectDemoList1
* @Description: 查詢
* @return
* @throws Exception
*/
List<Demo> selectDemoList1() throws Exception;
}6、mapper文件
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.ahut.mapper.DemoMapper">
<!-- 保存 -->
<insert id="saveDemo" parameterType="map">
INSERT INTO DEMO
VALUES(replace(UUID(),'-',''),#{USER_NAME},#{AGE},#{BIRTH_DAY},#{SEX})
</insert>
<!-- 查詢 -->
<select id="selectDemoList" resultType="map">
SELECT
ID,
USER_NAME,
AGE,
BIRTH_DAY,
SEX
FROM DEMO
</select>
<!-- 查詢 -->
<select id="selectDemoList1" resultType="com.ahut.entity.Demo">
SELECT
ID,
USER_NAME USERNAME,
AGE,
BIRTH_DAY BIRTHDAY,
SEX
FROM DEMO
</select>
</mapper>7、測試
package com.ahut.service;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import com.ahut.core.enums.SexEnum;
import com.ahut.entity.Demo;
/**
*
* @ClassName: DemoServiceTest
* @Description:
* @author cheng
* @date 2017年11月16日 下午9:28:56
*/
@SpringBootTest
@RunWith(SpringRunner.class)
public class DemoServiceTest {
@Autowired
private DemoService demoService;
/**
*
* @Title: testSelectDemoList1
* @Description:
* @throws Exception
*/
@Test
public void testSelectDemoList1() throws Exception {
List<Demo> demoList = demoService.selectDemoList1();
for (Demo demo : demoList) {
System.out.println(demo);
}
}
/**
*
* @Title: testSelectDemoList
* @Description:
* @throws Exception
*/
@Test
public void testSelectDemoList() throws Exception {
List<Map<String, Object>> demoList = demoService.selectDemoList();
for (Map<String, Object> map : demoList) {
for (String key : map.keySet()) {
if (key.equals("BIRTH_DAY")) {
Date birthDay = (Date) map.get(key);
System.out.println(key + ":" + birthDay);
} else if (key.equals("AGE")) {
int age = (int) map.get(key);
System.out.println(key + ":" + age);
} else if (key.equals("SEX")) {
SexEnum sex = (SexEnum) map.get(key);
System.out.println(key + ":" + sex);
} else {
String value = (String) map.get(key);
System.out.println(key + ":" + value);
}
}
}
}
/**
*
* @Title: testSaveDemo
* @Description:
* @throws Exception
*/
@Test
public void testSaveDemo() throws Exception {
Map<String, Object> map = new HashMap<>();
map.put("USER_NAME", "rick11");
map.put("AGE", 22);
map.put("BIRTH_DAY", new Date());
map.put("SEX", SexEnum.WOMAN);
demoService.saveDemo(map);
}
}執(zhí)行testSaveDemo方法:
SexEnum.WOMAN被轉換成了2存入到數據庫中

執(zhí)行testSelectDemoList1方法:
數據庫中的1、2成功被轉換成了枚舉
當resultType為包含枚舉的實體類時,mybatis調用了枚舉處理器


執(zhí)行testSelectDemoList方法:
報錯
由下圖可知,resultType為map時,并沒有調用枚舉處理器


以上為個人經驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關文章
IntelliJ IDEA 的 Spring 項目如何查看 @Value 的配置和值(方法詳解)
這篇文章主要介紹了IntelliJ IDEA 的 Spring 項目如何查看 @Value 的配置和值,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-10-10
IDEA中已配置阿里鏡像但maven無法下載jar包的問題及解決方法
這篇文章主要介紹了IDEA中已配置阿里鏡像但maven無法下載jar包的問題,本文給大家分享解決方法,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-08-08

