cocos 轻量级游戏框架

说明

• 以个人实践为主，有些方案并非是最佳实践。
• 适用于轻量级游戏，单一场景，界面使用 prefab 进行管理。
• 适用于新手，仅包含一些基础的游戏模块。
• 为什么需要游戏框架？https://www.yuque.com/fengyong/game-develop-road/dmuel4

使用方法

• 拷贝 release 页面中的相应文件到自己的项目中。
  • fy-*.d.ts，是框架声明文件，需要拷贝到 assets 目录外。
  • fy-*.dev.js，是框架文件，需要拷贝到 assets 目录下，并设置为插件脚本。
  • fy-*.min.js，是框架压缩文件，用于代替 dev.js 文件。不推荐使用，因为我已不再开发游戏，缺少大量的实际测试，框架不可避免会有一些 bug，使用压缩文件不易 debug。
• 下载完整项目，执行 npm install && npm run build 命令，拷贝 dist 目录下的相应文件到项目中。
• 模块实现参考。

项目

工具依赖

• typescript
• eslint
• prettier
• jest
• rollup

目录

• src/ 框架源码
• dist/ 框架打包内容
• types/ 框架自定义声明文件
• .vscode/ vscode 配置
• .gitignore git 配置
• package.json 依赖配置
• package-lock.json
• rollup.config.js rollup 配置
• tsconfig.json typescript 配置
• .eslintrc.json eslint 配置
• .prettierrc prettier 配置
• .prettierignore
• jest.config.js jest 配置

设计规范

• 【去依赖】框架除依赖 cocos creator 之外，不依赖其他外部库。
• 【独立化】减少框架内模块的相互依赖。
• 【扁平化】文件即作为一个模块。模块中 export 的全部内容均处于全局 fy 下。针对部分模块不适合放在全局下的，可以额外添加 1 层。

命名规范

• 命名规范参考 .eslintrc.json 文件
• 方法名使用动宾结构 do_something 完整描述。 动词 | 含义 -- | -- get | 获取某个值。 set | 设置某个值。一般没有返回值。 change | 修改某个值。 to | 转义某个值。 do | 执行某个逻辑。 try | 尝试执行某逻辑，一般后面还需要一个动词。一般返回 boolean 表示是否执行成功。 is | 判断某个逻辑。不要使用 are 来做区分。 load | 载入某个资源，一般用于引擎资源载入。 init | 初始化某个模块。 call | 调用原生。 log | 生成 log 信息。 random | 获取某个随机值。 ... | ...
• 一般不要使用缩写。部分缩写含义如下： 缩写 | 完整含义 -- | -- ins | instance，实例。 wp | world position，世界坐标。 lp | local position，本地坐标。 ... | ...
• 一般不要使用前缀后缀。部分前后缀含义如下： 前缀后缀 | 含义 -- | -- config | 配置信息。 event | 事件名。 meta | 配置表脚本。 panel | 界面脚本。 params | 参数，一般为复数。 ... | ...

git commit message 规范

• 参考资料：http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html
• TODO：未来会增加自动 change log。
• 7 个标识： 标识 | 含义 -- | -- feat | 新功能。 fix | 修补 bug。 docs | 文档。 style | 格式。不影响代码运行的变动。 refactor | 重构。即不是新增功能，也不是修改 bug 的代码变动。 test | 增加测试。 chore | 构建过程或辅助工具的变动。

代码规范

• 代码次序为：
  1. 依赖：import/export/cc._decorator
  2. 特殊数据：C-常量配置数据/EVENT-事件
  3. 类型定义：enum/interface/type/class
  4. 常量，变量，方法
• 使用 undefined 而不是 null。二者几乎没差别，但 null 一般表示此处不应该有值，undefined 一般表示此处有应该有值但未定义。
• 使用 export 而不是 export default。
• 使用 export namespace（模块） 而不是 namespace（命名空间）。
• 优先使用 private 而不是 public。
• 一般不要使用 _ 作为命名的开头。例外情况是：这个方法需要被导出，但并不希望被使用。
• 使用箭头函数而不是 function。
• 将方法参数中，object 或 function 类型的参数，置于最后。
• 优先使用 implements（组合） 而不是 extends（继承）。
• 使用「双引号」或「反引号」而不是单引号。
• 使用「字符串字面量类型」或「字符串枚举」而不是「数字枚举」。
• 使用 forEach 或者其他高阶方法遍历而不是 for 循环。（for 循环的性能最高，在大数组遍历时可以使用）（高阶方法参考：https://www.yuque.com/fengyong/game-develop-road/gwv8xo ）。还应该避免在 for 循环时添加 break 和 return 逻辑，这样做会影响循环的语义性。