Spring Boot - Rest Vorlage
Die Restvorlage wird zum Erstellen von Anwendungen verwendet, die RESTful Web Services verwenden. Du kannst den ... benutzenexchange()Methode zum Konsumieren der Webdienste für alle HTTP-Methoden. Der folgende Code zeigt, wie Sie Bean for Rest Template erstellen, um das Rest Template-Objekt automatisch zu verkabeln.
package com.tutorialspoint.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
@Bean
public RestTemplate getRestTemplate() {
return new RestTemplate();
}
}
BEKOMMEN
Consuming the GET API by using RestTemplate - exchange() method
Nehmen Sie diese URL an http://localhost:8080/products Gibt den folgenden JSON zurück und wir werden diese API-Antwort mithilfe der Restvorlage mit dem folgenden Code verwenden:
[
{
"id": "1",
"name": "Honey"
},
{
"id": "2",
"name": "Almond"
}
]
Sie müssen die angegebenen Punkte befolgen, um die API zu verwenden -
- Das Rest Template-Objekt wurde automatisch verdrahtet.
- Verwenden Sie HttpHeaders, um die Anforderungsheader festzulegen.
- Verwenden Sie HttpEntity, um das Anforderungsobjekt zu verpacken.
- Geben Sie den URL-, HttpMethod- und Return-Typ für die Exchange () -Methode an.
@RestController
public class ConsumeWebService {
@Autowired
RestTemplate restTemplate;
@RequestMapping(value = "/template/products")
public String getProductList() {
HttpHeaders headers = new HttpHeaders();
headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
HttpEntity <String> entity = new HttpEntity<String>(headers);
return restTemplate.exchange("
http://localhost:8080/products", HttpMethod.GET, entity, String.class).getBody();
}
}
POST
Consuming POST API by using RestTemplate - exchange() method
Nehmen Sie diese URL an http://localhost:8080/products Gibt die unten gezeigte Antwort zurück. Wir werden diese API-Antwort mithilfe der Restvorlage verwenden.
Der unten angegebene Code ist der Anfragetext -
{
"id":"3",
"name":"Ginger"
}
Der unten angegebene Code ist der Antworttext -
Product is created successfully
Sie müssen die unten angegebenen Punkte befolgen, um die API zu verwenden -
Das Rest Template-Objekt wurde automatisch verdrahtet.
Verwenden Sie die HttpHeaders, um die Anforderungsheader festzulegen.
Verwenden Sie die HttpEntity, um das Anforderungsobjekt zu verpacken. Hier verpacken wir das Product-Objekt, um es an den Anforderungshauptteil zu senden.
Geben Sie den URL-, HttpMethod- und Return-Typ für die exchange () -Methode an.
@RestController
public class ConsumeWebService {
@Autowired
RestTemplate restTemplate;
@RequestMapping(value = "/template/products", method = RequestMethod.POST)
public String createProducts(@RequestBody Product product) {
HttpHeaders headers = new HttpHeaders();
headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
HttpEntity<Product> entity = new HttpEntity<Product>(product,headers);
return restTemplate.exchange(
"http://localhost:8080/products", HttpMethod.POST, entity, String.class).getBody();
}
}
STELLEN
Consuming PUT API by using RestTemplate - exchange() method
Nehmen Sie diese URL an http://localhost:8080/products/3 Gibt die folgende Antwort zurück und wir werden diese API-Antwort mithilfe der Restvorlage verwenden.
Der unten angegebene Code lautet Anforderungshauptteil -
{
"name":"Indian Ginger"
}
Der unten angegebene Code ist der Antworttext -
Product is updated successfully
Sie müssen die unten angegebenen Punkte befolgen, um die API zu verwenden -
Das Rest Template-Objekt wurde automatisch verdrahtet.
Verwenden Sie HttpHeaders, um die Anforderungsheader festzulegen.
Verwenden Sie HttpEntity, um das Anforderungsobjekt zu verpacken. Hier verpacken wir das Product-Objekt, um es an den Anforderungshauptteil zu senden.
Geben Sie den URL-, HttpMethod- und Return-Typ für die exchange () -Methode an.
@RestController
public class ConsumeWebService {
@Autowired
RestTemplate restTemplate;
@RequestMapping(value = "/template/products/{id}", method = RequestMethod.PUT)
public String updateProduct(@PathVariable("id") String id, @RequestBody Product product) {
HttpHeaders headers = new HttpHeaders();
headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
HttpEntity<Product> entity = new HttpEntity<Product>(product,headers);
return restTemplate.exchange(
"http://localhost:8080/products/"+id, HttpMethod.PUT, entity, String.class).getBody();
}
}
LÖSCHEN
Consuming DELETE API by using RestTemplate - exchange() method
Nehmen Sie diese URL an http://localhost:8080/products/3 Gibt die unten angegebene Antwort zurück und wir werden diese API-Antwort mithilfe der Restvorlage verwenden.
Diese unten gezeigte Codezeile ist der Antworttext -
Product is deleted successfully
Sie müssen die unten gezeigten Punkte befolgen, um die API zu verwenden -
Das Rest Template-Objekt wurde automatisch verdrahtet.
Verwenden Sie HttpHeaders, um die Anforderungsheader festzulegen.
Verwenden Sie HttpEntity, um das Anforderungsobjekt zu verpacken.
Geben Sie den URL-, HttpMethod- und Return-Typ für die exchange () -Methode an.
@RestController
public class ConsumeWebService {
@Autowired
RestTemplate restTemplate;
@RequestMapping(value = "/template/products/{id}", method = RequestMethod.DELETE)
public String deleteProduct(@PathVariable("id") String id) {
HttpHeaders headers = new HttpHeaders();
headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
HttpEntity<Product> entity = new HttpEntity<Product>(headers);
return restTemplate.exchange(
"http://localhost:8080/products/"+id, HttpMethod.DELETE, entity, String.class).getBody();
}
}
Die vollständige Rest Template Controller-Klassendatei finden Sie unten -
package com.tutorialspoint.demo.controller;
import java.util.Arrays;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
import com.tutorialspoint.demo.model.Product;
@RestController
public class ConsumeWebService {
@Autowired
RestTemplate restTemplate;
@RequestMapping(value = "/template/products")
public String getProductList() {
HttpHeaders headers = new HttpHeaders();
headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
HttpEntity<String> entity = new HttpEntity<String>(headers);
return restTemplate.exchange(
"http://localhost:8080/products", HttpMethod.GET, entity, String.class).getBody();
}
@RequestMapping(value = "/template/products", method = RequestMethod.POST)
public String createProducts(@RequestBody Product product) {
HttpHeaders headers = new HttpHeaders();
headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
HttpEntity<Product> entity = new HttpEntity<Product>(product,headers);
return restTemplate.exchange(
"http://localhost:8080/products", HttpMethod.POST, entity, String.class).getBody();
}
@RequestMapping(value = "/template/products/{id}", method = RequestMethod.PUT)
public String updateProduct(@PathVariable("id") String id, @RequestBody Product product) {
HttpHeaders headers = new HttpHeaders();
headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
HttpEntity<Product> entity = new HttpEntity<Product>(product,headers);
return restTemplate.exchange(
"http://localhost:8080/products/"+id, HttpMethod.PUT, entity, String.class).getBody();
}
@RequestMapping(value = "/template/products/{id}", method = RequestMethod.DELETE)
public String deleteProduct(@PathVariable("id") String id) {
HttpHeaders headers = new HttpHeaders();
headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
HttpEntity<Product> entity = new HttpEntity<Product>(headers);
return restTemplate.exchange(
"http://localhost:8080/products/"+id, HttpMethod.DELETE, entity, String.class).getBody();
}
}
Der Code für die Spring Boot-Anwendungsklasse - DemoApplication.java ist unten angegeben:
package com.tutorialspoint.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
Der Code für Maven build - pom.xml ist unten angegeben -
<?xml version = "1.0" encoding = "UTF-8"?>
<project xmlns = "http://maven.apache.org/POM/4.0.0"
xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.tutorialspoint</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>demo</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.8.RELEASE</version>
<relativePath/>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
Der Code für Gradle Build - build.gradle ist unten angegeben -
buildscript {
ext {
springBootVersion = '1.5.8.RELEASE'
}
repositories {
mavenCentral()
}
dependencies {
classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
}
}
apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'
group = 'com.tutorialspoint'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8
repositories {
mavenCentral()
}
dependencies {
compile('org.springframework.boot:spring-boot-starter-web')
testCompile('org.springframework.boot:spring-boot-starter-test')
}
Sie können eine ausführbare JAR-Datei erstellen und die Spring Boot-Anwendung mit den folgenden Maven- oder Gradle-Befehlen ausführen:
Für Maven können Sie den folgenden Befehl verwenden:
mvn clean install
Nach "BUILD SUCCESS" finden Sie die JAR-Datei im Zielverzeichnis.
Für Gradle können Sie den folgenden Befehl verwenden:
gradle clean build
Nach "BUILD SUCCESSFUL" finden Sie die JAR-Datei im Verzeichnis build / libs.
Führen Sie nun die JAR-Datei mit dem folgenden Befehl aus:
java –jar <JARFILE>
Jetzt wurde die Anwendung auf dem Tomcat-Port 8080 gestartet.
Klicken Sie nun in der POSTMAN-Anwendung auf die folgenden URLs, und Sie können die Ausgabe sehen.
GET Produkte von Rest Template - http://localhost:8080/template/products
Produkte erstellen POST - http://localhost:8080/template/products
Produkt-PUT aktualisieren - http://localhost:8080/template/products/3
Produkt löschen - http://localhost:8080/template/products/3