Ceobe-Canteen-Serve

• git emoji 以后提交用这个吧

启动配置文件

启动配置文件支持 *.toml,*.json,*.yaml 可以将配置不同部分分布在不同的文件中（不推荐）

• 配置项介绍

  所属分组	名称	必须	类型	说明	补充
  database/db	scheme	是	String	数据库的 scheme,如 mysql	无
  database/db	username	是	String	数据库的 用户名	无
  database/db	password	是	String	数据库的 密码	无
  database/db	host	否	String	数据库的 host	默认为 localhost
  database/db	port	否	u16	数据库的 port	默认为3306
  database/db	name	是	String	使用的数据库名称	无
  database/db	max_conn	是	u32	数据库的最大连接数	无
  database/db	min_conn	是	u32	数据库的最小连接数	无
  database/db	logger	否	bool	是否开始数据库操作日志	默认关闭
  logger/log	to_stdout	否	bool	同时将日志输出到 Stdout	默认为 true
  logger/log	to_file	否	String	同时将日志输出的文件	有值将会同时将日志输出到指定文件
  logger/log	level	是	off 或者 error或者 warm 或者 info 或者 debug
  或者 trace	日志输出过滤等级	无
  resp_result/ rresult	body	是	String	响应成功时的响应体字段名称	无
  resp_result/ rresult	err-msg	是	String	响应失败时异常字段名称	无
  resp_result/ rresult	fix-field	是	bool	响应体固定字段	如果无需该字段值将为null
  resp_result/ rresult	bool-status	否	Option<String>	使用一个 bool 类型标记响应成功与否
  该字段缺省表示不使用
  resp_result/ rresult	body-extra-err	否	Option<String>	额外的异常信息在响应体中字段
  该字段缺省表示不使用
  resp_result/ rresult	header-extra-err	否	Option<String>	额外的异常信息在响应头中的字段名称
  该字段缺省表示不使用
  mongodb/ mongo	username	是	String	Mongodb 进行数据库连接使用的用户	该用户需要完整 Admin 权限
  mongodb/ mongo	password	是	String	Mongodb 进行数据库连接使用的用户密码	无
  mongodb/ mongo	host	否	String	Mongodb 进行数据库连接使用的 host	默认为localhost
  mongodb/ mongo	port	否	String	Mongodb 进行数据库连接使用的端口	默认为27017
  mongodb/ mongo	db_name	是	String	Mongodb 进行数据库连接使用的数据库	无
  mongodb/ mongo	query	否	HashMap<String, String>	Mongodb 进行数据库连接使用的参数	默认为{}
  user_auth/ auth	jwt/jwt-key	否	String	用户鉴权使用的Jwt密钥	最大长度不超过 32 位。过长部分将会被截断，过短部分将会被随机数填充
  user_auth/ auth	header/header_name	否	String	获取 token 的 Header	默认为Token
  user_auth/ auth	mob_header	否	String	获取 mob_id 的 Header	默认为mob-id
  admin_user/ user	username	是	String	默认后台第一个最高权限用户名
  admin_user/ user	password	是	String	默认后台第一个最高权限密码
  http_listen/ http	host	否	IpAddr	http 监听的 host	默认为127.0.0.1
  http_listen/ http	port	否	u16	http 监听的 port	默认为8000
  qiniu/ qiniu_secret	access_key	是	String	七牛云的 Access Key
  qiniu/ qiniu_secret	secret_key	是	String	七牛云的 Secret Key
  qiniu/ qiniu_secret	bucket	是	String	所有要使用的 Bucket(篮子)	必填
  redis	password	是	String	Redis 进行数据库连接使用的用户密码	无
  redis	host	否	String	Redis 进行数据库连接使用的 host	默认为localhost
  redis	port	否	u16	Redis 进行数据库连接使用的端口	默认为6379
  redis	db	是	u8	Redis 进行数据库连接使用的数据库	默认为0

• Toml

  [db]
  scheme="mysql"
  username="<db_user>"
  password="<db_pwd>"
  
  host="localhost"
  port=3306
  
  name="mansion_data"
  max_conn=16
  min_conn=2
  
  logger=true
  
  [log]
  level = "debug"
  to_file = "./logout.log"
  to_stdout = true
  
  [rresult]
  body = "body"
  err-msg = "e-msg"
  fix-field = false
  bool-status = "is-ok"
  body-extra-err = "status"
  
  [mongo]
  username = "<db-user>"
  password = "<db-pwd>"
  db_name = "ceobe-canteen"
  host = "localhost"

• Yaml

  log:
    to_file: ./logout.log
    level: info

• Json

  {
    "db": {
      "password": "pwd",
      "name": "name"
    }
  }

异常

• 前缀类型说明

  前缀	说明
  F	服务器异常
  D	数据库异常
  G	MongoDb 异常
  I	IO 过程异常
  P	数据转换时异常
  C	数据校验异常
  S	资源查找异常
  M	数据未变更
  A	权限认证异常
  Q	七牛云上传异常
  L	日志报告异常

• 服务异常

  前缀	异常码	httpCode	说明
  F	0001	500	服务器发生未预期 Panic
  F	0002	500	管道发生未预期关闭

• Io 异常

  前缀	异常码	httpCode	说明
  I	0001	500	std::io::Error
  I	0002	500	core::fmt::Error

