0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

构建RESTful Web服务的过程

「Spring」认证安全架构 来源:「Spring」认证安全架构 作者:「Spring」认证安全 2022-09-06 15:47 次阅读

本指南将引导您完成使用 Spring 创建“Hello, World”RESTful Web 服务的过程。

你将建造什么

您将构建一个接受 HTTP GET 请求的服务
http://localhost:8080/greeting

它将以 JSON 表示的问候进行响应,如以下清单所示:

{"id":1,"content":"Hello, World!"}复制

您可以在查询字符串中使用可选name参数自定义问候语,如以下清单所示:

http://localhost:8080/greeting?name=User复制

name参数值覆盖默认值World并反映在响应中,如以下清单所示:

{"id":1,"content":"Hello, User!"}复制

你需要什么

  • 约15分钟
  • 最喜欢的文本编辑器或 IDE
  • JDK 1.8或更高版本
  • Gradle 4+或Maven 3.2+
  • 您还可以将代码直接导入 IDE:
    • 弹簧工具套件 (STS)
    • IntelliJ IDEA

如何完成本指南

像大多数 Spring入门指南一样,您可以从头开始并完成每个步骤,也可以绕过您已经熟悉的基本设置步骤。无论哪种方式,您最终都会得到工作代码。

从头开始,请继续从 Spring Initializr 开始。

跳过基础知识,请执行以下操作:

  • 下载并解压缩本指南的源存储库,或使用Git克隆它:git clone https://github.com/spring-guides/gs-rest-service.git
  • 光盘进入gs-rest-service/initial
  • 继续创建资源表示类。

完成后,您可以对照中的代码检查结果gs-rest-service/complete

从 Spring Initializr 开始

您可以使用这个预先初始化的项目并单击 Generate 下载 ZIP 文件。此项目配置为适合本教程中的示例。

手动初始化项目:

  1. 导航到https://start.spring.io。该服务提取应用程序所需的所有依赖项,并为您完成大部分设置。
  2. 选择 Gradle 或 Maven 以及您要使用的语言。本指南假定您选择了 Java
  3. 单击Dependencies并选择Spring Web
  4. 单击生成
  5. 下载生成的 ZIP 文件,该文件是根据您的选择配置的 Web 应用程序的存档。

如果您的 IDE 具有 Spring Initializr 集成,您可以从您的 IDE 完成此过程。

你也可以从 Github 上 fork 项目并在你的 IDE 或其他编辑器中打开它。

创建资源表示类

现在您已经设置了项目和构建系统,您可以创建您的系统 Web 服务。

从考虑服务交互开始这个过程。

该服务将处理对 的GET请求/greeting,可以选择name在查询字符串中使用参数。该GET请求应200 OK在表示问候的正文中返回带有 JSON 的响应。它应该类似于以下输出:

{
    "id": 1,
    "content": "Hello, World!"
}复制

id字段是问候语的唯一标识符,是问候语content的文本表示。

要对问候表示建模,请创建一个资源表示类。为此,请提供一个普通的方法 Java 对象,其中包含用于idcontent数据的字段、构造函数和访问器,如以下清单(来自
src/main/java/com/example/restservice/Greeting.java)所示:

package com.example.restservice;

public class Greeting {

	private final long id;
	private final String content;

	public Greeting(long id, String content) {
		this.id = id;
		this.content = content;
	}

	public long getId() {
		return id;
	}

	public String getContent() {
		return content;
	}
}

此应用程序使用Jackson JSON库将类型的实例自动编组Greeting为 JSON。网络启动器默认包含 Jackson。

创建资源控制器

在 Spring 构建 RESTful Web 服务的方法中,HTTP 请求由控制器处理。这些组件由@RestController注释标识,GreetingController下面的清单 (from )通过返回类的新实例来
src/main/java/com/example/restservice/GreetingController.java处理GET请求:/greetingGreeting

package com.example.restservice;

import java.util.concurrent.atomic.AtomicLong;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class GreetingController {

	private static final String template = "Hello, %s!";
	private final AtomicLong counter = new AtomicLong();

	@GetMapping("/greeting")
	public Greeting greeting(@RequestParam(value = "name", defaultValue = "World") String name) {
		return new Greeting(counter.incrementAndGet(), String.format(template, name));
	}
}复制

