|
|
@@ -1,3 +1,4 @@
|
|
|
+
|
|
|
# 基础框架
|
|
|
|
|
|
框架基于ruoyi-vue版本，做了部分优化改造，并命名为miaxis。
|
|
|
@@ -69,8 +70,9 @@ com.miaxis
|
|
|
```
|
|
|
|
|
|
# 后端开发流程
|
|
|
-1. 创建表，表结构规范参考
|
|
|
-2. 使用代码生成器
|
|
|
+## 创建表
|
|
|
+建表规范，参考表结构规范参考
|
|
|
+## 使用代码生成器
|
|
|
本次以sys_config举例，实际项目中不要去生成系统自带的sys开头的表，否则启动不了，因为代码模板不一样，有细微区别
|
|
|
打开后台管理系统，点击菜单——>系统工具——>代码生成
|
|
|
|
|
|
@@ -99,7 +101,7 @@ com.miaxis
|
|
|
|
|
|
到此，基本的增删改查代码已经生成。
|
|
|
|
|
|
-3. swagger文档使用
|
|
|
+## swagger文档使用
|
|
|
|
|
|
未登录授权前，接口无法调试
|
|
|
|
|
|
@@ -119,7 +121,8 @@ com.miaxis
|
|
|
|
|
|
|
|
|
# 后端开发规范
|
|
|
-1. 命名规范
|
|
|
+## 命名规范
|
|
|
+
|
|
|
* 命名使用英文词组合，使用驼峰式，严禁使用中文拼音或拼音首字母组合命名（专有名词例外） 如: OrganizationTreeNode, OrganizationVO, OrganizationDTO， 常量应该用全大写，下划线命名，如: APP_SECRET
|
|
|
* Controller, Service, Mapper统一添加到对应分层目录
|
|
|
* 接口实现类添加Impl后缀标识
|
|
|
@@ -127,19 +130,22 @@ com.miaxis
|
|
|
* 接口api路径，使用restful风格命名规范，简单来说，url上不允许出现动词，只能使用名次，动作由请求方式来制定：GET-获取 POST-新增
|
|
|
PUT-更新 DELETE-删除(可以参考代码生成器生成的代码)
|
|
|
|
|
|
-2. 返回值类型Response<T> ，泛型T一定要指定类型，否则swagger无法识别返回值具体数据格式以及注解，如
|
|
|
+## 返回值类型
|
|
|
+
|
|
|
+http请求固定返回类型Response ，泛型一定要指定类型，否则swagger无法识别返回值具体数据格式以及注解，如
|
|
|
+
|
|
|
```java
|
|
|
@GetMapping(value = "/{id}")
|
|
|
@ApiOperation("获取电子教学日志详细信息")
|
|
|
public Response<TMClassRecordDetail> getInfo(
|
|
|
@ApiParam(name = "id", value = "电子教学日志参数", required = true)
|
|
|
- @PathVariable("id") Long id
|
|
|
-){
|
|
|
+ @PathVariable("id") Long id){
|
|
|
+
|
|
|
return Response.success(tMClassRecordDetailService.getById(id));
|
|
|
}
|
|
|
|
|
|
```
|
|
|
-3. 异常
|
|
|
+## 异常
|
|
|
* Controller层，可直接使用Response.error ，重载了多个方法，根据具体情形使用
|
|
|
|
|
|
```java
|
|
|
@@ -171,7 +177,7 @@ private void validateCode(String principal, String credential) {
|
|
|
}
|
|
|
|
|
|
```
|
|
|
-4. 枚举类
|
|
|
+## 枚举类
|
|
|
|
|
|
原则上，代码中不应该出现魔法数字，比如下面代码
|
|
|
```java
|
|
|
@@ -213,7 +219,7 @@ if (type == UserStatusEnum.OK.getCode()){
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-5. 入参，出参
|
|
|
+## 入参，出参
|
|
|
|
|
|
如果传入参数与实体字段相差较大，可以新建DTO对象，DTO 意思为数据传输对象，包含了出参，入参，如果为了区分，也可以把入参命名为DTO，返参命名为VO
|
|
|
```java
|
