Spring Boot構建RESTful Web服務

Spring Boot為為企業應用程式構建RESTful Web服務提供了非常好的支援。 本章將詳細介紹如何使用Spring Boot構建RESTful Web服務。

註 - 要構建RESTful Web服務，需要將Spring Boot Starter Web依賴項新增到構建組態檔案中。

如果是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.yiibai</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.yiibai'
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注釋用於定義RESTful Web服務。它提供JSON，XML和自定義響應。其語法如下所示 -

@RestController
public class ProductServiceController {
}

請求對映

@RequestMapping注釋用於定義存取REST端點的Request 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。
用於定義HTTP GET請求方法的範例程式碼如下所示。 在此範例中使用HashMap儲存產品。 請注意，使用POJO類作為要儲存的產品。
這裡，請求URI是/products，它將從HashMap儲存庫返回產品列表。下面給出了包含GET方法REST端點的控制器類檔案。

package com.yiibai.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.yiibai.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儲存Product，其中產品是POJO類。
這裡，請求URI是/products，它會在將產品儲存到HashMap儲存庫後返回字串。

package com.yiibai.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.yiibai.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庫後返回String。 請注意，使用路徑變數{id}來定義需要更新的產品ID。

package com.yiibai.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.yiibai.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。
下面給出的範例顯示了如何定義HTTP DELETE請求方法。 在此範例中，使用HashMap刪除現有產品，即POJO類。
請求URI是/products/{id}，它將在從HashMap儲存庫中刪除產品後返回字串。使用路徑變數{id}來定義需要刪除的產品ID。

package com.yiibai.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.yiibai.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);
   }
}

本節提供完整的原始碼集。請遵守以下程式碼了解其各自的功能 -

Spring Boot主應用程式類 - DemoApplication.java :

package com.yiibai.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);
   }
}

POJO類 - Product.java

package com.yiibai.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;
   }
}

Rest Controller類 - ProductServiceController.java

package com.yiibai.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.yiibai.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命令執行spring boot應用程式。
對於Maven，請使用下面顯示的命令 -

mvn clean install

在執行命令之後，看到控制台輸出"BUILD SUCCESS"之後，在目標目錄下找到JAR檔案。對於Gradle，請使用下面顯示的命令 -

gradle clean build

在看到控制台輸出"BUILD SUCCESSFUL"之後，可以在build/libs目錄下找到JAR檔案。使用下面顯示的命令執行JAR檔案 -

java –jar <JARFILE>

這將在Tomcat埠8080上啟動應用程式，如下所示 -

現在點選POSTMAN應用程式中顯示的URL，檢視輸出。

GET API URL為：http://localhost:8080/products

GET API URL為：http://localhost:8080/products

PUT API URL為：http://localhost:8080/products/3

DELETE API URL為：http://localhost:8080/products/3