unity3d:GameFramework+xLua+Protobuf+lua-protobuf,生成.cs,.pb工具流

2024-06-09 03:12

本文主要是介绍unity3d:GameFramework+xLua+Protobuf+lua-protobuf,生成.cs,.pb工具流,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

概述

1.区分lua,cs用的proto
2.proto生成cs,使用protogen.exe,通过csharp.xslt修改生成cs样式
3.proto生成lua加载.pb二进制文件,并生成.pb列表文件,用于初始化加载
4.协议id生成cs,lua中枚举

区分cs,lua用proto

cs中序列化使用基于CSPacketBase,SCPacketBase的子类
lua中序列化使用lua-protobuf,需要提前把pb二进制文件加载
cs,lua中不通用协议类型,即某个协议类型只能在cs或者lua的一侧使用
使用两个文件夹区分,cs用的.proto放CS,lua用.proto放Lua文件夹下,在生成工具中分别处理

协议id生成cs,lua中

在NetMsgID.txt中填写所有lua,cs用的协议id(不区分lua用,还是cs用),例如

CSLogin = 100,
SCLogin = 101,
CSPlayerInfo = 102,
SCPlayerInfo = 103,
CSSelectCharacter = 104,
SCSelectCharacter = 105,

生成到对应的模板中,NetMsgIDTmpCS.cs

namespace Network
{
/// <summary>
/// 网络协议ID
/// </summary>
public enum NetMsgID
{
__Content__
}}

NetMsgIDTmpLua.lua

--网络协议ID
NetMsgID = 
{
__Content__
}

替换__Content__,再复制到工程目录中

static void GenMsgID()
{string sMsgContent = File.ReadAllText(m_msgIDFullName);string sMsgCS = File.ReadAllText(m_msgIDTmpCSFullName);string sMsgLua = File.ReadAllText(m_msgIDTmpLuaFullName);sMsgCS = sMsgCS.Replace("__Content__", sMsgContent); File.WriteAllText(m_msgIDCSFullName,sMsgCS);sMsgLua = sMsgLua.Replace("__Content__", sMsgContent);sMsgLua = sMsgLua.Replace("//", "--");File.WriteAllText(m_msgIDLuaFullName, sMsgLua);
}

proto生成cs

使用protogen.exe把.proto生成.cs文件

.net控制台遍历文件夹生成cs

protogen.exe单独使用如下,运行命令行,cd到protogen.exe的盘符,再cd 到protogen.exe的根目录下
把Person.proto放到protogen.exe的同级目录下。

protogen -i:Person.proto -o:Person.cs 

编写.net控制台程序执行
启动cmd并cd到protogen.exe根目录

