SpringBoot中幹掉Whitelabel Error Page返回自定義內容的實現

Posted on by

 1. 引言

SpringBoot中對於錯誤請求的頁面是長這樣的，

Whitelabel Error Page

然而我們在訪問在一些網站時，如果請求錯誤，一般都會有友好美觀的提示，比如知乎這個，這比起一堆錯誤信息要友好的多瞭。

BHu

我們可以根據項目業務來自定義錯誤請求（RequestMapping中沒有映射到的請求）的處理，比如返回自定義錯誤頁面或者Json字符串。

2. 分析

我們看看SpringBoot中對於錯誤請求是如何處理的。SpringBoot項目中搜索Whitelabel定位到類WhitelabelErrorViewConfiguration，可以看到它是ErrorMvcAutoConfiguration的一個靜態內部類，而且正是這個類處理的錯誤請求的，代碼中的defaultErrorView正是我們看到的默認錯誤頁面。

@Configuration(proxyBeanMethods = false)
@ConditionalOnProperty(prefix = "server.error.whitelabel", name = "enabled", matchIfMissing = true)
@Conditional(ErrorMvcAutoConfiguration.ErrorTemplateMissingCondition.class)
protected static class WhitelabelErrorViewConfiguration {

	private final ErrorMvcAutoConfiguration.StaticView defaultErrorView = new ErrorMvcAutoConfiguration.StaticView();

	@Bean(name = "error")
	@ConditionalOnMissingBean(name = "error")
	public View defaultErrorView() {
		return this.defaultErrorView;
	}
	// and so on...
}

仔細研究這個代碼，我們不難發現，我們至少有兩種方法可以替換掉默認的實現自定義錯誤頁面。

入手點1：

@ConditionalOnProperty(prefix = "server.error.whitelabel", name = "enabled", matchIfMissing = true)

入手點2：

@Bean(name = "error")
@ConditionalOnMissingBean(name = "error")

3. 嘗試

3.1 嘗試 1

@ConditionalOnProperty(prefix = "server.error.whitelabel", name = "enabled", matchIfMissing = true)

我們看到server.error.whitelabel.enabled控制瞭這個類是否裝配，我們可以在配置中將其設為false

server:
 error:
  whitelabel:
   enabled: false
  path: /error

該配置類為ErrorProperties，默認的錯誤請求為/error，將 whitelabel 禁用後在 controller 中定義請求 /error返回自定義內容。

@Controller
public class ErrorController {

	@RequestMapping("/error")
	@ResponseBody
	public R error(HttpServletRequest request) {
		Integer status = (Integer) request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
		if (Objects.nonNull(status)) {
			HttpStatus httpStatus = HttpStatus.valueOf(status);
			return RUtils.fail(httpStatus);
		}
		return RUtils.fail("Error");
	}

}

運行！一頓操作猛如虎，仔細一看原地杵，想法不錯，但瘋狂報錯：

org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name ‘documentationPluginsBootstrapper’ defined in URL [jar:file:/D:/Environment/Maven/repository/io/springfox/springfox-spring-web/2.9.2/springfox-spring-web-2.9.2.jar!/springfox/documentation/spring/web/plugins/DocumentationPluginsBootstrapper.class]: Unsatisfied dependency expressed through constructor parameter 1; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name ‘webMvcRequestHandlerProvider’ defined in URL [jar:file:/D:/Environment/Maven/repository/io/springfox/springfox-spring-web/2.9.2/springfox-spring-web-2.9.2.jar!/springfox/documentation/spring/web/plugins/WebMvcRequestHandlerProvider.class]: Unsatisfied dependency expressed through constructor parameter 1; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name ‘requestMappingHandlerMapping’ defined in class path resource [xxx/xxx/xxx/config/WebMvcConfig.class]: Invocation of init method failed; nested exception is java.lang.IllegalStateException: Ambiguous mapping. Cannot map ‘basicErrorController’ method
org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController#error(HttpServletRequest)
to { /error}: There is already ‘errorController’ bean method

具體報錯原因未作分析，懷疑是我項目設置有問題，筆者使用的SpringBoot版本是2.3.6.RELEASE，大傢可以嘗試一些行不行。既然第一個方法嘗試接著嘗試失敗，那就試試第二個吧。

3.2 嘗試2

@Bean(name = "error")
@ConditionalOnMissingBean(name = "error")

這個操作更簡單，我們隻要向IoC 容器中註入一個名為error的Bean即可，返回類型為View:

@Configuration
public class MyConfig {
  @Bean("error")
	public View error() {
		ModelAndView view = new ModelAndView(new MappingJackson2JsonView());
		return view.getView();
	}
}

其中new MappingJackson2JsonView()返回的Json字符串的 View ，當然你也可以根據業務需求靈活使用，如果想獲取HttpServletRequest可以這樣獲取，但使用時需要註意判空，因為Bean實例化註入是可能獲取不到HttpServletRequest而造成NPE，項目啟動失敗。

public static HttpServletRequest getRequest() {
  return Optional.ofNullable(RequestContextHolder.getRequestAttributes())
     .map(r -> ((ServletRequestAttributes) r).getRequest())
     .orElse(null);
}

結果當然是沒問題的，會返回以下信息：

result

4. 總結

解決問題：

搜索引擎找解決方法深入源碼嘗試自己解決

到此這篇關於SpringBoot中幹掉Whitelabel Error Page返回自定義內容的文章就介紹到這瞭,更多相關SpringBoot返回自定義內容內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：