unity怎么加载json文件

Unity中加载JSON文件的完整指南**

在Unity开发中,JSON（JavaScript Object Notation）因其轻量级、易读以及与语言的良好兼容性，成为了数据交换格式的首选之一，无论是配置文件、存档数据、网络接口响应，还是场景/对象数据的序列化与反序列化，加载JSON文件都是一项核心技能，本文将详细介绍在Unity中加载JSON文件的多种方法，并提供代码示例和最佳实践。

JSON文件在Unity中的准备

我们需要在Unity项目中创建JSON文件,这些文件可以放置在以下位置：

Resources文件夹：这是Unity中一个特殊的文件夹，位于Assets目录下，放在此文件夹下的资源可以通过Resources.Load()方法直接加载，无需实例化，这是加载简单JSON配置文件的常用方式。
- 在Assets/Resources下创建一个名为data.json的文件。
StreamingAssets文件夹：此文件夹下的文件在构建后会原封不动地打包到游戏包中，可以通过特定的路径访问，它适合存放较大的JSON文件或需要从外部更新的文件（在PC平台可以直接读取，移动端则需要通过WWW或UnityWebRequest读取）。
- 在Assets/StreamingAssets下创建items.json。
Assets根目录或其他自定义文件夹：对于作为资源管理的JSON文件，可以放在任意文件夹，但需要通过AssetDatabase加载（编辑器模式）或将其作为TextAsset导入后使用。

示例JSON文件 (data.json)：

{
  "playerName": "Alice",
  "level": 5,
  "health": 100,
  "inventory": [
    { "id": 1, "name": "Sword", "quantity": 1 },
    { "id": 2, "name": "Potion", "quantity": 5 }
  ]
}

加载JSON文件的主要方法

使用Resources.Load() (适用于Resources文件夹下的文件)

这是最简单直接的方法,适用于将JSON文件作为TextAsset加载，然后解析其内容。

步骤：

确保JSON文件位于Assets/Resources文件夹下。
使用Resources.Load<TextAsset>("文件名不含扩展名")加载JSON文件。
将TextAsset的text属性传递给JSON解析库。

代码示例：

using UnityEngine;
using System.Collections.Generic;
// 定义与JSON结构对应的C#类
[System.Serializable]
public class PlayerData
{
    public string playerName;
    public int level;
    public int health;
    public List<Item> inventory;
}
[System.Serializable]
public class Item
{
    public int id;
    public string name;
    public int quantity;
}
public class JsonLoaderExample : MonoBehaviour
{
    void Start()
    {
        // 1. 加载JSON文件为TextAsset
        TextAsset jsonFile = Resources.Load<TextAsset>("data");
        if (jsonFile == null)
        {
            Debug.LogError("Failed to load JSON file!");
            return;
        }
        // 2. 解析JSON字符串为对象
        // 使用Unity自用的JsonUtility (适用于简单结构和Unity可序列化的类)
        PlayerData playerData = JsonUtility.FromJson<PlayerData>(jsonFile.text);
        // 或者使用第三方库如Newtonsoft.Json (更强大，支持复杂类型)
        // PlayerData playerData = JsonConvert.DeserializeObject<PlayerData>(jsonFile.text);
        // 3. 使用加载的数据
        Debug.Log("Player Name: " + playerData.playerName);
        Debug.Log("Player Level: " + playerData.level);
        Debug.Log("Player Health: " + playerData.health);
        foreach (var item in playerData.inventory)
        {
            Debug.Log($"Item: {item.name}, Quantity: {item.quantity}");
        }
        // 4. 卸载加载的资源 (可选，但推荐)
        Resources.UnloadAsset(jsonFile);
    }
}

注意事项：

Resources.Load()的路径是相对于Resources文件夹的，且不包含文件扩展名。
只有放在Resources文件夹下的文件才能通过此方法加载。
加载的资源在场景切换时不会自动卸载,需要手动调用Resources.UnloadAsset()或Resources.UnloadUnusedAssets()。

使用UnityWebRequest (适用于StreamingAssets文件夹及外部URL)

对于StreamingAssets文件夹，或者需要从网络URL加载JSON文件时，UnityWebRequest是推荐的方法，它在所有平台上都能正常工作。

步骤：

