如何用Spring Boot/Kotlin获取Neo4j的db.schema.visualization()查询结果？

核心原因 #

db.schema.visualization()返回的是包含节点标签、关系类型、属性的嵌套结构化数据，你的代码大概率只提取了结果的顶层键，没有对嵌套的节点/关系数据做映射和序列化处理。

解决方案步骤 #

1. 定义匹配查询结果的实体类

首先创建Kotlin数据类，精准映射Neo4j返回的Schema结构：

// 节点结构：包含标签和属性
data class SchemaNode(
    val labels: List<String>,
    val properties: Map<String, String>
)

// 关系结构：包含类型、起止节点标签和属性
data class SchemaRelationship(
    val type: String,
    val startLabel: String,
    val endLabel: String,
    val properties: Map<String, String>
)

// 整体结果结构：包含节点列表和关系列表
data class SchemaVisualizationResult(
    val nodes: List<SchemaNode>,
    val relationships: List<SchemaRelationship>
)

2. 修正Repository实现，完整提取数据

不要只提取顶层键，要从查询结果中解析出节点和关系的完整属性：

@Repository
class SchemaRepositoryImpl(
    private val neo4jTemplate: Neo4jTemplate
) : SchemaRepository {
    override fun getSchemaVisualization(): SchemaVisualizationResult {
        val query = "CALL db.schema.visualization()"
        
        // 使用use函数自动管理Session生命周期，避免资源泄漏
        return neo4jTemplate.session.use { session ->
            val resultRecord = session.run(query).single()
            
            // 解析节点数据
            val nodes = resultRecord.get("nodes").asList { nodeRecord ->
                val node = nodeRecord.asNode()
                SchemaNode(
                    labels = node.labels.map { it.name },
                    properties = node.properties.mapValues { it.value.toString() }
                )
            }
            
            // 解析关系数据
            val relationships = resultRecord.get("relationships").asList { relRecord ->
                val rel = relRecord.asRelationship()
                SchemaRelationship(
                    type = rel.type.name,
                    startLabel = rel.startNode.labels.first().name,
                    endLabel = rel.endNode.labels.first().name,
                    properties = rel.properties.mapValues { it.value.toString() }
                )
            }
            
            SchemaVisualizationResult(nodes, relationships)
        }
    }
}

3. 确保Controller正确返回序列化后的完整数据

Controller直接返回上述实体类即可，Spring Boot默认的Jackson序列化会自动处理嵌套结构：

@RestController
@RequestMapping("/api/schema")
class SchemaController(
    private val schemaRepository: SchemaRepository
) {
    @GetMapping("/visualization")
    fun getSchemaVisualization(): SchemaVisualizationResult {
        return schemaRepository.getSchemaVisualization()
    }
}

4. 排查额外问题

• 如果仍然只输出键，检查实体类是否被意外添加了@JsonIgnore等过滤注解
• 打印查询结果的原始数据（比如println(resultRecord)），确认Neo4j确实返回了完整的节点/关系属性
• 检查Jackson配置是否被修改过，比如设置了仅序列化带有特定注解的字段

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