一个SpringBoot项目的项目结构

红太狼 2022-11-12 02:45 193阅读 0赞

一个后端项目我们应该考虑如下问题：

*  ①：参数的接受及校验；
 *  ②：统一返回体；
 *  ③：统一异常处理；
 *  ④：代码生成器

### 1、参数的接受及校验 ###

我们可以通过自定义接受对象和返回对象来接受这个问题，再通过`@RequestBody`，`@RequestParam`和`@PathVariable`注解来进行参数获取。

**参数校验：**  
我们可以通过validation来解决这个问题，我们主要做三步：

*  引入组件：

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-validation</artifactId>
            </dependency>

*  给需要校验的字段上加注解

public class UserUpdateVM { 
    
        @NotBlank
        private String realName;
    
        private String age;
    
        private Integer sex;
    
        private String birthDay;
    
        private String phone;
    
        @NotNull
        private Integer userLevel;
    }

下面是常用的注解：

<table> 
 <thead> 
  <tr> 
   <th align="left">注解</th> 
   <th align="left">校验功能</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">@AssertFalse</td> 
   <td align="left">必须是false</td> 
  </tr> 
  <tr> 
   <td align="left">@AssertTrue</td> 
   <td align="left">必须是true</td> 
  </tr> 
  <tr> 
   <td align="left">@DecimalMax</td> 
   <td align="left">小于等于给定的值</td> 
  </tr> 
  <tr> 
   <td align="left">@DecimalMin</td> 
   <td align="left">大于等于给定的值</td> 
  </tr> 
  <tr> 
   <td align="left">@Digits</td> 
   <td align="left">可设定最大整数位数和最大小数位数</td> 
  </tr> 
  <tr> 
   <td align="left">@Email</td> 
   <td align="left">校验是否符合Email格式</td> 
  </tr> 
  <tr> 
   <td align="left">@Future</td> 
   <td align="left">必须是将来的时间</td> 
  </tr> 
  <tr> 
   <td align="left">@FutureOrPresent</td> 
   <td align="left">当前或将来时间</td> 
  </tr> 
  <tr> 
   <td align="left">@Max</td> 
   <td align="left">最大值</td> 
  </tr> 
  <tr> 
   <td align="left">@Min</td> 
   <td align="left">最小值</td> 
  </tr> 
  <tr> 
   <td align="left">@Negative</td> 
   <td align="left">负数（不包括0）</td> 
  </tr> 
  <tr> 
   <td align="left">@NegativeOrZero</td> 
   <td align="left">负数或0</td> 
  </tr> 
  <tr> 
   <td align="left">@NotBlank</td> 
   <td align="left">不为null并且包含至少一个非空白字符</td> 
  </tr> 
  <tr> 
   <td align="left">@NotEmpty</td> 
   <td align="left">不为null并且不为空</td> 
  </tr> 
  <tr> 
   <td align="left">@NotNull</td> 
   <td align="left">不为null</td> 
  </tr> 
  <tr> 
   <td align="left">@Null</td> 
   <td align="left">为null</td> 
  </tr> 
  <tr> 
   <td align="left">@Past</td> 
   <td align="left">必须是过去的时间</td> 
  </tr> 
  <tr> 
   <td align="left">@PastOrPresent</td> 
   <td align="left">必须是过去的时间，包含现在</td> 
  </tr> 
  <tr> 
   <td align="left">@PositiveOrZero</td> 
   <td align="left">正数或0</td> 
  </tr> 
  <tr> 
   <td align="left">@Size</td> 
   <td align="left">校验容器的元素个数</td> 
  </tr> 
 </tbody> 
</table>

*  Controller中方法添加`@valid`注解

@PostMapping("register")
    public Result register(@RequestBody @Valid UserRegisterVM vm){ 
    	...
    }

### 2、统一返回体 ###

常见的返回体如下：

public class Result<T> { 
        private int code;
        private String message;
        private T response;
        ...
    }

再搭配上系统状态类

public enum  SystemCode { 
        /** * 成功 */
        OK(1, "成功"),
        AccessTokenError(400, "用户登录令牌失效"),
        UNAUTHORIZED(401, "用户未登录"),
        AuthError(402, "用户名或密码错误"),
        InnerError(500, "系统内部错误"),
        ParameterValidError(501, "参数验证错误"),
        AccessDenied(502,"用户没有权限访问");
    
        int code;
        String message;
        
        ...
    }

我们再往Result类上添加一些静态方法，就很ok

public class Result<T> { 
        ...
        public static Result ok(){ 
            SystemCode ok = SystemCode.OK;
            return new Result(ok.getCode(),ok.getMessage());
        }
    
        public static<F> Result<F> ok(F data){ 
            SystemCode ok = SystemCode.OK;
            return new Result<>(ok.getCode(),ok.getMessage(),data);
        }
    
        public static Result fail(Integer code,String message){ 
            return new Result(code,message);
        }
    }

### 三、统一异常捕获 ###

使用`ControllerAdvice`\+`@ExceptionHandler`就可以解决，增强controller，对其抛出的Exception进行捕获。`MethodArgumentNotValidException`是validation校验失败后抛出的异常，`BindException`是前后端数据绑定失败抛出的异常，比如日期格式不正确。

@ControllerAdvice
    public class ExceptionHandle { 
       
        @ExceptionHandler(MethodArgumentNotValidException.class)
        @ResponseBody
        public Result handler(MethodArgumentNotValidException e) { 
    		...
        }
    
        @ExceptionHandler(BindException.class)
        @ResponseBody
        public Result handler(BindException e) { 
    		...
        }
    }

### 四、代码生成器 ###

使用intelllij IDEA编辑器推荐使用Easy-Code插件，好用，点赞！  
[EasyCode使用传送门][EasyCode]

[EasyCode]: https://www.jianshu.com/p/e4192d7c6844