溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
上篇文章我們講解了使用Hibernate Validation來校驗數據，當校驗完數據后，如果發生錯誤我們需要給客戶返回一個錯誤信息，因此這節我們來講解一下SpringBoot默認的錯誤處理機制以及如何自定義異常來處理請求錯誤。
一、SpringBoot默認的錯誤處理機制
我們在發送一個請求的時候，如果發生404 SpringBoot會怎么處理呢？我們來發送一個不存在的請求來驗證一下看看頁面結果。如下所示：
當服務器內部發生錯誤的時候，頁面會返回什么呢？
@GetMapping("/user/{id:\\d+}")
public User get(@PathVariable String id) {
throw new RuntimeException();
}
我們會發現無論是發生什么錯誤，SpringBoot都會返回一個狀態碼以及一個錯誤頁面，這個錯誤頁面是怎么來的呢？
我們來看看SpringBoot錯誤處理模塊的源碼就會非常清楚，默認的發生錯誤，它會將請求轉發到BasicErrorController控制器來處理請求，下面是該controller類的源碼：
@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {
private final ErrorProperties errorProperties;
/**
* Create a new {@link BasicErrorController} instance.
* @param errorAttributes the error attributes
* @param errorProperties configuration properties
*/
public BasicErrorController(ErrorAttributes errorAttributes,
ErrorProperties errorProperties) {
this(errorAttributes, errorProperties,
Collections.<ErrorViewResolver>emptyList());
}
/**
* Create a new {@link BasicErrorController} instance.
* @param errorAttributes the error attributes
* @param errorProperties configuration properties
* @param errorViewResolvers error view resolvers
*/
public BasicErrorController(ErrorAttributes errorAttributes,
ErrorProperties errorProperties, List<ErrorViewResolver> errorViewResolvers) {
super(errorAttributes, errorViewResolvers);
Assert.notNull(errorProperties, "ErrorProperties must not be null");
this.errorProperties = errorProperties;
}
@Override
public String getErrorPath() {
return this.errorProperties.getPath();
}
@RequestMapping(produces = "text/html")
public ModelAndView errorHtml(HttpServletRequest request,
HttpServletResponse response) {
HttpStatus status = getStatus(request);
Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes(
request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
response.setStatus(status.value());
ModelAndView modelAndView = resolveErrorView(request, response, status, model);
return (modelAndView == null ? new ModelAndView("error", model) : modelAndView);
}
@RequestMapping
@ResponseBody
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
Map<String, Object> body = getErrorAttributes(request,
isIncludeStackTrace(request, MediaType.ALL));
HttpStatus status = getStatus(request);
return new ResponseEntity<Map<String, Object>>(body, status);
}
從上面的源碼我們可以看到，它有兩個RequestMapping方法來映射錯誤請求，為什么會是兩個呢？其實errorHtml方法映射的是瀏覽器發送來的請求，而error方法映射的是不是瀏覽器而是其他軟件app客戶端發送的錯誤請求。
看了上面的源碼后，我們是否可以自己定義404或者500的錯誤頁面返回給客戶端呢？當然可以，我們可以在src/main/resources路徑下新建文件夾reources/error文件夾，然后新建404.html和500.html然后編寫自己的錯誤內容即可：
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>404</title> </head> <body> 親，您所訪問的頁面不存在 </body> </html>
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>500</title> </head> <body> 服務器內部錯誤 </body> </html>
不過注意的是上面的這種自定義頁面的方式只在瀏覽器端有效，而不是瀏覽器發送的請求不會生效。因此下面我們就講一下如何自定義異常處理來解決這個問題。
二、自定義異常處理
怎么自定義異常處理客戶端發送的錯誤信息呢？如果我們查詢一個用戶，該用戶不存在，我們是否可以將不存在的用戶的id返回給客戶呢？這樣的效果不是給客戶更好地體驗嗎？下面我們來實現這個功能。
首先我們需要編寫一個exception類繼承RuntimeException類：
package cn.shinelon.exception;
/**
* @author Shinelon
*
*/
public class UserNotExistException extends RuntimeException{
/**
*
*/
private static final long serialVersionUID = 1L;
private String id;
public UserNotExistException(String id) {
super("user not exist");
this.id=id;
}
public void setId(String id) {
this.id = id;
}
public String getId() {
return id;
}
}
接著我們需要編寫一個handler類處理controller層拋出的異常：
/**
*
*/
package cn.shinelon.exception;
import java.util.HashMap;
import java.util.Map;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
/**
* 控制器的異常處理類
* @author Shinelon
*
*/
//這個注解是指這個類是處理其他controller拋出的異常
@ControllerAdvice
public class ControllerExceptionHandler {
//這個注解是指當controller中拋出這個指定的異常類的時候，都會轉到這個方法中來處理異常
@ExceptionHandler(UserNotExistException.class)
//將返回的值轉成json格式的數據
@ResponseBody
//返回的狀態碼
@ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR) //服務內部錯誤
public Map<String,Object> handlerUserNotExistException(UserNotExistException ex){
Map<String,Object> result=new HashMap<String,Object>();
result.put("id", ex.getId());
result.put("message", ex.getMessage());
return result;
}
}
這個類加上@ControllerAdvice注解將會處理controller層拋出的對應的異常，這里我們處理controller拋出的UserNotExistException自定義異常，并且將錯誤信息以及用戶id以json串的格式返回給客戶。
接著，我們在controller的請求方法中拋出這個異常，會看到在瀏覽器中的異常是我們自定義的異常返回的json數據。
Controller層代碼：
@GetMapping("/user/{id:\\d+}")
//@RequestMapping(value="/user/{id:\\d+}",method=RequestMethod.GET)
@JsonView(User.DetailJsonView.class)
public User get(@PathVariable String id) {
throw new UserNotExistException(id);
}
到這里，我們就介紹了SpringBoot默認的錯誤處理機制以及我們自定義異常來處理錯誤請求，這更有利于我們的開發，帶給用戶更佳的使用效果。
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
