使用Web应用时,在请求处理过程中发生错误是非常常见的情况.SpringBoot为我们提供一个默认的映射:/error,当处理中抛出异常之后,会转到该请求中处理,并且该请求有一个全局的错误页面来展示异常内容.比如现在启动my-spring-boot项目,项目启动完成之后,在浏览器中随便输入一个访问地址,由于地址不存在,SpringBoot会跳转到错误页面,如图所示.
image.png
虽然Spring Boot为我们提供了默认的错误页面映射,但是在实际应用中,上图所示的错误页面对用户来说并不友好,我们需要自己来实现异常提示,接下来将演示自己实现错误的提示页面.
自定义错误页面
首先,在我们的Spring Boot项目目录/src/main/resources/static下新建自定义错误页面404.html,具体代码如下:
404页面
我累了,让我休息一会!
其次,在我们的Spring Boot项目目录/src/main/java/com/example/text下新建包error,并在包error下新建ErrorPageConfig配置类,具体代码如下:
@Configuration
public class ErrorPageConfig implements ErrorPageRegistrar {
@Override
public void registerErrorPages(ErrorPageRegistry registry) {
ErrorPage error404Page = new ErrorPage(HttpStatus.NOT_FOUND, "/404.html");
registry.addErrorPages(error404Page);
}
}
测试
重启项目,在浏览器上输入错误的链接,会出现如下自定义错误页面:
image.png
全局异常类开发
在项目中,我们会遇到各种各样的业务异常,业务异常是指业务处理时,由于某些业务的特殊要求而导致处理不能继续而抛出异常.比如说检测用户输入的内容中是否包含敏感词汇.我们希望这些业务异常能够被统一处理,接下来就是如何处理全局异常.
- 首先,统一封装自定义业务异常
BusinessException.
package com.example.test.error;
/**
* 描述:业务异常
* @Author zhangrui
* @Date 2019/10/31 11:50
*/
public class BussinessException extends RuntimeException {
public BussinessException(){}
public BussinessException(String message){
super(message);
}
}
- 然后,新建错误信息类
ErrorInfo
package com.example.test.error;
/**
* 描述:错误信息类
* @Author zhangrui
* @Date 2019/10/31 11:51
*/
public class ErrorInfo {
public static final Integer SUCCESS = 200;
public static final Integer ERROR = 100;
//错误信息
private Integer code;
//错误码
private String message;
private String url;
private T data;
public static Integer getSUCCESS() {
return SUCCESS;
}
public static Integer getERROR() {
return ERROR;
}
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
public String getUrl() {
return url;
}
public void setUrl(String url) {
this.url = url;
}
public T getData() {
return data;
}
public void setData(T data) {
this.data = data;
}
}
- 其次,新建统一异常处理类
GlobalDefaultExceptionHandler
package com.example.test.error;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
/**
* 描述:统一业务异常处理类
* @Author zhangrui
* @Date 2019/10/31 11:54
*/
@ControllerAdvice(basePackages = {"com.example.test",})//定义统一的异常处理类
public class GlobalDefaultExceptionHandler {
@ExceptionHandler({BussinessException.class})//用来定义函数针对的异常类型,可以传入多个需要捕获的异常类
@ResponseBody
public ErrorInfo defaultErrorHandler(HttpServletRequest req,Exception e) throws Exception{
System.out.println("req.getRequestURI():"+req.getRequestURI());
ErrorInfo errorInfo = new ErrorInfo();
errorInfo.setMessage(e.getMessage());
errorInfo.setUrl(req.getRequestURI());
errorInfo.setCode(ErrorInfo.SUCCESS);
return errorInfo;
}
}
- 最后,在控制层添加方法
findAll(),并在方法中抛出BusinessException异常,该异常会被全局异常处理类捕获.
package com.example.test.controller;
import com.example.test.error.BussinessException;
import com.example.test.entity.User;
import com.example.test.service.UserService;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.annotation.Resource;
import java.util.List;
@Controller
@RequestMapping("/user")
public class UserController {
@Resource
private UserService userService;
@RequestMapping("/findAll")
public String findAll(Model model) {
List user = userService.findAll();
model.addAttribute("users", user);
throw new BussinessException("业务异常");
}
}
代码开发完成之后,重启项目,在浏览器中输入访问地址http://localhost:8080/user/findAll,可以看到后端返回的json信息如下图所示:
image.png
这样就完成了简单的全局异常的处理.