Guide.md
2.66 KB
#开发注意事项的简要说明#
- 运行日志存放位置：对于一般应用，存放于 /Common/Runtime/Apps/[app_name]/下，其中[app_name]是应用的唯一标识符，对于 Common 公共接口自身以及非应用日志，均存放于 /Common/Runtime/Logs 下
- 站点缓存目录： /Common/Runtime/Temp/[domain_md5_start]/[domain_md5_end]/[domain]/目录下，其中 [domain_md5_start]和[domain_md5_end]分别表示企业域名（xxx.vchangyi.com or qy.vchangyi.com/xxx/ 中的 “xxx”）小写后的md5值的第一位和最后一位。[domain]是企业域名
- 对于所有请求 Common 公共接口的。均要指定当前请求的应用唯一标识符，赋值给 “identifier” 参数。比如：http://qy.vchangyi.org/local/Common/Api/Test/List/Index?identifier=XXX
- 除非必要一般绝对不允许对 /Common 以及 /ThinkPHP 进行随意的修改提交，除非是专门负责框架以及公共接口的人员，同时，一般修改也需要知会其他研发人员并及时更新文档
- 原则上一个接口控制层文件内只有一个接口方法，并且该方法尽量逻辑简单，复杂的逻辑过程请拆分使用私有类方法来调用
- /Demo 是作为实验代码或者调试或者前瞻性的代码而存在的，尽量不要提交未经验证的代码而影响其他人使用，原则说也不推荐使用 /Demo 进行调试，推荐本地使用 /Developer 作为测试调试代码应用目录，该目录不会被提交（已在 git 忽略列表内）
- git 提交日志，推荐使用【identifier】和#fix#开头，当前提交的代码是哪个应用的就使用【xxx】开头，后面是描述；#fix#是作为代码 review 修改而做的提交，比如某些代码不规范。完整的格式是：第一行，如前所述，不超过50个字；后面几行罗列具体修改的项目列表；最后可以附加问题/Bug/需求等反馈的 URL 便于跟踪
- 关于接口以及系统拋错的错误码编码。首先要确保编码是唯一的，具体的规则是：xxxyzzz。其中：xxx是应用编码，由应用开发初始确定；y是端标记，目前1表示手机前台，4表示管理后台；zzz是应用具体的编码，可以按顺序处理，只要确保唯一即可
- 关于系统错误码，使用：4位编码，保持唯一性即可。 10.关于公共接口编码，使用：5位编码，保持唯一性即可。第一位使用端编码，目前：1表示手机前台；4表示管理后台 11.关于接口的返回，非必要情况下，错误码不允许被前端使用，即前端不允许直接利用错误码进行操作判断。 12.数据表设计必须保留四个字段：domain、status、created、updated、deleted