logo

TechCodeview

Spring Boot – Prispôsobte chybovú stránku Whitelabel

Ak v ekosystéme Spring Boot neexistuje žiadna vlastná chybová stránka na spracovanie špecifickej chyby, Spring Boot štandardne spracuje chybu pomocou Chybová stránka Whitelabel.

Whitelabel_Error_Page



Toto je predvolená chybová stránka Whitelabel. Túto chybovú stránku whitelabel môžeme tiež prispôsobiť. V tomto článku si rozoberieme niektoré prístupy na prispôsobenie tejto chybovej stránky Whitelabel.

Poznámka: Chybovú stránku Whitelabel môžeme zakázať nastavením vlastnosti server.error.whitelabel.enabled na hodnotu false.
server.error.whitelabel.enabled=false

Nastavenie IDE pre projekt

Poďme nastaviť naše IDE vytvorením projektu Spring Boot. Ak chcete vytvoriť projekt Spring Boot, prejdite na Ponuka Súbor > Nový > Iní > Jarný štartovací projekt



springboot_starter_project_creation

Nakonfigurujte projekt podľa svojich požiadaviek.

Poznámka: Tu je Java verzia 8, nástroj na správu zostavovania Maven a IDE Eclipse používané pre vývojárov Java a webových vývojárov 2023-06



spring_starter_project_window

Pri nastavovaní projektu môžeme jedným kliknutím pridať aj nasledujúce závislosti.

Požadované závislosti 

Spring Boot DevTools Thymeleaf Spring Web Services>

A keď pridáte tieto závislosti, kliknite na „ skončiť “ sa vytvorí projekt.

add_dependencies_in_spring_starter_project

Nastavenie projektu pre aplikáciu

Krok 1: Pridanie závislostí

Po vytvorení projektu nám dovoľte nakonfigurovať súbor pom.xml (ak používate Maven) pridaním požadovaných závislostí.

spring-boot-starter-web-services : Na spracovanie metód a koncových bodov HTTP

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

jarné čižmy-štartér-tymílový list: Thymeleaf je nástroj na vytváranie šablón a poskytuje šablónam štruktúrovanejší formát.

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

spring-boot-devtools: Je to voliteľná závislosť, ale poskytuje mnoho vývojových nástrojov a funkcií na vytváranie aplikácií.

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

Krok 2: Vytvorenie zdrojov

Keď je súbor pom.xml nakonfigurovaný, vytvorme prostriedky.

  • Prejdite na ` src/main/resources ` priečinok v štruktúre projektu. Vnútri vytvorte priečinok s názvom ` šablóny ` na uloženie šablón HTML. Teraz vytvorte vlastnú chybovú stránku s ` .html ` rozšírenie. Napríklad šablónu HTML som pomenoval ako ` error_page `.html.

package_explorer

statická funkcia v jazyku Java
  • Teraz napíšte svoju prispôsobenú logiku, pomocou ktorej chcete prepísať predvolenú chybovú stránku whitelabel.

error_page.html:

HTML




> <>html>>> <>head>>> ><>title>>Errortitle> head>

Vlastná chybová stránka1>

Niečo sa pokazilo. Skúste to znova neskôr.p> body> html>>

 

>

strojopis dátum čas 
>

Krok 3: Prepísanie predvolených vlastností

  • V predvolenom nastavení Spring Boot používa ` aplikácie.vlastnosti ` alebo ` aplikácia.yml ` súbor na nastavenie vlastností aplikácie. Ak chcete prepísať akékoľvek predvolené správanie aplikácie Spring Boot, môžeme pridať a nakonfigurovať vlastnosti v týchto súboroch podľa vášho nástroja na správu zostavy. V predvolenom nastavení používa Spring Boot chybovú stránku Whitelabel. Ak chcete toto správanie prepísať, nakonfigurujte niektoré vlastnosti.
  • Skopírujte a prilepte nasledujúce vlastnosti do súboru ` aplikácie.vlastnosti ` (ak používate Maven)

//Táto vlastnosť sa používa na označenie cesty našej šablóny
spring.mvc.view.prefix=/templates/

//Táto vlastnosť sa používa na označenie rozšírenia alebo typu šablón
spring.mvc.view.suffix=.html

//Táto vlastnosť nastavená na false znamená, že nechceme použiť predvolenú chybovú stránku whitelabel server.error.whitelabel.enabled=false

//Táto vlastnosť sa používa na určenie cesty k našej chybovej stránke
server.error.path=/error

Krok 4: Vytvorenie triedy Controller

Vytvorme triedu Controller nášho projektu. Ak to chcete urobiť, prejdite na predvolený balík nášho projektu. Vytvorte podbalík s názvom ` ovládač ` a vnútri balíka ovládača vytvorte triedu ovládača. Triedu radiča som napríklad pomenoval ako ` 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'>;> >}> > }> 

>

>

Vysvetlenie pre vytvorenie triedy radiča:

Vo vyššie uvedenom kóde naša trieda ControllerClass implementuje znak ` ErrorController ` na vykreslenie chýb. V triede sme definovali ` handleError ` metóda, ktorá je označená znakom ` @GetMapping ` špecifikovaný s koncovým bodom ` /chyba ` a vrátením šablóny ` error_page `.

Štruktúra projektu

Uistite sa, že váš projekt má nasledujúcu štruktúru projektu.

projektová_štruktúra

Kroky na spustenie aplikácie

Ak chcete spustiť aplikáciu, kliknite pravým tlačidlom myši na projekt > Spustiť ako > Aplikácia Spring Boot.

springboot_application_run

Výstup vlastnej chybovej stránky:

Skúste zadať akúkoľvek cestu, ktorá nie je spracovaná v triede radiča. Zobrazí vlastnú chybovú stránku.

custom_error_page