cocos2dx 3.x 集成protobuf

vs2013+cocos2dx 3.13.1

这篇博文是集成Lua版本的protobuf，集成C++版本的过程也可参考。

主要参考博文地址《cocos2dx 3.x C++搭建protobuf环境》，这里的集成方式和参考博文有点不一样（这里是直接集成到引擎中，参考博文是当成一个库放到项目中），请仔细甄别。

1.下载pbc

①下载地址 pbc：https://github.com/cloudwu/pbc

②解压后的文件列表，我们所需要的就是如下图的三个文件(夹)里的文件。（其中binding文件夹中包含了lua和lua53两个文件夹，因为cocos2dx集成的lua版本是5.1，所以我们使用lua文件夹，而不用lua53文件夹）

③其实就分两部分，一部分是C++部分(pbc.h和src文件夹)，一部分就是C++绑定到lua部分(binding文件夹中lua文件夹)

2.将C++部分的代码集成到libcocos2d项目中

①在libcocos2d项目external文件夹中增加新的pbc文件夹，将pbc.h文件和src文件夹中的文件拷贝到里面去，并添加到项目中

②修改pbc.h文件

因为libcocos2d项目是一个dll项目，所以需要导出必要的函数让libluacocos2d项目进行调用，导出的函数前需要增加CC_DLL前缀。

首先include相应头文件，因为CC_DLL的定义在CCPlatformMacros.h中

然后给所有（所有！）函数前增加CC_DLL前缀，如下图只罗列了其中几个

③编译libcocos2d项目

3.将C++绑定到lua部分集成到libluacocos2d项目中

①在libluacocos2d项目中manual文件夹中增加新的pbc文件夹，并将pbc-lua.c文件拷贝（从bunding/lua中拷贝）进去，并新增（新增！）三个用于绑定的文件pbc-lua.h/lua_cocos2dx_pbc_manual.h/lua_cocos2dx_pbc_manual.cpp。如下图

②修改pbc-lua.c文件（只修改前面部分），入下图

③pbc-lua.h内容

#pragma once
#ifdef __cplusplus
extern "C" {
#endif
#include "lua.h"
#include "lualib.h"
#include "lauxlib.h"

#ifdef __cplusplus
}
#endif

#ifdef __cplusplus
extern "C" {
#endif
    int luaopen_protobuf_c(lua_State *L);
#ifdef __cplusplus
}
#endif

④lua_cocos2dx_pbc_manual.h内容

#pragma once

#ifdef __cplusplus
extern "C" {
#endif
#include "tolua++.h"
#ifdef __cplusplus
}
#endif

TOLUA_API int  register_pbc_module(lua_State* L);

⑤lua_cocos2dx_pbc_manual.cpp内容

#include "scripting/lua-bindings/manual/pbc/lua_cocos2dx_pbc_manual.h"

#include "platform/CCPlatformConfig.h"
#include "base/ccConfig.h"
#include "scripting/lua-bindings/manual/tolua_fix.h"
#include "scripting/lua-bindings/manual/LuaBasicConversions.h"
#include "scripting/lua-bindings/manual/CCLuaEngine.h"

#include "scripting/lua-bindings/manual/pbc/pbc-lua.h"

#include "cocos/platform/CCFileUtils.h"

int read_protobuf_file(lua_State *L){
    const char *buff = luaL_checkstring(L, -1);
    Data data = cocos2d::FileUtils::getInstance()->getDataFromFile(buff);
    lua_pushlstring(L, (const char*)data.getBytes(), data.getSize());
    return 1; 
}

TOLUA_API int register_pbc_module(lua_State* L)
{
    lua_getglobal(L, "_G");
    if (lua_istable(L, -1))//stack:...,_G,
    {
        lua_register(L, "read_protobuf_file_c", read_protobuf_file);
        luaopen_protobuf_c(L);
    }
    lua_pop(L, 1);
    return 1;
}

⑥在cocos2d-x\cocos\scripting\lua-bindings\manual\lua_module_register.cpp中进行注册

⑦编译libluacocos2d项目

以上，lua的在项目中的集成就完成了。下面来进行lua项目的验证。

4.在lua项目中的使用

①在bunding/lua中拷贝两个文件parser.lua/protobuf.lua到lua项目src中，然后在init.lua中进行require。

②定义MsgProtocol.proto文件

message Person {
  required string name = 1;
  required int32 id = 2;
  optional string email = 3;

  enum PhoneType {
    MOBILE = 0;
    HOME = 1;
    WORK = 2;
  }

  message PhoneNumber {
    required string number = 1;
    optional PhoneType type = 2 [default = HOME];
  }

  repeated PhoneNumber phone = 4;
}

message AddressBook {
  repeated Person person = 1;
}

③使用protoc.exe（这个工具需要到protobuf官方网站下载或者编译得到官网:https://github.com/google/protobuf/releases）生成MsgProtocol.pb文件

protoc.exe --descriptor_set_out=./MsgProtocol.pb ./MsgProtocol.proto

④将生成的MsgProtocol.pb放到资源res文件夹中！

⑤相关验证使用的Lua代码

local pbFilePath = cc.FileUtils:getInstance():fullPathForFilename("MsgProtocol.pb")
    release_print("PB file path: "..pbFilePath)
    
    local buffer = read_protobuf_file_c(pbFilePath)
    protobuf.register(buffer) --注:protobuf 是因为在protobuf.lua里面使用module(protobuf)来修改全局名字
    
    local stringbuffer = protobuf.encode("Person",      
        {      
            name = "Alice",      
            id = 12345,      
            phone = {      
                {      
                    number = "87654321"      
                },      
            }      
        })           
    
    
    local slen = string.len(stringbuffer)
    release_print("slen = "..slen)
    
    local temp = ""
    for i=1, slen do
        temp = temp .. string.format("0xX, ", string.byte(stringbuffer, i))
    end
    release_print(temp)
    local result = protobuf.decode("Person", stringbuffer)
    release_print("result name: "..result.name)
    release_print("result name: "..result.id)