【Java基础】自定义类型处理器xxxTypeHandler

1. 背景

在处理复杂的数据类型时，我们一般需要提供一种灵活的映射机制，以适应数据库字段和Java实体类之间的差异。

例：

dim_bu_info_private_i表中有一个json类型的字段extend_info

create table dim_bu_info_private_i
(
    id                          bigint      not null,
    name                        varchar(128),
    power_exchange_bu_id        varchar(128),
    standard_name               varchar(128),
    tenant_id                   varchar(32) not null,
    dim_power_exchange_f_id     bigint,
    extend_info                 json,
    is_activated                smallint,
    is_deleted                  smallint,
    create_time                 timestamp,
    update_time                 timestamp,
    primary key (id, tenant_id)
)

与此对应的实体类中有一个JSONArray类型的字段extendInfo

/**
 * 扩展信息json
 */
private JSONArray extendInfo;

因为 extendInfo 字段的数据类型是 JSONArray，而数据库表对应的字段extend_info并不直接支持 JSON数组 类型，那么我们需要自己定义类型转换逻辑，用于将 JSONArray 转换成数据库支持的格式，或者在从数据库中读取时将其转换回 JSONArray。

2. 自定义JSONArrayTypeHandler

@MappedTypes(JSONArray.class)
public class JSONArrayTypeHandler extends BaseTypeHandler<JSONArray> {

    @Override
    public void setNonNullParameter(PreparedStatement preparedStatement, int i, JSONArray jsonArray, JdbcType jdbcType) throws SQLException {
        preparedStatement.setString(i, jsonArray.toString());
    }

    @Override
    public JSONArray getNullableResult(ResultSet resultSet, String columnName) throws SQLException {
        String jsonString = resultSet.getString(columnName);
        return parseJSONArray(jsonString);
    }

    @Override
    public JSONArray getNullableResult(ResultSet resultSet, int columnIndex) throws SQLException {
        String jsonString = resultSet.getString(columnIndex);
        return parseJSONArray(jsonString);
    }

    @Override
    public JSONArray getNullableResult(CallableStatement callableStatement, int columnIndex) throws SQLException {
        String jsonString = callableStatement.getString(columnIndex);
        return parseJSONArray(jsonString);
    }

    private JSONArray parseJSONArray(String jsonString) {
        if (jsonString == null) {
            return null;
        }
        return JSONUtil.parseArray(jsonString);
    }
}

3. 定义配置类注册自定义类型处理类到MyBatis 的 TypeHandlerRegistry

@Configuration
public class MybatisPlusTypeHandlerConfig {

    @Autowired
    private SqlSessionFactory sqlSessionFactory;

    @PostConstruct
    public void registerTypeHandler() {
        TypeHandlerRegistry typeHandlerRegistry = sqlSessionFactory.getConfiguration().getTypeHandlerRegistry();
        typeHandlerRegistry.register(JSONArrayTypeHandler.class);
    }
}

4. 实体类属性上加对应注解

/**
 * 扩展信息json
 */
@TableField(typeHandler = JSONArrayTypeHandler.class)
private JSONArray extendInfo;