项目风格和规范
[TOC]
严格按照《阿里巴巴Java开发手册》进行代码编写。
IDEA安装阿里规约插件 Alibaba Java Coding Guidelines
使用 swagger2 的注解自动生成文档
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
</dependency>
{
"success":true,
"data":{}
}
{
"success":false,
"code": 404,
"msg":"数据不存在"
}
包的功能
文件夹名 | 功能 |
---|---|
controller | 访问路由 |
handler | 业务处理 |
service | 数据接入服务封装,可以做缓存功能 |
repository | 数据接入 |
component | 共同业务逻辑 |
domain | 前端数据实体 |
entity | 数据库实体 |
constants | 常量,枚举 |
mapper | 数据库实体转换成前端数据实体 |
包之间调用
graph TD
A[controller]-->|domain|B[handler]
B-->|entity|F[mapper]
F-->|domain|B
B-->|entity|C[service]
B-->|domain|E[component]
E-->|domain|E
E-->|entity|C
C-->|entity|D[repository]
E-->|entity|G[mapper]
G-->|domain|E
使用validator做基础数据校验,比如Null,空字符串等