MyBatis中如何优雅的使用枚举详解

2023-09-26 03:32:05 122

问题

本文主要给大家介绍的是关于MyBatis使用枚举的相关内容，我们在编码过程中，经常会遇到用某个数值来表示某种状态、类型或者阶段的情况，比如有这样一个枚举：

publicenumComputerState{
OPEN(10),//开启
CLOSE(11),//关闭
OFF_LINE(12),//离线
FAULT(200),//故障
UNKNOWN(255);//未知

privateintcode;
ComputerState(intcode){this.code=code;}
}

通常我们希望将表示状态的数值存入数据库，即ComputerState.OPEN存入数据库取值为10。

探索

首先，我们先看看MyBatis是否能够满足我们的需求。

MyBatis内置了两个枚举转换器分别是：org.apache.ibatis.type.EnumTypeHandler和org.apache.ibatis.type.EnumOrdinalTypeHandler。

EnumTypeHandler

这是默认的枚举转换器，该转换器将枚举实例转换为实例名称的字符串，即将ComputerState.OPEN转换OPEN。

EnumOrdinalTypeHandler

顾名思义这个转换器将枚举实例的ordinal属性作为取值，即ComputerState.OPEN转换为0,ComputerState.CLOSE转换为1。

使用它的方式是在MyBatis配置文件中定义：

以上的两种转换器都不能满足我们的需求，所以看起来要自己编写一个转换器了。

方案

MyBatis提供了org.apache.ibatis.type.BaseTypeHandler类用于我们自己扩展类型转换器，上面的EnumTypeHandler和EnumOrdinalTypeHandler也都实现了这个接口。

1.定义接口

我们需要一个接口来确定某部分枚举类的行为。如下：

publicinterfaceBaseCodeEnum{
intgetCode();
}

该接口只有一个返回编码的方法，返回值将被存入数据库。

2.改造枚举

就拿上面的ComputerState来实现BaseCodeEnum接口：

publicenumComputerStateimplementsBaseCodeEnum{
OPEN(10),//开启
CLOSE(11),//关闭
OFF_LINE(12),//离线
FAULT(200),//故障
UNKNOWN(255);//未知

privateintcode;
ComputerState(intcode){this.code=code;}

@Override
publicintgetCode(){returnthis.code;}
}

3.编写一个转换工具类

现在我们能顺利的将枚举转换为某个数值了，还需要一个工具将数值转换为枚举实例。

publicclassCodeEnumUtil{

publicstatic&BaseCodeEnum>EcodeOf(ClassenumClass,intcode){
E[]enumConstants=enumClass.getEnumConstants();
for(Ee:enumConstants){
if(e.getCode()==code)
returne;
}
returnnull;
}
}

4.自定义类型转换器

准备工作做的差不多了，是时候开始编写转换器了。

BaseTypeHandler一共需要实现4个方法：

voidsetNonNullParameter(PreparedStatementps,inti,Tparameter,JdbcTypejdbcType)
用于定义设置参数时，该如何把Java类型的参数转换为对应的数据库类型
TgetNullableResult(ResultSetrs,StringcolumnName)
用于定义通过字段名称获取字段数据时，如何把数据库类型转换为对应的Java类型
TgetNullableResult(ResultSetrs,intcolumnIndex)
用于定义通过字段索引获取字段数据时，如何把数据库类型转换为对应的Java类型
TgetNullableResult(CallableStatementcs,intcolumnIndex)
用定义调用存储过程后，如何把数据库类型转换为对应的Java类型

我是这样实现的：

publicclassCodeEnumTypeHandler&BaseCodeEnum>extendsBaseTypeHandler{

privateClasstype;

publicCodeEnumTypeHandler(Classtype){
if(type==null){
thrownewIllegalArgumentException("Typeargumentcannotbenull");
}
this.type=type;
}

@Override
publicvoidsetNonNullParameter(PreparedStatementps,inti,BaseCodeEnumparameter,JdbcTypejdbcType)
throwsSQLException{
ps.setInt(i,parameter.getCode());
}

@Override
publicEgetNullableResult(ResultSetrs,StringcolumnName)throwsSQLException{
inti=rs.getInt(columnName);
if(rs.wasNull()){
returnnull;
}else{
try{
returnCodeEnumUtil.codeOf(type,i);
}catch(Exceptionex){
thrownewIllegalArgumentException("Cannotconvert"+i+"to"+type.getSimpleName()+"byordinalvalue.",
ex);
}
}
}

@Override
publicEgetNullableResult(ResultSetrs,intcolumnIndex)throwsSQLException{
inti=rs.getInt(columnIndex);
if(rs.wasNull()){
returnnull;
}else{
try{
returnCodeEnumUtil.codeOf(type,i);
}catch(Exceptionex){
thrownewIllegalArgumentException("Cannotconvert"+i+"to"+type.getSimpleName()+"byordinalvalue.",
ex);
}
}
}

@Override
publicEgetNullableResult(CallableStatementcs,intcolumnIndex)throwsSQLException{
inti=cs.getInt(columnIndex);
if(cs.wasNull()){
returnnull;
}else{
try{
returnCodeEnumUtil.codeOf(type,i);
}catch(Exceptionex){
thrownewIllegalArgumentException("Cannotconvert"+i+"to"+type.getSimpleName()+"byordinalvalue.",
ex);
}
}
}
}

