【Unity3D编辑器扩展】Unity3D中实现Excel转XML、Json、CSV文件

推荐阅读

CSDN主页

GitHub开源地址

Unity3D插件分享

简书地址

我的个人博客

大家好，我是佛系工程师☆恬静的小魔龙☆，不定时更新Unity开发技巧，觉得有用记得一键三连哦。

一、前言

在日常开发中，可能会遇到将Excel表格转成其他格式文件的情况。

比如Excel转XML、Json、CSV文件，那么就来学习一下如何实现吧。

二、正文

2-1、导入读取Excel所需要的dll文件

读取Excel文件，需要导入一些dll文件，才能正常的读取、创建Excell文件：
在这里插入图片描述
这些文件，我放到了CSDN按需下载：
https://download.csdn.net/download/q764424567/21046571

将下载后的dll文件放到Plugins文件夹内：
在这里插入图片描述

2-2、Excel文件转成Json、XML、CSV文件

在Project视图中，进入Scripts文件夹，新建一个Editor文件夹，然后在Editor文件内右击→Create→C# Script新建脚本，命名为ExcelUtility，双击修改代码：

using UnityEngine;
using System.Collections;
using System.Collections.Generic;
using Excel;
using System.Data;
using System.IO;
using Newtonsoft.Json;
using System.Text;
using System.Reflection;
using System.Reflection.Emit;
using System;

public class ExcelUtility
{
    
    
    /// <summary>
    /// 表格数据集合
    /// </summary>
    private DataSet mResultSet;

    /// <summary>
    /// 读取表数据
    /// </summary>
    /// <param name="excelFile">Excel file.</param>
    public ExcelUtility(string excelFile)
    {
    
    
        FileStream mStream = File.Open(excelFile, FileMode.Open, FileAccess.Read);
        IExcelDataReader mExcelReader = ExcelReaderFactory.CreateOpenXmlReader(mStream);
        mResultSet = mExcelReader.AsDataSet();
    }

    /// <summary>
    /// 转换为Json格式文件
    /// </summary>
    /// <param name="JsonPath">Json文件路径</param>
    /// <param name="Header">表头行数</param>
    public void ConvertToJson(string JsonPath, Encoding encoding)
    {
    
    
        //判断Excel文件中是否存在数据表
        if (mResultSet.Tables.Count < 1)
            return;

        //默认读取第一个数据表
        DataTable mSheet = mResultSet.Tables[0];

        //判断数据表内是否存在数据
        if (mSheet.Rows.Count < 1)
            return;

        //读取数据表行数和列数
        int rowCount = mSheet.Rows.Count;
        int colCount = mSheet.Columns.Count;

        //准备一个列表存储整个表的数据
        List<Dictionary<string, object>> table = new List<Dictionary<string, object>>();

        //读取数据
        for (int i = 1; i < rowCount; i++)
        {
    
    
            //准备一个字典存储每一行的数据
            Dictionary<string, object> row = new Dictionary<string, object>();
            for (int j = 0; j < colCount; j++)
            {
    
    
                //读取第1行数据作为表头字段
                string field = mSheet.Rows[0][j].ToString();
                //Key-Value对应
                row[field] = mSheet.Rows[i][j];
            }

            //添加到表数据中
            table.Add(row);
        }

        //生成Json字符串
        string json = JsonConvert.SerializeObject(table, Newtonsoft.Json.Formatting.Indented);
        //写入文件
        using (FileStream fileStream = new FileStream(JsonPath, FileMode.Create, FileAccess.Write))
        {
    
    
            using (TextWriter textWriter = new StreamWriter(fileStream, encoding))
            {
    
    
                textWriter.Write(json);
            }
        }
    }

    /// <summary>
    /// 转换为CSV格式文件
    /// </summary>
    public void ConvertToCSV(string CSVPath, Encoding encoding)
    {
    
    
        //判断Excel文件中是否存在数据表
        if (mResultSet.Tables.Count < 1)
            return;

        //默认读取第一个数据表
        DataTable mSheet = mResultSet.Tables[0];

        //判断数据表内是否存在数据
        if (mSheet.Rows.Count < 1)
            return;

        //读取数据表行数和列数
        int rowCount = mSheet.Rows.Count;
        int colCount = mSheet.Columns.Count;

        //创建一个StringBuilder存储数据
        StringBuilder stringBuilder = new StringBuilder();

        //读取数据
        for (int i = 0; i < rowCount; i++)
        {
    
    
            for (int j = 0; j < colCount; j++)
            {
    
    
                //使用","分割每一个数值
                stringBuilder.Append(mSheet.Rows[i][j] + ",");
            }
            //使用换行符分割每一行
            stringBuilder.Append("\r\n");
        }

        //写入文件
        using (FileStream fileStream = new FileStream(CSVPath, FileMode.Create, FileAccess.Write))
        {
    
    
            using (TextWriter textWriter = new StreamWriter(fileStream, encoding))
            {
    
    
                textWriter.Write(stringBuilder.ToString());
            }
        }

    }

