[PostgreSQL] Spring boot Mybatis-plus PostgreSQL lida com situações do tipo json

2024-07-12

Spring boot + Mybatis-plus + PostgreSQL lida com situações do tipo json

I. Introdução
2. Pilha de tecnologia
3. Análise de antecedentes
4. Análise do programa
- 4.1 Armazene diretamente objetos JSON no banco de dados PostgreSQL
- 4.2 Armazenando strings json no banco de dados PostgreSQL
5. Processador de tipo personalizado
- 5.1 Definindo manipuladores de tipo
- 5.2 Usando processadores de tipo personalizado

I. Introdução

No desenvolvimento do projeto Springboot, um banco de dados relacional é geralmente usado como banco de dados principal para armazenar dados. Às vezes, os cenários de negócios exigem a extensão de informações de negócios personalizadas na estrutura da tabela existente. Nesse cenário, geralmente é usado o armazenamento do tipo json. Este artigo resume a solução prática para operar json no projeto Springboot com a ajuda do Mybatis-plus.

2. Pilha de tecnologia

Spring boot + Mybatis-plus + PostgreSQL, um determinado campo no banco de dados PostgreSQL é do tipo json.

Insira a descrição da imagem aqui

3. Análise de antecedentes

No MyBatis, o manipulador de tipos (TypeHandler) desempenha o papel de uma ponte entre JavaType e JdbcType. Eles são usados para definir o valor de um objeto Java como PreparedStatement ao executar uma instrução SQL ou para recuperar um valor de ResultSet ou CallableStatement.

MyBatis-Plus fornece alguns processadores do tipo integrado, que podem ser TableField As anotações são injetadas rapidamente no contêiner MyBatis, simplificando o processo de desenvolvimento. Documento de referência oficial do processador de tipo de campo MyBatis-Plus:Processador de tipo de campo | MyBatis-Plus (baomidou.com)

Manipulador de tipo de campo JSON

MyBatis-Plus possui uma variedade de processadores do tipo JSON integrados, incluindo AbstractJsonTypeHandler e suas subcategoriasFastjson2TypeHandler、FastjsonTypeHandler、GsonTypeHandler、JacksonTypeHandler espere. Esses processadores podem converter strings JSON de e para objetos Java.

4. Análise do programa

4.1 Armazene diretamente objetos JSON no banco de dados PostgreSQL

Os campos do banco de dados PostgreSQL são mostrados na figura acima: param_config é um campo do tipo json.

Passo 1: Escrevendo entidades DO

O tipo de dados do campo é com.alibaba.fastjson2.JSONObject 。

@Data
@Accessors(chain = true)
@TableName(autoResultMap = true)
public class User {
    
    private Long id;

    ...

    /**
   	 * 关键代码！！！
     * 必须开启映射注解
     *
     * @TableName(autoResultMap = true)
     *
     * 选择对应的 JSON 处理器，并确保存在对应的 JSON 解析依赖包
     */
    @TableField(value = "param_config", typeHandler = JacksonTypeHandler.class)
    // 或者使用 FastjsonTypeHandler
    // @TableField(typeHandler = FastjsonTypeHandler.class)
    private JSONObject paramConfig;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

Etapa 2: método de escrita correspondente à configuração XML

<!-- 关键代码！！！！！！！ -->
<!-- 单个字段的类型处理器配置 -->
<result column="param_config" jdbcType="VARCHAR" property="paramConfig" typeHandler="com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler" />

<!-- 多个字段中某个字段的类型处理器配置 -->
<resultMap id="departmentResultMap" type="com.baomidou...DepartmentVO">
    <result property="director" column="director" typeHandler="com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler" />
</resultMap>
<select id="selectPageVO" resultMap="departmentResultMap">
   select id,name,director from department ...
</select>
1
2
3
4
5
6
7
8
9
10
11

Visualize os resultados salvos no banco de dados, conforme mostrado abaixo:

Insira a descrição da imagem aqui

4.2 Armazenando strings json no banco de dados PostgreSQL

Primeiro adicione após o URL do banco de dados PostgreSQL &stringtype=não especificado, observe que se esta configuração for precedida diretamente pelo nome do banco de dados, você precisará & Substituir com? 。

Etapa 1: escrever a classe de entidade DO

@TableField(value = "param_config", typeHandler = JacksonTypeHandler.class)
private String paramConfig;
1
2

Etapa 2: método de escrita correspondente à configuração XML

<!-- 单个字段的类型处理器配置 -->
<result column="param_config" jdbcType="VARCHAR" property="paramConfig" typeHandler="com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler" />
1
2

Visualize os resultados salvos no banco de dados, conforme mostrado abaixo:

Insira a descrição da imagem aqui

5. Processador de tipo personalizado

No MyBatis-Plus, além de usar o processador de tipo integrado, os desenvolvedores também podem personalizar os processadores de tipo conforme necessário.

Por exemplo, ao usar um banco de dados PostgreSQL, você pode encontrar campos do tipo JSON. Nesse caso, você pode criar um processador de tipo personalizado para processar dados JSON.

5.1 Definindo manipuladores de tipo

A seguir está um exemplo de processador do tipo JSON personalizado:

package com.ruoyi.common.utils.pg;

import com.ruoyi.common.utils.StringUtils;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.MappedTypes;
import org.postgresql.util.PGobject;

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

/**
 * @ClassName: JsonTypeHandlerPg
 * @Description: json对象处理
 * @Author: hjm
 * @Date: 2024-07-11 10:34
 */
@MappedTypes(String.class)
public class JsonTypeHandlerPg extends BaseTypeHandler<String> {

