Mybatis Plus自定义枚举类型转换

博客介绍了自定义MyBatis枚举转换的方法,实际使用MyBatis Plus的枚举工具,拷贝修改为自己的枚举接口,以数据库里保存的数字类型进行转换,通过自动装配替换原生的MyBatisEnumTypeHandler枚举类型处理器。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

自定义Mybatis的枚举转换

这里实际使用的是mybatis plus的枚举工具,只不过拷贝出来修改为自己的枚举接口以及想用什么值进行转换;我这里使用的是通过数据库里面保存的数字类型进行转换,然后通过自动装配替换原生的枚举类型,原来的类型 MybatisEnumTypeHandler

public class CommonEnumTypeHandler<E extends CommonEnum> extends BaseTypeHandler<E> {

    private static final Map<String, String> TABLE_METHOD_OF_ENUM_TYPES = new ConcurrentHashMap();
    private static final ReflectorFactory REFLECTOR_FACTORY = new DefaultReflectorFactory();
    private final Class<E> enumClassType;
    //当前值的字段类型
    private final Class<?> propertyType;
    //mybatis plus封装的获取值的执行器
    private final Invoker getInvoker;

    public CommonEnumTypeHandler(Class<E> enumClassType) {
        if (enumClassType == null) {
            throw new IllegalArgumentException("Type argument cannot be null");
        } else {
            //获取到前字段的枚举类型
            this.enumClassType = enumClassType;
            //获取到枚举类型
            MetaClass metaClass = MetaClass.forClass(enumClassType, REFLECTOR_FACTORY);
            String name = CommonEnum.VALUE_FILED_NAME;
            //如果枚举类型不为 CommonEnum 接口的实现类,
            if (!CommonEnum.class.isAssignableFrom(enumClassType)) {
                name = findEnumValueFieldName(this.enumClassType)
                    .orElseThrow(() -> new IllegalArgumentException(String.format("Could not find @EnumValue in Class: %s.",
                                                                                  this.enumClassType.getName())));
            }
            //通过getter方法来获取到对于属性值的类型
            this.propertyType = ReflectionKit.resolvePrimitiveIfNecessary(metaClass.getGetterType(name));
            this.getInvoker = metaClass.getGetInvoker(name);
        }
    }

    /**
     * 根据枚举类型来获取对应字段的 @EnumValue 注解的值
     *
     * @param clazz
     * @return
     */
    public static Optional<String> findEnumValueFieldName(Class<?> clazz) {
        if (clazz != null && clazz.isEnum()) {
            String className = clazz.getName();
            return Optional.ofNullable(CollectionUtils.computeIfAbsent(TABLE_METHOD_OF_ENUM_TYPES, className, (key) -> {
                Optional<Field> fieldOptional = findEnumValueAnnotationField(clazz);
                return fieldOptional.map(Field::getName).orElse(null);
            }));
        } else {
            return Optional.empty();
        }
    }

    /**
     * 处理字段上是否设置了 EnumValue
     *
     * @param clazz
     * @return
     */
    private static Optional<Field> findEnumValueAnnotationField(Class<?> clazz) {
        return Arrays.stream(clazz.getDeclaredFields()).filter((field) -> field.isAnnotationPresent(EnumValue.class)).findFirst();
    }

    /**
     * 判断是否是CommonEnum的接口实现
     *
     * @param clazz
     * @return
     */
    public static boolean isMpEnums(Class<?> clazz) {
        return clazz != null && clazz.isEnum() && (CommonEnum.class.isAssignableFrom(clazz) || findEnumValueFieldName(clazz).isPresent());
    }

    public void setNonNullParameter(PreparedStatement ps, int i, E parameter, JdbcType jdbcType) throws SQLException {
        if (jdbcType == null) {
            ps.setObject(i, this.getValue(parameter));
        } else {
            ps.setObject(i, this.getValue(parameter), jdbcType.TYPE_CODE);
        }

    }

