首页 > 代码库 > Protobuf最佳实践(1)-- Sublime工程

Protobuf最佳实践(1)-- Sublime工程

本文以及后续的几篇文章,是我自己使用Protobuf的一些经验之谈。这些经验是我在开发游戏服务器时获得的,所以并不一定适用于其他领域。另外,这里所谓的最佳实践,其实包含了很多个人偏好。

Sublime工程

从某种程度上讲,Protobuf也算是一种语言,保存这种语言的文件一般以.proto作为后缀。既然是语言,那么就需要编译(它的编译器就是protoc),也需要一个语法着色的编辑器。只要花上几分钟的时间,就可以把Sublime打造成一个适合编写Protobuf的IDE,具体请参考这篇文章。

目录结构

我根据自己的情况,总结了一个Protobuf工程的目录结构,如下图所示:

下面是各个目录和文件的说明:

  • protoc-2.6.1-win32 这个文件夹里放了protoc的Windows版
  • generated protoc编译出来的Java或C++代码放在这个目录里
  • protos 这个目录里是分门别类的proto文件
    • enums 这个目录里放的是需要共享的枚举定义
    • dto 这个目录存放需要共享的DTO(Data Transfer Objects)定义
    • msg_xxx 按功能分类的消息定义
  • .sublime-project Sublime工程文件,里面包含工程目录结构,如何编译.proto文件,等信息
  • gen_java.bat 批处理文件,执行这个文件可以一次性编译所有的proto

Github

我已经把整个工程放到了Github上面。

Protobuf最佳实践(1)-- Sublime工程