• 类型转换异常

  前缀	异常码	httpCode	说明
  P	0001	400	Url 转化异常
  P	0002	400	数字转换异常
  P	0003	400	jwt 转换异常
  P	0004	400	日期转换异常
  P	0005	500	字符串编码异常
  P	0006	400	http 请求头内容解析异常
  P	0007	500	非法 Http 请求头内容
  P	0008	500	UUID解析异常

数据校验异常

| 前缀 | 异常码 | httpCode | 说明 | |:-----:|:----:|:--------:|:------------------------------------| | C | 0001 | 400 | 范围检查未通过 | | C | 0002 | 400 | 饼学大厦 id 格式不是 {int}.{int} | | C | 0003 | 400 | 错误的 Fraction 值范围(0~5) | | C | 0004 | 400 | Json 序列化/反序列化异常 | | C | 0005 | 400 | Path 数据加载异常 | | C | 0006 | 400 | 未知的预期确信度等级 | | C | 0007 | 400 | Query 加载异常 | | C | 0008 | 409 | 饼学大厦的 Id 已经存在 | | C | 0009 | 400 | BV 号格式错误 | | C | 000A | 400 | 版本号格式错误 | | C | 000B | 409 | 版本号已经被使用 | | C | 000C | 400 | Bincode 序列化/反序列化异常 | | C | 000D | 500 | 存在多个可用的资源全可用的记录 | | C | 000E | 400 | 预期为 0 值取得非 0 值 | | C | 000F | 400 | 获取MultiPart异常 | | C | 0010 | 400 | 解析MultiPart异常 | | C | 0011 | 400 | MultiPart Field 不存在 | | C | 0012 | 500 | 平台下存在数据源，无法删除平台 | | C | 0013 | 400 | 未找到平台 | | C | 0014 | 400 | {origin} 无法被 {RHS} 整除，余数{rem} | | C | 0015 | 400 | Json 对象不符合预期 | | C | 0016 | 400 | Bson 序列化异常 | | C | 0017 | 409 | 版本号过旧 | | C | 0018 | 403 | 正在试图抹除自身存在 |

• 数据库异常（SeaOrm）

  前缀	异常码	httpCode	说明
  D	0001	500	数据库连接失败
  D	0002	500	数据库请求操作失败
  D	0003	500	数据库查询失败
  D	0004	500	数据库记录不存在
  D	0005	500	数据库 CustomError
  D	0006	500	数据库类型转换失败
  D	0007	500	数据库类型序列化失败
  D	0008	500	数据库 Migrate 失败

• 数据库异常（MongoDb）

  前缀	异常码	httpCode	说明
  G	0001	500	非法参数
  G	0002	500	权限不足
  G	0003	500	Bson反序列化失败
  G	0004	500	Bson序列化失败
  G	0005	500	Bson序列化失败
  G	0006	500	写冲突
  G	0007	500	指令错误
  G	0008	500	DNS处理异常
  G	0009	500	网络异常
  G	0010	500	Io 异常
  G	0011	500	非法响应
  G	0012	500	客户端无法选择数据库服务
  G	0013	500	客户端未提供 Session
  G	0014	500	非法 TLS 配置
  G	0015	500	写入异常
  G	0016	500	事务异常
  G	0017	500	服务不可用异常
  G	0018	500	数据库不存在
  G	0019	500	数据库中集合不存在

• Redis 异常

  前缀	异常码	httpCode	说明
  R	0001	500	无效响应
  R	0002	500	权限不足
  R	0003	500	类型不匹配
  R	0004	500	脚本执行终止
  R	0005	500	正在加载转储，无法响应
  R	0006	500	请求脚本不存在
  R	0007	500	给客户端的参数错误
  R	0008	500	键移动到不同的节点
  R	0009	500	密钥移动到不同节点且访问
  R	0010	500	需要重试请求
  R	0011	500	redis 集群关闭
  R	0012	500	一个请求跨越多个槽
  R	0013	500	集群主机不可用
  R	0014	500	redis 错误不是系统本身的错误
  R	0015	500	在执行之前在客户端上识别出的错误
  R	0016	500	扩展错误
  R	0017	500	尝试写入只读服务器

• 数据未变更

  前缀	异常码	httpCode	说明
  M	0001	304	Ceobe 在当前提供时间戳下无更新

• 资源查找异常

  前缀	异常码	httpCode	说明
  S	0001	404	指定饼学大厦未找到
  S	0002	404	不存在的路由
  S	0003	500	发起请求时出现异常
  S	0004	404	版本号不存在
  S	0005	404	暂没有版本信息
  S	0006	500	不存在可用的资源全可用的记录

• | S | 000A | 404 | 不存在可用的资源全可用的记录 |

• 权限认证异常

  前缀	异常码	httpCode	说明
  A	0001	401	缺少 Token 字段
  A	0002	401	权限不足
  A	0003	404	Token 对应信息不存在
  A	0004	401	密码错误
  A	0005	500	密码处理错误
  A	0006	401	Token 失效
  A	0007	404	用户不存在
  A	0008	400	用户已经被使用
  A	0009	400	密码未更改
  A	000A	500	缺少用户鉴权中间件

• 七牛云上传异常

  前缀	异常码	httpCode	说明
  Q	0001	500	上传七牛云时出现异常

• 日志报告异常

  |前缀 | 异常码 | httpCode | 说明| | :--: | :----: | :------: | :------------------- | | L | 0001 | 500 | 与Grpc服务端建立连接失败 | | L | 0002 | 500 | Grpc service 返回异常响应 | | L | 0003 | 500 | 发送日志时收到失败响应 |