记录golang+cocos creator3.x + protobuf协议的坑

首先我的proto文件结构如下图


image.png

按照这样的proto文件夹结构生成对应go/js/ts 代码的话,message 相互调用是不可避免的,而golang 的导入 import和protobufjs的导入的 import是不一样的。

例如:Golang:

import "common/models/user/user.proto";

而 protobufjs 按照这样的 import 导入是找不到 user.proto文件的,所以我们需要把 import改为一个相对路径,如下

import "../user/user.proto";

再次执行 pbjs -t static-module -w commonjs -o chat.js chat.proto 就没有找不到 user.proto的错误了。

当然除此之外也可以把所有 proto文件放在一个文件夹内,用生成所有的proto 文件命令也不会报错。pbjs -t static-module -w commonjs -o all.js *.proto

以上两种方式生成完毕后还需要手动去修改几个地方才可以再cc 中使用

1.修改生成的js文件中的$protobufjs和root

原:
var $protobuf = require("protobufjs/minimal");
修改为:
var $protobuf = protobuf;

原:
var $root = $protobuf.roots["default"] || ($protobuf.roots["default"] = {});
修改为:
const $root = $protobuf.roots.creator3 || ($protobuf.roots.creator3 = $util.global);

2.如果你的proto文件中有 uint64/int64的变量时需要在ts文件导入 long

import { Long } from "protobufjs";

3.解决proto中引用问题

生成的ts源文件为:
import * as $protobuf from "protobufjs";
export namespace user {
  //省略中间代码
}

修改为

import * as $protobuf from "protobufjs";
import { Long } from "protobufjs";

declare global {
  export namespace user {
  //省略中间代码
  }
}
export { user as default };

最后代码中使用

let msg = user.LoginReq.create({LoginName: username, LoginPW: password})
let buffer = user.LoginReq.encode(msg).finish()
let sendData = ProtocolUtils.getInstance().getDataPack(1002, buffer)
NetManager.getInstance().send(sendData)

最后在将上述操作写为脚本
下面的两个shell 脚本路径是和我首图项目中的common处于同级,另外是用于mac,其他操作系统可能有些函数的不兼容,需要自己做下修改
Golang:

# shellcheck disable=SC2239

#!bin/sh
function deleteGoFile(){
  for file in `ls $1`
  do
     if [ -d $1"/"$file ]
       then
        deleteGoFile $1"/"$file
     else
        if [ "${file##*.}" = "go" ]
          then
            rm -f $1"/"$file
        fi
   fi
  done
}

function addGoFile(){
  for file in `ls $1`
  do
     if [ -d $1"/"$file ]
       then
        addGoFile $1"/"$file
     else
        if [ "${file##*.}" = "proto" ]
           then
             echo $1"/"$file
           protoc --go_out=. $1"/"$file
        fi
   fi
  done
}
deleteGoFile common/models
addGoFile common/models

cocos creator


# shellcheck disable=SC2239

#!bin/sh
function cpDirs(){
  for file in `ls $1`
    do
    cp -r $1"/"$file "/Users/luffy/Desktop/ts_protos"
  done
}

resetProtoFileContent(){
  for file in `ls $1`
      do
      if [ -d $1"/"$file ]
         then
            resetProtoFileContent $1"/"$file
         else
              if [ "${file##*.}" = "proto" ]
                 then
                   #注意这里是mac的sed用法
                sed -i '' 's/import "common\/models/import "../g' $1"/"$file
              fi
      fi
    done
}


function addJsFile(){
  for file in `ls $1`
  do
     if [ -d $1"/"$file ]
       then
        addJsFile $1"/"$file
     else
        if [ "${file##*.}" = "proto" ]
           then
            cd $1 && pbjs -t static-module -w commonjs -o ${file%.*}".js" $file
        fi
   fi
  done
}

function addTsFile(){
  for file in `ls $1`
  do
     if [ -d $1"/"$file ]
       then
        addTsFile $1"/"$file
     else
        if [ "${file##*.}" = "proto" ]
           then
            cd $1 && pbts -o ${file%.*}".d.ts" ${file%.*}".js"
        fi
   fi
  done
}

function resetJsFileContent() {
     for file in `ls $1`
      do
         if [ -d $1"/"$file ]
           then
            resetJsFileContent $1"/"$file
         else
            if [ "${file##*.}" = "js" ]
               then
                sed -i '' 's/require("protobufjs\/minimal");/protobuf;/g' $1"/"$file
                sed -i '' '10d' $1"/"$file
                sed -i '' '10i\
const $root = $protobuf.roots.creator3 || ($protobuf.roots.creator3 = $util.global);\
' $1"/"$file
                sed -i '' '$d' $1"/"$file
            fi
       fi
      done
}

function resetTsFileContent() {
     for file in `ls $1`
      do
         if [ -d $1"/"$file ]
           then
            resetTsFileContent $1"/"$file
         else
            if [ "${file##*.}" = "ts" ]
               then
                  sed -i '' '2i\
import { Long } from "protobufjs";\
\
declare global {\
\
' $1"/"$file

                  sed -i '' "\$a\\
}\\
\\
export {${1##*/} as default};"  $1'/'$file

            fi
       fi
      done
}

#在桌面创建一个中间文件夹 生成js/ts
rm -rf /Users/luffy/Desktop/ts_protos
mkdir /Users/luffy/Desktop/ts_protos
cpDirs common/models
resetProtoFileContent /Users/luffy/Desktop/ts_protos #修改原proto文件 import 为相对路径
addJsFile /Users/luffy/Desktop/ts_protos
resetJsFileContent /Users/luffy/Desktop/ts_protos
addTsFile /Users/luffy/Desktop/ts_protos
resetTsFileContent /Users/luffy/Desktop/ts_protos

最后将生成的ts / js文件拖入cocos creator 中就行了。
顺便说一下,这样的情况 ts 文件会报错,原因是有引用其他包message,也会在当前ts 文件中写出来。可以不用去管它,不影响项目,也可以手动或者在脚本中删除。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,076评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,658评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,732评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,493评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,591评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,598评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,601评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,348评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,797评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,114评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,278评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,953评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,585评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,202评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,442评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,180评论 2 367
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,139评论 2 352

推荐阅读更多精彩内容