Mybatis映射数据库中存储内容为json的字段到Java类

最新推荐文章于 2024-09-04 17:28:02 发布

原创最新推荐文章于 2024-09-04 17:28:02 发布 · 1.6w 阅读

17 ·

CC 4.0 BY-SA版权

mybatis 专栏收录该内容

3 篇文章

订阅专栏

本文介绍如何在MyBatis中配置JSON字段与Java对象的双向映射，包括配置TypeHandler位置、在mapper.xml中定义序列化和反序列化规则，以及编写JsonTypeHandler实现。

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

POJO里有个属性是非基本数据类型，在DB存储时我们想存的是json格式的字符串，从DB拿出来时想直接映射成目标类型，也即json格式的字符串字段与Java类的相互类型转换。

1 首先在application.properties中配置TypeHandler的位置

mybatis.configuration.type-handlers-package: xxx.typehandler  # xxx为你项目的包名

2 在mapper.xml中配置

实体序列化存入数据库 #{jsonDataField, typeHandler=xxx.JsonTypeHandler}

字段反序列化到实体 <result property="jsonDataField" column="json_data_field" javaType="xxx.xxxclass" typeHandler="xxx.JsonTypeHandler" />

3 编写JsonTypeHandler，内部使用Jackson做Json反序列化

import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;


public class JsonTypeHandler<T extends Object> extends BaseTypeHandler<T> {

    private static final ObjectMapper mapper = new ObjectMapper();
    private Class<T> clazz;

    public JsonTypeHandler(Class<T> clazz) {
        if (clazz == null) {
            throw new IllegalArgumentException("Type argument cannot be null");
        }
        this.clazz = clazz;
    }

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

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

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

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

    private String toJson(T object) {
        try {
            return mapper.writeValueAsString(object);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    private T toObject(String content, Class<?> clazz) {
        if (content != null && !content.isEmpty()) {
            try {
                return (T) mapper.readValue(content, clazz);
            } catch (Exception e) {
                throw new RuntimeException(e);
            }
        } else {
            return null;
        }
    }

}