logo

TechCodeview

Spring Boot – налаштуйте сторінку помилок Whitelabel

В екосистемі Spring Boot, якщо немає спеціальної сторінки помилки для обробки конкретної помилки, Spring Boot за замовчуванням обробляє помилку за допомогою Сторінка помилки Whitelabel.

Whitelabel_Error_Page



Це типова сторінка помилки Whitelabel. Ми також можемо налаштувати цю сторінку помилок білої мітки. У цій статті давайте обговоримо деякі підходи до налаштування цієї сторінки помилки Whitelabel.

Примітка: Ми можемо вимкнути сторінку помилок Whitelabel, встановивши для властивості server.error.whitelabel.enabled значення false.
server.error.whitelabel.enabled=false

Налаштування IDE для проекту

Давайте налаштуємо нашу IDE, створивши проект Spring Boot. Щоб створити проект завантаження Spring, перейдіть до Меню «Файл». > новий > інші > Весняний стартовий проект



springboot_starter_project_creation

Налаштуйте проект відповідно до ваших вимог.

Примітка: Тут Java версії 8, інструмент керування збіркою Maven і IDE Eclipse, що використовуються для Java і веб-розробників 2023-06



spring_starter_project_window

перемикач java

Ми також можемо додати наступні залежності в один клік під час налаштування проекту.

Необхідні залежності 

Spring Boot DevTools Thymeleaf Spring Web Services>

І як тільки ви додасте ці залежності, натисніть ' закінчити «проект буде створено.

adding_dependencies_in_spring_starter_project

Налаштування проекту для програми

Крок 1: Додавання залежностей

Після створення проекту давайте налаштуємо наш файл pom.xml (якщо ви використовуєте Maven), додавши необхідні залежності.

spring-boot-starter-web-services : для обробки методів і кінцевих точок HTTP

  org.springframework.boot  spring-boot-starter-web-services>

spring-boot-starter-thymeleaf: Thymeleaf — це система шаблонів, яка забезпечує більш структурований формат для шаблонів.

  org.springframework.boot  spring-boot-starter-thymeleaf>

spring-boot-devtools: Це необов’язкова залежність, але вона надає багато інструментів розробки та функцій для створення програм.

  org.springframework.boot  spring-boot-devtools  runtime  true>

Крок 2: Створення ресурсів

Коли файл pom.xml налаштовано, давайте створимо ресурси.

  • Перейдіть до ` src/main/resources ` у структурі проекту. Усередині цього створіть папку з назвою ` шаблони ` для зберігання шаблонів HTML. Тепер створіть спеціальну сторінку помилок із символом ` .html ` розширення. Наприклад, я назвав шаблон HTML як ` error_page `.html.

package_explorer

  • Тепер напишіть свою налаштовану логіку, за допомогою якої ви хочете замінити сторінку помилки білої мітки за замовчуванням.

error_page.html:

HTML




масив об'єктів java
> <>html>>> <>head>>> ><>title>>Errortitle> head>

Спеціальна сторінка помилок h1>

Щось пішло не так. Спробуйте пізніше.p> body> html>>

 

>

>

Крок 3: Заміна властивостей за замовчуванням

  • За замовчуванням Spring Boot використовує ` додаток.властивості ` або ` application.yml ` для налаштування властивостей програми. Щоб перевизначити будь-яку поведінку за замовчуванням програми Spring Boot, ми можемо додати та налаштувати властивості в цих файлах відповідно до вашого інструменту керування збірками. За замовчуванням Spring Boot використовує сторінку помилки Whitelabel. Щоб змінити цю поведінку, давайте налаштуємо деякі властивості.
  • Скопіюйте та вставте такі властивості в ` додаток.властивості ` (якщо ви використовуєте Maven)

//Ця властивість використовується для вказівки шляху нашого шаблону
spring.mvc.view.prefix=/templates/

//Ця властивість використовується для вказівки розширення або типу шаблонів
spring.mvc.view.suffix=.html

//Ця властивість, встановлена ​​на false, вказує на те, що ми не хочемо використовувати сторінку помилки whitelabel за умовчанням server.error.whitelabel.enabled=false

//Ця властивість використовується для визначення шляху нашої сторінки помилки
server.error.path=/помилка

Крок 4: Створення класу Controller

Давайте створимо клас Controller нашого проекту. Для цього перейдіть до стандартного пакета нашого проекту. Створіть підпакет із назвою ` контролер ` і всередині пакунка контролера створіть клас контролера. Наприклад, я назвав клас контролера ` ControllerClass.java `.

Java




package> com.example.demo.controller;> > import> org.springframework.boot.web.servlet.error.ErrorController;> import> org.springframework.stereotype.Controller;> import> org.springframework.web.bind.annotation.GetMapping;> > @Controller> public> class> ControllerClass>implements> ErrorController {> > >@GetMapping>(>'/error'>)> >public> String handleError() {> >return> 'error_page'>;> >}> > }> 

>

>

Пояснення для створення класу контролера:

У наведеному вище коді наш ControllerClass реалізує ` ErrorController ` для відтворення помилок. У класі ми визначили ` handleError ` метод, який позначено ` @GetMapping ` вказано з кінцевою точкою ` /помилка ` і повернення шаблону ` error_page `.

випадкове число java

Структура проекту

Переконайтеся, що ваш проект відповідає наведеній нижче структурі проекту.

структура_проекту

Кроки для запуску програми

Щоб запустити програму, клацніть правою кнопкою миші на проекті > Бігати як > Додаток Spring Boot.

springboot_application_run

Вихід користувацької сторінки помилок:

Спробуйте вказати будь-який шлях, який не обробляється в класі контролера. Відобразиться спеціальна сторінка помилки.

custom_error_page