工程名

• 在 Java Group 下创建项目
• 命名以 *-api 结尾，能尽量体现业务含义，简单好理解

代码结构

• 推荐使用单模块风格代码结构
• 公共一方库或二方库可作为独立工程进行维护

框架引入

所有 Java 微服务工程需引入统一框架包，目前最新的 RELEASE 版本为 2.2.0 （以实际版本为准）

生产环境禁止引用框架包的 SNAPSHOT 版本

日志记录

• 使用框架提供的API进行日志记录，禁止直接使用log4j、logback等
• 框架会自动记录 Controller 层、Dao 层的性能日志
• 对于未捕获的500错误，框架会自动记录异常日志
• 其他业务异常日志、系统异常日志按实际业务需求处理

Http 状态码

• 500 统一由框架进行设置和处理
• 502、503、504，业务层不允许返回以上状态码

监控报警

配置中心

网关接入

• 网关类型
  • c-api-gateway
    • C端网关，服务于C端用户调用，例如：小程序
  • op/mp-api-gateway
    • B端网关，服务于OP/MP（运营/商户）系统的ajax接口调用，统一解决跨域、认证授权问题
  • open-api-gateway
    • 三方网关，用于三方系统调用HQT系统使用

除 Feign 调用外，其余调用方式均需接入统一网关

接口性能

• 原则上要求单个接口的响应时间 < 200ms
• 单机QPS不低于200