这个控制器简洁明了,但引擎盖下有很多事情要做。我们一步一步分解。

@GetMapping注释确保 HTTP GET 请求/greeting映射到greeting()方法。

有其他 HTTP 动词的伴随注释(例如@PostMappingPOST)。还有一个@RequestMapping它们都源自的注释,并且可以用作同义词(例如@RequestMapping(method=GET))。

@RequestParam将查询字符串参数的值绑定name到方法的name参数中greeting()。如果name请求中没有参数,则使用defaultValueof World

方法体的实现创建并返回一个新Greeting对象,该对象具有idcontent基于下一个值的属性,并使用 greetingcounter格式化给定的格式。nametemplate

传统 MVC 控制器和前面显示的 RESTful Web 服务控制器之间的一个关键区别是 HTTP 响应主体的创建方式。这个 RESTful Web 服务控制器不是依靠视图技术来执行服务器端将问候数据呈现为 HTML,而是填充并返回一个Greeting对象。对象数据将作为 JSON 直接写入 HTTP 响应。

此代码使用 Spring@RestController注释,它将类标记为控制器,其中每个方法都返回域对象而不是视图。它是同时包含@Controller和的简写@ResponseBody

Greeting对象必须转换为 JSON。感谢 Spring 的 HTTP 消息转换器支持,您无需手动进行此转换。因为Jackson 2在类路径上,所以会自动选择 Spring
MappingJackson2HttpMessageConverterGreeting实例转换为 JSON。

@SpringBootApplication是一个方便的注释,它添加了以下所有内容:

  • @Configuration: 将类标记为应用程序上下文的 bean 定义源。
  • @EnableAutoConfiguration:告诉 Spring Boot 根据类路径设置、其他 bean 和各种属性设置开始添加 bean。例如,如果spring-webmvc位于类路径上,则此注释将应用程序标记为 Web 应用程序并激活关键行为,例如设置DispatcherServlet.
  • @ComponentScan: 告诉 Spring 在包中查找其他组件、配置和服务com/example,让它找到控制器。

main()方法使用 Spring Boot 的SpringApplication.run()方法来启动应用程序。您是否注意到没有一行 XML?也没有web.xml文件。这个 Web 应用程序是 100% 纯 Java,您不必处理任何管道或基础设施的配置。

构建一个可执行的 JAR

您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必要依赖项、类和资源的单个可执行 JAR 文件并运行它。构建可执行 jar 可以在整个开发生命周期、跨不同环境等中轻松地作为应用程序交付、版本化和部署服务。

如果您使用 Gradle,则可以使用./gradlew bootRun. 或者,您可以使用构建 JAR 文件./gradlew build,然后运行 ​JAR 文件,如下所示:

java -jar build/libs/gs-rest-service-0.1.0.jar

如果您使用 Maven,则可以使用./mvnw spring-boot:run. 或者,您可以使用构建 JAR 文件,./mvnw clean package然后运行该 JAR 文件,如下所示:

java -jar 目标/gs-rest-service-0.1.0.jar

此处描述的步骤创建了一个可运行的 JAR。您还可以构建经典的 WAR 文件。

显示记录输出。该服务应在几秒钟内启动并运行。

测试服务

现在服务已经启动,访问
http://localhost:8080/greeting,您应该会看到:

{"id":1,"content":"Hello, World!"}复制

通过访问提供name查询字符串参数
http://localhost:8080/greeting?name=Usercontent请注意属性的值如何从Hello, World!变为Hello, User!,如以下清单所示:

{"id":2,"content":"Hello, User!"}复制

这一变化表明,@RequestParam安排在GreetingController按预期工作。该name参数已被赋予默认值,World但可以通过查询字符串显式覆盖。

还要注意id属性是如何从1变为 的2。这证明您正在GreetingController跨多个请求处理同一个实例,并且其counter字段在每次调用时都按预期递增。

概括

恭喜!您刚刚使用 Spring 开发了一个 RESTful Web 服务。

审核编辑:汤梓红

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • Web
    Web
    +关注

    关注

    2

    文章

    1255

    浏览量

    69310
  • spring
    +关注

    关注

    0

    文章

    338

    浏览量

    14301
  • Restful
    +关注

    关注

    0

    文章

    11

    浏览量

    3526
