SpringBoot-RESTfulWebサービスの構築

Spring Bootは、エンタープライズアプリケーション向けのRESTfulWebサービスの構築に非常に優れたサポートを提供します。この章では、SpringBootを使用したRESTfulWebサービスの構築について詳しく説明します。

Note − RESTful Webサービスをビルドするには、Spring Boot StarterWeb依存関係をビルド構成ファイルに追加する必要があります。

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 Webサービスの構築に進む前に、次のアノテーションについての知識があることをお勧めします-

Restコントローラー

@RestControllerアノテーションは、RESTfulWebサービスを定義するために使用されます。JSON、XML、カスタム応答を提供します。その構文を以下に示します-

@RestController
public class ProductServiceController { 
}

マッピングのリクエスト

@RequestMappingアノテーションは、RESTエンドポイントにアクセスするためのリクエストURIを定義するために使用されます。オブジェクトを消費および生成するRequestメソッドを定義できます。デフォルトのリクエストメソッドはGETです。

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

リクエストボディ

@RequestBodyアノテーションは、リクエスト本文のコンテンツタイプを定義するために使用されます。

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

パス変数

@PathVariableアノテーションは、カスタムまたは動的リクエストURIを定義するために使用されます。リクエストURIのPath変数は、以下に示すように中括弧{}として定義されます-

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

リクエストパラメータ

@RequestParamアノテーションは、リクエストURLからリクエストパラメータを読み取るために使用されます。デフォルトでは、これは必須パラメーターです。次に示すように、リクエストパラメータのデフォルト値を設定することもできます-

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

GET API

デフォルトのHTTPリクエストメソッドはGETです。このメソッドはリクエストボディを必要としません。リクエストパラメータとパス変数を送信して、カスタムURLまたは動的URLを定義できます。

HTTPGETリクエストメソッドを定義するためのサンプルコードを以下に示します。この例では、HashMapを使用して製品を保存しました。保存する製品としてPOJOクラスを使用したことに注意してください。

ここで、リクエストURIは /productsそして、HashMapリポジトリから製品のリストを返します。GETメソッドRESTエンドポイントを含むコントローラークラスファイルを以下に示します。

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または動的URLを定義できます。

次の例は、HTTPPOSTリクエストメソッドを定義するためのサンプルコードを示しています。この例では、HashMapを使用してProductを格納しました。ここで、productはPOJOクラスです。

ここで、リクエストURIは /products、および製品を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または動的URLを定義できます。

以下の例は、HTTPPUT要求メソッドを定義する方法を示しています。この例では、HashMapを使用して、製品がPOJOクラスである既存の製品を更新しました。

ここでリクエストURIは /products/{id}これは、製品の後の文字列をHashMapリポジトリに返します。Path変数を使用したことに注意してください{id} これは、更新が必要な製品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);
   }   
}

DELETE API

HTTP削除要求は、既存のリソースを削除するために使用されます。このメソッドにはリクエストボディは含まれていません。リクエストパラメータとパス変数を送信して、カスタムURLまたは動的URLを定義できます。

以下の例は、HTTPDELETE要求メソッドを定義する方法を示しています。この例では、HashMapを使用して、POJOクラスである既存の製品を削除しました。

リクエストURIは /products/{id}HashMapリポジトリから製品を削除した後、文字列を返します。Path変数を使用しました{id} これは、削除する必要のある製品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コマンドを使用してSpringBootアプリケーションを実行できます。

Mavenの場合、以下に示すコマンドを使用します-