Spring Boot：如何优雅地进行参数传递、响应数据封装、异常处理？

秒速五厘米 2023-09-26 21:32 157阅读 0赞

在项目开发中，接口与接口之间、前后端之间的数据传输都使用 JSON 格式。

## fastjson使用 ##

阿里巴巴的 fastjson是目前应用最广泛的JSON解析框架。本文也将使用fastjson。

### 1.1 引入依赖 ###

<dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.35</version>
    </dependency>

## 2 统一封装返回数据 ##

在web项目中，接口返回数据一般要包含状态码、信息、数据等，例如下面的接口示例：

import com.alibaba.fastjson.JSONObject;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    
    /**
     * @author guozhengMu
     * @version 1.0
     * @date 2019/8/21 14:55
     * @description
     * @modify
     */
    @RestController
    @RequestMapping(value = "/test", method = RequestMethod.GET)
    public class TestController {
        @RequestMapping("/json")
        public JSONObject test() {
            JSONObject result = new JSONObject();
            try {
                // 业务逻辑代码
                result.put("code", 0);
                result.put("msg", "操作成功！");
                result.put("data", "测试数据");
            } catch (Exception e) {
                result.put("code", 500);
                result.put("msg", "系统异常，请联系管理员！");
            }
            return result;
        }
    }

这样的话，每个接口都这样处理，非常麻烦，需要一种更优雅的实现方式。

### 2.1 定义统一的JSON结构 ###

统一的 JSON 结构中属性包括数据、状态码、提示信息，其他项可以自己根据需要添加。一般来说，应该有默认的返回结构，也应该有用户指定的返回结构。由于返回数据类型无法确定，需要使用泛型，代码如下：

public class ResponseInfo<T> {
        /**
         * 状态码
         */
        protected String code;
        /**
         * 响应信息
         */
        protected String msg;
        /**
         * 返回数据
         */
        private T data;
    
        /**
         * 若没有数据返回，默认状态码为 0，提示信息为“操作成功！”
         */
        public ResponseInfo() {
            this.code = 0;
            this.msg = "操作成功！";
        }
    
        /**
         * 若没有数据返回，可以人为指定状态码和提示信息
         * @param code
         * @param msg
         */
        public ResponseInfo(String code, String msg) {
            this.code = code;
            this.msg = msg;
        }
    
        /**
         * 有数据返回时，状态码为 0，默认提示信息为“操作成功！”
         * @param data
         */
        public ResponseInfo(T data) {
            this.data = data;
            this.code = 0;
            this.msg = "操作成功！";
        }
    
        /**
         * 有数据返回，状态码为 0，人为指定提示信息
         * @param data
         * @param msg
         */
        public ResponseInfo(T data, String msg) {
            this.data = data;
            this.code = 0;
            this.msg = msg;
        }
        // 省略 get 和 set 方法
    }

### 2.2 使用统一的JSON结构 ###

我们封装了统一的返回数据结构后，在接口中就可以直接使用了。如下：

import com.example.demo.model.ResponseInfo;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    
    /**
     * @author guozhengMu
     * @version 1.0
     * @date 2019/8/21 14:55
     * @description
     * @modify
     */
    @RestController
    @RequestMapping(value = "/test", method = RequestMethod.GET)
    public class TestController {
        @RequestMapping("/json")
        public ResponseInfo test() {
            try {
                // 模拟异常业务代码
                int num = 1 / 0;
                return new ResponseInfo("测试数据");
            } catch (Exception e) {
                return new ResponseInfo(500, "系统异常，请联系管理员！");
            }
        }
    }

如上，接口的返回数据处理便优雅了许多。针对上面接口做个测试，启动项目，通过浏览器访问：localhost:8096/test/json，得到响应结果：

{"code":500,"msg":"系统异常，请联系管理员！","data":null}

##  ##

## 3 全局异常处理 ##

### 3.1 系统定义异常处理 ###

