Spring Boot - tworzenie usług internetowych zgodnych z REST

Spring Boot zapewnia bardzo dobrą obsługę tworzenia RESTful Web Services dla aplikacji korporacyjnych. W tym rozdziale wyjaśniono szczegółowo tworzenie usług internetowych zgodnych z REST przy użyciu Spring Boot.

Note - Aby zbudować RESTful Web Services, musimy dodać zależność Spring Boot Starter Web do pliku konfiguracyjnego kompilacji.

Jeśli jesteś użytkownikiem Maven, użyj poniższego kodu, aby dodać poniższą zależność w pliku pom.xml plik -

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>    
</dependency>

Jeśli jesteś użytkownikiem Gradle, użyj poniższego kodu, aby dodać poniższą zależność w pliku build.gradle plik.

compile('org.springframework.boot:spring-boot-starter-web')

Kod pełnego pliku konfiguracji kompilacji Maven build – pom.xml podano poniżej -

<?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>

Kod pełnego pliku konfiguracji kompilacji Gradle Build – build.gradle podano poniżej -

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

Przed przystąpieniem do tworzenia usługi internetowej zgodnej ze standardem REST zaleca się zapoznanie się z następującymi adnotacjami -

Rest Controller

Adnotacja @RestController służy do definiowania usług internetowych RESTful. Obsługuje JSON, XML i niestandardową odpowiedź. Jego składnię pokazano poniżej -

@RestController
public class ProductServiceController { 
}

Poproś o mapowanie

Adnotacja @RequestMapping służy do definiowania identyfikatora URI żądania w celu uzyskania dostępu do punktów końcowych REST. Możemy zdefiniować metodę Request, aby konsumować i produkować obiekt. Domyślną metodą żądania jest GET.

@RequestMapping(value = "/products")
public ResponseEntity<Object> getProducts() { }

Treść żądania

Adnotacja @RequestBody służy do definiowania typu zawartości treści żądania.

public ResponseEntity<Object> createProduct(@RequestBody Product product) {
}

Zmienna ścieżki

Adnotacja @PathVariable służy do definiowania niestandardowego lub dynamicznego identyfikatora URI żądania. Zmienna Path w identyfikatorze URI żądania jest zdefiniowana jako nawiasy klamrowe {}, jak pokazano poniżej -

public ResponseEntity<Object> updateProduct(@PathVariable("id") String id) {
}

Poproś o parametr

Adnotacja @RequestParam służy do odczytywania parametrów żądania z adresu URL żądania. Domyślnie jest to parametr wymagany. Możemy również ustawić domyślne wartości parametrów żądania, jak pokazano tutaj -

public ResponseEntity<Object> getProduct(
   @RequestParam(value = "name", required = false, defaultValue = "honey") String name) {
}

GET API

Domyślną metodą żądania HTTP jest GET. Ta metoda nie wymaga żadnej treści żądania. Możesz wysłać parametry żądania i zmienne ścieżki, aby zdefiniować niestandardowy lub dynamiczny adres URL.

Przykładowy kod definiujący metodę żądania HTTP GET przedstawiono poniżej. W tym przykładzie użyliśmy HashMap do przechowywania produktu. Zauważ, że użyliśmy klasy POJO jako produktu do przechowywania.

Tutaj identyfikator URI żądania to /productsi zwróci listę produktów z repozytorium HashMap. Plik klasy kontrolera jest podany poniżej, który zawiera metodę GET REST Endpoint.

package com.tutorialspoint.demo.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.tutorialspoint.demo.model.Product;

@RestController
public class ProductServiceController {
   private static Map<String, Product> productRepo = new HashMap<>();
   static {
      Product honey = new Product();
      honey.setId("1");
      honey.setName("Honey");
      productRepo.put(honey.getId(), honey);
      
      Product almond = new Product();
      almond.setId("2");
      almond.setName("Almond");
      productRepo.put(almond.getId(), almond);
   }
   @RequestMapping(value = "/products")
   public ResponseEntity<Object> getProduct() {
      return new ResponseEntity<>(productRepo.values(), HttpStatus.OK);
   }
}

POST API

Żądanie HTTP POST służy do tworzenia zasobu. Ta metoda zawiera treść żądania. Możemy wysłać parametry żądania i zmienne ścieżki, aby zdefiniować niestandardowy lub dynamiczny adres URL.

Poniższy przykład przedstawia przykładowy kod definiujący metodę żądania HTTP POST. W tym przykładzie użyliśmy HashMap do przechowywania produktu, gdzie produkt jest klasą POJO.

Tutaj identyfikator URI żądania to /productsi zwróci String po zapisaniu produktu w repozytorium HashMap.

package com.tutorialspoint.demo.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
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 com.tutorialspoint.demo.model.Product;

@RestController
public class ProductServiceController {
   private static Map<String, Product> productRepo = new HashMap<>();
   
   @RequestMapping(value = "/products", method = RequestMethod.POST)
   public ResponseEntity<Object> createProduct(@RequestBody Product product) {
      productRepo.put(product.getId(), product);
      return new ResponseEntity<>("Product is created successfully", HttpStatus.CREATED);
   }
}

