Spring Boot 教程：构建 RESTful Web 服务

最新推荐文章于 2024-07-25 22:44:17 发布
最新推荐文章于 2024-07-25 22:44:17 发布
阅读量436 收藏
点赞数
分类专栏： 信码由缰 文章标签： spring boot
原文链接：https://www.tutorialspoint.com/spring_boot/spring_boot_building_restful_web_services.htm
版权

【注】本文译自：  https://www.tutorialspoint.com/spring_boot/spring_boot_building_restful_web_services.htm

    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.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 Controller

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

@RestController

public class ProductServiceController {

}

Request Mapping

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

@RequestMapping(value = "/products")

public ResponseEntity<Object> getProducts() { }

Request Body

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

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

}

Path Variable

   @PathVariable 注解被用于定义自定义或动态的请求 URI，Path variable 被放在请求 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 端点：

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 来存储 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。

    下面的例子展示了如何定义 HTTP PUT 请求方法。在这个例子中，我们使用 HashMap 更新现存的产品。此处，产品是一个 POJO 类。

    这里，请求 URI 是 /products/{id}，在产品被存入 HashMap 仓储后，它会返回字符串。注意我们使用路径变量 {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 Delete 请求用于删除存在的资源。这个方法不包含任何请求体。我们可以通过发送请求参数和路径变量来定义自定义或动态 URL。

   下面的例子展示如何定义 HTTP DELETE 请求方法。这个例子中，我们使用 HashMap 来移除现存的产品，用 POJO 来表示。

   请求 URI 是 /products/{id} 在产品被从 HashMap 仓储中删除后，它会返回字符串。 我们使用路径变量 {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);

   }

}

   下面给出完整的源代码：

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.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 命令来运行 spring boot 应用：

   Maven命令如下：

mvn clean install

   “构建成功“后，可以在 target 文件夹下发现 JAR 文件。

   Gradle命令如下：

gradle clean build

    “构建成功“后，可以在 build/libs 文件夹下发现 JAR 文件。

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

java –jar <JARFILE>

    以 Tomcat 端口号 8080 启动应用，如下所示：

    在 POSTMAN 应用中点击下面的 URL 可以看到相应的输出：

GET API URL 为: http://localhost:8080/products

POST API URL 为: http://localhost:8080/products

PUT API URL 为: http://localhost:8080/products/3

DELETE API URL 为: http://localhost:8080/products/3

 

 

