mybatis 指定类型映射处理,实现针对数组集合,枚举,JSON对应类型映射

本文介绍如何在MyBatis中使用自定义类型处理器处理复杂数据类型,如数组和枚举,通过实例展示了如何创建和应用JsonIntegerArrayTypeHandler及GenderTypeEnumTypeHandler,以实现更高效的数据映射。

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

主要说明对于mapper映射查询和新增时候进行的一些特殊类型处理。

首先讲解一下映射数组

CREATE TABLE `admin_role_ids` (
  `id` bigint(20) NOT NULL primary key AUTO_INCREMENT COMMENT 'id',
  `type` varchar(16) DEFAULT NULL COMMENT '分别 admin , tourist 枚举',
  `role_ids` varchar(256) DEFAULT NULL COMMENT '所属角色:[1,2,3,4,5,7,8,9] 数组'
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='角色权限表';

使用代码构建器直接构建出来mapper,创建表的时候[role_ids]字段为varchar(256),所以mapper的对应java type是 java.lang.String 类型。查询出来之后数据就会是一行字符串[1,2,5,6],所以我们希望能把这个字符串转换成数组。

/**
 * 所属角色
*/
private String roleIds;


可以在数据模型上面进行get set 进行处理,也是可以达到同样的效果。比如获取的时候需要是数组,则可以直接在get里面进行数据转换。数据查询是实现的。插入的时候就会以get转换之后的数据进行插入。则直接抛出异常。

public Integer[] getRoleIds() {
	...
}

所以我们希望能够直接使用数组类型进行CURD 而不用这么麻烦的去进行数据转换。

这里需要使用上mybatis 包里面 BaseTypeHandler 一个类型处理的抽象类型

package org.apache.ibatis.type;
...
public abstract class BaseTypeHandler<T> extends TypeReference<T> implements TypeHandler<T> {
	....
}

BaseTypeHandler T就是需要处理的类型。

所以生成之后的数据模型需要进行更改

/**
* 所属角色
*/
private Integer[] roleIds;

然后新创建一个针对Integer[] 映射处理的类型。来继承BaseTypeHandler类型,T则是数据模型里面的类型Integer[] 。

分别重写【setNonNullParameter(),getNullableResult(),getNullableResult(),getNullableResult()】

重写这几个方法既可以针对类型进行映射处理,可以看到 处理Statement的时候进行了分别进行了数据转换达到目的。

public class JsonIntegerArrayTypeHandler extends BaseTypeHandler<Integer[]> {
    private static final ObjectMapper MAPPER = new ObjectMapper();

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, Integer[] parameter, JdbcType jdbcType) throws SQLException {
        ps.setString(i, toJson(parameter));
    }

    @Override
    public Integer[] getNullableResult(ResultSet rs, String columnName) throws SQLException {
        return this.toObject(rs.getString(columnName));
    }

    @Override
    public Integer[] getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        return this.toObject(rs.getString(columnIndex));
    }

    @Override
    public Integer[] getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        return this.toObject(cs.getString(columnIndex));
    }

    private String toJson(Integer[] params) {
        try {
            return MAPPER.writeValueAsString(params);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return "[]";
    }

    private Integer[] toObject(String content) {
        if (content != null && !content.isEmpty()) {
            try {
                return MAPPER.readValue(content, Integer[].class);
            } catch (Exception e) {
                throw new RuntimeException(e);
            }
        } else {
            return null;
        }
    }
}

做好这两部分之后,并不会直接使用这个类型转换处理器而是需要在 Statement 里面需要指定处理器类型。

找到查询的Mpper 直接进行设置

<result column="role_ids" property="roleIds" jdbcType="VARCHAR" typeHandler="*.*.*.mybatis.JsonIntegerArrayTypeHandler" />

这里已经改写完成之后。映射已经不会异常了。只是,没有数据。所以还需要做一步针对mybatis 读取该转换类型的步骤。

因为高版本的mybatis 需要指定 xml ,所以在spirng 配置中需要指定mybait的配置文件

在mybatis 文件中 加入 以下配置

 <typeHandlers>
 	<typeHandler handler="*.*.*.mybatis.JsonIntegerArrayTypeHandler"/>
 </typeHandlers>

mybatis-puls 可以直接在spring 中配置,只要指定处理类型所在的包即可

mybatis-plus:
 type-handlers-package: *.*.*.mybatis

枚举和 集合或是其他指定类型同理。可以直接新建对应的处理类型即可。
枚举部分:

table:

im_sex bit(1) DEFAULT b’0’ COMMENT ‘性别: 0:女 1:男’,

因为是一个bit的类型所以对应的是javaType 是bool类型。,所以在模型上面应该改成指定的枚举类型

@ApiModelProperty(value = "性别: 0:女  1:男")
// private Boolean imSex;
private GenderTypeEnum imSex;
/**
 * 性别枚举
 *
 * @author Dizzy
 */

public enum GenderTypeEnum {
    /**
     * 男
     */
    MAN("M", "男"),
    /**
     * 女
     */
    WOMAN("W", "女"),
    /**
     * 男
     */
    WX_NAM("1", "男"),
    /**
     * 女
     */
    WX_WOMAN("0", "女"),
    ;


    private String value;
    private String desc;

    GenderTypeEnum(String value, String desc) {
        this.value = value;
        this.desc = desc;
    }

    public static String descOf(String key) {
        for (GenderTypeEnum d : GenderTypeEnum.values()) {
            if (d.value.equals(key)) {
                return d.value;
            }
        }
        return null;
    }

    public static GenderTypeEnum getTypeEnum(String value) {
        for (GenderTypeEnum d : GenderTypeEnum.values()) {
            if (d.value.equals(value)) {
                return d;
            }
        }
        return null;
    }

    public String getDesc() {
        return desc;
    }

    public String getValue() {
        return value;
    }

    public Boolean isMan() {
        switch (this) {
            case WOMAN:
            case WX_WOMAN:
                return false;
            default:
                return true;
        }
    }

    public static GenderTypeEnum getGenderTypeEnum(Boolean bool) {
        if (bool) {
            return MAN;
        }
        return WOMAN;
    }

}

Mapper 部分

<result column="im_sex" property="imSex" typeHandler="*.*.*.mybatis.GenderTypeEnumTypeHandler" />

处理类型部分:

/**
 * <columnOverride column="ids" javaType="java.lang.Integer[]" typeHandler="JsonIntegerArrayTypeHandler"/>
 *
 * @author Dizzy
 */
public class GenderTypeEnumTypeHandler extends BaseTypeHandler<GenderTypeEnum> {

    @Override
    public void setNonNullParameter(PreparedStatement preparedStatement, int i, GenderTypeEnum genderTypeEnum, JdbcType jdbcType) throws SQLException {
        preparedStatement.setBoolean(i, genderTypeEnum.isMan());
    }

    @Override
    public GenderTypeEnum getNullableResult(ResultSet resultSet, String columnName) throws SQLException {
        return GenderTypeEnum.getGenderTypeEnum(resultSet.getBoolean(columnName));
    }

    @Override
    public GenderTypeEnum getNullableResult(ResultSet resultSet, int columnIndex) throws SQLException {
        return GenderTypeEnum.getGenderTypeEnum(resultSet.getBoolean(columnIndex));
    }

    @Override
    public GenderTypeEnum getNullableResult(CallableStatement callableStatement, int columnIndex) throws SQLException {
        return GenderTypeEnum.getGenderTypeEnum(callableStatement.getBoolean(columnIndex));
    }

}

效果

image.png

### 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]。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值