    /**
     * 引入PGSQL提供的工具类PGobject
     */
    private static final PGobject JSON_OBJECT = new PGobject();
    public static final String JSON_TYPE = "json";

    /**
     * 关键位置!!!
     */
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, String param, JdbcType jdbcType) throws SQLException {
        JSON_OBJECT.setType(JSON_TYPE);
        JSON_OBJECT.setValue(param);
        ps.setObject(i, JSON_OBJECT);
    }

    @Override
    public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
        String sqlJson = rs.getString(columnName);
        if (StringUtils.isNotBlank(sqlJson)) {
            return sqlJson;
        }
        return null;
    }

    // 根据列索引，获取可以为空的结果
    @Override
    public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        String sqlJson = rs.getString(columnIndex);
        if (StringUtils.isNotBlank(sqlJson)) {
            return sqlJson;
        }
        return null;
    }

    @Override
    public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        String sqlJson = cs.getString(columnIndex);
        if (StringUtils.isNotBlank(sqlJson)) {
            return sqlJson;
        }
        return null;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

5.2 Usando processadores de tipo personalizado

Na classe de entidade, passe TableField As anotações especificam manipuladores de tipo personalizados:

/**
 * 测试对象
 *
 * @author hjm
 * @date 2024-07-11
 */
@Data
@EqualsAndHashCode(callSuper = true)
@TableName("data_test")
public class DataTest extends BaseEntity {

    private static final long serialVersionUID = 1L;

    /**
     * 主键
     */
    @TableId(value = "id")
    private Long id;
    
    /**
     * 关键位置!!!
     */
    @TableField(typeHandler = JsonTypeHandlerPg.class)
    private String jsonData;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

Modificar arquivo mapeador

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
    PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.ruoyi.dt.mapper.DataTestMapper">

    <resultMap type="com.ruoyi.dt.domain.DataTest" id="DataTestResult">
        <result property="id" column="id"/>
		<!-- 关键位置!!! -->
        <result property="jsonData" column="json_data" typeHandler="com.ruoyi.common.utils.pg.JsonTypeHandlerPg"/>
        <result property="createBy" column="create_by"/>
        <result property="createTime" column="create_time"/>
        <result property="updateBy" column="update_by"/>
        <result property="updateTime" column="update_time"/>
    </resultMap>

</mapper>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Código comercial

    /**
     * 新增数据
     */
    @Override
    public Boolean insertByAo(DataTestAo ao) {
        DataTest add = BeanUtil.toBean(ao, DataTest.class);
        // 关键位置!!!
		add.setJsonData(JSONUtil.toJsonStr(ao));
        validEntityBeforeSave(add);
        boolean flag = baseMapper.insert(add) > 0;
        if (flag) {
            ao.setId(add.getId());
        }
        return flag;
    }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Este artigo está concluído!

Compartilhamento de tecnologia