SpringBoot错误处理

默认情况下，SpringBoot应用出现错误时，无论是404请求资源不存在还是500程序内部错误，都将给用户显示一个白板页面，显然这是不太友好的。

SpringBoot出现错误时默认显示的页面

在SpringBoot中，错误的处理需要关注下面三点

• 指定错误页

• 数据验证错误

• 全局异常

默认情况下的错误页是无法满足实际项目需求的，所以通常会通过自定义错误页面来覆盖“Whitelabel Error Page”默认错误页。在传统的JavaWeb项目当中也可以设置自己的错误页面，具体方式请参考JavaWeb设置错误页面。
SpringBoot项目当中是没有web.xml文件的，如果要自定义错误页，最好的做法是对于常见的Http错误码都定义相应的错误页。只要两步就能完成SpringBoot项目的指定错误页。

1. 
   

   
   

   在“src/main/view/static”目录下创建常见的HTTP错误码对应的静态页面，用于在发生相应错误时的页面展示。

   自定义错误页

2. 添加一个错误页的配置类

@Configurationpublic class ErrorPageConfig {    @Bean
    public EmbeddedServletContainerCustomizer containerCustomizer(){        return new EmbeddedServletContainerCustomizer(){            @Override
            public void customize(ConfigurableEmbeddedServletContainer container) {
                ErrorPage errorPage_400 = new ErrorPage(HttpStatus.BAD_REQUEST,"/error-400.html");
                ErrorPage errorPage_404 = new ErrorPage(HttpStatus.NOT_FOUND,"/error-404.html");
                ErrorPage errorPage_500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR,"/error-500.html");
                container.addErrorPages(errorPage_400,errorPage_404,errorPage_500);
            }
        };
    }
}

WEB应用下很多场景需要对请求到后台的数据进行校验，只要涉及到数据交互都要假设用户的输入都是恶意的，不能单纯的通过前端来对数据数据校验而后台不做校验，因为前端的数据校验是很容易被绕过的。
SpringBoot程序中可以借助Hibernate Validator对前端参数进行校验。假设我们有个用户注册功能，需要对输入的用户参数进行校验，UserBean定义如下

public class User implements Serializable{    @NotNull(message = "用户ID不能为空")    @Size(min = 6, max = 12, message = "用户ID长度为6-12位")    private String uid;    @NotNull(message = "年龄不能为空")    @Digits(integer = 3, message = "年龄必须是合法数字", fraction = 0)    private Integer age;    @NotNull(message = "薪水不能为空")    @Digits(integer = 10, fraction = 2, message = "薪水格式不对")    private Double salary;    private Date birthday;    @Email(message = "邮箱格式不对")    private String email;    public String getUid() {        return uid;
    }    public void setUid(String uid) {        this.uid = uid;
    }    public Integer getAge() {        return age;
    }    public void setAge(Integer age) {        this.age = age;
    }    public Double getSalary() {        return salary;
    }    public void setSalary(Double salary) {        this.salary = salary;
    }    public Date getBirthday() {        return birthday;
    }    public void setBirthday(Date birthday) {        this.birthday = birthday;
    }    public String getEmail() {        return email;
    }    public void setEmail(String email) {        this.email = email;
    }
}

前端form表单addUser.html

我们的UserController类实现如下

@Controllerpublic class UserController {    @RequestMapping(value = "/addUser",method = RequestMethod.GET)    public String addUser(){        return "addUser";
    }    @RequestMapping(value = "/addUser", method = RequestMethod.POST)    @ResponseBody
    public Object addUser(@Valid User user, BindingResult result){        // 现在表示执行的验证出现错误
        if (result.hasErrors()) {            // 获取全部错误信息
            Iterator iterator = result.getAllErrors().iterator();            while (iterator.hasNext()) {                // 取出每一个错误
                ObjectError error = iterator.next();
                System.out.println("【错误信息】code = " + error.getCode() + "，message = " +
                        error.getDefaultMessage());
            }            return result.getAllErrors();
        }else {            return user;
        }
    }    @InitBinder
    public void initBinder(WebDataBinder binder) {  // 在本程序里面需要针对于日期格式进行处理
        // 首先建立一个可以将字符串转换为日期的工具程序类
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd") ;        // 明确的描述此时需要注册一个日期格式的转化处理程序类
        binder.registerCustomEditor(java.util.Date.class, new CustomDateEditor(sdf, true));
    }
}

在“指定错误页”中，我们配置了如果应用出现内部异常的话，程序会跳转到error-500.html页面，如果我们想在这个页面中输出一些错误信息的话要怎么办？这个时候可以单独定义一个页面进行错误的信息显示处理，而这个页面，可以定义在“src/main/view/templates/error.html”，这个页面里面要求可以输出一些信息

    
    
    对不起，出现了500错误！
    
    
    

那上面定义的${url}和${exception.message}是从哪里将参数传递进来的呢？这需要我们定义一个全局的异常处理类，该类的代码如下

@ControllerAdvice// 作为一个控制层的切面处理//@RestControllerAdvicepublic class GlobalExceptionHandler {    
    public static final String DEFAULT_ERROR_VIEW = "error"; // 定义错误显示页，error.html
    @ExceptionHandler(Exception.class)    public ModelAndView defaultErrorHandler(HttpServletRequest request,
                                            Exception e) { // 出现异常之后会跳转到此方法
        ModelAndView mav = new ModelAndView(DEFAULT_ERROR_VIEW); // 设置跳转路径
        mav.addObject("exception", e); // 将异常对象传递过去
        mav.addObject("url", request.getRequestURL()); // 获得请求的路径
        return mav;
    }
}

全局的异常处理类有两种写法：使用@ControllerAdvice或@RestControllerAdvice。它们都是通过AOP代理的方式，捕捉到异常就跳转到自定义的页面中，并将需要的参数传递到页面中。示例中注释的代码是使用@RestControllerAdvice的写法，它使用的还是SpringBoot提供的默认页面。

作者：Coding小聪
链接：https://www.jianshu.com/p/4e39ae27b05b