如何基于Hibernate构造DSL属性路径 实现类型安全的HQL查询构建

1. 核心DSLProperty类设计 #

你需要的链式属性调用能力核心逻辑是让每个属性节点持有当前拼接的路径，调用下一级属性时自动拼接路径并返回对应类型的属性实例，基础实现如下：

// 基础属性抽象类
public class DSLProperty<T> {
    // 存储当前拼接完成的属性路径
    private final String path;

    // 根属性构造方法
    public DSLProperty(String propertyName) {
        this.path = propertyName;
    }

    // 子属性拼接构造方法
    protected DSLProperty(String parentPath, String childProperty) {
        this.path = parentPath + "." + childProperty;
    }

    // 对外暴露获取完整路径的方法
    public String getPath() {
        return path;
    }

    // 通用子属性拼接方法，基础类型属性可以直接调用该方法生成
    protected <R> DSLProperty<R> join(String childProperty) {
        return new DSLProperty<R>(this.path, childProperty);
    }
}

2. 实体对应属性子类扩展 #

要支持链式调用，需要为每个实体类生成对应的DSLProperty子类，封装自身所有关联属性的调用方法：

// IdentityCard实体对应的属性子类
public class IdentityCardDSLProperty extends DSLProperty<IdentityCard> {
    public IdentityCardDSLProperty(String parentPath, String childProperty) {
        super(parentPath, childProperty);
    }

    // 基础类型属性直接返回DSLProperty即可
    public DSLProperty<String> lastName() {
        return join("lastName");
    }
}

// Person实体对应的属性子类
public class PersonDSLProperty extends DSLProperty<Person> {
    public PersonDSLProperty(String path) {
        super(path);
    }

    // 关联实体属性返回对应实体的属性子类
    public IdentityCardDSLProperty identityCard() {
        return new IdentityCardDSLProperty(getPath(), "identityCard");
    }
}

之后修改实体类的静态属性定义，返回对应类型的属性子类：

@Entity
public class User {
    public static PersonDSLProperty person() {
        return new PersonDSLProperty("person");
    }
    @OneToOne
    @JoinColumn(name="person_id")
    private Person person;
    // 其余Getter、Setter等逻辑
}

此时你要的User.person().identityCard().lastName()链式调用已经可以正常运行，调用getPath()方法即可得到完整属性路径person.identityCard.lastName。

3. 查询条件拼接逻辑 #

你可以基于上述实现扩展条件构造方法，示例eq方法实现如下：

// 条件封装类，你可以根据需求扩展更多操作符
public record Condition(String express, Object param) {}

public static Condition eq(String alias, DSLProperty<?> property, Object value) {
    String fullExpress = alias + "." + property.getPath() + " = ?";
    return new Condition(fullExpress, value);
}

配合你已有的查询构建器基础逻辑，收集所有Condition对象后即可自动生成无拼写错误的HQL语句，完全匹配你预期的API使用方式。

4. 可选优化方案 #

• 编写注解处理器自动扫描所有实体类，生成对应的DSLProperty子类和静态属性方法，无需手动编写避免人工错误
• 扩展DSLProperty类直接内置like、gt、between等常用操作方法，无需单独定义全局工具方法
• 加入泛型类型校验，编译期即可拦截属性与参数类型不匹配的错误

内容的提问来源于stack exchange，提问作者Pavel Polyakoff