园友们好，元旦很快就到来了，提前祝各位园友们元旦快乐，今天给大家分享一个工作中必用一个知识点，就是使用枚举构建自定义异常并应用于springboot的异常处理器。开始之前我先把这个案例的结构大致说明一下：
1、使用idea创建一个springboot的Gradle/Maven项目，引入web模块即可（由于案例的重点是异常处理，所以跳过其他操作）。
2、创建一个javabean，用来接收前台的参数。
3、创建一个枚举、封装异常的错误码等信息。
4、创建一个自定义异常类继承RuntimeException。
5、创建一个controller，用来处理用户请求。
6、创建一个springboot的异常处理类。
7、运行项目，测试。
OK、接下来就进入正题，先来第一步，创建项目（创建项目的过程就不需要一一演示了吧，^_^），下面是创建项目之后的Gradle项目中build.gradle中的依赖：
1 dependencies {
2 implementation(‘org.springframework.boot:spring-boot-starter-web‘)
3 testImplementation(‘org.springframework.boot:spring-boot-starter-test‘)
4 }
如果各位读者是maven项目的话，pom.xml文件中的依赖应该长这样子：
1 <dependencies> 2 <dependency> 3 <groupId>org.springframework.boot</groupId> 4 <artifactId>spring-boot-starter-web</artifactId> 5 </dependency> 6 7 <dependency> 8 <groupId>org.springframework.boot</groupId> 9 <artifactId>spring-boot-starter-test</artifactId> 10 <scope>test</scope> 11 </dependency> 12 </dependencies>
ok，下面开始第二步，创建一个javabean：
package com.maolinjava.entity;
import java.io.Serializable;
/**
* Created by tml on 2018/12/28.
*/
public class User implements Serializable {
private String username;
private String password;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
}
ok，再来第三步，创建一个枚举、封装异常的错误码等信息：
package com.maolinjava.commons.constant;
/**
* Created by tml on 2018/12/28.
*/
public enum ServiceErrCode {
REQ_PARAM_ERR(10001,"请求参数异常"),
NOTFOUND_RESULT_ERR(10004,"未找到结果");
private int code;
ServiceErrCode(int code,String msg){
this.code = code;
}
public int getCode() {
return code;
}
}
再来第四步、创建自定义异常类：
package com.maolinjava.commons.exception;
import com.maolinjava.commons.constant.ServiceErrCode;
/**
* Created by tml on 2018/12/28.
*/
public class BaseServiceException extends RuntimeException {
private int code;
public BaseServiceException(String message, ServiceErrCode serviceErrCode) {//构造器的第二个参数是上面创建的那个枚举，之后把枚举里面定义的code给了这个code
super(message);
this.code = serviceErrCode.getCode();
}
public int getCode() {
return code;
}
@Override
public String getMessage() {
return super.getMessage();
}
}
第五步，创建一个controller：
package com.maolinjava.controller;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.maolinjava.commons.constant.ServiceErrCode;
import com.maolinjava.commons.exception.BaseServiceException;
import com.maolinjava.entity.User;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
import java.util.Objects;
/**
* Created by tml on 2018/12/28.
*/
@RestController
public class UserController {
@Resource
private ObjectMapper jsonMapper;
@PostMapping("/login")
public ObjectNode login(@RequestBody(required = false) User user){
//如果用户发起的请求参数中user为null的话，就会抛出自定义的异常，之后会被全局的异常处理器所拦截响应到前端
if(Objects.isNull(user)){
throw new BaseServiceException("用户为空，请填写用户名和密码", ServiceErrCode.REQ_PARAM_ERR);
}
//如果输入了用户名和密码则正常把输入的信息响应回去
System.out.println(user);
return jsonMapper.createObjectNode().putPOJO("data",user);
}
}
OK，再来第六步、创建一个springboot的异常处理类：
package com.maolinjava.commons.exception.handler;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.maolinjava.commons.exception.BaseServiceException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import javax.annotation.Resource;
/**
* Created by tml on 2018/12/28.
*/
@RestControllerAdvice
public class GlobalExceptionHandler {
@Resource
private ObjectMapper jsonMapper;
@ExceptionHandler(BaseServiceException.class)
public ObjectNode baseServiceException(BaseServiceException e){
int code = e.getCode();
String msg = e.getMessage();
return jsonMapper.createObjectNode().put("code",code).put("msg",msg);
}
}
这个异常处理类主要用到的两个注解是@RestControllerAdvice和@ExceptionHandler(xxx.class)，说明一下：@RestControllerAdvice注解表示全局的异常通知，里面的value属性可以指定一个异常通知的包范围，一般这个不用去指定，就让他对全部的包进行扫描即可；@ExceptionHandler(xxx.class)这个注解加在方法上，表示要拦截的某个异常并对该异常进行处理，里面的参数是要拦截的异常的类型，我这里拦截的是BaseServiceException这个异常，如果程序中有抛出BaseServiceException的地方就会进入该方法进行处理。
代码已经全部OK，启动项目，打开postman访问 localhost:8080/login，附一张postman的请求截图：
很明显，这个请求中是有传递用户名和密码的，所以程序正常运行，返回如下结果：
我们的重点是要测试异常，所以把请求参数都去掉，什么都不传，响应以下结果：
很明显，code就是我们在枚举中定义的code，msg就是在抛出异常的时候填写的异常信息，随后这个异常完美的被带有@RestControllerAdvice注解的GlobalExceptionHandler类的baseServiceException方法所拦截，成功响应上面的结果。
OK，这就是springboot的异常处理与自定义异常的使用案例，这些都是十分基础的东西，后面我会给大家分享一些技术干货，请各位园友多多支持。
非淡泊无以明志，非宁静无以致远。
原文地址：https://www.cnblogs.com/maolinjava/p/10193280.html