新建一个 ExceptionHandlerAdvice 全局异常处理类，然后加上 @RestControllerAdvice 注解即可拦截项目中抛出的异常，如下代码中包含了几个异常处理，如参数格式异常、参数缺失、系统异常等，见下例：

@RestControllerAdvice
    @Slf4j
    public class ExceptionHandlerAdvice {
    
        // 参数格式异常处理
        @ExceptionHandler({IllegalArgumentException.class})
        @ResponseStatus(HttpStatus.BAD_REQUEST)
        public ResponseInfo badRequestException(IllegalArgumentException exception) {
         log.error("参数格式不合法：" + e.getMessage());
            return new ResponseInfo(HttpStatus.BAD_REQUEST.value() + "", "参数格式不符！");
        }
    
     // 权限不足异常处理
        @ExceptionHandler({AccessDeniedException.class})
        @ResponseStatus(HttpStatus.FORBIDDEN)
        public ResponseInfo badRequestException(AccessDeniedException exception) {
            return new ResponseInfo(HttpStatus.FORBIDDEN.value() + "", exception.getMessage());
        }
    
     // 参数缺失异常处理
        @ExceptionHandler({MissingServletRequestParameterException.class})
        @ResponseStatus(HttpStatus.BAD_REQUEST)
        public ResponseInfo badRequestException(Exception exception) {
            return new ResponseInfo(HttpStatus.BAD_REQUEST.value() + "", "缺少必填参数！");
        }
    
        // 空指针异常
        @ExceptionHandler(NullPointerException.class)
        @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
        public ResponseInfo handleTypeMismatchException(NullPointerException ex) {
            log.error("空指针异常，{}", ex.getMessage());
            return new JsonResult("500", "空指针异常");
        }
    
        @ExceptionHandler(Exception.class)
        @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
        public JsonResult handleUnexpectedServer(Exception ex) {
            log.error("系统异常：", ex);
            return new JsonResult("500", "系统发生异常，请联系管理员");
        }
        
        // 系统异常处理
        @ExceptionHandler(Throwable.class)
        @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
        public ResponseInfo exception(Throwable throwable) {
            log.error("系统异常", throwable);
            return new ResponseInfo(HttpStatus.INTERNAL_SERVER_ERROR.value() + "系统异常，请联系管理员！");
        }
    }

1.  @RestControllerAdvice 注解包含了 @Component 注解，说明在 Spring Boot 启动时，也会把该类作为组件交给 Spring 来管理。
2.  @RestControllerAdvice 注解包含了 @ResponseBody 注解，为了异常处理完之后给调用方输出一个 JSON 格式的封装数据。
3.  @RestControllerAdvice 注解还有个 basePackages 属性，该属性用来拦截哪个包中的异常信息，一般我们不指定这个属性，我们拦截项目工程中的所有异常。
4.  在方法上通过 @ExceptionHandler 注解来指定具体的异常，然后在方法中处理该异常信息，最后将结果通过统一的 JSON 结构体返回给调用者。
5.  但在项目中，我们一般都会比较详细地去拦截一些常见异常，拦截 Exception 虽然可以一劳永逸，但是不利于我们去排查或者定位问题。实际项目中，可以把拦截 Exception 异常写在 GlobalExceptionHandler 最下面，如果都没有找到，最后再拦截一下 Exception 异常，保证输出信息友好。

下面我们通过一个接口来进行测试：

@RestController
    @RequestMapping(value = "/test", method = RequestMethod.POST)
    public class TestController {
        @RequestMapping("/json")
        public ResponseInfo test(@RequestParam String userName, @RequestParam String password) {
            try {
                String data = "登录用户：" + userName + "，密码：" + password;
                return new ResponseInfo("0", "操作成功！", data);
            } catch (Exception e) {
                return new ResponseInfo("500", "系统异常，请联系管理员！");
            }
        }
    }

