la Primavera di Avvio fornisce un ottimo supporto per la costruzione di Servizi RESTful Web per le applicazioni aziendali. Questo capitolo spiegherà in dettaglio la creazione di servizi web RESTful utilizzando Spring Boot.
Nota-Per creare un servizio Web RESTful, è necessario aggiungere la dipendenza Web Spring Boot Starter nel file di configurazione della build.,
Se sei un utente Maven, usa il seguente codice per aggiungere la dipendenza sottostante nel tuo pom.file xml-
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>
Se sei un utente Gradle, usa il seguente codice per aggiungere la dipendenza sottostante nella tua build.file gradle.
compile('org.springframework.boot:spring-boot-starter-web')
Il codice per il file di configurazione di compilazione completa Maven build – pom.xml è dato di seguito –
Il codice per il file di configurazione di compilazione completa Gradle Build-build.,gradle è dato di seguito-
Prima di procedere alla creazione di un servizio web RESTful, si suggerisce di avere conoscenza delle seguenti annotazioni −
Rest Controller
L’annotazione @RestController viene utilizzata per definire i servizi web RESTful. Serve JSON, XML e risposta personalizzata. La sua sintassi è mostrata di seguito −
@RestControllerpublic class ProductServiceController { }
Mappatura delle richieste
L’annotazione @RequestMapping viene utilizzata per definire l’URI di richiesta per accedere agli endpoint REST. Possiamo definire il metodo di richiesta per consumare e produrre oggetti. Il metodo di richiesta predefinito è GET.,
@RequestMapping(value = "/products")public ResponseEntity<Object> getProducts() { }
Corpo della richiesta
L’annotazione @RequestBody viene utilizzata per definire il tipo di contenuto del corpo della richiesta.
public ResponseEntity<Object> createProduct(@RequestBody Product product) {}
Variabile di percorso
L’annotazione @PathVariable viene utilizzata per definire l’URI di richiesta personalizzata o dinamica. La variabile Path nell’URI della richiesta è definita come parentesi graffe {} come mostrato di seguito-
public ResponseEntity<Object> updateProduct(@PathVariable("id") String id) {}
Parametro di richiesta
L’annotazione @RequestParam viene utilizzata per leggere i parametri della richiesta dall’URL della richiesta. Per impostazione predefinita, è un parametro obbligatorio., Possiamo anche impostare il valore predefinito per i parametri di richiesta come mostrato qui-
public ResponseEntity<Object> getProduct( @RequestParam(value = "name", required = false, defaultValue = "honey") String name) {}
GET API
Il metodo di richiesta HTTP predefinito è GET. Questo metodo non richiede alcun corpo di richiesta. È possibile inviare parametri di richiesta e variabili di percorso per definire l’URL personalizzato o dinamico.
Il codice di esempio per definire il metodo HTTP GET request è mostrato di seguito. In questo esempio, abbiamo usato HashMap per memorizzare il Prodotto. Si noti che abbiamo utilizzato una classe POJO come prodotto da memorizzare.
Qui, l’URI di richiesta è / products e restituirà l’elenco dei prodotti dal repository HashMap., Di seguito viene riportato il file della classe controller che contiene l’endpoint REST del metodo GET.
API POST
La richiesta HTTP POST viene utilizzata per creare una risorsa. Questo metodo contiene il Corpo della richiesta. Possiamo inviare parametri di richiesta e variabili di percorso per definire l’URL personalizzato o dinamico.
Il seguente esempio mostra il codice di esempio per definire il metodo HTTP POST request. In questo esempio, abbiamo usato HashMap per memorizzare il prodotto, dove il prodotto è una classe POJO.
Qui, l’URI di richiesta è / products e restituirà la stringa dopo aver memorizzato il prodotto nel repository HashMap.,
PUT API
La richiesta PUT HTTP viene utilizzata per aggiornare la risorsa esistente. Questo metodo contiene un corpo di richiesta. Possiamo inviare parametri di richiesta e variabili di percorso per definire l’URL personalizzato o dinamico.
L’esempio riportato di seguito mostra come definire il metodo di richiesta HTTP PUT. In questo esempio, abbiamo usato HashMap per aggiornare il prodotto esistente, in cui il prodotto è una classe POJO.
Qui l’URI di richiesta è /products/{id} che restituirà la stringa dopo un prodotto in un repository HashMap., Si noti che abbiamo utilizzato la variabile Path {id} che definisce l’ID prodotti che deve essere aggiornato.
DELETE API
La richiesta HTTP Delete viene utilizzata per eliminare la risorsa esistente. Questo metodo non contiene alcun corpo di richiesta. Possiamo inviare parametri di richiesta e variabili di percorso per definire l’URL personalizzato o dinamico.
L’esempio riportato di seguito mostra come definire il metodo HTTP DELETE request. In questo esempio, abbiamo usato HashMap per rimuovere il prodotto esistente, che è una classe POJO.,
L’URI di richiesta è /products/{id} e restituirà la stringa dopo aver eliminato il prodotto dal repository HashMap. Abbiamo utilizzato la variabile Path {id} che definisce l’ID dei prodotti che deve essere eliminato.
Questa sezione fornisce il set completo di codice sorgente. Osservare i seguenti codici per le rispettive funzionalità-
La classe di applicazione principale Spring Boot – DemoApplication.java
La classe POJO-Prodotto.java
La classe del controller Rest – ProductServiceController.,java
È possibile creare un file JAR eseguibile ed eseguire l’applicazione spring boot utilizzando i seguenti comandi Maven o Gradle come mostrato −
Per Maven, utilizzare il comando mostrato di seguito −
mvn clean install
Dopo “BUILD SUCCESS”, è possibile trovare il file JAR nella directory di destinazione.
Per Gradle, usa il comando mostrato di seguito −
gradle clean build
Dopo “BUILD SUCCESSFUL”, puoi trovare il file JAR nella directory build / libs.,
Puoi eseguire il file JAR usando il comando mostrato di seguito −
java –jar <JARFILE>
Questo avvierà l’applicazione sulla porta Tomcat 8080 come mostrato di seguito −
Ora premi l’URL mostrato di seguito nell’applicazione POSTMAN e vedi l’output.,
GET API URL is: http://localhost:8080/products
POST API URL is: http://localhost:8080/products
PUT API URL is: http://localhost:8080/products/3
DELETE API URL is: http://localhost:8080/products/3
