MyBatis(Plus) 枚举数组的映射

MyBatisPlus中枚举数组的映射技巧

最新推荐文章于 2025-08-26 07:45:00 发布

原创最新推荐文章于 2025-08-26 07:45:00 发布 · 1.5k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #开发语言 #后端

常用工具同时被 3 个专栏收录

39 篇文章

订阅专栏

JAVA

32 篇文章

订阅专栏

MyBatis(Plus)

6 篇文章

订阅专栏

本文介绍了如何在MyBatisPlus中处理数据库字段与Java枚举数组的映射问题。在PostgreSQL等支持数组类型的数据库中，可以直接映射，但无法直接映射枚举类型的数组。为解决这一问题，文章提出了一种扩展方法，通过自定义转换，实现了枚举类型数组的自动映射，使得映射过程得以顺利进行。

背景

我们都知道用MyBatis的EnumTypeHandler可以将数据库里的字段直接映射成Java里的枚举, 以下是MybatisPlus的示例代码：

public enum Sex {
	MAN, WOMAN
}

@Data
@TableName("student")
public class Student {
    private String stuId;
    private Sex sex;
}

另外，像PostgrelSql这种数据库，是支持数组类型的，这时候可以用ArrayTypeHandler去和Java里面的数组做映射：

@Data
@TableName("student")
public class Student {
    private String stuId;
    private Sex sex;
    @TableField(value="hobbies", typeHandler = ArrayTypeHandler.class)
    private String[] hobbies;
}

public enum Hobby {
	READ, SPORT, MUSIC,
}

但是如果想将字符串数组想映射成一个枚举类型的数组，是没有办法直接映射的, 以下代码不会成功：

public enum Hobby {
	READ, SPORT, MUSIC,
}

@Data
@TableName("student")
public class Student {
    private String stuId;
    private Sex sex;
    @TableField(value="hobbies", typeHandler = ArrayTypeHandler.class)
    private Hobby[] hobbies;
}

解决方法

可以扩展ArrayTypeHandler，针对枚举类型的数组做自动转换：


import org.apache.ibatis.type.ArrayTypeHandler;
import org.apache.ibatis.type.JdbcType;

import java.sql.Array;

/**
 * 扩展 ArrayTypeHandler
 */
public class ArrayTypeHandlerX extends ArrayTypeHandler {
    private final Class<?> type;

    public ArrayTypeHandlerX(Class<?> type) {
        if (type == null) {
            throw new IllegalArgumentException("Type argument cannot be null");
        }
        this.type = type;
    }
    
    @Override
    protected Object extractArray(Array array) throws SQLException {
        // 判断数据类型是否是枚举
        Class<?> componentType = this.type.getComponentType();
        if (!componentType.isEnum()) {
            return super.extractArray(array);
        }
        // 获取原有的数组值
        Object[] objects = (Object[]) super.extractArray(array);
        if (null == objects) {
            return null;
        }
        // 枚举值转换
        Object[] resultArray = (Object[]) java.lang.reflect.Array.newInstance(componentType, objects.length);
        for (int i = 0; i < objects.length; i++) {
            resultArray[i] = Enum.valueOf((Class<? extends Enum>) componentType, objects[i].toString());
        }
        return resultArray;
    }
}

使用

public enum Hobby {
	READ, SPORT, MUSIC,
}

@Data
@TableName("student")
public class Student {
    private String stuId;
    private Sex sex;
    @TableField(value="hobbies", typeHandler = ArrayTypeHandlerX.class)
    private Hobby[] hobbies;
}