Spring Boot 构建RESTful Web服务
-
构建RESTful Web服务
Spring Boot为为企业应用程序构建RESTful Web服务提供了很好的支持。本章将详细说明有关使用Spring Boot构建RESTful Web服务的信息。注 –为了构建RESTful Web服务,我们需要将Spring Boot Starter Web依赖项添加到构建配置文件中。如果您是Maven用户,请使用以下代码在pom.xml文件中添加以下依赖项-如果您是Gradle用户,请使用以下代码在build.gradle文件中添加以下依赖项。下面给出了完整的构建配置文件Maven 构建 – pom.xml的代码-下面给出了完整的构建配置文件Gradle 构建 – build.gradle的代码-在继续构建RESTful Web服务之前,建议您了解以下注解 -
@RestController
@RestController注解用于定义RESTful Web服务。它提供JSON,XML和自定义响应。其语法如下所示- -
@RequestMapping
@RequestMapping注解用于定义请求URI来访问REST端点。我们可以定义Request方法来使用和产生对象。默认请求方法是GET。 -
@RequestBody
@RequestBody注解用于定义请求正文内容类型。 -
@PathVariable
@PathVariable注解用于定义自定义或动态请求URI。请求URI中的Path变量定义为大括号{},如下所示- -
@RequestParam
@RequestParam 注解用于从请求URL读取请求参数。默认情况下,它是必需的参数。我们还可以为请求参数设置默认值,如下所示- -
GET API
默认的HTTP请求方法是GET。此方法不需要任何请求正文。您可以发送请求参数和路径变量来定义定制URL或动态URL。下面显示了定义HTTP GET请求方法的示例代码。在此示例中,我们使用HashMap来存储产品。请注意,我们使用POJO类作为要存储的产品。 在这里,请求URI是/products,它将返回HashMap存储库中的产品列表。下面给出了包含GET方法REST Endpoint的控制器类文件。 -
POST API
HTTP POST请求用于创建资源。此方法包含请求正文。我们可以发送请求参数和路径变量来定义自定义或动态URL。以下示例显示了用于定义HTTP POST请求方法的示例代码。在此示例中,我们使用HashMap来存储产品,其中产品是POJO类。在这里,请求URI是/products,在将产品存储到HashMap存储库后,它将返回String。 -
PUT API
HTTP PUT请求用于更新现有资源。此方法包含一个请求正文。我们可以发送请求参数和路径变量来定义自定义或动态URL。下面给出的示例显示了如何定义HTTP PUT请求方法。在此示例中,我们使用HashMap来更新现有产品,其中产品是POJO类。这里的请求URI是/products/{id},它将在产品放入HashMap存储库后返回String。请注意,我们使用了路径变量{id},该变量定义了需要更新的产品ID。 -
DELETE API
HTTP DELETE请求用于删除现有资源。此方法不包含任何请求正文。我们可以发送请求参数和路径变量来定义自定义或动态URL。下面给出的示例显示了如何定义HTTP DELETE请求方法。在此示例中,我们使用HashMap删除了现有的产品,该产品是POJO类。请求URI为/products/{id},从HashMap存储库中删除产品后,它将返回String。我们使用了路径变量{id},该变量定义了需要删除的产品ID。 -
完整代码及请求示例
本节为您提供完整的源代码集。请遵守以下代码以了解其各自的功能:Spring Boot主应用程序类 – DemoApplication.java-POJO类– Product.javaRest控制器类– ProductServiceController.java您可以创建一个可执行的JAR文件,并使用以下Maven或Gradle命令运行spring boot应用程序,如下所示- 对于Maven,请使用下面显示的命令在“BUILD SUCCESS”提示之后,您可以在target目录下找到JAR文件。对于Gradle,请使用下面显示的命令-在“BUILD SUCCESSFUL”之后,您可以在build/libs目录下找到JAR文件。您可以使用下面显示的命令来运行JAR文件-这将在Tomcat端口8080上启动应用程序现在,在POSTMAN应用程序中访问下面显示的URL,然后查看输出。GET API URL是 - http://localhost:8080/productsPOST API URL是 - http://localhost:8080/productsPUT API URL是 - http://localhost:8080/products/3DELETE API URL是 - http://localhost:8080/products/3