C# JsonSerializer.Serialize 返回空对象

Question

我遇到了关于将结构体序列化为JSON的问题。我有一个名为“坐标”的结构体。

namespace CoordinatesNameSpace
{
    public struct Coordinates
    {
        public Coordinates(string key, string x, string y, string z)
        {
            this.key = key;
            this.x = x;
            this.y = y;
            this.z = z;
        }
        public string key;
        public string x;
        public string y;
        public string z;
        public override string ToString()
        {
            return $"{key} {this.x} {this.y} {this.z}";
        }
    }
}

所有属性都是公共的，因此我期望 json 序列化器会返回 { "key": "v", "x": "0.12331212" ... }，但它只返回了一个空对象。

using CoordinatesNameSpace;

namespace ObjToJSON
{
    class Program
    {
        static void Main(string[] args)
        {
            List<Coordinates> parsedCoordinatesList = new List<Coordinates>();
            Coordinates _c;
            _c.key = splitted[0]; // "v"
            _c.x = splitted[1]; // "1.324394"
            _c.y = splitted[2]; // "-0.219625"
            _c.z = splitted[3]; // "-0.422554"
            parsedCoordinatesList.Add(_c);

            // returns an [{}, {}, {} ...]
            //string json = JsonSerializer.Serialize<List<Coordinates>>(parsedCoordinatesList);

            // returns {}
            string json = JsonSerializer.Serialize<Coordinates>(parsedCoordinatesList[0]);

请有人给我解释一下，为什么它会这样做以及如何使其正确序列化？

- Dmitry Klymenko

Answer 1

看起来目前System.Text.Json不支持序列化字段。将字段改为属性，一切都应该正常工作：

public struct Coordinates
{
    public Coordinates(string key, string x, string y, string z)
    {
        this.key = key;
        this.x = x;
        this.y = y;
        this.z = z;
    }
    public string key  { get; set; }
    public string x  { get; set; }
    public string y  { get; set; }
    public string z  { get; set; }
    public override string ToString()
    {
        return $"{key} {this.x} {this.y} {this.z}";
    }
}

同样来自文档：

序列化行为：

...

• 目前，字段被排除在外。

更新

自.NET 5起，可以通过JsonSerializerOptions.IncludeFields全局设置或JsonIncludeAttribute来包括字段。

public struct Coordinates
{
    public Coordinates(string key, string x, string y, string z)
    {
        this.key = key;
        this.x = x;
        this.y = y;
        this.z = z;
    }
    [JsonInclude]
    public string key;
    [JsonInclude]
    public string x;
    [JsonInclude]
    public string y;
    [JsonInclude]
    public string z;

    public override string ToString()
    {
        return $"{key} {this.x} {this.y} {this.z}";
    }
}

- Guru Stron

Answer 2

JsonSerializer是微软最近推出的一个相当新的库。它确实缺少一些功能，比如字段序列化。

其中一个选项是将字段转换为属性，这是一个很好的建议，因为公共字段不是一个好的设计实践，因为您正在暴露对象的内部状态。 然而，如果无法避免这种情况，那么可以选择一个复杂的JsonSerializer，例如可用作Nuget包的Newtonsoft.Json。

Newtonsoft.Json

它可以按如下方式使用：

string json = JsonConvert.SerializeObject(parsedCoordinatesList[0], Formatting.Indented);

- Durga Prasad