SpringBoot统一接口数据格式、数据加密、全局异常处理

科技 08-20 来源： 程序小舟

目前开发大都是前后端分离模式，一套规范的接口是非常有必要的，不仅能够提高对接效率，而且能提高代码的可阅读性。本文主要介绍了统一接口数据封装、全局异常处理等。

1、统一接口格式

  • 定义返回数据对象
@Datapublic class Result {private int code;// 状态码private String message;// 提示信息private T data;// 返回数据public Result(int code, String message, T data) {super();this.code = code;this.message = message;this.data = data;}public Result(StatusCode statusCode, T data) {this(statusCode.getCode(), statusCode.getMessage(), data);}public static Result success(Object data) {return new Result(StatusCode.SUCCESS, data);}public static Result error(String message) {return new Result(StatusCode.ERROR, message);}}
  • 定义状态码
@Getter@AllArgsConstructorpublic enum StatusCode {SUCCESS(1, "成功"), ERROR(0, "失败");//...自定义private int code;// 返回码private String message;// 返回结果描述}
  • 在Controller中使用封装对象
@GetMapping("hello")public Result test() {    return Result.success("hello");}
  • 返回结果
{"code":1,"message":"成功","data":"hello"}

如何优雅的实现所有的接口都统一格式？

采用ResponseBodyAdvice技术来实现response的统一格式 springboot提供了ResponseBodyAdvice来帮我们处理ResponseBodyAdvice的作用：拦截Controller方法的返回值，统一处理返回值/响应体，一般用来做response的统一格式、加解密、签名等。

@RestControllerAdvice@ControllerAdvice(basePackages = "com.test.controller")public class MyResponseAdvice implements ResponseBodyAdvice {@Autowiredprivate ObjectMapper objectMapper;@Overridepublic boolean supports(MethodParameter returnType,Class<? extends HttpMessageConverter<?>> converterType) {return true;}/** * 处理返回结果,可以对结果加密 */@Overridepublic Object beforeBodyWrite(Object body, MethodParameter returnType,MediaType selectedContentType,Class<? extends HttpMessageConverter<?>> selectedConverterType,ServerHttpRequest request, ServerHttpResponse response) {// 处理字符串类型数据if (body instanceof String) {try {return objectMapper.writeValueAsString(Result.success(body));} catch (JsonProcessingException e) {e.printStackTrace();}}// 返回类型是否已经封装if (body instanceof Result) {return body;}return Result.success(body);}}
  • 测试
@GetMapping("test")public String test2() {return "使用advice";}
{"code":1,"message":"成功","data":"使用advice"}
注意：在使用@ControllerAdvice时，要加上basePackages,@ControllerAdvice(basePackages = "com.test.controller"),如果不加的话，在使用swagger时会出现空白页异常。
  • 加密可以使用Hutool-crypto加密工具，封装了常用的加密加密方法，直接调用。
    cn.hutool    hutool-all    5.7.21
2、实现全局异常处理
@RestControllerAdvicepublic class GlobalExceptionHandler {/** * 参数异常拦截 （model里的） */@ExceptionHandler(MethodArgumentNotValidException.class)@ResponseBodypublic Result handle(MethodArgumentNotValidException e) {FieldError fieldError = e.getBindingResult().getFieldError();String field = fieldError.getField();String message = fieldError.getDefaultMessage();// 具体出错信息String messageAll = String.format("%s:%s", field, message);return Result.error(messageAll);}/** *  * 参数异常拦截 （方法上的） */@ExceptionHandler(ConstraintViolationException.class)@ResponseBodypublic Result constraintViolationException(ConstraintViolationException e) {StringBuilder builder = new StringBuilder();Set> constraintViolations = e.getConstraintViolations();for (ConstraintViolation<?> constraintViolation : constraintViolations) {String message = constraintViolation.getMessage();builder.append(message);}return Result.error(builder.toString());}/** * 其他异常 */@ExceptionHandler@ResponseBodypublic Result handleException(Exception e) {return Result.error(e.getMessage());}
  • 测试 实体user属性username 长度最大是10
@Entity@Table(name = "user")@Datapublic class User implements Serializable {@Column(name = "username")@Size(max = 10)@ApiModelProperty(value = "用户名")private String username;......}@PostMapping("add")@ApiOperation("添加用户")public Result add(@RequestBody @Validated User u) {User user = userService.save(u);return Result.success(user);}
  • 测试结果
{  "code": 0,  "message": "失败",  "data": "username:个数必须在0和10之间"}
这样，就实现了统一接口数据封装、全局异常处理。
            
 

            
 
              
 
                
  • 
                  
      
    
                  支付宝打赏 
    • 
                     
    
                
     
                
  • 
                  
      
    
                  微信打赏 
    • 
                     
    
            
    
            
     全局   数据格式   接口 
    
            
    
			
    


    
            
            
    发表评论
    
            
    
              

    

    

    留言与评论（共有 0 条评论）
“”
    

    


    

    

    


    

    



   

    

    
验证码：
 
 
 








      

     
    		

    

    
    		

    

    
	
    
        
    
          
        
    
        
    
 

    	     
            
    
          
          
          
    
            
    相关文章
    
            
    
              
    
                
      基于 AOP + Redis + 自定义注解 实现细粒度的接口IP访问限制 
                  
     基于 AOP + Redis + 自定义注解 实 
    
                
    
              
    
                
      实用小技巧：完美实现JavaFx 全局快捷键和监听剪切板功(Kotlin) 
                  
     实用小技巧：完美实现JavaFx 全局快 
    
                
    
              
    
                
      看阿里测试工程师如何玩转postman+newman+jenkins接口自动化 
                  
     看阿里测试工程师如何玩转postman+ 
    
                
    
              
    
                
      人脸识别API接口 
                  
     人脸识别API接口 
    
                
    
              
    
                
      Mybatis 中的 DAO 接口和 XML 文件里的 SQL他们如何建立关系？ 
                  
     Mybatis 中的 DAO 接口和 XML 文件 
    
                
    
              
    
                
      Python接口自动化之request请求封装 
                  
     Python接口自动化之request请求封 
    
                
    
              
                
    
          
    
        
         
      
    
        
        
    
          
    
            
    推荐文章
    
          
    
          
     
            
      
                          
    
          
    
          
    
        
    
        
    
        
        
    
        
    
          
    
            
    最热点击文章
    
          
    
          
     
            
          
    
          
    
        
    
        
    
          
    
            
    热门标签