如何为 System.Serializable 类设置自定义 json 字段名称？

Question

我正在从服务器获取响应：

{
    "auth_token": "062450b9dd7e189f43427fbc5386f7771ba59467"
}

为了访问它，我需要使用与原始 JSON 相同的名称。

[System.Serializable]
public class TokenResponse
{
    public string auth_token; // I want to rename it to authToken without renaming corresponding field in json
    public static TokenResponse CreateFromJSON(string json) {
        return JsonUtility.FromJson<TokenResponse>(json);
    }
}

如何在不丢失功能的情况下将 TokenResponse.auth_token 重命名为 TokenResponse.authToken？

Answer 1

@Mike Mat's answer 接近于 Unity 的一个很好的解决方案，但不幸的是它并不能很好地工作（因为Unity never serializes C# properties）。

这是他的答案的一个变体，它在 Unity 中编译并正常工作（在 Unity 2018.3.1 中测试）。

[System.Serializable]
public class TokenResponse
{
    [SerializeField] private string auth_token;
    public string authToken { get { return auth_token; } }

    public static TokenResponse CreateFromJSON(string json) {
        return JsonUtility.FromJson<TokenResponse>(json);
    }
}

Answer 2

使用JsonDotNet 代替JsonUtility

这样做：

[System.Serializable]
public class TokenResponse
{
    // what is `JsonProperty` see:https://www.newtonsoft.com/json/help/html/JsonPropertyName.htm
    [JsonProperty("auth_token")] 
    public string authToken {set; get;} 

    public static TokenResponse CreateFromJSON(string json) {
        return JsonConvert.DeserializeObject<TokenResponse>(json);
    }
}

Answer 3

我想这是 Unity 的代码。不幸的是，它似乎不允许您立即更改 JSON 字符串的键名。

但是the documentation 说您可以使用 [NonSerialized] 属性来省略字段。所以下面的代码可能会让你做你想做的事。

[System.Serializable]
public class TokenResponse
{
    [NonSerialized]
    public string AuthToken;

    public string auth_token { get { return AuthToken; } }

    public static TokenResponse CreateFromJSON(string json)
    {
        return JsonUtility.FromJson<TokenResponse>(json);
    }
}

希望这会有所帮助。