需求

有的对象字段需要存储为Json，可以直接转成Json赋值后再保存。也可以通过Mybatis的TypeHandler自动处理。

实现方案

1. 先定义一个抽象的JsonTypeHandler

public abstract class AbstractJsonTypeHandler extends BaseTypeHandler<Object> {
    
    protected Class<?> classType;

    public AbstractJsonTypeHandler(Class<?> classType) {
        this.classType = classType;
    }

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

    @Override
    public Object getNullableResult(ResultSet rs, String columnName) throws SQLException {
        final String json = rs.getString(columnName);
        return StringUtils.isBlank(json) ? null : parse(json);
    }

    @Override
    public Object getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        final String json = rs.getString(columnIndex);
        return StringUtils.isBlank(json) ? null : parse(json);
    }

    @Override
    public Object getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        final String json = cs.getString(columnIndex);
        return StringUtils.isBlank(json) ? null : parse(json);
    }

    protected abstract Object parse(String json);

    protected abstract String toJson(Object obj);
}

2. JacksonTypeHandler
   简单的JacksonTypeHandler，支持数组，以为泛型擦除，对List，Set等集合反序列会丢失类型，导致数据被反序列化为Map。

@Slf4j
public class JacksonTypeHandler extends AbstractJsonTypeHandler {

    private static final ObjectMapper MAPPER = new ObjectMapper();

    static {
        // 未知字段忽略
        MAPPER.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        // 不使用科学计数
        MAPPER.configure(JsonGenerator.Feature.WRITE_BIGDECIMAL_AS_PLAIN, true);
        // null 值不输出(节省内存)
        MAPPER.setDefaultPropertyInclusion(JsonInclude.Include.NON_NULL);
    }

    public JacksonTypeHandler(Class<?> classType) {
        super(classType);
    }

    @Override
    protected Object parse(String jsonStr) {
        if (StringUtils.isBlank(jsonStr)) {
            return null;
        }
        try {
            return MAPPER.readValue(jsonStr, classType);
        } catch (JsonProcessingException e) {
            log.error("parse failed, jsonStr={}", jsonStr, e);
            return null;
        }
    }

    @Override
    protected String toJson(Object obj) {
        if (Objects.isNull(obj)) {
            return null;
        }
        try {
            return MAPPER.writeValueAsString(obj);
        } catch (JsonProcessingException e) {
            throw new RuntimeException("Object to json string failed!" + obj, e);
        }
    }
}

3. GenericJacksonTypeHandler
   生成json是保存类信息，这样反序列化的时候能正常序列化，包括List和Set，缺点是生成的Json包含类信息，另外生成后类和包都不能修改。

public class GenericJacksonTypeHandler extends AbstractJsonTypeHandler {

    private static final ObjectMapper MAPPER = new ObjectMapper();

    static {
        // 未知字段忽略
        MAPPER.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        // 不使用科学计数
        MAPPER.configure(JsonGenerator.Feature.WRITE_BIGDECIMAL_AS_PLAIN, true);
        // null 值不输出(节省内存)
        MAPPER.setDefaultPropertyInclusion(JsonInclude.Include.NON_NULL);
        // 配置输出 反序列化类名的形式
        MAPPER.activateDefaultTyping(
                LaissezFaireSubTypeValidator.instance,
                ObjectMapper.DefaultTyping.NON_FINAL,
                JsonTypeInfo.As.PROPERTY
        );
    }

    public GenericJacksonTypeHandler(Class<?> classType) {
        super(classType);
    }

    @Override
    protected Object parse(String jsonStr) {
        if (StringUtils.isBlank(jsonStr)) {
            return null;
        }
        try {
            return MAPPER.readValue(jsonStr, classType);
        } catch (JsonProcessingException e) {
            log.error("parse failed, jsonStr={}", jsonStr, e);
            return null;
        }
    }

    @Override
    protected String toJson(Object obj) {
        if (Objects.isNull(obj)) {
            return null;
        }
        try {
            return MAPPER.writeValueAsString(obj);
        } catch (JsonProcessingException e) {
            throw new RuntimeException("Object to json string failed!" + obj, e);
        }
    }
}

生成的json如下：

[
  "[Lcom.example.tkmybatisdemo.entity.UserInfo;",
  [
    {
      "@class": "com.example.tkmybatisdemo.entity.UserInfo",
      "info1": "1111",
      "info2": [
        "java.util.ArrayList",
        [
          {
            "@class": "com.example.tkmybatisdemo.entity.UserInfo2",
            "info21": "2222",
            "info22": "33333"
          }
        ]
      ]
    }
  ]
]

Mybatis TypeHandler 泛型支持的问题

这个限制mybatis开发者在写一个 patch，希望以后能支持泛型，毕竟Array操作上有点不方便。

使用说明

如果使用tk或者mybatis-plus可以通过注解来实现。

@Data
//tk 标识表名
@Table(name = "user")
//mybatis-plus如果属性里指定了TypeHandler，需要开启autoResultMap=true，才会正常处理
@TableName(autoResultMap = true)
public class User {

    //tk指定id列
    @Id
    private Long id;

    private String name;

    private Integer age;

    //tk默认会忽略Enum类型属性
    //3.5以上可以配置mapper.enum-as-simple-type=true 启用
    //4.0以上可以通过配置@Column或者@ColumnType就不会忽略了
    @Column
    private GenderEnum gender;

    private String mobile;
    
    //tk指定typehandler
    @ColumnType(typeHandler = JacksonTypeHandler.class)
    //mybatis-plus指定typehandler
    @TableField(typeHandler = JacksonTypeHandler.class)
    private UserInfo[] infos;

    private Date createTime;

    private Date updateTime;

}

定义Mapper

tk或者mybatis-plus，在对象上声明的typeHandler使用内置的函数都是生效的。但是对Mapper中自定义的函数无效，需要配置@Result指定typeHandler。

• TK通用mapper

@Repository
public interface UserMapper extends Mapper<User> {

    @Results(value = {
            @Result(column = "infos", property = "infos", typeHandler = JacksonTypeHandler.class)
    })
    @Select("select * from user")
    List<User> listAll();
}

• Mybatis-Plus

@Repository
public interface User2Mapper extends BaseMapper<User> {

    @Results(value = {
            @Result(column = "infos", property = "infos", typeHandler = JacksonTypeHandler.class)
    })
    @Select("select * from user")
    List<User> listAll();
}