表达式解析工具 - BeanPath

介绍

在复杂的 JavaBean 中，嵌套的属性层级可能非常深，获取这些嵌套的属性值会使代码变得冗长且不易维护。为了解决这个问题，Hutool 提供了 BeanPath 工具类，它允许通过表达式的方式轻松访问嵌套的属性值。BeanPath 支持对 JavaBean、Map 和集合等结构的解析，使得获取深层次的属性值变得更加简洁和灵活。

使用场景

• 复杂对象属性的获取：在业务开发中，某些复杂对象可能嵌套多层，通过 BeanPath 可以快速获取其中的属性值。
• 灵活处理数据结构：支持对集合、数组、Map 以及 JavaBean 的灵活访问，适用于解析从数据库、JSON、XML 等来源获取的数据。
• 简化代码结构：通过表达式访问属性，避免多层级的 get 操作，提高代码可读性。

表达式语法

BeanPath 支持两种表达式语法：

1. . 表达式：用于访问 JavaBean 对象的属性或 Map 中的值。
2. [] 表达式：用于访问集合、数组中的元素。

示例表达式：

• "person"：获取 person 对象。
• "person.name"：获取 person 对象的 name 属性值。
• "persons[3]"：获取 persons 集合或数组的第 4 个元素（索引从 0 开始）。
• "person.friends[5].name"：获取 person 对象的 friends 列表中第 6 个元素的 name 属性值。

主要方法

1. 创建 BeanPath

BeanPath 的创建需要传入表达式，表示要解析的路径。

示例：创建 BeanPath

import cn.hutool.core.bean.BeanPath;
import java.util.HashMap;
import java.util.Map;

public class BeanPathExample {
    public static void main(String[] args) {
        // 创建表达式路径
        BeanPath resolver = new BeanPath("userInfo.examInfoDict[0].id");
    }
}

关键点：

• new BeanPath(String expression)：通过表达式创建 BeanPath 实例。

作用：初始化一个 BeanPath 实例，用于解析指定路径下的属性值。

2. 获取嵌套属性值

通过 get 方法可以解析并获取指定路径下的属性值。

示例：获取嵌套属性值

import cn.hutool.core.bean.BeanPath;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class BeanPathExample {
    public static void main(String[] args) {
        // 构建复杂对象结构
        Map<String, Object> tempMap = createComplexBean();

        // 创建表达式路径
        BeanPath resolver = new BeanPath("userInfo.examInfoDict[0].id");

        // 获取嵌套属性值
        Object result = resolver.get(tempMap);
        System.out.println("第一门考试的ID: " + result); // 输出：1
    }

    private static Map<String, Object> createComplexBean() {
        // 考试信息
        List<Map<String, Object>> examInfoDicts = new ArrayList<>();
        examInfoDicts.add(createExamInfo(1, 0, 1));
        examInfoDicts.add(createExamInfo(2, 0, 0));
        examInfoDicts.add(createExamInfo(3, 1, 0));

        // 用户信息
        Map<String, Object> userInfoDict = new HashMap<>();
        userInfoDict.put("id", 1);
        userInfoDict.put("photoPath", "yx.mm.com");
        userInfoDict.put("realName", "张三");
        userInfoDict.put("examInfoDict", examInfoDicts);

        // 顶层Map
        Map<String, Object> tempMap = new HashMap<>();
        tempMap.put("userInfo", userInfoDict);
        tempMap.put("flag", 1);

        return tempMap;
    }

    private static Map<String, Object> createExamInfo(int id, int examType, int answerIs) {
        Map<String, Object> examInfo = new HashMap<>();
        examInfo.put("id", id);
        examInfo.put("examType", examType);
        examInfo.put("answerIs", answerIs);
        return examInfo;
    }
}

关键点：

• get(Object bean)：通过表达式获取指定路径下的属性值。

作用：适用于需要从深层次嵌套结构中获取指定数据的场景。

3. 快捷入口方法

Hutool 的 BeanUtil 工具类提供了 getProperty 方法作为 BeanPath 的快捷入口。

示例：使用快捷方法获取属性值

import cn.hutool.core.bean.BeanUtil;

public class BeanUtilExample {
    public static void main(String[] args) {
        Map<String, Object> tempMap = BeanPathExample.createComplexBean();

        // 直接使用 BeanUtil 获取嵌套属性值
        Object result = BeanUtil.getProperty(tempMap, "userInfo.examInfoDict[0].id");
        System.out.println("第一门考试的ID: " + result); // 输出：1
    }
}

关键点：

• BeanUtil.getProperty(Object bean, String expression)：通过表达式获取属性值，简化了 BeanPath 的使用。

作用：提供了更加直观和易用的属性访问方式。

4. 自定义表达式解析

BeanPath 支持自定义表达式规则，可以在复杂场景中实现灵活的数据解析。

示例：自定义解析器（高级用法）

// 高级用法通常用于对复杂业务需求进行定制化解析，涉及自定义 BeanPath 解析逻辑。

总结

BeanPath 工具类通过表达式简化了复杂对象属性的访问过程，使得代码更加简洁、易维护。它适用于：

• 多层嵌套对象的属性访问：避免多重 get 方法调用，直接通过表达式获取属性值。
• 集合和数组的动态索引访问：通过 [] 语法灵活访问集合、数组中的元素。
• Map 和 Bean 的混合解析：支持同时解析 Map 和 JavaBean 结构，适应复杂数据结构的处理。