unity怎么引用json

Unity中引用与解析JSON数据的完整指南**

在Unity游戏开发中,JSON（JavaScript Object Notation）因其轻量级、易读易写以及与JavaScript的天然亲和力，成为了数据交换和配置文件存储的常用格式，无论是加载游戏配置、读取存档数据，还是与服务器进行通信，JSON都扮演着重要角色，本文将详细介绍在Unity中如何引用和解析JSON数据，涵盖从内置方法到流行第三方库的多种方式。

为什么在Unity中使用JSON？

在开始之前,我们先简单回顾一下在Unity中使用JSON的优势：

轻量级：相比XML等格式，JSON数据更紧凑，传输和解析开销更小。
易读易写：人类可读性强，方便调试和手动编辑配置文件。
语言无关性：虽然名字里有JavaScript，但JSON是一种独立于语言的数据格式，几乎所有编程语言都支持其解析和生成。
结构灵活：能够表示复杂的数据结构，如嵌套对象和数组。

Unity内置的JSON支持：JsonUtility

Unity自1版本起，引入了System.Text.Json.JsonUtility命名空间（早期版本可以使用Newtonsoft.Json，但现在是内置的JsonUtility），这是Unity官方推荐的处理JSON数据的方式，尤其适用于处理简单的JSON数据结构以及与MonoBehaviour序列化相关的场景。

准备C#数据类（Model）

要使用JsonUtility解析JSON，首先需要创建一个与JSON结构相匹配的C#类（或结构体），类的字段名称和类型必须与JSON的键和值类型一一对应。

示例JSON数据 (player.json)：

{
  "playerName": "Alice",
  "level": 5,
  "health": 100.0,
  "isAlive": true,
  "inventory": [
    "sword",
    "potion",
    "shield"
  ]
}

对应的C#类 (PlayerData.cs)：

using System.Collections.Generic;
using UnityEngine;
[System.Serializable] // 必须添加此特性才能被JsonUtility序列化/反序列化
public class PlayerData
{
    public string playerName;
    public int level;
    public float health;
    public bool isAlive;
    public List<string> inventory; // JSON数组对应C#的List<T>
}

从JSON字符串解析对象（反序列化）

假设你有一个JSON字符串,想将其转换为PlayerData对象：

using System;
using UnityEngine;
public class JsonExample : MonoBehaviour
{
    void Start()
    {
        string jsonString = @"{
            ""playerName"": ""Bob"",
            ""level"": 10,
            ""health"": 85.5,
            ""isAlive"": true,
            ""inventory"": [""axe"", ""armor""]
        }";
        try
        {
            PlayerData playerData = JsonUtility.FromJson<PlayerData>(jsonString);
            Debug.Log("Player Name: " + playerData.playerName);
            Debug.Log("Level: " + playerData.level);
            Debug.Log("Health: " + playerData.health);
            Debug.Log("Is Alive: " + playerData.isAlive);
            Debug.Log("Inventory: " + string.Join(", ", playerData.inventory));
        }
        catch (Exception e)
        {
            Debug.LogError("Failed to parse JSON: " + e.Message);
        }
    }
}

将对象转换为JSON字符串（序列化）

如果你想把PlayerData对象保存为JSON字符串：

PlayerData playerData = new PlayerData();
playerData.playerName = "Charlie";
playerData.level = 15;
playerData.health = 120.0f;
playerData.isAlive = true;
playerData.inventory = new List<string> { "bow", "arrows", "leather" };
string jsonString = JsonUtility.ToJson(playerData, true); // 第二个参数formatting=true，格式化输出，便于阅读
Debug.Log(jsonString);

输出结果：

{
    "playerName": "Charlie",
    "level": 15,
    "health": 120,
    "isAlive": true,
    "inventory": [
        "bow",
        "arrows",
        "leather"
    ]
}

从JSON文件加载

JSON数据会存储在外部文件中（如.json文件），你需要将这些文件放在Unity项目的Resources文件夹下，或者使用StreamingAssets文件夹（推荐，适用于所有平台）。

示例：从StreamingAssets加载

