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 构建 – pom.xml 代码如下：

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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>3.3.3</version>
      <relativePath/> <!-- lookup parent from repository -->
   </parent>
   <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>
   <url/>
   <licenses>
      <license/>
   </licenses>
   <developers>
      <developer/>
   </developers>
   <scm>
      <connection/>
      <developerConnection/>
      <tag/>
      <url/>
      </scm>
      <properties>
         <java.version>21</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.gradle 代码如下：

buildscript {
   ext {
      springBootVersion = '3.3.3'
   }
   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 = 21

repositories {
   mavenCentral()
}
dependencies {
   compile('org.springframework.boot:spring-boot-starter-web')
   testCompile('org.springframework.boot:spring-boot-starter-test')
}

在您继续构建 RESTful Web 服务之前，建议您了解以下注解：

Rest Controller

@RestController 注解用于定义 RESTful Web 服务。它提供 JSON、XML 和自定义响应。其语法如下：

@RestController
public class ProductServiceController { 
}

Request Mapping

@RequestMapping 注解用于定义访问 REST 端点的请求 URI。我们可以定义请求方法来消费和生成对象。默认请求方法为 GET。

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

Request Body

@RequestBody 注解用于定义请求正文内容类型。

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

Path Variable

@PathVariable 注解用于定义自定义或动态请求 URI。请求 URI 中的路径变量定义为花括号 {}，如下所示：

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

Request Parameter

@RequestParam 注解用于从请求 URL 读取请求参数。默认情况下，它是一个必需参数。我们还可以为请求参数设置默认值，如下所示：

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

GET API

默认的 HTTP 请求方法是 GET。此方法不需要任何请求正文。您可以发送请求参数和路径变量来定义自定义或动态 URL。

以下代码示例显示了如何定义 HTTP GET 请求方法。在此示例中，我们使用 HashMap 存储 Product。请注意，我们使用 POJO 类作为要存储的产品。

这里，请求 URI 为 /products，它将从 HashMap 存储库返回产品列表。以下给出了包含 GET 方法 REST 端点的控制器类文件。

...
@RestController
public class ProductServiceController {
   ...
   @GetMapping(value = "/products")
   public ResponseEntity<Object> getProduct() {
      return new ResponseEntity<>(productRepo.values(), HttpStatus.OK);
   }
}

POST API

HTTP POST 请求用于创建资源。此方法包含请求正文。我们可以发送请求参数和路径变量来定义自定义或动态 URL。

以下示例显示了如何定义 HTTP POST 请求方法。在此示例中，我们使用 HashMap 存储 Product，其中 Product 是一个 POJO 类。

这里，请求 URI 为 /products，它将在将产品存储到 HashMap 存储库后返回字符串。

...
@RestController
public class ProductServiceController {
   ...   
   @PostMapping(value = "/products")
   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 更新现有 Product，其中 Product 是一个 POJO 类。

这里的请求 URI 为 /products/{id}，它将在将产品添加到 HashMap 存储库后返回字符串。请注意，我们使用了路径变量 {id}，它定义了需要更新的产品 ID。

...
@RestController
public class ProductServiceController {
   ...   
   @PutMapping(value = "/products/{id}")
   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 Delete 请求用于删除现有资源。此方法不包含任何请求正文。我们可以发送请求参数和路径变量来定义自定义或动态 URL。

以下示例显示了如何定义 HTTP DELETE 请求方法。在此示例中，我们使用 HashMap 删除现有产品，它是一个 POJO 类。

请求 URI 为 /products/{id}，它将在从 HashMap 存储库删除产品后返回字符串。我们使用了路径变量 {id}，它定义了需要删除的产品 ID。

...
@RestController
public class ProductServiceController {
   ...   
   @DeleteMapping(value = "/products/{id}")
   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.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);
   }
}

POJO 类

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

Rest Controller 类

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.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
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);
   }
   
   @DeleteMapping(value = "/products/{id}")
   public ResponseEntity<Object> delete(@PathVariable("id") String id) { 
      productRepo.remove(id);
      return new ResponseEntity<>("Product is deleted successsfully", HttpStatus.OK);
   }
   
   @PutMapping(value = "/products/{id}")
   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);
   }
   
   @PostMapping(value = "/products")
   public ResponseEntity<Object> createProduct(@RequestBody Product product) {
      productRepo.put(product.getId(), product);
      return new ResponseEntity<>("Product is created successfully", HttpStatus.CREATED);
   }
   
   @GetMapping(value = "/products")
   public ResponseEntity<Object> getProduct() {
      return new ResponseEntity<>(productRepo.values(), HttpStatus.OK);
   }
}

