springboot的错误处理有几种不同的方式,这里我们介绍三种最常见的方式,首先我们来看第一种。
方法一:
该方式会将一切错误页面引导至我们自定义的页面。
我们将所有的错误映射到/error,然后自己实现ErrorController,当遇到错误时,后台会自动调用该实现ErrorController的控制器。
首先我们在pom.xml中添加ErrorController的相关依赖(如果有的话,无需添加):
<!-- ErrorController接口依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>2.1.6.RELEASE</version>
</dependency>
然后新建“BaseErrorController”的控制器,加入如下代码:
package com.wangs.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.web.servlet.error.ErrorController;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping(value="error")
public class BaseErrorController implements ErrorController {
//如果出错了,我们需要使用Logger记录一下日志
private static final Logger LOG =LoggerFactory.getLogger(BaseErrorController.class);
@Override
public String getErrorPath() {
LOG.info("出错啦,进入自定义控制器!");
return "error/error";
}
@RequestMapping
public String error() {
return getErrorPath();
}
}
这里我们说明一下,我们已事先配置了thymeleaf模板,返回路径为“classpath:/web/”,所以,这里将会返回"web/error/error.html"页面,所以我们新建这个页面:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>ERROR</title>
</head>
<body>
<h1>出错啦!</h1>
</body>
</html>
随便输入“localhost:8081/asdasihsaljsda”的一个错误地址,我们会看到直接跳转至我们自定义的页面:
方法二:
该方式会区分404/400/500等错误类型,并引导至我们自定义的对应页面。
我们不实现ErrorController,直接在resource目录下新建public--error--404.html页面即可。这时候报错或根据错误码进入不同的页面,如404进入404.html,500进入500.html,具体实现步骤如下:
1.首先屏蔽方法一种的Controller,因为如果有Controller实现了ErrorController,那么该Controller触发的优先级要高于public--error-错误页面的优先级。
/*package com.wangs.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.web.servlet.error.ErrorController;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping(value="error")
public class BaseErrorController implements ErrorController {
//如果出错了,我们需要使用Logger记录一下日志
private static final Logger LOG =LoggerFactory.getLogger(BaseErrorController.class);
@Override
public String getErrorPath() {
LOG.info("出错啦,进入自定义控制器!");
return "error/error";
}
@RequestMapping
public String error() {
return getErrorPath();
}
}*/
2.我们新建public-error目录,在该目录下新建错误页面:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>404</title>
</head>
<body>
public -- error -- 404页面
</body>
</html>
3.我们输入一个错误页面,这时候会直接跳转至我们新建的404.html中
同样的,如果报错为500,那么就会进入500.html,我们只需要在error文件夹中建立以错误码为名称的html页面即可。
方法三:
该方式能够区分普通Exception、RuntimeException等不同的异常并引导至我们自定义的对应页面,我们在目录下建立对应页面即可,同样的如果我们新建“404.html”的话,如果页面找不到,仍然会访问该404界面。
方法如下:
首先我们删除方法二中的public文件夹,因为这三种方式不可同时用否则只会生效一个;然后我们新建一个ErrorExceptionHandler
并在其中写入如下代码:
package com.wangs.handler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
@ControllerAdvice
public class ErrorExceptionHandler {
private static final Logger LOG=LoggerFactory.getLogger(ErrorExceptionHandler.class);
//处理通用exception
@ExceptionHandler
@ResponseStatus(HttpStatus.OK)
public String processException(Exception e,Model model) {
LOG.info("--自定义异常处理-exception--");
model.addAttribute("message", e.getMessage());
return"error/500";
}
//处理RuntimeException
@ExceptionHandler
@ResponseStatus(HttpStatus.OK)
public String processException(RuntimeException e,Model model) {
LOG.info("--自定义异常处理-exception--");
model.addAttribute("message", e.getMessage());
return"error/500";
}
}
然后我们在StudentController中添加异常方法:
package com.wangs.controller;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import com.wangs.bean.Student;
@Controller
@RequestMapping("/student/")
public class StudentController {
@RequestMapping("show")
public String show(Model model) {
//添加字符串
model.addAttribute("hello", "hello spring boot thymeleaf!");
model.addAttribute("img", "http://img.xiuren.com/upload/image/201904/02/17/1554197531769682.jpg");
//添加实体类
Student stu=new Student();
stu.setAge(18);
stu.setGender("女");
stu.setName("杨秀芹");
model.addAttribute("stu",stu);
//添加list或map
List<Map<String,String>>list=new ArrayList<Map<String,String>>();
for(int i=0;i<10;i++) {
Map<String,String>map =new HashMap<String,String>();
map.put("name", "杨秀芹"+i);
if(i==9) {
map.put("name", "杨秀芹");
}
list.add(map);
}
model.addAttribute("list", list);
//return的字符串与模板的html名字一致,此处对应“student.html”
return "student";
}
@RequestMapping("exception")
public String exception(Model model) throws Exception {
throw new Exception();
}
}
然后我们在web/error中添加500.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>ERROR</title>
</head>
<body>
<h1>500出错啦!</h1>
</body>
</html>
这是,我们请求Exception,会得到如下界面
说明我们配置成功了。
总结:三种异常处理界面各不相同,但不能同时使用,配置其中一个之前一定要把之前配置的其他错误处理配置屏蔽了,不然会报错或没有效果。
个人推荐使用第三种方式,很舒心。