Spring Boot - создание веб-служб RESTful

Spring Boot обеспечивает очень хорошую поддержку для создания веб-служб RESTful для корпоративных приложений. В этой главе подробно рассказывается о создании веб-сервисов RESTful с использованием Spring Boot.

Note - Для создания веб-служб RESTful нам необходимо добавить веб-зависимость Spring Boot Starter в файл конфигурации сборки.

Если вы являетесь пользователем Maven, используйте следующий код, чтобы добавить указанную ниже зависимость в свой pom.xml файл -

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

Если вы являетесь пользователем Gradle, используйте следующий код, чтобы добавить указанную ниже зависимость в свой build.gradle файл.

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

Код для полного файла конфигурации сборки Maven build – pom.xml приведен ниже -

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

Код для полного файла конфигурации сборки Gradle Build – build.gradle приведен ниже -

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

Прежде чем приступить к созданию веб-службы RESTful, предлагается ознакомиться со следующими аннотациями:

Регулятор отдыха

Аннотация @RestController используется для определения веб-служб RESTful. Он обслуживает JSON, XML и настраиваемый ответ. Его синтаксис показан ниже -

@RestController
public class ProductServiceController { 
}

Запросить сопоставление

Аннотация @RequestMapping используется для определения URI запроса для доступа к конечным точкам REST. Мы можем определить метод запроса для потребления и производства объекта. Метод запроса по умолчанию - GET.

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

Тело запроса

Аннотация @RequestBody используется для определения типа содержимого тела запроса.

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

Переменная пути

Аннотация @PathVariable используется для определения пользовательского или динамического URI запроса. Переменная Path в URI запроса определяется как фигурные скобки {}, как показано ниже -

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

Параметр запроса

Аннотация @RequestParam используется для чтения параметров запроса из URL-адреса запроса. По умолчанию это обязательный параметр. Мы также можем установить значение по умолчанию для параметров запроса, как показано здесь -

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

ПОЛУЧИТЬ API

Метод HTTP-запроса по умолчанию - GET. Для этого метода не требуется тело запроса. Вы можете отправить параметры запроса и переменные пути, чтобы определить настраиваемый или динамический URL.

Пример кода для определения метода запроса HTTP GET показан ниже. В этом примере мы использовали HashMap для хранения продукта. Обратите внимание, что мы использовали класс POJO в качестве продукта для хранения.

Здесь URI запроса /productsи он вернет список продуктов из репозитория HashMap. Ниже приведен файл класса контроллера, который содержит конечную точку REST GET.

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

Запрос HTTP POST используется для создания ресурса. Этот метод содержит тело запроса. Мы можем отправлять параметры запроса и переменные пути для определения настраиваемого или динамического URL-адреса.

В следующем примере показан образец кода для определения метода запроса HTTP POST. В этом примере мы использовали HashMap для хранения продукта, где продукт является классом POJO.

Здесь URI запроса /products, и он вернет String после сохранения продукта в репозитории 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

Запрос HTTP PUT используется для обновления существующего ресурса. Этот метод содержит тело запроса. Мы можем отправлять параметры запроса и переменные пути для определения настраиваемого или динамического URL-адреса.

В приведенном ниже примере показано, как определить метод запроса HTTP PUT. В этом примере мы использовали HashMap для обновления существующего продукта, где продукт является классом POJO.

Здесь URI запроса /products/{id}который вернет строку после продукта в репозиторий HashMap. Обратите внимание, что мы использовали переменную Path{id} который определяет идентификатор продукта, который необходимо обновить.

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

УДАЛИТЬ API

HTTP-запрос на удаление используется для удаления существующего ресурса. Этот метод не содержит тела запроса. Мы можем отправлять параметры запроса и переменные пути для определения настраиваемого или динамического URL.

В приведенном ниже примере показано, как определить метод запроса HTTP DELETE. В этом примере мы использовали HashMap для удаления существующего продукта, который является классом POJO.

URI запроса: /products/{id}и он вернет строку после удаления продукта из репозитория HashMap. Мы использовали переменную Path{id} который определяет идентификатор продукта, который необходимо удалить.

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

В этом разделе представлен полный набор исходного кода. Соблюдайте следующие коды для их соответствующих функций -

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

Вы можете создать исполняемый файл JAR и запустить приложение весенней загрузки, используя приведенные ниже команды Maven или Gradle, как показано:

Для Maven используйте команду, показанную ниже -