Owork.connect.buildproto NPM

owork.connect.buildproto

介绍

命令行工具
生成数据传输协议使用的消息类型码的相关类文件(typescript文件/javascript文件)

安装

建议全局安装:
npm i -g owork.connect.buildproto

使用

#要求proto进行一些特殊的注释:

//message的上一行起始,加上这个固定前缀"//MessageTypeCode=",后面跟上类型码即可,如下:

//MessageTypeCode=10001
message Test1
{
 int32 a = 1;
}

#命令行:

oworkbuildmsgc "dir" [--buildopcodets] [--buildopcodejs]

参数	说明
dir	将该目录下的所有proto文件,都生成对应的.cs类文件,如果有定义类型码或继承类型,则会再生成.IMPart.cs
buildopcodets	如果proto文件有定义类型码的话,会同时生成类型码的TypeScript文件
buildopcodejs	如果proto文件有定义类型码的话,会同时生成类型码的JavaScript文件

例子

#文件"d:\proto\Project1.proto"

syntax = "proto3";
package Test.Project1;

//通知断开连接
//MessageTypeCode=10000
message Disconnect //:FzCyjh.IM.IMessageBody
{
	int32 Error = 91;
	string Message = 92;
}

#命令行

oworkbuildmsgc "d:\proto\" --buildopcodets

#得到类型码的ts文件

export class testMessageTypeCodes {
    public static Login:number = 10001;
    public static LoginResult:number = 10002;
    public static CodeToName :{[key: string]:string} = {  "Op_10001": "Login" , "Op_10002": "LoginResult"  };
}