STACKJAVA

Spring Boot tùy chỉnh trang Whitelabel Error Page

Spring Boot tùy chỉnh trang Whitelabel Error Page.

Whitelabel Error Page là gì?

Whiteable Error Page là trang lỗi mặc định được Spring Boot xử dụng trong trường hợp server có lỗi.

Ví dụ lỗi thường gặp nhất: 404:

Lỗi này xảy ra do sai đường dẫn (path/url) hoặc thiếu thư viện thymeleaf:

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

Disable Whitelabel Error Page

Nhìn chung thì whitelabel error page không thực sự giúp chúng ta thấy rõ lỗi và nguyên nhân.

Để tắt tính năng whitelable error page ta làm như sau:

Cách 1: Thiết lập server.error.whitelabel.enabled=false trong file applications.properties hoặc file application.yml

Cách 2: Exclude ErrorMvcAutoConfiguration

Cài đặt trong file applications.properties hoặc file application.yml:

spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration

Hoặc sử dụng annotation @EnableAutoConfiguration(exclude = {ErrorMvcAutoConfiguration.class}) trong file main class, ví dụ:

@SpringBootApplication
@EnableAutoConfiguration(exclude = {
 ErrorMvcAutoConfiguration.class
})
public class SpringBootApplication { //application code 
}

Sau khi disable tính năng whitelable error page thì khi có lỗi xảy ra nó sẽ trả về lỗi của Servlet Container.

Ví dụ trang lỗi 404 của tomcat:

Để tùy chỉnh trang lỗi theo ý muốn các bạn có thể xem lại ví dụ: Code ví dụ Spring Boot xử lý Exception, lỗi 404.

 

References:

https://docs.spring.io/…/howto-actuator.html