利用Spring Boot实现MySQL 8.0和MyBatis-Plus的JSON查询

'# 利用Spring Boot实现MySQL 8.0和MyBatis-Plus的JSON查询

一、背景与问题

在现代应用开发中，JSON类型字段已成为存储结构化数据的常见方案。MySQL 8.0对JSON类型的支持提供了丰富的函数，如JSON_EXTRACT、JSON_CONTAINS、JSON_ARRAY等。然而在实际开发中，开发者常遇到以下问题：

1. 如何在Spring Boot中通过MyBatis-Plus框架高效查询JSON字段内容
2. 如何处理复杂的JSON嵌套结构查询
3. 如何在保持数据库索引效率的同时实现灵活查询
4. 如何避免常见的SQL注入风险

传统做法是将JSON数据拆分为多个字段存储，但这种方式会导致数据冗余和维护成本。本文将深入探讨MySQL 8.0 JSON类型与MyBatis-Plus的集成方案，重点分析其工作原理和实际应用场景。

二、基本原理

1. MySQL 8.0 JSON类型特性

MySQL 8.0引入了完整的JSON文档支持，主要包括：

• JSON类型字段存储：CREATE TABLE test (json_data JSON)
• JSON函数支持：JSON_EXTRACT、JSON_CONTAINS、JSON_KEYS等
• JSON索引支持：KEY json_index (json_data)

2. MyBatis-Plus查询机制

MyBatis-Plus通过QueryWrapper构建动态查询条件，其核心机制是：

QueryWrapper<YourEntity> wrapper = new QueryWrapper<>();
wrapper.eq("json_field", "value");

当处理JSON类型字段时，需要特殊处理字段类型和查询表达式。

三、环境准备

1. 依赖配置

在pom.xml中添加必要依赖：

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-j</artifactId>
    <version>8.0.33</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.3</version>
</dependency>

2. 数据库配置

创建测试表结构：

