Mybatis存取json字段步骤 - 继承BaseTypeHandler

概要

BaseTypeHandler是MyBatis框架中的一个抽象类，用于处理数据库类型和Java类型之间的转换。通过继承BaseTypeHandler类，可以自定义类型处理器来处理不支持的或非标准的类型。
以下是BaseTypeHandler的一些常用方法和示例代码：

1. getNullableResult(ResultSet rs, String columnName)：从ResultSet中获取指定列名的值，并将其转换为Java类型。

public class JsonTypeHandler extends BaseTypeHandler<Object> {
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, Object parameter, JdbcType jdbcType) throws SQLException {
    	// 将Object 类型的参数设置到PreparedStatement中的指定位置
        ps.setObject(i, parameter);
    }
}

2. setNonNullParameter(PreparedStatement ps, int i, CustomType parameter, JdbcType jdbcType)：将Java类型的参数设置到PreparedStatement中的指定位置。

public class JsonTypeHandler extends BaseTypeHandler<Object> {
    @Override
    public Object getNullableResult(ResultSet rs, String columnName) throws SQLException {
    	// 从ResultSet中获取指定列名的值，并将其转换为Object 类型
        return rs.getObject(columnName);
    }
}

简单介绍数据库存储 json与jsonb 情况下自定义类型处理器的实现和问题分享。

方法步骤

自定义类型处理器

通过继承BaseTypeHandler类，自定义类型处理器来处理不支持的或非标准的类型。

//json格式类型
@MappedTypes({Object.class})
@MappedJdbcTypes({JdbcType.OTHER})
public class JsonTypeHandler extends BaseTypeHandler<Object> {
    static {
        SerializeConfig.getGlobalInstance().propertyNamingStrategy = PropertyNamingStrategy.SnakeCase;
    }

    private static final PGobject jsonObject = new PGobject();

    private static final ObjectMapper objectMapper = new ObjectMapper();

    @SneakyThrows
    @Override
    public void setNonNullParameter(PreparedStatement preparedStatement, int i, Object strings, JdbcType jdbcType) throws SQLException {
        if (Objects.nonNull(strings)) {
            jsonObject.setType("json");
            //日期格式化
            objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
            //驼峰转下划线
            objectMapper.setPropertyNamingStrategy(com.fasterxml.jackson.databind.PropertyNamingStrategy.SNAKE_CASE);
            jsonObject.setValue(objectMapper.writeValueAsString(strings));
            preparedStatement.setObject(i, jsonObject);
        }
    }

    @Override
    public Object getNullableResult(ResultSet resultSet, String s) throws SQLException {
        if (null != resultSet.getString(s)) {
            return JSON.parseObject(resultSet.getString(s));
        }
        return null;
    }

    @Override
    public Object getNullableResult(ResultSet resultSet, int i) throws SQLException {
        if (null != resultSet.getString(i)) {
            return JSON.parseObject(resultSet.getString(i));
        }
        return null;
    }

    @Override
    public Object getNullableResult(CallableStatement callableStatement, int i) throws SQLException {
        if (null != callableStatement.getString(i)) {
            return JSON.parseObject(callableStatement.getString(i));
        }
        return null;
    }
}

备注：项目中使用到的pgsql 数据库，使用到了 PGobject 。PGobject是PostgreSQL JDBC驱动程序中的一个类，用于处理PostgreSQL数据库中的自定义数据类型。依赖：

<dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <version>版本号</version>
</dependency>

入库操作

mybatis : 在字段上添加注解 @ColumnType 指定自定义 typeHandler

@Table(name = "test_table")
public class Demo {
    @ColumnType(typeHandler = JsonTypeHandler.class)
    private Object car;
}

mybatis-plus：在字段上添加注解 @TableField 指定自定义 typeHandler ，并将autoResultMap设置成true

@Data
@TableName(value = "test_table", autoResultMap = true)
public class DemoDTO {

    @TableField(typeHandler = JsonTypeHandler.class)
    private Object description;
}

xml文件：手写的sql语句，需在指定字段除设置 typeHandler
如：

    <insert id="insertTest">
        INSERT INTO dictionary_type ( car ) VALUES
        ( #{car,jdbcType=OTHER,typeHandler=com.project.common.config.JsonTypeHandler} )
    </insert>

查询操作

xml文件：

    <resultMap id="BaseResultMap" type="com.unisinsight.project.model.Demo">
        <result column="car" jdbcType="OTHER" property="car" typeHandler="com.project.common.config.JsonbTypeHandler"/>
    </resultMap>

小结

通过继承BaseTypeHandler类，自定义类型处理器简化了必要的格式转换操作，优雅存取json与jsonb字段。
j