关于当前node项目的框架扩展和编码规范补充
框架调整:
- 编写统一的错误处理的中间件
- 编写渠道信息(boys,girls,kids,lifestyle)处理的中间件
-
接口调用工具方法需要实现:
- 统一签名处理
- 接口返回默认处理的方法
- 接口返回可以覆写默认处理的方法
- 支持接口串行按顺序调用
- 接口方法需要展示调用的传参日志
- 接口方法对于错误的返回,需要打error的日志
编写默认模块页面模块的前置中间件(module,page)
编写url的app跳转的统一处理方法
统一404页面和错误页面的跳转和编写
获取req.user.uid,判断是否登录和当前用户的信息
资源位位置码单独提出一个文件,放在doraemon目录,统一管理
library独立出一个项目,作为一个私有依赖包,托管私库。
编码规范
- 错误异常,不能直接catch不处理,catch错误必须处理和日志打印(error),致命错误必须throw
- 給对象附加属性可以使用 assign 或者lodash的一些对象处理方法,不允逐一赋值许赋值。
- 所有的当前模块的常量,必须放在代码的顶部,加以注释
- 如果是全局的常量,必须要单独放在全局的doraemon目录,加以注释
- 日志添加,在model层必须在异常分支加error和warn日志,在正常重要分支加info(需要加一些必要的debug,参考express)
- 关于注释,每个方法必须要加注释(方法的意义,传参的解释,如果是工具方法:要加use case)
- 关键分支必须加注释,关键变量加注释,常量加注释
- 错误类型和消息需要统一放在doraemon目录
- 私有方法必须用
_
命名,放在当前模块最上面 - model层代码编写一致
- 禁止直接使用
console.log
打印日志,请使用library下的log模块
module.exprots = {
xxx: a,
yyy: b
...
}