logo

Spring Boot: personalizza la pagina di errore Whitelabel

Nell'ecosistema Spring Boot, quando non è presente una pagina di errore personalizzata per gestire un errore specifico, Spring Boot per impostazione predefinita gestisce l'errore con l'aiuto del Pagina di errore Whitelabel.

Whitelabel_Error_Page



Questa è la pagina di errore Whitelabel predefinita. Possiamo anche personalizzare questa pagina di errore whitelabel. In questo articolo, discutiamo alcuni approcci per personalizzare questa pagina di errore Whitelabel.

Nota: Possiamo disabilitare la pagina di errore Whitelabel impostando la proprietà server.error.whitelabel.enabled su false.
server.error.whitelabel.enabled=false

Configurazione IDE per il progetto

Impostiamo il nostro IDE creando il progetto Spring Boot. Per creare un progetto Spring Boot, accedere al file Menù archivio > Nuovo > Altri > Progetto Starter di Primavera



springboot_starter_project_creation

Configura il progetto in base alle tue esigenze.

Nota: Qui, Java versione 8, strumento di gestione build Maven e IDE Eclipse utilizzati per Java e sviluppatori Web 2023-06



spring_starter_project_window

Possiamo anche aggiungere le seguenti dipendenze con un clic durante l'impostazione del progetto.

Dipendenze richieste

Spring Boot DevTools Thymeleaf Spring Web Services>

E una volta aggiunte queste dipendenze, fai clic su ' fine ‘ il progetto verrà creato.

aggiunta_dipendenze_in_spring_starter_project

Impostazione del progetto per l'applicazione

Passaggio 1: aggiunta di dipendenze

Una volta creato il progetto, configuriamo il nostro file pom.xml (se utilizzi Maven) aggiungendo le dipendenze richieste.

servizi web spring-boot-starter : per gestire metodi ed endpoint HTTP

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

spring-boot-starter-thymeleaf: Thymeleaf è un motore di modelli e fornisce un formato più strutturato per i modelli.

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

spring-boot-devtools: È una dipendenza facoltativa ma fornisce molti strumenti e funzionalità di sviluppo per creare applicazioni.

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

Passaggio 2: creazione delle risorse

Una volta configurato il file pom.xml, creiamo le risorse.

teoria degli alberi e dei grafi
  • Passare al ` src/principale/risorse ` cartella nella struttura del progetto. All'interno, crea una cartella denominata ` modelli ` per memorizzare i modelli HTML. Ora crea una pagina di errore personalizzata con un file ` .html `estensione. Ad esempio, ho denominato il modello HTML come ` pagina_errore `.html.

pacchetto_esploratore

  • Ora scrivi la logica personalizzata con cui desideri sovrascrivere la pagina di errore whitelabel predefinita.

pagina_errore.html:

HTML




elimina l'ultimo commit git

> <>html>>> <>head>>> ><>title>>Titolo errore> testa>

Pagina errore personalizzatah1>

Qualcosa è andato storto. Riprova più tardi.p> body> html>>

>

>

Passaggio 3: sovrascrivere le proprietà predefinite

  • Per impostazione predefinita, Spring Boot utilizza l'estensione ` proprietà.applicazione 'o''. applicazione.yml ` file per impostare le proprietà di un'applicazione. Per sovrascrivere qualsiasi comportamento predefinito dell'applicazione Spring Boot, possiamo aggiungere e configurare le proprietà in questi file in base allo strumento di gestione della build. Per impostazione predefinita, Spring Boot utilizza la pagina di errore Whitelabel. Per sovrascrivere questo comportamento configuriamo alcune proprietà.
  • Copia e incolla le seguenti proprietà nel file ` proprietà.applicazione ` (se stai usando Maven)

//Questa proprietà viene utilizzata per indicare il percorso del nostro modello
spring.mvc.view.prefix=/templates/

//Questa proprietà viene utilizzata per indicare l'estensione o il tipo dei modelli
spring.mvc.view.suffix=.html

//Questa proprietà impostata su false indica che non vogliamo utilizzare la pagina di errore whitelabel predefinita server.error.whitelabel.enabled=false

//Questa proprietà viene utilizzata per specificare il percorso della nostra pagina di errore
server.error.path=/errore

Passaggio 4: creazione della classe Controller

Creiamo la classe Controller del nostro progetto. Per fare ciò, vai al pacchetto predefinito del nostro progetto. Crea un sottopacchetto denominato ` controllore ` e all'interno del pacchetto controller creare la classe controller. Ad esempio, ho chiamato la classe controller come ` ControllerClass.java `.

Giava


numeri romani 1-100



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'>;> >}> > }>

>

>

Spiegazione per la creazione della classe controller:

Nel codice precedente, la nostra ControllerClass implementa il ` ErrorController ` per visualizzare gli errori. Nella classe abbiamo definito un file ` handleErrore ` metodo che è annotato con ` @GetMapping ` specificato con l'endpoint ` /errore ` e restituendo il modello ` pagina_errore `.

Struttura del progetto

Assicurati che il tuo progetto sia nella seguente struttura di progetto.

struttura_progetto

Passaggi per eseguire l'applicazione

Per eseguire l'applicazione, fare clic con il pulsante destro del mouse sul progetto > Correre come > Applicazione Spring Boot.

springboot_application_run

Output della pagina di errore personalizzata:

Prova a fornire qualsiasi percorso non gestito nella classe controller. Mostrerà la pagina di errore personalizzata.

pagina_errore_personalizzata