编译和执行

您可以创建一个可执行的 JAR 文件，并使用以下 Maven 或 Gradle 命令运行 Spring Boot 应用程序，如下所示：

对于 Maven，使用以下命令：

mvn clean install

“BUILD SUCCESS” 后，您可以在 target 目录下找到 JAR 文件。

对于 Gradle，使用以下命令：

gradle clean build

“BUILD SUCCESSFUL” 后，您可以在 build/libs 目录下找到 JAR 文件。

您可以使用以下命令运行 JAR 文件：

java –jar <JARFILE> 

这将在 Tomcat 端口 8080 上启动应用程序，如下所示：

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/

[32m :: Spring Boot :: [39m              [2m (v3.3.3)[0;39m

[2024-09-04T12:55:59Z] [org.springframework.boot.StartupInfoLogger] [main] [50] [INFO ] Starting DemoApplication using Java 21.0.3 with PID 19132 (E:\Dev\demo\target\classes started by Tutorialspoint in E:\Dev\demo)
[2024-09-04T12:55:59Z] [org.springframework.boot.SpringApplication] [main] [654] [INFO ] No active profile set, falling back to 1 default profile: "default"
[2024-09-04T12:56:00Z] [org.springframework.boot.web.embedded.tomcat.TomcatWebServer] [main] [111] [INFO ] Tomcat initialized with port 8080 (http)
[2024-09-04T12:56:00Z] [org.apache.juli.logging.DirectJDKLog] [main] [173] [INFO ] Initializing ProtocolHandler ["http-nio-8080"]
[2024-09-04T12:56:00Z] [org.apache.juli.logging.DirectJDKLog] [main] [173] [INFO ] Starting service [Tomcat]
[2024-09-04T12:56:00Z] [org.apache.juli.logging.DirectJDKLog] [main] [173] [INFO ] Starting Servlet engine: [Apache Tomcat/10.1.28]
[2024-09-04T12:56:00Z] [org.apache.juli.logging.DirectJDKLog] [main] [173] [INFO ] Initializing Spring embedded WebApplicationContext
[2024-09-04T12:56:00Z] [org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext] [main] [296] [INFO ] Root WebApplicationContext: initialization completed in 947 ms
[2024-09-04T12:56:01Z] [org.apache.juli.logging.DirectJDKLog] [main] [173] [INFO ] Starting ProtocolHandler ["http-nio-8080"]
[2024-09-04T12:56:01Z] [org.springframework.boot.web.embedded.tomcat.TomcatWebServer] [main] [243] [INFO ] Tomcat started on port 8080 (http) with context path '/'
[2024-09-04T12:56:01Z] [org.springframework.boot.StartupInfoLogger] [main] [56] [INFO ] Started DemoApplication in 1.857 seconds (process running for 3.612)

输出

现在在 POSTMAN 应用程序中点击以下 URL 并查看输出。

GET API URL 为：https://127.0.0.1:8080/products

POST API URL 为：https://127.0.0.1:8080/products

PUT API URL 为：https://127.0.0.1:8080/products/3

DELETE API URL 为：https://127.0.0.1:8080/products/3