springboot + 统一返回json数据 + 统一异常处理

迈不过友情╰ 2024-03-16 10:26 183阅读 0赞

环境

1、创建一个springboot项目

  • 只需引入web依赖即可

在这里插入图片描述

  • pom.xml文件



    org.springframework.boot
    spring-boot-starter-web

2、简单的配置

  1. # 应用名称
  2. spring.application.name=res_exc_demo
  3. # 端口号
  4. server.port=8099

统一返回

1、定义一个类，返回固定的格式

一般格式包括

  • 状态码
  • 状态码信息

  • 具体返回数据

    public class Resp {

  1.     //状态码
  2.     private int code = 200;
  3.     //状态码信息
  4.     private String msg = "success";
  5.     //返回的信息
  6.     private T data;
  8.     private Resp(int code,String msg,T data){
  10.         this.code = code;
  11.         this.msg = msg;
  12.         this.data = data;
  13.     }
  15.     public static <T> Resp success(T data){
  17.         Resp resp = new Resp(200, "success", data);
  18.         return resp;
  19.     }
  21.     public static <T> Resp success(String msg,T data){
  23.         Resp resp = new Resp(200,msg, data);
  24.         return resp;
  25.     }
  27.     public static <T> Resp error(AppExceptionCodeMsg appExceptionCodeMsg){
  29.         Resp resp = new Resp(appExceptionCodeMsg.getCode(), appExceptionCodeMsg.getMsg(), null);
  30.         return resp;
  31.     }
  32.     public static <T> Resp error(int code,String msg){
  34.         Resp resp = new Resp(code,msg, null);
  35.         return resp;
  36.     }
  38.     public int getCode() {
  40.         return code;
  41.     }
  43.     public String getMsg() {
  45.         return msg;
  46.     }
  48.     public T getData() {
  50.         return data;
  51.     }
  53. }

2、controller统一返回

  1. @RestController
  2. public class DemoController {
  5.     @GetMapping("demo")
  6.     public Resp<String> demo1(String name){
  8.         //...
  9.        return Resp.success("default");
  10.     }
  11. }

统一异常处理

1、创建一个枚举类型

存储各种类型的异常状态码和信息

  1. package com.pzz.exce;
  3. /**
  4.  * 枚举类，所有自定义异常的状态码和信息
  5.  */
  6. //这个枚举类中定义的都是跟业务有关的异常
  7. public enum AppExceptionCodeMsg {
  10.     INVALID_CODE(10000,"验证码无效"),
  11.     USERNAME_NOT_EXISTS(10001,"用户名不存在"),
  12.     USER_CREDIT_NOT_ENOUTH(10002,"用户积分不足");
  14.     private int code ;
  15.     private String msg ;
  17.     public int getCode() {
  19.         return code;
  20.     }
  22.     public String getMsg() {
  24.         return msg;
  25.     }
  28.     AppExceptionCodeMsg(int code, String msg){
  30.         this.code = code;
  31.         this.msg = msg;
  32.     }
  34. }

2、创建自定义的异常类

  1. package com.pzz.exce;
  3. public class AppException extends RuntimeException{
  6.     private int code = 500;
  7.     private String msg = "服务器异常";
  10.     public AppException(AppExceptionCodeMsg appExceptionCodeMsg){
  12.         super();
  13.         this.code = appExceptionCodeMsg.getCode();
  14.         this.msg = appExceptionCodeMsg.getMsg();
  16.     }
  18.     public AppException(int code,String msg){
  20.         super();
  21.         this.code = code;
  22.         this.msg = msg;
  24.     }
  26.     public int getCode() {
  28.         return code;
  29.     }
  31.     public String getMsg() {
  33.         return msg;
  34.     }
  36. }

3、创建全局统一异常处理类

  1. package com.pzz.exce;
  3. import com.pzz.resp.Resp;
  4. import org.springframework.web.bind.annotation.ControllerAdvice;
  5. import org.springframework.web.bind.annotation.ExceptionHandler;
  6. import org.springframework.web.bind.annotation.ResponseBody;
  8. /**
  9.  * 全局异常
  10.  */
  11. @ControllerAdvice
  12. public class GlobalExceptionHandler {
  16.     @ExceptionHandler(value = {
  17.     Exception.class})
  18.     @ResponseBody
  19.     public <T> Resp<T> exceptionHandler(Exception e){
  21.         //这里先判断拦截到的Exception是不是我们自定义的异常类型
  22.         if(e instanceof AppException){
  24.             AppException appException = (AppException)e;
  25.             return Resp.error(appException.getCode(),appException.getMsg());
  26.         }
  28.         //如果拦截的异常不是我们自定义的异常(例如：数据库主键冲突)
  29.         return Resp.error(500,"服务器端异常");
  30.     }
  31. }

4、controller

  1. package com.pzz.controller;
  3. import com.pzz.exce.AppException;
  4. import com.pzz.exce.AppExceptionCodeMsg;
  5. import com.pzz.resp.Resp;
  6. import org.springframework.web.bind.annotation.GetMapping;
  7. import org.springframework.web.bind.annotation.RestController;
  9. import java.util.Arrays;
  10. import java.util.List;
  12. @RestController
  13. public class DemoController {
  17.     @GetMapping("demo")
  18.     public Resp<String> demo1(String name){
  21.         if("ok".equals(name)){
  23.             return Resp.success("succ");
  24.         }
  25.         if("err".equals(name)){
  27.             //抛业务相关的异常
  28.             throw new AppException(AppExceptionCodeMsg.USERNAME_NOT_EXISTS);
  29.         }
  31.         if("errcode".equals(name)){
  33.             throw new AppException(AppExceptionCodeMsg.INVALID_CODE);
  34.         }
  35.         if("0".equals(name)){
  37.             int i=1/0;
  38.         }
  40.         //检查用户积分是否足够，如果不够，就抛出异常
  41.         if("notenough".equals(name)){
  43.             throw new AppException(AppExceptionCodeMsg.USER_CREDIT_NOT_ENOUTH);
  44.         }
  46.         return Resp.success("default");
  47.     }
  49.    @GetMapping("list")
  50.     public Resp<List> list(){
  52.         List<String> list = Arrays.asList("zhangsan","lisi","wangwu");
  54.         return Resp.success(list);
  55.     }
  56. }

测试效果

在这里插入图片描述
在这里插入图片描述

结束！
hy:6

  1. 人可以犯错，但是不可犯同一个错。---苏格拉底

发表评论

表情：
评论列表 （有 0 条评论，183人围观）

还没有评论，来说两句吧...

相关阅读