使用Neo4jClient 5.1.3时[JsonIgnore]标记未生效问题咨询

我有一个C#类，期望调用Create方法时将其简单属性保存到Neo4j节点中。但使用Neo4jClient 5.1.3构建查询时，被[JsonIgnore]标记的复杂类属性Employer仍被包含在CREATE命令中。

Person类定义 #

public class Person {
        public string FirstName { get; set; }
        public string LastName { get; set; }    
        public string Email { get; set; }

        [JsonIgnore]
        public Organization Employer { get; set; }
}

创建实例代码 #

var person = new Person
{
    Email = "absdfasdf@12341234.com",
    FirstName = "Job",
    LastName = "Bob",
    Employer = previouslyCreatedEmployer,
};

执行查询代码 #

var query = neo.Client.Cypher
    .Create("(p:Person:Security $object)")
    .WithParams(new Dictionary<string, object> {
        { "object", person }
    });

调试生成的QueryText #

CREATE (p:Person:Security {
  Email: "absdfasdf@12341234.com",
  FirstName: "Job",
  LastName: "Bob",
  Employer: {
    Logo: "",
    IxId: "89becda5-98b4-4623-928f-4c6580cd554f",
    name: "Joe's Bakery"
  },
  IxId: "eb117b37-b062-40e1-b038-1749156ecf7a"
})

我原本以为给Employer标记了[JsonIgnore]就不会被包含进来，请问哪里出错了？另外，是不是不该用[JsonIgnore]，有没有更简洁的查询写法？

问题原因 #

Neo4jClient的序列化机制默认不识别System.Text.Json的[JsonIgnore]特性，它有自己独立的序列化配置和属性忽略逻辑，所以这个标记对Neo4jClient不起作用。

解决方法 #

1. 使用Neo4jClient自带的[Ignore]特性

直接把[JsonIgnore]替换为Neo4jClient提供的IgnoreAttribute，需要先引用Neo4jClient.Attributes命名空间：

using Neo4jClient.Attributes;

public class Person {
    public string FirstName { get; set; }
    public string LastName { get; set; }    
    public string Email { get; set; }

    [Ignore]
    public Organization Employer { get; set; }
}

这样序列化时Employer属性就会被自动忽略。

2. 手动构建参数对象

如果不想修改类的特性，可以手动创建仅包含需要保存属性的匿名对象，精准控制序列化内容：

var query = neo.Client.Cypher
    .Create("(p:Person:Security $object)")
    .WithParams(new Dictionary<string, object> {
        { "object", new {
            person.FirstName,
            person.LastName,
            person.Email,
            person.IxId // 按需添加需要保存的属性
        }}
    });

这种方式还能让查询逻辑更清晰，避免意外序列化不必要的属性。

3. 全局配置序列化器（进阶）

如果项目中需要统一使用System.Text.Json的特性，可以自定义Neo4jClient的序列化配置，替换默认的序列化器。不过这个步骤相对复杂，适合有全局序列化需求的场景。

关于[JsonIgnore]的使用建议 #

不要用[JsonIgnore]来适配Neo4jClient，因为它不属于Neo4jClient的序列化体系。改用Neo4jClient原生的[Ignore]特性更直接，或者手动构建参数对象能让查询更简洁可控。

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