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

程序员文章站 2022-04-23 16:53:32

...

主要说明对于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

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