SpringBoot：如何优雅地进行参数传递、响应数据封装(1)

/**

• @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() + “系统异常，请联系管理员！”);

}

}

• @RestControllerAdvice 注解包含了 @Component 注解，说明在 Spring Boot 启动时，也会把该类作为组件交给 Spring 来管理。

• @RestControllerAdvice 注解包含了 @ResponseBody 注解，为了异常处理完之后给调用方输出一个 JSON 格式的封装数据。

• @RestControllerAdvice 注解还有个 basePackages 属性，该属性用来拦截哪个包中的异常信息，一般我们不指定这个属性，我们拦截项目工程中的所有异常。

• 在方法上通过 @ExceptionHandler 注解来指定具体的异常，然后在方法中处理该异常信息，最后将结果通过统一的 JSON 结构体返回给调用者。

• 但在项目中，我们一般都会比较详细地去拦截一些常见异常，拦截 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这项故意空缺：

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;

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

最后

还有Java核心知识点+全套架构师学习资料和视频+一线大厂面试宝典+面试简历模板可以领取+阿里美团网易腾讯小米爱奇艺快手哔哩哔哩面试题+Spring源码合集+Java架构实战电子书+2021年最新大厂面试题。

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！
！！（备注Java获取）**

最后

还有Java核心知识点+全套架构师学习资料和视频+一线大厂面试宝典+面试简历模板可以领取+阿里美团网易腾讯小米爱奇艺快手哔哩哔哩面试题+Spring源码合集+Java架构实战电子书+2021年最新大厂面试题。
[外链图片转存中…(img-7nkHpeOE-1712207283665)]
《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！