PUT API

Żądanie HTTP PUT służy do aktualizacji istniejącego zasobu. Ta metoda zawiera treść żądania. Możemy wysłać parametry żądania i zmienne ścieżki, aby zdefiniować niestandardowy lub dynamiczny adres URL.

Poniższy przykład pokazuje, jak zdefiniować metodę żądania HTTP PUT. W tym przykładzie użyliśmy HashMap, aby zaktualizować istniejący produkt, gdzie produkt jest klasą POJO.

Tutaj jest identyfikator URI żądania /products/{id}co zwróci ciąg znaków po produkcie do repozytorium HashMap. Zauważ, że użyliśmy zmiennej Path{id} który określa identyfikator produktu, który należy zaktualizować.

package com.tutorialspoint.demo.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
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 com.tutorialspoint.demo.model.Product;

@RestController
public class ProductServiceController {
   private static Map<String, Product> productRepo = new HashMap<>();
   
   @RequestMapping(value = "/products/{id}", method = RequestMethod.PUT)
   public ResponseEntity<Object> updateProduct(@PathVariable("id") String id, @RequestBody Product product) { 
      productRepo.remove(id);
      product.setId(id);
      productRepo.put(id, product);
      return new ResponseEntity<>("Product is updated successsfully", HttpStatus.OK);
   }   
}

USUŃ API

Żądanie HTTP Delete służy do usunięcia istniejącego zasobu. Ta metoda nie zawiera treści żądania. Możemy wysłać parametry żądania i zmienne ścieżki, aby zdefiniować niestandardowy lub dynamiczny adres URL.

Poniższy przykład pokazuje, jak zdefiniować metodę żądania HTTP DELETE. W tym przykładzie użyliśmy HashMap do usunięcia istniejącego produktu, który jest klasą POJO.

Identyfikator URI żądania to /products/{id}i zwróci String po usunięciu produktu z repozytorium HashMap. Użyliśmy zmiennej Path{id} który określa identyfikator produktu, który należy usunąć.

package com.tutorialspoint.demo.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
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 com.tutorialspoint.demo.model.Product;

@RestController
public class ProductServiceController {
   private static Map<String, Product> productRepo = new HashMap<>();
   
   @RequestMapping(value = "/products/{id}", method = RequestMethod.DELETE)
   public ResponseEntity<Object> delete(@PathVariable("id") String id) { 
      productRepo.remove(id);
      return new ResponseEntity<>("Product is deleted successsfully", HttpStatus.OK);
   }
}

Ta sekcja zawiera pełny zestaw kodu źródłowego. Przestrzegaj następujących kodów dotyczących ich funkcji -

The Spring Boot main application class – DemoApplication.java

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

The POJO class – Product.java

package com.tutorialspoint.demo.model;

public class Product {
   private String id;
   private String name;

   public String getId() {
      return id;
   }
   public void setId(String id) {
      this.id = id;
   }
   public String getName() {
      return name;
   }
   public void setName(String name) {
      this.name = name;
   }
}

The Rest Controller class – ProductServiceController.java

package com.tutorialspoint.demo.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
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 com.tutorialspoint.demo.model.Product;

@RestController
public class ProductServiceController {
   private static Map<String, Product> productRepo = new HashMap<>();
   static {
      Product honey = new Product();
      honey.setId("1");
      honey.setName("Honey");
      productRepo.put(honey.getId(), honey);
      
      Product almond = new Product();
      almond.setId("2");
      almond.setName("Almond");
      productRepo.put(almond.getId(), almond);
   }
   
   @RequestMapping(value = "/products/{id}", method = RequestMethod.DELETE)
   public ResponseEntity<Object> delete(@PathVariable("id") String id) { 
      productRepo.remove(id);
      return new ResponseEntity<>("Product is deleted successsfully", HttpStatus.OK);
   }
   
   @RequestMapping(value = "/products/{id}", method = RequestMethod.PUT)
   public ResponseEntity<Object> updateProduct(@PathVariable("id") String id, @RequestBody Product product) { 
      productRepo.remove(id);
      product.setId(id);
      productRepo.put(id, product);
      return new ResponseEntity<>("Product is updated successsfully", HttpStatus.OK);
   }
   
   @RequestMapping(value = "/products", method = RequestMethod.POST)
   public ResponseEntity<Object> createProduct(@RequestBody Product product) {
      productRepo.put(product.getId(), product);
      return new ResponseEntity<>("Product is created successfully", HttpStatus.CREATED);
   }
   
   @RequestMapping(value = "/products")
   public ResponseEntity<Object> getProduct() {
      return new ResponseEntity<>(productRepo.values(), HttpStatus.OK);
   }
}

Możesz utworzyć wykonywalny plik JAR i uruchomić aplikację rozruchu sprężynowego za pomocą poniższych poleceń Maven lub Gradle, jak pokazano -

W przypadku Mavena użyj polecenia pokazanego poniżej -