Partage de technologie

[PostgreSQL] Spring Boot Mybatis-plus PostgreSQL gère les situations de type JSON

2024-07-12

한어Русский языкEnglishFrançaisIndonesianSanskrit日本語DeutschPortuguêsΕλληνικάespañolItalianoSuomalainenLatina

Introduction

Dans le développement d'un projet Springboot, une base de données relationnelle est généralement utilisée comme base de données principale pour stocker les données. Parfois, les scénarios commerciaux nécessitent d'étendre les informations commerciales personnalisées sur la structure de table existante. Dans ce scénario, le stockage de type json est généralement utilisé. Cet article résume la solution pratique pour exploiter json dans le projet Springboot à l'aide de Mybatis-plus.

2. Pile technologique

Spring Boot + Mybatis-plus + PostgreSQL, un certain champ de la base de données PostgreSQL est de type json.

Insérer la description de l'image ici

3. Analyse du contexte

Dans MyBatis, le gestionnaire de types (TypeHandler) joue le rôle de pont entre JavaType et JdbcType. Ils sont utilisés pour définir la valeur d'un objet Java sur un PreparedStatement lors de l'exécution d'une instruction SQL, ou pour récupérer une valeur d'un ResultSet ou d'un CallableStatement.

MyBatis-Plus vous fournit des processeurs de type intégrés, qui peuvent être TableField Les annotations sont rapidement injectées dans le conteneur MyBatis, simplifiant ainsi le processus de développement. Document de référence officiel du processeur de type champ MyBatis-Plus :Processeur de type champ | MyBatis-Plus (baomidou.com)

Gestionnaire de type de champ JSON

MyBatis-Plus dispose d'une variété de processeurs de type JSON intégrés, notamment AbstractJsonTypeHandler et ses sous-catégoriesFastjson2TypeHandlerFastjsonTypeHandlerGsonTypeHandlerJacksonTypeHandler attendez. Ces processeurs peuvent convertir des chaînes JSON vers et depuis des objets Java.

4. Analyse du programme

4.1 Stocker directement les objets json dans la base de données PostgreSQL

Les champs de la base de données PostgreSQL sont présentés dans la figure ci-dessus : param_config est un champ de type json.

Étape 1 : Écriture des entités DO

Le type de données du champ est 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

Étape 2 : méthode d'écriture correspondante à la configuration 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

Affichez les résultats enregistrés dans la base de données, comme indiqué ci-dessous :

Insérer la description de l'image ici

4.2 Stockage des chaînes json dans la base de données PostgreSQL

Ajoutez d'abord après l'URL de la base de données PostgreSQL &stringtype=non spécifié, notez que si cette configuration est directement précédée du nom de la base de données, vous devez & Remplacer par?

Étape 1 : Écriture de la classe d'entité DO

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

Étape 2 : méthode d'écriture correspondante à la configuration XML

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

Affichez les résultats enregistrés dans la base de données, comme indiqué ci-dessous :

Insérer la description de l'image ici

5. Processeur de type personnalisé

Dans MyBatis-Plus, en plus d'utiliser le processeur de type intégré, les développeurs peuvent également personnaliser les processeurs de type selon leurs besoins.

Par exemple, lors de l'utilisation d'une base de données PostgreSQL, vous pouvez rencontrer des champs de type JSON. Dans ce cas, vous pouvez créer un processeur de type personnalisé pour traiter les données JSON.

5.1 Définition des gestionnaires de types

Voici un exemple de processeur de type JSON personnalisé :

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 Utilisation de processeurs de type personnalisé

Dans la classe d'entité, passez TableField Les annotations spécifient des gestionnaires de types personnalisés :

/**
 * 测试对象
 *
 * @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

Modifier le fichier du mappeur

<?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

Code d'entreprise

    /**
     * 新增数据
     */
    @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

Cet article est terminé !