构建StreamingAssets的路径（不同平台路径获取方式不同）。
创建UnityWebRequest对象，设置URL和下载方法（GET或POST）。
发送请求并等待下载完成。
获取下载的文本数据（JSON字符串）。
解析JSON字符串。
处理完毕后, Dispose UnityWebRequest。

代码示例 (加载StreamingAssets下的JSON)：

using UnityEngine;
using UnityEngine.Networking;
using System.Collections;
using System.Collections.Generic;
// 使用与方法一相同的PlayerData和Item类
public class JsonWebRequestExample : MonoBehaviour
{
    void Start()
    {
        StartCoroutine(LoadJsonFromStreamingAssets());
    }
    IEnumerator LoadJsonFromStreamingAssets()
    {
        string filePath = Application.streamingAssetsPath + "/items.json";
        UnityWebRequest webRequest = UnityWebRequest.Get(filePath);
        yield return webRequest.SendWebRequest();
        if (webRequest.result == UnityWebRequest.Result.ConnectionError || webRequest.result == UnityWebRequest.Result.ProtocolError)
        {
            Debug.LogError($"Error loading JSON: {webRequest.error}");
        }
        else
        {
            string jsonContent = webRequest.downloadHandler.text;
            Debug.Log("JSON Content: " + jsonContent);
            // 解析JSON
            PlayerData playerData = JsonUtility.FromJson<PlayerData>(jsonContent);
            // 或者使用Newtonsoft.Json: PlayerData playerData = JsonConvert.DeserializeObject<PlayerData>(jsonContent);
            if (playerData != null)
            {
                Debug.Log("Loaded Player Name: " + playerData.playerName);
                // ... 使用数据
            }
        }
        webRequest.Dispose();
    }
}

代码示例 (从网络URL加载JSON)：

// 只需要修改LoadJsonFromStreamingAssets方法名为LoadJsonFromUrl，并替换filePath为URL
IEnumerator LoadJsonFromUrl()
{
    string url = "https://example.com/api/data.json";
    UnityWebRequest webRequest = UnityWebRequest.Get(url);
    yield return webRequest.SendWebRequest();
    // 后续处理逻辑与StreamingAssets类似
    // ...
}

注意事项：

Application.streamingAssetsPath在PC上返回file://开头的路径，移动端则返回jar:或asset:等，需要配合UnityWebRequest使用。
UnityWebRequest是异步操作，需要放在协程（Coroutine）中执行。
网络请求需要处理超时、错误等情况。

使用第三方JSON库 (如Newtonsoft.Json)

虽然Unity自带的JsonUtility非常轻量且易于使用，但它有一些限制，

不能很好地处理字典（Dictionary）。
不能直接解析JSON数组为List（需要包装类）。
对复杂类型的支持有限。

Newtonsoft.Json（也称为Json.NET）是一个功能强大且广泛使用的第三方库，可以弥补这些不足。

步骤：

导入库：将Newtonsoft.Json的DLL文件导入Unity项目，可以通过Unity Package Manager安装（如果可用），或从官网下载DLL放入Assets/Plugins或Assets/Scripts文件夹。
使用JsonConvert.DeserializeObject<T>(jsonString)方法进行解析。

代码示例：

using UnityEngine;
using Newtonsoft.Json; // 需要引入命名空间
using System.Collections.Generic;
// 定义与JSON结构对应的C#类 (可以包含Dictionary等复杂类型)
[System.Serializable]
public class PlayerDataNewtonsoft
{
    public string playerName;
    public int level;
    public int health;
    public List<Item> inventory;
    // 可以有一个字典属性
    // public Dictionary<int, string> customData;
}
// 使用与方法一相同的Item类
public class NewtonsoftJsonExample : MonoBehaviour
{
    void Start()
    {
        // 假设jsonText是从文件或网络加载的JSON字符串
        string jsonText = "{\"playerName\":\"Bob\",\"level\":10,\"health\":150,\"inventory\":[{\"id\":3,\"name\":\"Shield\",\"quantity\":1}]}";
        try
        {
            PlayerDataNewtonsoft playerData = JsonConvert.DeserializeObject<PlayerDataNewtonsoft>(jsonText);
            if (playerData != null)
            {
                Debug.Log("Player Name (Newtonsoft): " + playerData.playerName);
                Debug.Log("Player Level (Newtonsoft): " + playerData.level);
                // ...
            }
        }
        catch (JsonException e)
        {
            Debug.LogError("JSON解析错误: " + e.Message);
        }
    }
}

优点：