Spring Boot中自定義404異常處理問題學習筆記

1. 問題背景

在Spring Boot項目中，需要手動返回404異常給前端。為此，我創建了一個自定義的404異常類UnauthorizedAccessException，并在全局異常處理器GlobalExceptionHandler中處理該異常。然而，在使用Postman測試時，返回的仍然是500錯誤，而不是預期的404錯誤。

2. 代碼實現

2.1 自定義404異常類

package cn.jbolt.config.exception;import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;/*** 自定義無權限訪問的異常*/
@ResponseStatus(HttpStatus.NOT_FOUND)
public class UnauthorizedAccessException extends RuntimeException {private final HttpStatus status;public UnauthorizedAccessException(String message) {super(message);this.status = HttpStatus.NOT_FOUND;}public HttpStatus getStatus() {return status;}
}

2.2 全局異常處理器

package cn.jbolt.config.exception;import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;@RestControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(UnauthorizedAccessException.class)public ResponseEntity<String> handleUnauthorizedAccessException(UnauthorizedAccessException ex) {System.out.println("UnauthorizedAccessException-------------------------: " + ex.getMessage());HttpStatus status = ex.getStatus();String message = ex.getMessage();return new ResponseEntity<>(message, status);}
}

2.3 過濾器中拋出自定義異常

package cn.jbolt.teaching_tools.school;import cn.jbolt.config.exception.UnauthorizedAccessException;
import cn.jbolt.teaching_tools.school.entity.School;
import cn.jbolt.teaching_tools.school.service.SchoolService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class SchoolContextFilter implements Filter {@Autowiredprivate SchoolService schoolService;@Overridepublic void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)throws IOException, ServletException {HttpServletRequest httpRequest = (HttpServletRequest) request;HttpServletResponse httpResponse = (HttpServletResponse) response;try {// 從域名獲取學校信息String serverName = httpRequest.getServerName();String[] domainParts = serverName.split("\\.");if (domainParts.length >= 3) {String subdomain = domainParts[0];// 查詢學校IDSchool school = schoolService.getByDomain(subdomain);if (school != null) {// 設置到SchoolContextHolder和請求屬性SchoolContextHolder.setSchoolId(school.getId().toString());} else {// 如果找不到學校，拋出異常throw new UnauthorizedAccessException("異常域名");}} else {// 如果不是二級域名，拋出異常throw new UnauthorizedAccessException("異常域名");}chain.doFilter(request, response);} catch (UnauthorizedAccessException ex) {// 手動處理異常，寫入響應httpResponse.setStatus(HttpStatus.NOT_FOUND.value());httpResponse.setContentType("application/json;charset=UTF-8");httpResponse.getWriter().write("{\"timestamp\": " + System.currentTimeMillis() + ", \"status\": 404, \"error\": \"Not Found\", \"message\": \"" + ex.getMessage() + "\", \"path\": \"" + httpRequest.getRequestURI() + "\"}");} finally {SchoolContextHolder.clear();}}
}

3. 問題分析

3.1?`Filter`拋出的異常未被Spring MVC捕獲

在Spring Boot中，Filter是Servlet API的一部分，而Spring MVC的全局異常處理器（@ControllerAdvice或@RestControllerAdvice）只能捕獲Spring MVC控制器中拋出的異常。因此，當Filter拋出異常時，Spring MVC的全局異常處理器無法捕獲，導致返回了500錯誤。

3.2?`@RestControllerAdvice`未正確掃描

如果GlobalExceptionHandler類所在的包沒有被Spring Boot掃描到，它將無法生效。確保GlobalExceptionHandler類所在的包在Spring Boot的掃描路徑內。

3.3 Spring Boot的默認錯誤處理機制

Spring Boot的默認錯誤處理機制可能會覆蓋自定義的異常處理邏輯。可以通過配置application.properties或application.yml文件來調整默認錯誤處理行為。

4. 解決方案

4.1 在`Filter`中手動處理異常

由于Filter拋出的異常無法被Spring MVC的全局異常處理器捕獲，因此需要在Filter中手動處理異常，將異常信息寫入響應中。具體實現如下：

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)throws IOException, ServletException {HttpServletRequest httpRequest = (HttpServletRequest) request;HttpServletResponse httpResponse = (HttpServletResponse) response;try {// 從域名獲取學校信息String serverName = httpRequest.getServerName();String[] domainParts = serverName.split("\\.");if (domainParts.length >= 3) {String subdomain = domainParts[0];// 查詢學校IDSchool school = schoolService.getByDomain(subdomain);if (school != null) {// 設置到SchoolContextHolder和請求屬性SchoolContextHolder.setSchoolId(school.getId().toString());} else {// 如果找不到學校，拋出異常throw new UnauthorizedAccessException("異常域名");}} else {// 如果不是二級域名，拋出異常throw new UnauthorizedAccessException("異常域名");}chain.doFilter(request, response);} catch (UnauthorizedAccessException ex) {// 手動處理異常，寫入響應httpResponse.setStatus(HttpStatus.NOT_FOUND.value());httpResponse.setContentType("application/json;charset=UTF-8");httpResponse.getWriter().write("{\"timestamp\": " + System.currentTimeMillis() + ", \"status\": 404, \"error\": \"Not Found\", \"message\": \"" + ex.getMessage() + "\", \"path\": \"" + httpRequest.getRequestURI() + "\"}");} finally {SchoolContextHolder.clear();}
}

4.2 確保`@RestControllerAdvice`被正確掃描

確保GlobalExceptionHandler類所在的包在Spring Boot的掃描路徑內。例如：

@SpringBootApplication(scanBasePackages = "cn.jbolt")
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}

