CypherDSL查询Neo4j节点时@Relationship属性缺失问题排查

实体类定义 #

@Node
@Builder
@Data
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode(exclude = {"children", "visibleEntities"})
@ToString(exclude = {"children", "visibleEntities"})
public class VisibilityGroup {

    public static final String CAN_SEE_REL_TYPE ="CAN_SEE";
    public static final String CONTAINS_REL_TYPE ="CONTAINS";

    public static final String ENTITY_ID_PROPERTY= "entityId";


    @DynamicLabels
    @Singular(ignoreNullCollections = true)
    private List<String> labels;

    @Property("name")
    private String nodeName;

    @Property(ENTITY_ID_PROPERTY)
    private UUID entityId;

    @Id
    @GeneratedValue(generatorClass = UUIDStringGenerator.class)
    private String id;

    @Relationship(type = CONTAINS_REL_TYPE, direction = Relationship.Direction.OUTGOING)
    @Builder.Default
    private Set<VisibilityGroupRelationship> children = new HashSet<>();

    @Relationship(type = CAN_SEE_REL_TYPE, direction = Relationship.Direction.OUTGOING)
    @Builder.Default
    private Set<VisibilityGroupRelationship> visibleEntities = new HashSet<>();

    // 省略其他代码
}

问题现象 #

• 使用ReactiveCrudRepository.findById(ID id)查询时，children和visibleEntities属性能正常初始化，包含对应的关联关系数据
• 使用CypherDSL的ReactiveCypherdslStatementExecutor.findOne()查询时，这两个属性始终为null

相关Repository代码 #

default Mono<VisibilityGroup> findEntity(UUID originEntityId, String originType,
                                         UUID targetEntityId, String targetType,
                                         boolean useContains){

        Node targetNode = Cypher.node(targetType)
            .named("target")
            .withProperties(VisibilityGroup.ENTITY_ID_PROPERTY,
                Cypher.literalOf(targetEntityId.toString()));
        Node originNode = Cypher.node(originType)
            .named("origin")
            .withProperties(VisibilityGroup.ENTITY_ID_PROPERTY,
                Cypher.literalOf(originEntityId.toString()));
        Relationship relationship = useContains ?
            originNode.relationshipTo(targetNode, VisibilityGroup.CAN_SEE_REL_TYPE,
                VisibilityGroup.CONTAINS_REL_TYPE).unbounded() :
            originNode.relationshipTo(targetNode, VisibilityGroup.CAN_SEE_REL_TYPE).unbounded();
        SymbolicName permissionVariable = Cypher.name("p");
        ResultStatement statement = Cypher.match(relationship)
            .where(/* 省略条件判断 */)
            .returningDistinct(targetNode).build();
        return findOne(statement);
    }

临时解决方案 #

通过先查询节点再调用findById补全关联属性：

return findOne(statement).flatMap(visibilityGroup -> findById(visibilityGroup.getId()));

疑问与补充说明 #

当前Repository方法的逻辑是判断源节点是否能查看目标节点（管理员通过CONTAINS关系，普通用户通过CAN_SEE关系），这部分逻辑已正常工作。但需要返回的目标节点包含其直接邻居：

1. 通过CAN_SEE关系直接关联的节点，映射到visibleEntities属性
2. 通过CONTAINS关系直接关联的节点，映射到children属性

想确认这是CypherDSL的正常特性，还是自己的用法有误？

原因分析与正确做法 #

这是CypherDSL的正常设计特性，并非误用：

• Spring Data Neo4j（SDN）的默认findById方法会自动根据实体类的@Relationship注解，触发额外查询加载关联关系，属于SDN的自动关联加载机制
• 而CypherDSL的查询完全遵循你编写的Cypher语句逻辑，只会返回你明确指定的内容。当前语句只返回targetNode，没有包含它OUTGOING方向的CAN_SEE和CONTAINS关系，SDN没有足够数据映射children和visibleEntities属性，因此为null

要解决问题，需修改Cypher语句，明确返回目标节点及其对应的关联关系。示例修改如下：

// 构造目标节点的OUTGOING关系
Relationship containsRel = targetNode.relationshipOut(VisibilityGroup.CONTAINS_REL_TYPE).named("contains");
Relationship canSeeRel = targetNode.relationshipOut(VisibilityGroup.CAN_SEE_REL_TYPE).named("canSee");

ResultStatement statement = Cypher.match(relationship)
    .match(containsRel)
    .match(canSeeRel)
    .where(/* 省略条件判断 */)
    .returningDistinct(targetNode, containsRel, canSeeRel).build();

也可使用CypherDSL的fetch语法关联加载关系，确保返回数据包含映射@Relationship属性所需的关系信息，SDN就能正确将关系映射到对应集合属性中。

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