Skip to content

Latest commit

 

History

History
36 lines (29 loc) · 2.62 KB

promise.md

File metadata and controls

36 lines (29 loc) · 2.62 KB

代码相关约定

  • 各个INSTALLED_APP之间不要夸应用调用,避免APP之间参数依赖(其他APP可以依 applications/common)
  • 异常信息务必记录到SysLogger.error(e, exc_info=True)记录到日志里面,便于排查错误
  • 只定义了一个API 通过不同的请求方式,来执行不同的操作(查询用get 添加用post 更新用put 删除用delete参考

handlers层

  • 每个App应该有自己的CommonHandler,如无必要,请直接使用 from trest.handler import BaseHandler
  • handlers层 接受请求参数、校验参数,请求services,响应结果,后续处理调用;
  • 在handlers层不能直接调用models层
  • 在handlers层不能直接调用assemblers层

services层

  • services层 供handlers层或者其他脚本调用需要事务性的的功能,由它来引入models,操作数据库,比如用户注册功能;数据列表功能,都可以定义到services里面;
  • services层 方法return 数据类型,尽量以少些代码为原则,从数据库里面出来的是 对象,就直接返回,不要特意转化为字典类型了;如果是方法从多张表里面聚合数据,返回数据类型根据事情情况确定;
  • services层可以调用其他services层层;

models层

  • 所有模型通过“codegen.py”脚本自动生成,放到 applications/common/models/[model_name].py文件里,
  • models层 单纯的和数据表做映射关系,可以在这里添加虚拟熟悉,格式化数据等功能;

assemblers层

  • assemblers层,只对API协议需要的数据进行格式化组装(不在该层调用model或者其他service),如果API协议没有特殊需要,可以不定义相应的assembler
  • assemblers层不可以调用其他assemblers层

数据库相关约定

  • 尽可能不连表查询,在assemblers层组装API协议需要的数据格式;
  • 数据库密码经过AES加密,没有明文存储,进过AES加密的密码,格式 aes::: + ciphertext
  • 数据库使用utf8mb4编码
  • 数据库和时间相关的字段统一使用Unix时间戳格式 bigint(13),单位为毫秒
  • 数据库表的主键统一用 bigint(20)
  • 数据库和利息相关字段数据类型统一用 decimal(4,4)
  • 数据库和金额相关字段数据类型统一用 decimal(16,2)

其他约定