风格与约定
pomelo 有自己的风格以及一些约定,下面对其进行了简单的总结:
- pomelo 是一个框架,因此我们再编写的代码都是用来配置框架的,特别是要求我们自己定义一些框架所需的回调方法;
- 在 pomelo 中,无论是 component、handler、filter、module、remote 等等,它们在导出的时候,往往都会导出一个工厂函数,而不是直接导出对象,这样的话,就能够进行上下文的注入,同时在加载时可以传入一些配置参数。比起直接导出一个对象,更为灵活好用。在 pomelo 中也大量使用这种方式;
- pomelo 中,很多情况下,框架会从特定的地方读取配置和代码,因此代码组织要遵循 pomelo 的规范。在 game-server/app/servers 目录下书写服务器的代码。每一个服务器代码都分到名为 handler 和 remote 的两个目录下,它们分别描述了这个服务器接受客户端请求和接受 rpc 请求的服务端逻辑。因此,在 pomelo 中此目录结构很重要;
- pomelo 中命名风格基本上与常见的 java 中命名风格相同:
- 用于创建对象的函数全部首字母大写;
- 普通方法和对象的方法采用首单词小写字母开头,后面单词大写字母开头的方式,不使用下划线;
- 常量使用全大写,单词间使用下划线隔开,这种风格是非常常见的命名风格;
- 其他,关于编码风格以及编程模式方面,欢迎贡献。