Hibernate Search 6中如何统一索引映射路径实现跨实体地址搜索？

问题背景 #

我们有多个索引实体，它们以不同方式关联地址实体，但希望使用统一的地址字段映射路径对任意实体进行搜索。在Hibernate Search 5中，可通过@IndexedEmbedded(prefix = ...)定义带圆点的索引映射路径来解决此问题，但Hibernate Search 6不支持路径中使用显式圆点。

当前代码存在路径不一致问题：

• Entity1的line1字段索引映射路径为addresses.address.line1
• Entity2的line1字段索引映射路径为addresses.line1

我们需要统一路径，以便复用底层代码构建的SearchPredicates。

解决方案 #

在Hibernate Search 6中，可通过@IndexedEmbedded的prefix属性构建所需层级路径，HS6会自动为前缀添加点分隔符，无需手动写入圆点。

修改Entity2代码 #

调整getAddresses()方法上的@IndexedEmbedded注解，添加prefix = "address."：

@Entity
@Table(name = "entity2")
@Indexed(index = "ENTITY2")
public class Entity2 {

    private Address physicalAddress;
    
    @Embedded
    @AttributeOverrides({
            @AttributeOverride(name = "line1", column = @Column(name = "physical_addr_line_1")),
            //...other address fields
    })
    public Address getPhysicalAddress() {
        return physicalAddress;
    }

    public void setPhysicalAddress(Address physicalAddress) {
        this.physicalAddress = physicalAddress;
    }

    @Transient
    @IndexingDependency(derivedFrom = @ObjectPath(@PropertyValue(propertyName = "physicalAddress")))
    @IndexedEmbedded(prefix = "address.") // 添加prefix构建addresses.address.*路径
    public Set<Address> getAddresses() {
        Set<Address> addresses = Sets.newLinkedHashSet();
        
        if (hasPhysicalAddress()) {
            addresses.add(physicalAddress);
        }       
        //...add other addresses
        
        return addresses;
    }
}

效果说明 #

修改后，Entity2的line1字段索引映射路径会变为addresses.address.line1，与Entity1的路径完全一致。此时即可复用统一的字段常量构建SearchPredicates：

// 定义统一的字段常量
public static final String LINE1_FIELD = "addresses.address.line1";

// 创建SearchPredicateFactory并复用断言
SearchSession searchSession = Search.session(session);
// 切换为Entity2.class的scope，断言依然有效
SearchPredicateFactory pf = searchSession.scope(Entity1.class).predicate();

var myBool = pf.bool();
myBool.should(
    pf.match()
        .field(LINE1_FIELD)
        .matching("100 main street")
);

其他可选方案 #

如果需要更灵活的字段路径控制，还可以：

• 在Address类的字段上直接指定name属性，比如@FullTextField(name = "address.line1")，但这种方式会固定字段路径，适用于所有使用该Address的场景。
• 使用自定义字段桥（Field Bridge），手动控制字段的索引路径，但这种方式复杂度较高，仅在特殊场景下使用。

内容的提问来源于stack exchange，提问作者Rick Gagne