CREATE TABLE json_table (
    id BIGINT PRIMARY KEY AUTO_INCREMENT,
    json_data JSON
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

四、核心实现

1. 基础查询示例

// 查询json_data中包含"key1":"value1"的记录
QueryWrapper<JsonEntity> wrapper = new QueryWrapper<>();
wrapper.eq("JSON_CONTAINS(json_data, '{"key1": "value1"}', '$')", 1);
List<JsonEntity> result = jsonMapper.selectList(wrapper);

关键点：

• 使用JSON_CONTAINS函数进行模糊匹配
• 注意JSON字符串需要转义处理
• 建议对json_data字段创建索引

2. 嵌套JSON查询

// 查询json_data中"key1.key2"字段等于"subValue"的记录
QueryWrapper<JsonEntity> wrapper = new QueryWrapper<>();
wrapper.eq("JSON_EXTRACT(json_data, '$.key1.key2')", "subValue");
List<JsonEntity> result = jsonMapper.selectList(wrapper);

3. 动态查询构建

public List<JsonEntity> queryJsonData(String key, String value) {
    QueryWrapper<JsonEntity> wrapper = new QueryWrapper<>();
    wrapper.eq("JSON_CONTAINS(json_data, '" + key + "', '$')", value);
    return jsonMapper.selectList(wrapper);
}

五、完整案例

1. 项目结构

src
├── main
│   ├── java
│   │   └── com.example
│   │       └── demo
│   │           ├── controller
│   │           ├── service
│   │           └── entity
│   └── resources
│       └── application.yml

2. 实体类定义

@Data
public class JsonEntity {
    private Long id;
    private String jsonData;
}

3. 数据库操作

// 插入JSON数据
JsonEntity entity = new JsonEntity();
entity.setJsonData("{\"key1\": \"value1\", \"key2\": {\"subKey\": \"subValue\"}}");
jsonMapper.insert(entity);

// 查询JSON字段
QueryWrapper<JsonEntity> wrapper = new QueryWrapper<>();
wrapper.eq("JSON_EXTRACT(json_data, '$.key2.subKey')", "subValue");
List<JsonEntity> result = jsonMapper.selectList(wrapper);

4. 完整接口示例

@RestController
@RequestMapping("/json")
public class JsonController {

    @Autowired
    private JsonService jsonService;

    @PostMapping("/query")
    public List<JsonEntity> queryJson(@RequestBody Map<String, String> request) {
        String key = request.get("key");
        String value = request.get("value");
        return jsonService.queryJson(key, value);
    }
}

六、源码解析

1. MyBatis-Plus查询构建机制

MyBatis-Plus通过AbstractWrapper类构建查询条件，其核心逻辑如下：

public abstract class AbstractWrapper implements IQueryWrapper {
    protected String sqlSelect;
    protected String sqlFrom;
    protected String sqlWhere;
    
    public void eq(String column, Object value) {
        // 构建 WHERE 条件
        this.sqlWhere += " AND " + column + " = " + value;
    }
}

2. JSON函数处理

在MyBatis-Plus中，JSON函数需要特殊处理：

// 构建JSON_CONTAINS查询条件
String condition = "JSON_CONTAINS(json_data, '" + key + "', '$')";

七、进阶使用

1. 索引优化

为JSON字段创建索引：

CREATE INDEX idx_json_data ON json_table (json_data);

2. 复杂查询示例

// 查询包含多个键值对的JSON
QueryWrapper<JsonEntity> wrapper = new QueryWrapper<>();
wrapper.and(wrapper
    .eq("JSON_CONTAINS(json_data, '{\"key1\": \"value1\"}', '$')", 1)
    .or()
    .eq("JSON_CONTAINS(json_data, '{\"key2\": \"value2\"}', '$')", 1));

3. 动态查询构建

public List<JsonEntity> dynamicQuery(String key, String value) {
    QueryWrapper<JsonEntity> wrapper = new QueryWrapper<>();
    wrapper.eq("JSON_EXTRACT(json_data, '$." + key + "')", value);
    return jsonMapper.selectList(wrapper);
}

八、性能与工程实践

1. 性能优化

2. 异常处理

try {
    // JSON格式校验
    if (!isValidJson(jsonData)) {
        throw new IllegalArgumentException("Invalid JSON format");
    }
} catch (Exception e) {
    log.error("JSON处理异常", e);
}

3. 安全风险

• SQL注入风险：使用MyBatis-Plus的条件构造器可避免
• JSON格式错误：需要添加校验逻辑
• 索引失效：避免在WHERE条件中使用函数操作

九、常见问题与踩坑

1. 常见错误

2. 常见坑点

• JSON路径格式错误：$.key1.key2需要转义
• 索引失效：避免在WHERE条件中使用函数
• 数据更新问题：更新JSON字段需要使用JSON_SET函数
• 大字段处理：避免一次性加载整个JSON文档

十、最佳实践

1. 推荐方案

1. 对复杂结构数据使用JSON类型字段
2. 对JSON字段创建适当索引
3. 使用MyBatis-Plus的条件构造器构建查询
4. 对输入数据进行JSON格式校验
5. 对关键查询添加缓存机制

2. 使用建议

应该使用：

• 需要灵活查询的结构化数据
• 数据结构经常变更的场景
• 需要快速查询的JSON嵌套字段

不应该使用：

• 需要频繁更新JSON字段的场景
• 需要全文检索的文本数据
• 未进行索引优化的复杂查询

十一、总结

MySQL 8.0的JSON类型功能与MyBatis-Plus的结合，为现代应用开发提供了灵活的数据存储方案。通过合理使用JSON函数和MyBatis-Plus的查询构造器，可以在保持数据库索引效率的同时实现复杂的查询需求。实际开发中需要注意JSON路径格式、索引优化和安全校验等关键点。对于结构复杂且需要灵活查询的数据，这种方案能显著提升开发效率。但需注意在频繁更新或全文检索场景下，可能需要考虑其他存储方案。通过合理的设计和优化，JSON类型字段可以成为现代应用开发中非常有用的工具。