信码由缰
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot 精通系列-构建一个RESTful Web 服务
初学者
09-08 1930
导语   现在越来越多的企业推荐使用的是RESTful风格来构建企业应用接口，那么什么是RESTful呢？ 文章目录什么是RESTfulSpringBoot对于RESTful有哪些支持快速实例定义Message对象 什么是RESTful   RESTful是目前最为流行的一种互联网架构，REST(Respresentational State Transfer，表述性状态转移)，这个是来源自于...
Spring Boot 构建一个 RESTful Web 服务
01-01
Spring Boot 构建 RESTful Web 服务 Spring Boot 构建 RESTful Web 服务是当前最流行的一种互联网软件架构。REST（Representational State Transfer，表述性状态转移）是一种软件架构风格，由 Roy Thomas Fielding ...
Spring Boot 构建 RESTful Web 服务
long_steve的博客
07-19 380
2）即，确保访问/greeting的HTTPGET请求由greeting()函数处理。（1）用于接收HTTPGET请求传过来的name值，默认值为“World”。来处理HTTP请求，需要用到@RestController注解。在Springboot中创建RestfulWeb服务，使用。在IDEA中进行SpringInitializr创建。它们都源自的注释，并且可以用作同义词（例如。（1）带有此注释的类型被视为控制器。greeting()方法。...........................
Spring系列学习之使用Spring Boot构建RESTful Web服务
纸上得来终觉浅，绝知此事要躬行
12-21 1861
英文原文：https://spring.io/guides/gs/rest-service/ 目录 你要构建什么 你需要什么 如何完成本指南 使用Gradle构建 使用Maven构建 IDE构建 创建资源表示类 创建资源控制器 使应用程序可执行 构建可执行的JAR 测试服务 总结 更多 本指南将引导您完成使用Spring创建“hello world”RESTful W...
SpringBoot基础教程2-1-1 搭建RESTful风格Web服务
weixin_33850015的博客
07-06 155
2019独角兽企业重金招聘Python工程师标准>>> ...
spring boot rest例子
yangactive的专栏
03-20 364
简介： 本文将帮助您使用 Spring Boot 创建简单的 REST 服务。   你将学习   什么是 REST 服务？ 如何使用 Spring Initializr 引导创建 Rest 服务应用程序？ 如何创建获取 REST 服务以检索学生注册的课程？ 如何为学生注册课程创建 Post REST 服务？ 如何利用 postman 执行 rest 服务？   本教程...
使用Spring Boot构建RESTful Web服务
专业的开发者“讨论”
06-03 197
The continuation of this tutorial is here connect to firebase and persist data 在下面的教程中，我们将使用&#24102...
spring-rest-api:构建 RESTful Web 服务
06-29
总结起来，“spring-rest-api”项目涵盖了使用Spring框架构建RESTful Web服务的关键概念和技术，包括Spring MVC、HTTP方法、资源路由、依赖管理和安全控制。开发者可以通过这个项目学习并实践如何优雅地设计和实现一...
gs-rest-service：构建RESTful Web服务::了解如何使用Spring创建RESTful Web服务
02-05
在IT行业中，构建RESTful Web服务是开发现代Web应用程序的核心技术之一。REST（Representational State Transfer）是一种架构风格，用于设计网络应用程序，尤其适合互联网规模的分布式系统。本教程将聚焦于使用...
gs-actuator-service:使用Spring Boot Actuator构建RESTful Web服务
05-13
目录 是的子项目。 它为您的应用程序增加... 您构建的服务的业务功能与构建RESTful Web服务中的功能相同。 尽管比较结果可能会很有趣，但是您无需使用该指南即可利用这一指南。 你需要什么 https://raw.githubusercont
使用Springboot系统构建RESTful Web服务.pdf
07-05
### 使用Spring Boot构建RESTful Web服务 #### 一、引言 随着互联网技术的发展，Web服务已成为连接不同应用的关键组成部分。RESTful架构以其简洁、易理解的特点成为了构建Web服务的标准模式之一。Spring Boot作为...
java利用springboot搭建restful风格的web service
千里小马哥的博客
04-12 1401
0、前言 传统的web请求：一个操作一个url，难以维护。而什么是restful呢？RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务使能接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。说的还是不明白。简而言之，同一类事物的操作只使用一个url，而具体的...
spring boot 快速搭建 基于 Restful 风格的微服务
weixin_34037515的博客
05-19 270
使用 spring boot 快速搭建 基于 Restful 风格的微服务，无spring 配置文件，纯java 工程，可以快速发布，调试项目1.创建一个maven 工程2. 导入如下配置<projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSch...
springboot webflux响应式编程入门案例
雨季的博客
01-02 333
1. 主类(注意，这里使用了lombok插件，如果不使用，请将注解修改为常规代码): 如果使用lombok,请引入并配置开发环境: annotationProcessor 'org.projectlombok:lombok:1.18.+' compileOnly 'org.projectlombok:lombok:1.18.+' package com.webflux.demo; import org.springframework.boot.SpringApplication; ..
Spring Boot 之 构建RESTful服务
探索er的博客
04-21 2008
构建RESTful服务
idea添加依赖包不完全以及org.springframework.boot:spring-boot-starter-web:unknown报错遇到的问题-有图解---及idea软件问题
热门推荐
南下有你
04-10 5万+
一.把idea要下载的依赖包自动放在一个文件夹下面，步骤如下 打开D:\apache-maven\apache-maven-3.6.0\conf\settings.xml文件（每个人的位置不同） 二：在原先的文件里面操作（打开D:\apache-maven\apache-maven-3.6.0\conf\settings.xml文件），在mirrors节点下添加以下，提升maven引入包的下载速...
Could not transfer artifact org.springframework.boot:spring-boot-starter-parent:pom:1.5.4.RELEASE
desirelll的博客
06-30 4万+
第一次用 Spring Starter Project 创建一个Spring应用时，POM 文件报错： Project build error: Non-resolvable parent POM for com.example:demo-1:0.0.1-SNAPSHOT: Failure to transfer org.springframework.boot:spring-boo
真正解决Could not transfer artifact org.springframework.boot:spring-boot-starter-parent:pom
m0_37581001的博客
05-21 1万+
转载自：https://blog.csdn.net/FungLi_notLove/article/details/104469940 解决新建springboot项目时包导不进来的问题 发现问题 新建一个springboot项目 此时maven的setting配置文件配置的阿里云的源 发现很多包导不进来,于是reimport,没有效果 于是执行clean命令 报错 Could not transfer artifact org.springframework.boot:spring-boot-starte
使用Gradle创建一个最简单的Spring Boot项目
啦啦啦啦 la
11-30 5万+
最近在学习Spring Boot，但是由于没有科学上网，导致使用gradle开发时编译特别慢并且经常出错，遇到很多问题，看了很多博客都写的非常零碎和混乱，今天在公司看了一天的官方文档才算是刚刚入门，所以记录一下，希望能对初学者能有所帮助 开发工具及环境 JDK 1.7+ Spring Boot 要求JDK不低于，推荐使用1.8 编译工具 Gradle 安装可以
Spring Boot 集成 Kafka
最新发布
Casual_Lei的博客
07-25 648
Spring Boot 与 Kafka 的集成使得消息队列的使用变得更加简单和高效。通过上述步骤，你可以轻松地配置 Kafka、实现生产者和消费者，并利用 Spring Boot 提供的强大功能来处理消息流。了解 Kafka 的高级特性（如事务和异步处理）能够帮助你更好地满足业务需求，确保系统的高可用性和数据一致性。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值