0

0

如何在 Java 中动态生成 JsonPath 表达式(无需硬编码)

聖光之護

聖光之護

发布时间:2026-01-07 14:53:29

|

620人浏览过

|

来源于php中文网

原创

如何在 Java 中动态生成 JsonPath 表达式(无需硬编码)

本文介绍如何根据运行时用户筛选条件(如国家代码、房间数等)动态构建合法、安全的 jsonpath 表达式,避免字符串拼接风险,提升可维护性与灵活性。

在实际企业级 JSON 数据处理场景中,前端常需向后端传递动态筛选条件(例如:国家代码为 "IN" 或 "ENG",且公寓房间数为 1 或 2),而后端需据此生成对应的 JsonPath 表达式对原始 JSON 进行过滤。若直接使用字符串拼接(如 "$.countries[?(@.country.countryCode=='IN')].building[?(@.floor[?(@.apartment[?(@.rooms==1)])])]")不仅易出错、难维护,还存在注入与语法错误风险。

推荐采用 语义化构建 + 第三方库辅助 的方式实现动态 JsonPath 生成。以下以主流库 Jayway JsonPath 为例(Maven 依赖:com.jayway.jsonpath:json-path:2.9.0),展示专业、可扩展的实现方案:

✅ 正确做法:基于 Criteria 构建可组合过滤器

Jayway JsonPath 提供了 Filter 和 Criteria API,支持链式构建逻辑表达式,避免手写复杂字符串:

Beautiful.ai
Beautiful.ai

AI在线创建幻灯片

下载
import com.jayway.jsonpath.Configuration;
import com.jayway.jsonpath.DocumentContext;
import com.jayway.jsonpath.Filter;
import com.jayway.jsonpath.Criteria;
import com.jayway.jsonpath.JsonPath;
import com.jayway.jsonpath.Option;

import java.util.Arrays;
import java.util.List;

public class DynamicJsonPathGenerator {

    /**
     * 动态生成 JsonPath 过滤表达式
     * @param countryCodes 允许的国家代码列表(如 ["IN", "ENG"])
     * @param roomNumbers  允许的房间数列表(如 [1, 2])
     * @return 完整的 JsonPath 字符串(兼容 $.countries[*].country.* 结构)
     */
    public static String generateJsonPath(List countryCodes, List roomNumbers) {
        // Step 1: 构建国家码匹配条件(嵌套在 countries[*].country 下)
        Criteria countryCriteria = Criteria.where("country.countryCode").in(countryCodes.toArray());

        // Step 2: 构建房间数匹配条件(深层嵌套:building[*].floor[*].apartment[*].rooms)
        // 注意:JsonPath 中需用 '..' 或显式路径;此处按原始结构展开
        String roomCondition = String.format(
            "building[*].floor[*].apartment[*].rooms in %s",
            roomNumbers.toString().replace("[", "[").replace("]", "]")
        );

        // Step 3: 组合为完整 Filter(注意:Jayway 的 Filter 不直接支持多层嵌套 in,建议分步或改用 Predicate)
        // 更健壮方式:使用 DocumentContext 配合自定义 Predicate(见下方进阶示例)
        return "$.countries[?(@." + countryCriteria.toString() + ")]"
                + ".[" + roomCondition + "]";
    }

    // ✅ 推荐进阶方案:使用 Predicate 实现类型安全、可调试的动态过滤
    public static  List filterJsonByDynamicCriteria(String json, List countryCodes, List roomNumbers) {
        Configuration config = Configuration.defaultConfiguration();
        DocumentContext ctx = JsonPath.parse(json, config);

        // 自定义 Predicate —— 完全可控、可单元测试、无字符串注入风险
        Predicate predicate = item -> {
            if (!(item instanceof Map)) return false;
            Map countryMap = (Map) item;
            Object countryCodeObj = getNestedValue(countryMap, "country", "countryCode");
            if (countryCodeObj == null || !countryCodes.contains(countryCodeObj.toString())) {
                return false;
            }

            Object buildingsObj = getNestedValue(countryMap, "country", "building");
            if (!(buildingsObj instanceof List)) return false;

            for (Object building : (List) buildingsObj) {
                if (!(building instanceof Map)) continue;
                Object floorsObj = getNestedValue((Map) building, "floor");
                if (!(floorsObj instanceof List)) continue;

                for (Object floor : (List) floorsObj) {
                    if (!(floor instanceof Map)) continue;
                    Object apartmentsObj = getNestedValue((Map) floor, "apartment");
                    if (!(apartmentsObj instanceof List)) continue;

                    for (Object apt : (List) apartmentsObj) {
                        if (!(apt instanceof Map)) continue;
                        Object roomsObj = getNestedValue((Map) apt, "rooms");
                        if (roomsObj instanceof Number && roomNumbers.contains(((Number) roomsObj).intValue())) {
                            return true; // 找到匹配项
                        }
                    }
                }
            }
            return false;
        };

        return ctx.parseJson()
                .read("$.countries[?]", List.class)
                .stream()
                .filter(predicate)
                .map(Object::toString)
                .map(s -> (T) s)
                .toList();
    }

    // 辅助方法:安全获取嵌套 Map 值
    private static Object getNestedValue(Map map, String... keys) {
        Object result = map;
        for (String key : keys) {
            if (result instanceof Map && ((Map) result).containsKey(key)) {
                result = ((Map) result).get(key);
            } else {
                return null;
            }
        }
        return result;
    }
}

⚠️ 注意事项与最佳实践

  • 避免纯字符串拼接:"$.countries[" + index + "]" 类方式极易引发越界或语法错误,且无法校验 JSON 结构合法性;
  • 优先使用 Predicate + DocumentContext.read():比生成 JsonPath 字符串更灵活、更易调试,尤其适合复杂嵌套与运行时逻辑;
  • 输入校验不可少:对 countryCodes、roomNumbers 等参数做空值、非法字符(如 ', ], *)过滤,防止恶意构造;
  • 性能考量:若数据量极大,建议预编译 JsonPath(JsonPath.compile(path))并复用;
  • 替代方案参考:对简单场景,也可结合 Jackson 的 JsonNode 遍历 + 条件判断,语义更清晰。

✅ 总结

动态生成 JsonPath 的本质不是“拼字符串”,而是将业务筛选逻辑映射为可执行的、类型安全的过滤策略。借助 Jayway JsonPath 的 Predicate 或 Jackson 的树模型遍历,不仅能彻底规避硬编码,还能保障健壮性、可测性与长期可维护性。在微服务与低代码平台中,此类能力是构建动态 API 查询能力的关键基础设施。

立即学习Java免费学习笔记(深入)”;

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

827

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

732

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

733

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

396

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

398

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16925

2023.08.03

java学习网站推荐汇总
java学习网站推荐汇总

本专题整合了java学习网站相关内容,阅读专题下面的文章了解更多详细内容。

3

2026.01.08

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.3万人学习

C# 教程
C# 教程

共94课时 | 6.2万人学习

Java 教程
Java 教程

共578课时 | 43.4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号