收藏 人收藏

    评论

    相关推荐

    请问LabVIEW通过无线WiFi采集数据 基于restful

    本帖最后由 eehome 于 2013-1-5 09:47 编辑 求助,有没有兄弟做过相关的项目啊,labview编写一个程序作为一个web service,基于restful。 需要将采集到
    发表于 03-22 18:08

    编写restful

    求助,有没有兄弟做过相关的项目啊,现在写了一个程序作为一个web service,基于restful。 需要将采集到的数据经过wifi传输,数据传输想用到restful。有没有推荐的自带的re
    发表于 03-22 18:12

    基于ARM和Linux的嵌入式Web服务器的构建及应用

    摘要:本文主要研究了基于ARM和Linux的嵌入式Web服务器的构建及应用.随着互联网的飞速发展,越来越多的信息化产品需要接入互联网并通过Web页面进行远程访问和控制,嵌入式
    发表于 11-05 06:07

    如何在ARM上构建一个web服务

    本人现在在做ARM上构建一个web服务器,就是将网页放在这个服务器上,然后接入internet可以通过PC机上网访问即可。用的是C#编程,实际实现上还是有些模糊,希望有心人能教教俺,最
    发表于 10-28 10:55

    在4.3.1版的restful_server示例中找不到npm是怎么回事?

    /../front/web-demo/dist doesn't exit.Please run 'npm run build' inC:/esp-431/ws431/restful_server/main
    发表于 02-17 07:31

    基于TLA的Web服务组合研究

    随着以Web服务为基础的面向服务的体系结构的发展,如何有效地组合自治的、分布的、不同功能的Web服务
    发表于 11-10 16:28 22次下载

    基于.NET的XML Web服务构建

    以一个ShoppingAssistant案例的ASP.NET Web服务为例,构建新的基于事件的编程模型,利用XmlSerializer类的XML串行化功能,将对象的内容串行化到XML文件中,在
    发表于 03-21 10:46 16次下载

    构建实战:Nginx+IIS构筑Web服务器集群负载均衡

    构建实战:Nginx+IIS构筑Web服务器集群负载均衡
    发表于 09-05 10:56 4次下载
    <b class='flag-5'>构建</b>实战:Nginx+IIS构筑<b class='flag-5'>Web</b><b class='flag-5'>服务</b>器集群负载均衡

    Web服务推荐SOA系统

    为解决Web服务决策过程中新增信息多且信息不精确的问题,提出一种基于Web服务推荐的面向服务体系
    发表于 02-24 14:59 0次下载
    <b class='flag-5'>Web</b><b class='flag-5'>服务</b>推荐SOA系统

    Web服务组合匹配框架研究

    在现有服务发现方法中,单一考虑原子服务服务组合的方式难以满足用户日益增长的需求。针对该问题,设计一个基于模型转换的Web服务匹配框架。在
    发表于 03-05 13:35 0次下载
    <b class='flag-5'>Web</b><b class='flag-5'>服务</b>组合匹配框架研究

    ASP NET MVC和WEB与API的知识点总结

     一、理解WEB API:提供基于RESTful架构的WEB服务,通过HTTP请求方法(GET, PUT, POST, DELETE)映射到服务
    发表于 11-27 16:43 13次下载
    ASP NET MVC和<b class='flag-5'>WEB</b>与API的知识点总结

    基于Web云端应用服务构建等的齿轮云测量终端系统

    基于Web云端应用服务构建等的齿轮云测量终端系统
    发表于 06-30 11:39 9次下载

    如何使用Spring构建REST服务(一)

    关于 REST 如何适应微服务世界还有一个更大的讨论,但是——对于本教程——让我们看看构建 RESTful 服务
    的头像 发表于 07-28 15:59 886次阅读

    如何使用Spring构建REST服务(三)

    到目前为止,您拥有一个基于 Web 服务来处理涉及员工数据的核心操作。但这还不足以让事情变得“RESTful”。
    的头像 发表于 07-28 16:01 801次阅读

    使用RESTful Web服务过程

    本指南将引导您完成创建使用#spring# #spring认证# RESTful Web 服务的应用程序的过程
    的头像 发表于 09-06 15:47 686次阅读