4.3 調整Spring Boot的默認錯誤處理機制

可以通過配置application.properties或application.yml文件來調整默認錯誤處理行為。例如：

server.error.include-stacktrace=never
server.error.include-message=always
server.error.include-binding-errors=always
server.error.include-exception=false

5. 測試驗證

5.1 測試用例

使用Postman測試以下兩種場景：

正常請求：請求的域名和路徑符合預期，應返回正常響應。
異常請求：請求的域名不符合預期，應返回404錯誤。

5.2 測試結果

正常請求：返回正常響應。

異常請求：返回404錯誤，響應內容如下：

{"timestamp": 1745483881203,"status": 404,"error": "Not Found","message": "異常域名","path": "/auth/login"
}

6. 注意事項

6.1 異常處理的優先級

如果項目中有多個全局異常處理器，可能會導致異常處理邏輯被覆蓋。確保自定義的異常處理邏輯優先級高于其他全局異常處理器。

6.2 日志記錄

在全局異常處理器中添加日志記錄，方便調試和排查問題。例如：

@ExceptionHandler(UnauthorizedAccessException.class)
public ResponseEntity<String> handleUnauthorizedAccessException(UnauthorizedAccessException ex) {System.out.println("UnauthorizedAccessException-------------------------: " + ex.getMessage());HttpStatus status = ex.getStatus();String message = ex.getMessage();return new ResponseEntity<>(message, status);
}

6.3 響應格式的統一

確保返回的響應格式與前端的要求一致。可以使用統一的錯誤響應類來封裝錯誤信息，例如：

public class ErrorResponse {private Long timestamp;private int status;private String error;private String message;private String path;// Getters and Setters
}

然后在Filter中返回統一的錯誤響應：

httpResponse.getWriter().write(new ObjectMapper().writeValueAsString(new ErrorResponse(System.currentTimeMillis(), 404, "Not Found", ex.getMessage(), httpRequest.getRequestURI())));

7. 總結

通過在Filter中手動處理異常，確保返回給前端的響應是正確的404錯誤，而不是500錯誤。

本文來自互聯網用戶投稿，該文觀點僅代表作者本人，不代表本站立場。本站僅提供信息存儲空間服務，不擁有所有權，不承擔相關法律責任。
如若轉載，請注明出處：http://www.pswp.cn/diannao/80354.shtml
繁體地址，請注明出處：http://hk.pswp.cn/diannao/80354.shtml
英文地址，請注明出處：http://en.pswp.cn/diannao/80354.shtml

如若內容造成侵權/違法違規/事實不符，請聯系多彩編程網進行投訴反饋email:809451989@qq.com，一經查實，立即刪除！