在Spring Boot + MyBatis-Plus项目中如何使用 PostgreSQL 的 jsonb

在Spring Boot + MyBatis-Plus项目中使用 jsonb 类型的字段，首先需要确保 PostgreSQL 数据库表的相应字段类型为 jsonb。然后，使用 MyBatis-Plus 来操作这些 jsonb 字段。整个过程涉及以下几个步骤：

1. 数据库设计

首先，确保数据库中使用 jsonb 类型存储数据。例如：

CREATE TABLE example (
    id SERIAL PRIMARY KEY,
    data jsonb
);

2. 实体类设计

在实体类中，使用 @TableField 注解标记 JSONB 字段，通常情况下，可以使用 String 或 Object 来表示 JSONB 数据。如果你想操作特定的 JSON 结构，可以使用 Map 或 POJO 类。

使用 String 存储 jsonb 数据

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableName;

@TableName("example")
public class Example {

    private Long id;

    @TableField("data")
    private String data;  // 这里存储jsonb数据，直接作为字符串

    // Getters and Setters
}

使用 Map<String, Object> 存储 jsonb 数据

如果你的 JSON 数据是结构化的，可以使用 Map<String, Object> 来映射：

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableName;
import java.util.Map;

@TableName("example")
public class Example {

    private Long id;

    @TableField("data")
    private Map<String, Object> data;  // 直接映射成Map

    // Getters and Setters
}

使用 POJO 映射复杂的 JSON 结构

如果你的 JSONB 字段包含复杂结构，可以创建对应的 POJO 类来映射：

public class Data {
    private String name;
    private Integer age;

    // Getters and Setters
}

@TableName("example")
public class Example {

    private Long id;

    @TableField("data")
    private Data data;  // 直接映射为Data对象

    // Getters and Setters
}

3. 自定义类型处理器（可选）

如果你希望更方便地进行 JSON 和 Java 对象之间的转换，可以使用 MyBatis 提供的自定义类型处理器。

首先，创建一个自定义的类型处理器类来处理 JSON 和 Java 对象之间的转换。例如，使用 Jackson 或 Gson 库来进行转换。

import com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;

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

public class JsonbTypeHandler extends BaseTypeHandler<Object> {

    private final ObjectMapper objectMapper = new ObjectMapper();

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, Object parameter, JdbcType jdbcType) throws SQLException {
        try {
            ps.setString(i, objectMapper.writeValueAsString(parameter));
        } catch (IOException e) {
            throw new SQLException("Failed to serialize JSON", e);
        }
    }

    @Override
    public Object getNullableResult(ResultSet rs, String columnName) throws SQLException {
        try {
            String json = rs.getString(columnName);
            return objectMapper.readValue(json, Object.class);  // 可以根据需要返回特定类型
        } catch (IOException e) {
            throw new SQLException("Failed to deserialize JSON", e);
        }
    }

    @Override
    public Object getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        try {
            String json = rs.getString(columnIndex);
            return objectMapper.readValue(json, Object.class);  // 可以根据需要返回特定类型
        } catch (IOException e) {
            throw new SQLException("Failed to deserialize JSON", e);
        }
    }

    @Override
    public Object getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        try {
            String json = cs.getString(columnIndex);
            return objectMapper.readValue(json, Object.class);  // 可以根据需要返回特定类型
        } catch (IOException e) {
            throw new SQLException("Failed to deserialize JSON", e);
        }
    }
}

然后，在 MyBatis 配置中注册这个自定义类型处理器。

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new JsonbTypeHandler());
    return interceptor;
}

4. 使用 MyBatis-Plus 进行操作

在 MyBatis-Plus 中进行常规的 CRUD 操作，直接使用实体类操作即可，MyBatis-Plus 会自动处理与 jsonb 字段的交互。

@Service
public class ExampleService {

    @Autowired
    private ExampleMapper exampleMapper;

    public void createExample() {
        Example example = new Example();
        example.setData(new HashMap<String, Object>() {{
            put("name", "John");
            put("age", 30);
        }});

        exampleMapper.insert(example);
    }

    public Example getExample(Long id) {
        return exampleMapper.selectById(id);
    }
}

5. 查询 jsonb 字段的操作

PostgreSQL 提供了一些操作符和函数来操作 jsonb 数据。你可以在 MyBatis-Plus 中使用自定义 SQL 来查询、更新 jsonb 数据。

例如：

-- 查询包含name为"John"的记录
SELECT * FROM example WHERE data @> '{"name": "John"}';

你可以在 MyBatis Mapper 中使用 @Select 注解执行此类查询：

@Mapper
public interface ExampleMapper extends BaseMapper<Example> {

    @Select("SELECT * FROM example WHERE data @> '{\"name\": \"John\"}'")
    List<Example> findByName(@Param("name") String name);
}

6. 创建索引（可选）

为了提高查询性能，特别是当你需要通过 jsonb 字段进行查询时，可以为 jsonb 字段创建索引。可以使用 GIN 索引来加速 jsonb 查询：

CREATE INDEX idx_example_data ON example USING gin (data);

7. 总结

在 Spring Boot + MyBatis-Plus 项目中使用 jsonb 类型时，最常用的方式是将 jsonb 字段映射为 Java 对象（如 Map 或 POJO 类），然后在 MyBatis 中直接进行 CRUD 操作。对于复杂的查询，可以使用自定义 SQL 来访问 jsonb 数据，并根据需要创建索引以优化查询性能。