    public E getNullableResult(ResultSet rs, String columnName) throws SQLException {
        Object value = rs.getObject(columnName, this.propertyType);
        return null == value && rs.wasNull() ? null : this.valueOf(value);
    }

    public E getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        Object value = rs.getObject(columnIndex, this.propertyType);
        return null == value && rs.wasNull() ? null : this.valueOf(value);
    }

    public E getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        Object value = cs.getObject(columnIndex, this.propertyType);
        return null == value && cs.wasNull() ? null : this.valueOf(value);
    }

    private E valueOf(Object value) {
        E[] es = (E[]) this.enumClassType.getEnumConstants();
        return (E) Arrays.stream(es).filter((e) -> this.equalsValue(value, this.getValue(e))).findAny().orElse((E) null);
    }

    protected boolean equalsValue(Object sourceValue, Object targetValue) {
        String sValue = StringUtils.toStringTrim(sourceValue);
        String tValue = StringUtils.toStringTrim(targetValue);
        return sourceValue instanceof Number
               &&
               targetValue instanceof Number
               && (new BigDecimal(sValue)).compareTo(new BigDecimal(tValue)) == 0 || Objects.equals(sValue, tValue);
    }

    private Object getValue(Object object) {
        try {
            return this.getInvoker.invoke(object, new Object[0]);
        } catch (ReflectiveOperationException var3) {
            throw ExceptionUtils.mpe(var3);
        }
    }
}

通过自动装配替换原来的枚举类型处理器

/**
     * 配置mybatis plus自定义的枚举类型转换器
     *
     * @return
     */
    @Bean
    public ConfigurationCustomizer enumConfigurationCustomizer() {
        return configuration -> configuration.setDefaultEnumTypeHandler(CommonEnumTypeHandler.class);
    }
### MyBatis Plus 中集合和枚举的映射实现 #### 枚举类型的映射 在MyBatis-Plus中,对枚举的支持较为简便。通过`@EnumValue`注解以及自定义处理器的方式能够更轻松地完成枚举类型与数据库字段之间的转换[^1]。 对于简单的枚举映射,可以直接利用内置的功能来处理基本的数据交换需求。例如性别枚举: ```java public enum Sex { MAN, WOMAN; } ``` 当涉及到实体类时,则可以通过如下方式声明属性并关联上述枚举: ```java @Data @TableName("student") public class Student { private String stuId; @TableField(typeHandler = EnumTypeHandler.class) private Sex sex; } ``` 这里使用了`typeHandler`指定为`EnumTypeHandler`以便于自动处理枚举值与字符串间的相互转化[^2]。 #### 集合类型的映射 针对更为复杂的场景——即需要存储多个枚举实例组成的列表或数组形式的情况,在MyBatis-Plus里同样提供了灵活的方法来进行映射操作。一种常见的做法是采用JSON序列化/反序列化的手段保存这些数据结构至单一列内;另一种则是创建额外的关系表以支持一对多关系建模。 如果选择前者(推荐),则需引入Jackson库或其他类似的JSON解析器,并配置相应的TypeHandler: ```xml <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>${jackson.version}</version> </dependency> ``` 接着编写自定义的TypeHandler用于处理特定业务逻辑下的对象持久化过程: ```java import com.baomidou.mybatisplus.extension.handlers.AbstractJsonTypeHandler; import com.fasterxml.jackson.databind.ObjectMapper; // 假设有一个名为Hobby的枚举... public class HobbyListTypeHandler extends AbstractJsonTypeHandler<List<Hobby>> { public HobbyListTypeHandler() { super(new ObjectMapper()); } @Override protected List<Hobby> parse(String json) throws Exception { return getObjectMapper().readValue(json, new TypeReference<List<Hobby>>() {}); } // ...其他必要的方法重写 } ``` 最后一步是在对应的Entity类上应用此TypeHandler: ```java @TableField(typeHandler = HobbyListTypeHandler.class) private List<Hobby> hobbies; ``` 这样就完成了从Java端到数据库层面完整的双向映射机制构建工作[^3]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值