-
Notifications
You must be signed in to change notification settings - Fork 2.5k
编码规范
模型建立
1.1 数据库模型
表名: t_table_name
字段名: en_name
状态字段:
请采用 smallInt定义, 并且在描述字段中写如下格式,以便逆向成应用枚举:
enum_type
smallint(1) NOT NULL COMMENT '枚举描述,1:枚举1(enumOne);2:枚举2(enumTwo);3:枚举3(enumThree)'
1.2 应用模型
持久实体: TTableName
数据传输实体:DTableName
-
服务命名: 2.1 开放服务: os-serviceName 2.2 微服务: ms-serviceName
-
端口命名: 3.1 SpringCloud 系列占用端口: 2900* 3.2 微服务占用端口: 2800* 3.3 公共服务占用端口: 2700* 3.4 MQ或则其它占用端口 : 2600*
-
服务调用规则
-
开放服务 以REST方式中的 GET, POST, PUT,DELETE作为调用方式 例如: // 请求路径 请求方法 作用 // -/users HTTP GET 得到users // -/user HTTP POST 新增user // -/user/1 HTTP GET 得到id为1的user.class // -/user/1 HTTP PUT 更新id为1的user // -/user/1 HTTP DELETE 删除id为1的user
-
微服务 以REST方式中的 GET,POST作为调用方式. 例如:
- GET restTemplate.getForObject("http://" + SERVICE_NAME + "/user/" + id, User.class);
- POST restTemplate.postForObject("http://" + SERVICE_NAME + "/user/create", user, Integer.class); restTemplate.postForObject("http://" + SERVICE_NAME + "/user/update", user, Integer.class); restTemplate.postForObject("http://" + SERVICE_NAME + "/user/delete/" + id, null, Integer.class);
-
5. 异常处理:
区分业务异常与应用运行异常,采用枚举方式客户话提示信息
6. 微服务返回: CREATE, UPDATE, DELETE需要返回成功或者失败编码
7. 项目结构:
base-domain: 对应数据库的持久实体, 数据传输实体
common:公共代码库, 例如分页查询, 异常定义,服务请求头, 服务返回,
微服务:
ms-serviceName
开放服务项目结构:
os-serviceName
powered by Bosn@Alimama MUX
-
WIKI Home
- What is RAP
- Quick Guide
- User Manual
- Deploy Manual
- Dev Manual(writing)
- Wiki主页 (中文版)