using UnityEngine;
using System.IO;
public class LoadJsonFromFile : MonoBehaviour
{
    void Start()
    {
        string filePath = Path.Combine(Application.streamingAssetsPath, "player.json");
        string jsonString = "";
        if (File.Exists(filePath))
        {
            jsonString = File.ReadAllText(filePath);
            PlayerData playerData = JsonUtility.FromJson<PlayerData>(jsonString);
            Debug.Log("Loaded Player: " + playerData.playerName);
        }
        else
        {
            Debug.LogError("Cannot find JSON file at " + filePath);
        }
    }
}

注意事项：

JsonUtility对JSON格式有一定要求，例如JSON的顶层必须是一个对象（{}），而不能是数组（[]）。
对于复杂的JSON结构（如多层数组嵌套），手动编写对应的C#类可能会比较繁琐。
JsonUtility不支持字典（Dictionary<T, U>）的直接序列化/反序列化，需要一些额外处理或使用第三方库。

使用第三方库：Newtonsoft.Json (Json.NET)

尽管JsonUtility是内置的，但Newtonsoft.Json（也称为Json.NET）是一个功能更强大、更灵活的第三方库，在Unity社区中也非常流行，它支持更复杂的JSON场景，如LINQ to JSON、自定义序列化器、直接读写JSON数组等。

引入Newtonsoft.Json

你可以通过以下方式在Unity中使用Newtonsoft.Json：

Unity Package Manager (UPM): 在Window > Package Manager中，点击"+"号，选择"Add package from git URL..."，然后输入com.unity.newtonsoft-json (如果Unity已收录) 或直接从NuGet获取并导入。
下载DLL: 从NuGet官网下载Newtonsoft.Json的DLL文件，然后将其放在Unity项目的Assets/Plugins文件夹下。

使用Newtonsoft.Json解析和生成JSON

基本使用示例：

using Newtonsoft.Json;
using UnityEngine;
public class NewtonsoftJsonExample : MonoBehaviour
{
    void Start()
    {
        string jsonString = @"{
            ""playerName"": ""Diana"",
            ""level"": 20,
            ""health"": 150.0,
            ""isAlive"": true,
            ""inventory"": [""staff"", ""robe""]
        }";
        // 反序列化
        PlayerData playerData = JsonConvert.DeserializeObject<PlayerData>(jsonString);
        Debug.Log("Player Name (Newtonsoft): " + playerData.playerName);
        // 序列化
        string newJsonString = JsonConvert.SerializeObject(playerData, Formatting.Indented);
        Debug.Log("Serialized JSON (Newtonsoft): " + newJsonString);
        // 示例：直接解析JSON数组
        string jsonArrayString = @"[""item1"", ""item2"", ""item3""]";
        List<string> items = JsonConvert.DeserializeObject<List<string>>(jsonArrayString);
        Debug.Log("First item: " + items[0]);
    }
}

优势：

功能强大,支持复杂JSON结构。
性能通常优于JsonUtility（尤其在处理大量数据时）。
社区支持好,文档丰富。
支持字典的直接序列化/反序列化。

其他JSON处理库

除了JsonUtility和Newtonsoft.Json，还有一些其他轻量级的JSON库可供选择，

LitJSON: 一个非常轻量级、快速的JSON库，API简单易用。
SimpleJSON: 一个轻量级的JSON解析器，特别适合需要快速解析JSON而不需要完整对象映射的场景，它返回一个JSONNode对象，可以通过键动态访问数据。

选择哪个库取决于你的具体需求,如项目复杂度、性能要求、包大小等，对于大多数简单到中等复杂度的场景，JsonUtility已经足够；而对于需要高级功能或处理复杂数据的场景，Newtonsoft.Json是更好的选择。

最佳实践与注意事项

数据类与JSON结构匹配：确保你的C#数据类的字段名和类型与JSON键值严格对应，并标记[System.Serializable]。
错误处理：JSON数据可能格式不正确或缺失字段，解析时应使用try-catch块捕获异常，避免程序崩溃。
文件路径：使用Application.streamingAssetsPath或Application.persistentDataPath来读取和写入JSON文件，注意不同平台的路径差异。
性能考虑：对于频繁的JSON解析或大量数据，可以考虑使用性能更好的库如Newtonsoft.Json