前言
作为游戏开发者，我们经常需要存储和检索数据。CSV 文件是一种常见的数据存储格式，它以纯文本形式存储表格数据。CSV 文件非常简单，易于阅读和编辑，因此它在游戏开发中非常流行。
但是，在 Unity 中读写 CSV 文件并不总是那么容易。有时候，我们需要编写大量的代码来实现这一功能（重复造轮子）。这就是为什么我创建了 CsvUtility 工具的原因，让它和使用 Unity 自带的 JsonUtility 那样简单、优雅、开箱即食！
关于 CSV
CSV（Comma-Separated Values）是一种常见的数据存储格式，它以纯文本形式存储表格数据。CSV 文件中的每一行都表示一个数据记录，每个记录由一个或多个字段组成，字段之间用逗号分隔。
CSV 文件非常简单，易于阅读和编辑。它可以被许多不同类型的软件读取和写入，包括常见的 WPS、Excel、写字板和文本编辑器等。
CsvUtility
CsvUtility 是一个用于 Unity 的 CSV 文件读写工具。它可以帮助您轻松地在 Unity 中读取和写入 CSV 文件，而无需编写大量的代码。
CsvUtility 的主要特点包括：
- 简单易用：CsvUtility 的 API 非常简单，易于使用。
- ORM 风格：CsvUtility 的 API 风格向 Unity 的 JsonUtility 靠拢，支持对象关系映射（ORM）。
- 支持忽略字段：CsvUtility 支持使用 CsvIgnoreAttribute 标记不需要处理的字段。
- 支持字段别名：CsvUtility 支持使用 ColumnAttribute 为字段指定别名。
CSV 读写的实现
下面是一些 CsvUtility 的关键代码片段，展示了如何使用 CsvUtility 来实现 CSV 文件的读写。
1. 如何将指定对象列表存储成 csv 文件?
下面是一个简单的示例，演示如何使用 CsvUtility 将指定对象列表存储成 csv 文件：
using UnityEngine;
using System.Collections.Generic;
using zFramework.Extension;
public class Example : MonoBehaviour
{
public class Person
{
public string name;
public int age;
public string gender;
}
void Start()
{
List<Person> people = new List<Person>()
{
new Person() { name = "Alice", age = 25, gender = "Female" },
new Person() { name = "Bob", age = 32, gender = "Male" },
new Person() { name = "Charlie", age = 18, gender = "Male" }
};
CsvUtility.Write(people, Application.dataPath + "/people.csv");
}
}
上面的代码定义了一个 Person 类，并创建了一个包含三个 Person 对象的列表。然后，我们使用 Write 方法将这些对象转换为 CSV 数据，并将其保存到名为 "people.csv" 的文件中。
2. 如何读取 csv 文件内容到指定对象列表?
下面是一个简单的示例，演示如何使用 CsvUtility 读取 csv 文件内容到指定对象列表：
using UnityEngine;
using System.Collections.Generic;
using zFramework.Extension;
public class Example : MonoBehaviour
{
public class Person
{
public string name;
public int age;
public string gender;
}
void Start()
{
List<Person> people = CsvUtility.Read<Person>(Application.dataPath + "/people.csv");
foreach (Person person in people)
{
Debug.Log(person.name + ", " + person.age + ", " + person.gender);
}
}
}
上面的代码定义了一个 Person 类，并使用 Read 方法从名为 "people.csv" 的文件中读取数据，并将其转换为 Person 对象列表。最后，我们遍历这个列表，并将每个对象的信息输出到控制台。
3. 如何根据指定字段和值获取指定行的数据并返回一个对象?
下面是一个简单的示例，演示如何使用 CsvUtility 根据指定字段和值获取指定行的数据并返回一个对象：
using UnityEngine;
using System.Collections.Generic;
using zFramework.Extension;
public class Example : MonoBehaviour
{
public class Person
{
public string name;
public int age;
public string gender;
}
void Start()
{
Person person = CsvUtility.Read<Person>(Application.dataPath + "/people.csv", v => v.name == "Alice");
Debug.Log(person.name + ", " + person.age + ", " + person.gender);
}
}
上面的代码定义了一个 Person 类，并使用 Read 方法从名为 "people.csv" 的文件中读取数据，并根据指定的字段和值获取指定行的数据。最后，我们将获取到的对象的信息输出到控制台。
4. 如何更新已存在的对象?
下面是一个简单的示例，演示已存在的对象如何使用 CsvUtility 根据指定字段获取指定行的数据并填充数据：
using UnityEngine;
using System.Collections.Generic;
using zFramework.Extension;
public class Example : MonoBehaviour
{
public class Person
{
public string name;
public int age;
public string gender;
}
void Start()
{
var name = "Bob";
Person person = new Person(){ name = name};
CsvUtility.FromCsvOverwrite<Person>(Application.dataPath + "/people.csv", v => v.person =="Bob");
Debug.Log(person.name + ", " + person.age + ", " + person.gender);
}
}
上面的代码定义了一个 Person 类，并使用 FromCsvOverwrite 方法从名为 "people.csv" 的文件中读取数据，并根据指定的字段获取指定行的数据。最后，我们将获取到的对象的信息输出到控制台。
5. 如何根据指定对象更新 csv 数据?
下面是一个简单的示例，演示如何使用 CsvUtility 根据指定对象更新 csv 数据：
using UnityEngine;
using System.Collections.Generic;
using zFramework.Extension;
public class Example : MonoBehaviour
{
public class Person
{
public string name;
public int age;
public string gender;
}
void Start()
{
Person person = new Person() { name = "Alice", age = 30, gender = "Female" };
CsvUtility.Write(person, Application.dataPath + "/people.csv", v => v.name == person.name, KeyinType.Update);
}
}
上面的代码定义了一个 Person 类，并创建了一个新的 Person 对象。然后，我们使用 Write 方法将这个对象的数据更新到名为 "people.csv" 的文件中。
6. 如何根据指定对象新增 csv 数据?
下面是一个简单的示例，演示如何使用 CsvUtility 根据指定对象新增 csv 数据：
using UnityEngine;
using System.Collections.Generic;
using zFramework.Extension;
public class Example : MonoBehaviour
{
public class Person
{
public string name;
public int age;
public string gender;
}
void Start()
{
Person person = new Person() { name = "Dave", age = 40, gender = "Male" };
CsvUtility.Write(person, Application.dataPath + "/people.csv", v => v.name == "Dave", KeyinType.Append);
}
}
上面的代码定义了一个 Person 类，并创建了一个新的 Person 对象。然后，我们使用 Write 方法将这个对象的数据新增到名为 "people.csv" 的文件中。
7. 如何使用 CsvIgnoreAttribute 标记不需要处理的字段?
CsvUtility 支持使用 CsvIgnoreAttribute 标记不需要处理的字段。下面是一个简单的示例：
using UnityEngine;
using System.Collections.Generic;
using zFramework.Extension;
public class Example : MonoBehaviour
{
public class Person
{
[CsvIgnore]
public string id;
public string name;
public int age;
public string gender;
}
void Start()
{
List<Person> people = new List<Person>()
{
new Person() { id = "1", name = "Alice", age = 25, gender = "Female" },
new Person() { id = "2", name = "Bob", age = 32, gender = "Male" },
new Person() { id = "3", name = "Charlie", age = 18, gender = "Male" }
};
CsvUtility.Write(people, Application.dataPath + "/people.csv");
}
}
上面的代码定义了一个 Person 类，并在其中使用 CsvIgnoreAttribute 标记了 id 字段。这意味着当我们使用 Write 方法将这些对象转换为 CSV 数据时，id 字段将不会被包含在生成的 CSV 文件中。
8. 如何使用 ColumnAttribute 为字段指定别名?
CsvUtility 支持使用 ColumnAttribute 为字段指定别名。下面是一个简单的示例：
using UnityEngine;
using System.Collections.Generic;
using zFramework.Extension;
public class Example : MonoBehaviour
{
public class Person
{
[Column("First Name")]
public string name;
[Column("Age")]
public int age;
[Column("Gender")]
public string gender;
}
void Start()
{
List<Person> people = new List<Person>()
{
new Person() { name = "Alice", age = 25, gender = "Female" },
new Person() { name = "Bob", age = 32, gender = "Male" },
new Person() { name = "Charlie", age = 18, gender = "Male" }
};
CsvUtility.Write(people, Application.dataPath + "/people.csv");
}
}
上面的代码定义了一个 Person 类，并在其中使用 ColumnAttribute 为每个字段指定了别名。这意味着当我们使用 Write 方法将这些对象转换为 CSV 数据时，生成的 CSV 文件中的列名将使用指定的别名。
示例
使用 UPM 安装完成本工具，并导入测试用例。 测试用例提供了 8 个常用情景，导入Unity 后，无需进入 Play 模式，直接点击面板（Inspector）上的按钮即可看到数据的读写效果。
再简单的看看脚本中的逻辑就知道如何使用啦！
| 保存 | 加载 | 更新 | 新增 |
|---|---|---|---|
 |
 |
 |
 |
单例测试
为保证 API 的有效性，更为了方便测试，我使用 Unity 提供的单例测试工具（Test Runer）写就了测试用例，并且测试全部通过~
扩展阅读
- CsvUtility 工具仓库：https://github.com/Bian-Sh/CsvUtility-For-Unity
- AI 对话 PDF 地址：https://github.com/Bian-Sh/CsvUtility-For-Unity/tree/master/doc/ai
写到最后
- 如果您的数据量庞大，笔者推荐使用 SQLite 来替代 CSV 👉Unity 示例👈
- CSVUtility 是笔者与 Newbing AI 协同构建完成！在这个工具实现的过程中，笔者基本上没有写多少代码；更多的是参与了代码测试、重构、优化建议及引导（对话内容请看扩展阅读），乃至此博文大部分内容都是 AI 执笔。
请勇于尝试，让 AI 成为生产力，如果你的知识面有广度，AI 可以让它有深度 - 笔者言
- 希望这篇博客能够帮助您更好在 Unity 中优雅地读写 CSV 数据。如果您有任何问题或建议，欢迎在评论区留言。感谢您的阅读！
版权所有，转载请注明出处