using (Process p = new Process())
{//启动cmd,并设置好相关属性。p.StartInfo.FileName = "cmd.exe";p.StartInfo.UseShellExecute = false;    //是否使用操作系统shell启动p.StartInfo.RedirectStandardInput = true;//接受来自调用程序的输入信息p.StartInfo.RedirectStandardOutput = true;//由调用程序获取输出信息p.StartInfo.RedirectStandardError = true;//重定向标准错误输出p.StartInfo.CreateNoWindow = true;//不显示程序窗口p.StartInfo.WindowStyle = ProcessWindowStyle.Hidden;p.Start();//cmd要到protogen.exe的根目录string[] arrDiskName = Directory.GetCurrentDirectory().Split(':');string diskName = arrDiskName[0] + ":";p.StandardInput.WriteLine(diskName);string cdPath = "cd " + m_protoRootPath;p.StandardInput.WriteLine(cdPath);

遍历proto/CS目录下proto文件生成到工程目录

//遍历所有cs文件下proto
var files = new DirectoryInfo(m_protoPathCS).GetFiles("*.proto", SearchOption.AllDirectories);
foreach (var f in files)
{string fileName = f.Name.Replace(".proto", "");//生成cs{string sIn = " -i:proto/CS/" + f.Name;string sOut = " -o:" + m_csPath  + fileName + ".cs";string sCmd = protogenPath + sIn + sOut;p.StandardInput.WriteLine(sCmd);}
}

csharp.xslt修改输出cs样式

XSL 指扩展样式表语言(EXtensible Stylesheet Language), 它是一个 XML 文档的样式表语言。
XSLT 指 XSL 转换
通过 XSLT,您可以向输出文件添加元素和属性,或从输出文件移除元素和属性。

在csharp.xslt中载入自定义.xslt

  <xsl:import href="custom.xslt"/>

修改基类名

csharp.xslt中增加自定义函数getBaseClassName

public partial class <xsl:call-template name="pascal"/> <xsl:call-template name="getBaseClassName"> </xsl:call-template> 

custom.xslt中实现getBaseClassName

 <!-- 定义获取基类名方法 --><xsl:template name="getBaseClassName"><xsl:variable name = "className" ><xsl:call-template name="pascal"/></xsl:variable><xsl:choose ><xsl:when test="starts-with($className,'SC')"> : SCPacketBase</xsl:when><xsl:when test="starts-with($className,'CS')"> : CSPacketBase</xsl:when><xsl:otherwise> </xsl:otherwise></xsl:choose></xsl:template>

如果SC开头的类,增加基类为SCPacketBase,服务器给客户端包
如果SC开头的类,增加基类为CSPacketBase,客户端给服务器包

增加Clear函数

csharp.xslt中增加自定义函数methodClear

<xsl:call-template name = "methodClear" ></xsl:call-template>

custom.xslt中实现methodClear

<!-- 是否显示Clear方法模版 --><xsl:template name="methodClear"><xsl:variable name = "className" ><xsl:call-template name="pascal"/></xsl:variable><xsl:choose><xsl:when test="starts-with($className,'SC') or starts-with($className,'CS')"> //网络协议Idpublic override int Id { get {return (int)Network.NetMsgID.<xsl:value-of select="$className"/>;} } //回到引用池,变量设置初始化。如果是引用型成员变量也要回到引用池public override void Clear(){
//<xsl:value-of select="$className"/>Clear}</xsl:when><xsl:otherwise>//回到引用池,变量设置初始化。如果是引用型成员变量也要回到引用池public override void Clear(){
//<xsl:value-of select="$className"/>Clear}		</xsl:otherwise></xsl:choose></xsl:template>

协议类CS,SC开头类,子结构类都是基于引用池,需要实现Clear(),作用是回到引用池时,需要把变量置为初始值,这里先写入注释//className,等待cs进入unity工程时,通过正则再进一步处理
SC,CS协议类需要实现协议ID,这里对应NetMsgID.txt一一对应,例如协议类名为CSLogin,那么NetMsgID.txt有条内容为CSLogin = 100

正则表达式填充Clear中类成员设置默认值

上一步生成的Clear内容为

	public override void Clear(){
//CSLgoin}

需要对上一步生成Clear函数内填充内容,把类中成员设置为默认值,例如CSLogin填充为

	public override void Clear(){_account = "" ;_password = "" ;}

用正则匹配文本规则添加
1.遍历所有packet.cs文件
2.一个packet.cs文件中匹配类名@"public partial class (\w+) : ",一个可能包含1至N个Class。例如包含ClassA,ClassB
3.提取文件中类名开始到Clear结尾时一个类的部分,例如ClassA

    public static string GetClassContent(string fileContent,string className){string classContent = "";string pattern = "(?s)public partial class " + className + "(.*?)" + className + "Clear";//(?s):这是一个正则表达式的选项,称为“单行”模式(single-line mode),它使 . 匹配所有字符,包括换行符。Debug.Log(pattern);// // 创建正则表达式对象,使用 RegexOptions.Multiline 选项Regex regex = new Regex(pattern, RegexOptions.Multiline);// 执行匹配Match match = regex.Match(fileContent);if (match.Success){classContent = match.Groups[1].Value;Debug.Log(match.Groups[1].Value);}return classContent;}

4.ClassA中获取private变量,进行取的类型,默认值进行替换

    public static string GetClassMemberClear(string classContent){StringBuilder sbClear = new StringBuilder();string pattern = "private (.*?);";Regex regex = new Regex(pattern);// 执行匹配MatchCollection matches = regex.Matches(classContent);// 遍历所有匹配项foreach (Match match in matches){// 检查是否有成功的匹配if (match.Success){// 提取匹配的类名(捕获组1)string sMember = match.Groups[1].Value;Debug.Log("找到成员:" + sMember);  //string _account = ""string[] arrMember = sMember.Split(' ');string sType = arrMember[0];string sVariant = arrMember[1];//非引用池类型string clear = "";for (int i = 1; i < arrMember.Length; i++){clear += arrMember[i];clear += " ";}clear = clear + ";" + "\n";sbClear.Append("		" + clear);}}string sClear = sbClear.ToString();Debug.Log($"Clear中{sClear}");return sClear;}

注意,SC,CS类已经是引用池类,类中间不能再嵌套引用池为类成员

可以使用unity监听导入资源,对上一步产生的CS类再加工处理

    private static void OnPostprocessAllAssets(string[] importedAssets, string[] deletedAssets, string[] movedAssets, string[] movedFromAssetPaths){if (m_isEnable == false){//防止一边导入,一边处理又一边导入了return;}m_isEnable = false;for (int i = 0; i < importedAssets.Length; i++){string path = importedAssets[i];if (path.StartsWith("Assets/GameMain/Scripts/Network/Protobuf/ProtoCS")){//对生成cs类,处理clear函数PacketGenClear.GenClear2ProtoCS(path);}}m_isEnable = true;}

Protoc生成pb二进制文件

使用protoc.exe把.proto生成.pb二进制文件,用于lua中加载
基本使用

protoc -o addressbook.pb addressbook.proto

遍历文件夹生成.pd到工程目录

var luaProtoFiles = new DirectoryInfo(m_protoPathLua).GetFiles("*.proto", SearchOption.AllDirectories);
//遍历所有luaproto
foreach (var f in luaProtoFiles)
{string fileName = f.Name.Replace(".proto", "");//生成pb{string sIn = " proto/Lua/" + f.Name;string spbFullName = m_pbPath + fileName + ".pb";string sOut = " -o " + spbFullName;string sCmd = protocPath + sOut + sIn;p.StandardInput.WriteLine(sCmd);}m_sbProtoList.AppendLine(fileName);
}

生成pd列表文件

File.WriteAllText(m_protoListFullName, m_sbProtoList.ToString());

执行效果

在这里插入图片描述

生成cs类

[global::System.Serializable, global::ProtoBuf.ProtoContract(Name=@"CSLogin")]
public partial class CSLogin : CSPacketBase
{
public CSLogin() {}private string _account = "";
[global::ProtoBuf.ProtoMember(1, IsRequired = false, Name=@"account", DataFormat = global::ProtoBuf.DataFormat.Default)]
[global::System.ComponentModel.DefaultValue("")]
public string account
{get { return _account; }set { _account = value; }
}private string _password = "";
[global::ProtoBuf.ProtoMember(2, IsRequired = false, Name=@"password", DataFormat = global::ProtoBuf.DataFormat.Default)]
[global::System.ComponentModel.DefaultValue("")]
public string password
{get { return _password; }set { _password = value; }
} //网络协议Idpublic override int Id { get {return (int)Network.NetMsgID.CSLogin;} } //回到引用池,变量设置初始化。如果是引用型成员变量也要回到引用池public override void Clear(){_account = "" ;_password = "" ;}}

生成CS,pd流程图
在这里插入图片描述

这篇关于unity3d:GameFramework+xLua+Protobuf+lua-protobuf,生成.cs,.pb工具流的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1044082

相关文章

基于Python开发Windows自动更新控制工具

《基于Python开发Windows自动更新控制工具》在当今数字化时代,操作系统更新已成为计算机维护的重要组成部分,本文介绍一款基于Python和PyQt5的Windows自动更新控制工具,有需要的可... 目录设计原理与技术实现系统架构概述数学建模工具界面完整代码实现技术深度分析多层级控制理论服务层控制注

k8s admin用户生成token方式

《k8sadmin用户生成token方式》用户使用Kubernetes1.28创建admin命名空间并部署,通过ClusterRoleBinding为jenkins用户授权集群级权限,生成并获取其t... 目录k8s admin用户生成token创建一个admin的命名空间查看k8s namespace 的

基于Go语言开发一个 IP 归属地查询接口工具

《基于Go语言开发一个IP归属地查询接口工具》在日常开发中,IP地址归属地查询是一个常见需求,本文将带大家使用Go语言快速开发一个IP归属地查询接口服务,有需要的小伙伴可以了解下... 目录功能目标技术栈项目结构核心代码(main.go)使用方法扩展功能总结在日常开发中,IP 地址归属地查询是一个常见需求:

使用python制作一款文件粉碎工具

《使用python制作一款文件粉碎工具》这篇文章主要为大家详细介绍了如何使用python制作一款文件粉碎工具,能够有效粉碎密码文件和机密Excel表格等,感兴趣的小伙伴可以了解一下... 文件粉碎工具:适用于粉碎密码文件和机密的escel表格等等,主要作用就是防止 别人用数据恢复大师把你刚删除的机密的文件恢

Vue3 如何通过json配置生成查询表单

《Vue3如何通过json配置生成查询表单》本文给大家介绍Vue3如何通过json配置生成查询表单,本文结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录功能实现背景项目代码案例功能实现背景通过vue3实现后台管理项目一定含有表格功能,通常离不开表单

Java使用Javassist动态生成HelloWorld类

《Java使用Javassist动态生成HelloWorld类》Javassist是一个非常强大的字节码操作和定义库,它允许开发者在运行时创建新的类或者修改现有的类,本文将简单介绍如何使用Javass... 目录1. Javassist简介2. 环境准备3. 动态生成HelloWorld类3.1 创建CtC

Python从Word文档中提取图片并生成PPT的操作代码

《Python从Word文档中提取图片并生成PPT的操作代码》在日常办公场景中,我们经常需要从Word文档中提取图片,并将这些图片整理到PowerPoint幻灯片中,手动完成这一任务既耗时又容易出错,... 目录引言背景与需求解决方案概述代码解析代码核心逻辑说明总结引言在日常办公场景中,我们经常需要从 W

Python实战之SEO优化自动化工具开发指南

《Python实战之SEO优化自动化工具开发指南》在数字化营销时代,搜索引擎优化(SEO)已成为网站获取流量的重要手段,本文将带您使用Python开发一套完整的SEO自动化工具,需要的可以了解下... 目录前言项目概述技术栈选择核心模块实现1. 关键词研究模块2. 网站技术seo检测模块3. 内容优化分析模

C#使用Spire.XLS快速生成多表格Excel文件

《C#使用Spire.XLS快速生成多表格Excel文件》在日常开发中,我们经常需要将业务数据导出为结构清晰的Excel文件,本文将手把手教你使用Spire.XLS这个强大的.NET组件,只需几行C#... 目录一、Spire.XLS核心优势清单1.1 性能碾压:从3秒到0.5秒的质变1.2 批量操作的优雅

Python使用python-pptx自动化操作和生成PPT

《Python使用python-pptx自动化操作和生成PPT》这篇文章主要为大家详细介绍了如何使用python-pptx库实现PPT自动化,并提供实用的代码示例和应用场景,感兴趣的小伙伴可以跟随小编... 目录使用python-pptx操作PPT文档安装python-pptx基础概念创建新的PPT文档查看