5.使用

接下来需要指定哪个类使用我们自己编写转换器进行转换，在MyBatis配置文件中配置如下：

搞定！经测试ComputerState.OPEN被转换为10,ComputerState.UNKNOWN被转换为255，达到了预期的效果。

6.优化

在第5步时，我们在MyBatis中添加typeHandler用于指定哪些类使用我们自定义的转换器，一旦系统中的枚举类多了起来，MyBatis的配置文件维护起来会变得非常麻烦，也容易出错。如何解决呢？

在SpringBoot中我们可以干预SqlSessionFactory的创建过程，来完成动态的转换器指定。

思路

通过sqlSessionFactory.getConfiguration().getTypeHandlerRegistry()取得类型转换器注册器
扫描所有实体类，找到实现了BaseCodeEnum接口的枚举类
将实现了BaseCodeEnum的类注册使用CodeEnumTypeHandler进行转换。

实现如下：

MyBatisConfig.java

@Configuration
@ConfigurationProperties(prefix="mybatis")
publicclassMyBatisConfig{

privateStringconfigLocation;

privateStringmapperLocations;

@Bean
publicSqlSessionFactorysqlSessionFactory(DataSourcedataSource,ResourcesUtilresourcesUtil)throwsException{
SqlSessionFactoryBeanfactory=newSqlSessionFactoryBean();
factory.setDataSource(dataSource);


//设置配置文件地址
ResourcePatternResolverresolver=newPathMatchingResourcePatternResolver();
factory.setConfigLocation(resolver.getResource(configLocation));
factory.setMapperLocations(resolver.getResources(mapperLocations));


SqlSessionFactorysqlSessionFactory=factory.getObject();

//-----------动态加载实现BaseCodeEnum接口的枚举，使用CodeEnumTypeHandler转换器

//取得类型转换注册器
TypeHandlerRegistrytypeHandlerRegistry=sqlSessionFactory.getConfiguration().getTypeHandlerRegistry();


//扫描所有实体类
ListclassNames=resourcesUtil.list("com/example","/**/entity");

for(StringclassName:classNames){
//处理路径成为类名
className=className.replace('/','.').replaceAll("\\.class","");
//取得Class
ClassaClass=Class.forName(className,false,getClass().getClassLoader());

//判断是否实现了BaseCodeEnum接口
if(aClass.isEnum()&&BaseCodeEnum.class.isAssignableFrom(aClass)){
//注册
typeHandlerRegistry.register(className,"com.example.typeHandler.CodeEnumTypeHandler");
}
}

//---------------end

returnsqlSessionFactory;
}

publicStringgetConfigLocation(){
returnconfigLocation;
}

publicvoidsetConfigLocation(StringconfigLocation){
this.configLocation=configLocation;
}

publicStringgetMapperLocations(){
returnmapperLocations;
}

publicvoidsetMapperLocations(StringmapperLocations){
this.mapperLocations=mapperLocations;
}
}

ResourcesUtil.java

@Component
publicclassResourcesUtil{

privatefinalResourcePatternResolverresourceResolver;

publicResourcesUtil(){
this.resourceResolver=newPathMatchingResourcePatternResolver(getClass().getClassLoader());
}

/**
*返回路径下所有class
*
*@paramrootPath根路径
*@paramlocationPattern位置表达式
*@return
*@throwsIOException
*/
publicListlist(StringrootPath,StringlocationPattern)throwsIOException{
Resource[]resources=resourceResolver.getResources("classpath*:"+rootPath+locationPattern+"/**/*.class");
ListresourcePaths=newArrayList<>();
for(Resourceresource:resources){
resourcePaths.add(preserveSubpackageName(resource.getURI(),rootPath));
}
returnresourcePaths;
}
}

总结

以上就是我对如何在MyBatis中优雅的使用枚举的探索。如果你还有更优的解决方案，请一定在评论中告知，万分感激。希望本文的内容对大家的学习或者工作能带来一定的帮助，谢谢大家对毛票票的支持。

MyBatis中如何优雅的使用枚举详解

热门推荐

随机推荐