    /// <summary>
    /// 转换为Xml格式文件
    /// </summary>
    public void ConvertToXml(string XmlFile)
    {
    
    
        //判断Excel文件中是否存在数据表
        if (mResultSet.Tables.Count < 1)
            return;

        //默认读取第一个数据表
        DataTable mSheet = mResultSet.Tables[0];

        //判断数据表内是否存在数据
        if (mSheet.Rows.Count < 1)
            return;

        //读取数据表行数和列数
        int rowCount = mSheet.Rows.Count;
        int colCount = mSheet.Columns.Count;

        //创建一个StringBuilder存储数据
        StringBuilder stringBuilder = new StringBuilder();
        //创建Xml文件头
        stringBuilder.Append("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
        stringBuilder.Append("\r\n");
        //创建根节点
        stringBuilder.Append("<Table>");
        stringBuilder.Append("\r\n");
        //读取数据
        for (int i = 1; i < rowCount; i++)
        {
    
    
            //创建子节点
            stringBuilder.Append("  <Row>");
            stringBuilder.Append("\r\n");
            for (int j = 0; j < colCount; j++)
            {
    
    
                stringBuilder.Append("   <" + mSheet.Rows[0][j].ToString() + ">");
                stringBuilder.Append(mSheet.Rows[i][j].ToString());
                stringBuilder.Append("</" + mSheet.Rows[0][j].ToString() + ">");
                stringBuilder.Append("\r\n");
            }
            //使用换行符分割每一行
            stringBuilder.Append("  </Row>");
            stringBuilder.Append("\r\n");
        }
        //闭合标签
        stringBuilder.Append("</Table>");
        //写入文件
        using (FileStream fileStream = new FileStream(XmlFile, FileMode.Create, FileAccess.Write))
        {
    
    
            using (TextWriter textWriter = new StreamWriter(fileStream, Encoding.GetEncoding("utf-8")))
            {
    
    
                textWriter.Write(stringBuilder.ToString());
            }
        }
    }
}

2-3、工具使用方法

使用方法：制作一个简单的编辑器工具，来快捷使用：

在这里插入图片描述
在Editor文件夹内，再新建一个脚本，命名为ExcelTools.cs，双击修改代码：

using UnityEngine;
using UnityEditor;
using System.Collections;
using System.Collections.Generic;
using System.Text;

public class ExcelTools : EditorWindow
{
    
    
	/// <summary>
	/// 当前编辑器窗口实例
	/// </summary>
	private static ExcelTools instance;

	/// <summary>
	/// Excel文件列表
	/// </summary>
	private static List<string> excelList;

	/// <summary>
	/// 项目根路径	
	/// </summary>
	private static string pathRoot;

	/// <summary>
	/// 滚动窗口初始位置
	/// </summary>
	private static Vector2 scrollPos;

	/// <summary>
	/// 输出格式索引
	/// </summary>
	private static int indexOfFormat=0;

	/// <summary>
	/// 输出格式
	/// </summary>
	private static string[] formatOption=new string[]{
    
    "JSON","CSV","XML"};

	/// <summary>
	/// 编码索引
	/// </summary>
	private static int indexOfEncoding=0;

	/// <summary>
	/// 编码选项
	/// </summary>
	private static string[] encodingOption=new string[]{
    
    "UTF-8","GB2312"};

	/// <summary>
	/// 是否保留原始文件
	/// </summary>
	private static bool keepSource=true;

	/// <summary>
	/// 显示当前窗口	
	/// </summary>
	[MenuItem("Plugins/ExcelTools")]
	static void ShowExcelTools()
	{
    
    
		Init();
		//加载Excel文件
		LoadExcel();
		instance.Show();
	}

	void OnGUI()
	{
    
    
		DrawOptions();
		DrawExport();
	}

	/// <summary>
	/// 绘制插件界面配置项
	/// </summary>
	private void DrawOptions()
	{
    
    
		GUILayout.BeginHorizontal();
		EditorGUILayout.LabelField("请选择格式类型:",GUILayout.Width(85));
		indexOfFormat=EditorGUILayout.Popup(indexOfFormat,formatOption,GUILayout.Width(125));
		GUILayout.EndHorizontal();

		GUILayout.BeginHorizontal();
		EditorGUILayout.LabelField("请选择编码类型:",GUILayout.Width(85));
		indexOfEncoding=EditorGUILayout.Popup(indexOfEncoding,encodingOption,GUILayout.Width(125));
		GUILayout.EndHorizontal();

		keepSource=GUILayout.Toggle(keepSource,"保留Excel源文件");
	}