接口调用，password这项故意空缺：

![ef7b61455e284cecb755d9cf6429a361.png][]

图片

### 3.2 自定义异常拦截 ###

在实际项目中，除了拦截一些系统异常外，在某些业务上，我们需要自定义一些业务异常，要处理一个服务的调用时，那么可能会调用失败或者调用超时等等，此时我们需要自定义一个异常，当调用失败时抛出该异常，让 ExceptionHandlerAdvice 去捕获。

3.2.1 定义异常信息

由于在业务中，有很多异常，上面的系统定义异常远远不能覆盖，为了方便项目异常信息管理，我们一般会定义一个异常信息枚举类。比如：

public enum BusinessMsgEnum {
        /**
         * 参数异常
         */
        PARMETER_EXCEPTION("101", "参数异常!"),
        /**
         * 等待超时
         */
        SERVICE_TIME_OUT("102", "服务超时！"),
        /**
         * 参数过大
         */
        PARMETER_BIG_EXCEPTION("903", "内容不能超过200字，请重试!"),
        /**
         * 数据库操作失败
         */
        DATABASE_EXCEPTION("509", "数据库操作异常，请联系管理员！"),
        /**
         * 500 : 一劳永逸的提示也可以在这定义
         */
        UNEXPECTED_EXCEPTION("500", "系统发生异常，请联系管理员！");
        // 还可以定义更多的业务异常
    
        /**
         * 消息码
         */
        private String code;
        /**
         * 消息内容
         */
        private String msg;
    
        private BusinessMsgEnum(String code, String msg) {
            this.code = code;
            this.msg = msg;
        }
        // set get方法
    }

3.2.2 拦截自定义异常

我们可以定义一个业务异常，当出现业务异常时，我们就抛出这个自定义的业务异常即可。比如我们定义一个 BusinessErrorException 异常，如下：

public class BusinessErrorException extends RuntimeException {
    
        private static final long serialVersionUID = -7480022450501760611L;
    
        /**
         * 异常码
         */
        private String code;
        /**
         * 异常提示信息
         */
        private String msg;
    
        public BusinessErrorException(BusinessMsgEnum businessMsgEnum) {
            this.code = businessMsgEnum.code();
            this.msg = businessMsgEnum.msg();
        }
        // get set方法
    }

在构造方法中，传入我们上面自定义的异常枚举类，在项目中，如果有新的异常信息需要添加，我们直接在枚举类中添加即可，很方便，做到统一维护，在拦截该异常时获取即可。

@RestControllerAdvice
    @Slf4j
    public class GlobalExceptionHandler {
    
        /**
         * 拦截业务异常，返回业务异常信息
         * @param ex
         * @return
         */
        @ExceptionHandler(BusinessErrorException.class)
        @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
        public ResponseInfo handleBusinessError(BusinessErrorException ex) {
            String code = ex.getCode();
            String message = ex.getMessage();
            return new ResponseInfo(code, message);
        }
    }

在接口层，模拟异常场景，如下：

@RestController
    @RequestMapping("/test")
    public class ExceptionController {
    
        private static final Logger logger = LoggerFactory.getLogger(ExceptionController.class);
    
        @GetMapping("/exception")
        public ResponseInfo testException() {
            try {
                int i = 1 / 0;
            } catch (Exception e) {
                throw new BusinessErrorException(BusinessMsgEnum.UNEXPECTED_EXCEPTION);
            }
            return new ResponseInfo();
        }
    }

启动项目，请求该接口：

![73ce487b7ab1a741aa1bf81eade553f1.png][]

[ef7b61455e284cecb755d9cf6429a361.png]: https://img-blog.csdnimg.cn/img_convert/ef7b61455e284cecb755d9cf6429a361.png
[73ce487b7ab1a741aa1bf81eade553f1.png]: https://img-blog.csdnimg.cn/img_convert/73ce487b7ab1a741aa1bf81eade553f1.png