	/// <summary>
	/// 绘制插件界面输出项
	/// </summary>
	private void DrawExport()
	{
    
    
		if(excelList==null) return;
		if(excelList.Count<1)
		{
    
    
			EditorGUILayout.LabelField("目前没有Excel文件被选中哦!");
		}
		else
		{
    
    
			EditorGUILayout.LabelField("下列项目将被转换为" + formatOption[indexOfFormat] + ":");
			GUILayout.BeginVertical();
			scrollPos=GUILayout.BeginScrollView(scrollPos,false,true,GUILayout.Height(150));
			foreach(string s in excelList)
			{
    
    
				GUILayout.BeginHorizontal();
				GUILayout.Toggle(true,s);
				GUILayout.EndHorizontal();
			}
			GUILayout.EndScrollView();
			GUILayout.EndVertical();

			//输出
			if(GUILayout.Button("转换"))
			{
    
    
				Convert();
			}
		}
	}

	/// <summary>
	/// 转换Excel文件
	/// </summary>
	private static void Convert()
	{
    
    
		foreach(string assetsPath in excelList)
		{
    
    
			//获取Excel文件的绝对路径
			string excelPath=pathRoot + "/" + assetsPath;
			//构造Excel工具类
			ExcelUtility excel=new ExcelUtility(excelPath);

			//判断编码类型
			Encoding encoding=null;
			if(indexOfEncoding==0){
    
    
				encoding=Encoding.GetEncoding("utf-8");
			}else if(indexOfEncoding==1){
    
    
				encoding=Encoding.GetEncoding("gb2312");
			}

			//判断输出类型
			string output="";
			if(indexOfFormat==0){
    
    
				output=excelPath.Replace(".xlsx",".json");
				excel.ConvertToJson(output,encoding);
			}else if(indexOfFormat==1){
    
    
				output=excelPath.Replace(".xlsx",".csv");
				excel.ConvertToCSV(output,encoding);
			}else if(indexOfFormat==2){
    
    
				output=excelPath.Replace(".xlsx",".xml");
				excel.ConvertToXml(output);
			}

			//判断是否保留源文件
			if(!keepSource)
			{
    
    
				FileUtil.DeleteFileOrDirectory(excelPath);
			}

			//刷新本地资源
			AssetDatabase.Refresh();
		}

		//转换完后关闭插件
		//这样做是为了解决窗口
		//再次点击时路径错误的Bug
		instance.Close();

	}

	/// <summary>
	/// 加载Excel
	/// </summary>
	private static void LoadExcel()
	{
    
    
		if(excelList==null) excelList=new List<string>();
		excelList.Clear();
		//获取选中的对象
		object[] selection=(object[])Selection.objects;
		//判断是否有对象被选中
		if(selection.Length==0)
			return;
		//遍历每一个对象判断不是Excel文件
		foreach(Object obj in selection)
		{
    
    
			string objPath=AssetDatabase.GetAssetPath(obj);
			if(objPath.EndsWith(".xlsx"))
			{
    
    
				excelList.Add(objPath);
			}
		}
	}

	private static void Init()
	{
    
    
		//获取当前实例
		instance=EditorWindow.GetWindow<ExcelTools>();
		//初始化
		pathRoot=Application.dataPath;
		//对路径进行处理
		pathRoot=pathRoot.Substring(0,pathRoot.LastIndexOf("/"));
		excelList=new List<string>();
		scrollPos=new Vector2(instance.position.x,instance.position.y+75);
	}

	void OnSelectionChange() 
	{
    
    
		//当选择发生变化时重绘窗体
		Show();
		LoadExcel();
		Repaint();
	}
}

选中Project视图中的xlsx文件，点击转换就可以了：
在这里插入图片描述
转化后的样子：

三、后记

主要使用了Unity的编辑器拓展，制作了一个简单的Excel文件转XML、JSON、CSV文件小工具。

因为有些平台比如WEBGL不支持IO加载Excel文件，所以将Excel转成CSV文件就很有用了。

你的点赞就是对博主的支持，有问题记得留言：

博主主页有联系方式。

博主还有跟多宝藏文章等待你的发掘哦：

专栏	方向	简介
Unity3D开发小游戏	小游戏开发教程	分享一些使用Unity3D引擎开发的小游戏，分享一些制作小游戏的教程。
Unity3D从入门到进阶	入门	从自学Unity中获取灵感，总结从零开始学习Unity的路线，有C#和Unity的知识。
Unity3D之UGUI	UGUI	Unity的UI系统UGUI全解析，从UGUI的基础控件开始讲起，然后将UGUI的原理，UGUI的使用全面教学。
Unity3D之读取数据	文件读取	使用Unity3D读取txt文档、json文档、xml文档、csv文档、Excel文档。
Unity3D之数据集合	数据集合	数组集合：数组、List、字典、堆栈、链表等数据集合知识分享。
Unity3D之VR/AR（虚拟仿真）开发	虚拟仿真	总结博主工作常见的虚拟仿真需求进行案例讲解。
Unity3D之插件	插件	主要分享在Unity开发中用到的一些插件使用方法，插件介绍等
Unity3D之日常开发	日常记录	主要是博主日常开发中用到的，用到的方法技巧，开发思路，代码分享等
Unity3D之日常BUG	日常记录	记录在使用Unity3D编辑器开发项目过程中，遇到的BUG和坑，让后来人可以有些参考。