Spring Boot @PathVariable
最后修改于 2023 年 7 月 18 日
Spring Boot @PathVariable 教程展示了如何使用 @PathVariable 注解读取 URL 模板变量。我们创建一个 Spring Boot RESTful 应用程序来演示这个注解。
Spring 是一个流行的 Java 应用程序框架，而 Spring Boot 是 Spring 的一个演进，它有助于轻松创建独立的、生产级别的基于 Spring 的应用程序。
@PathVariable
@PathVariable 是一个 Spring 注解，它指示一个方法参数应该绑定到一个 URI 模板变量。
它具有以下可选元素：
- name - 要绑定的路径变量的名称
- required - 指示是否需要路径变量
- value - name 的别名
Spring Boot @PathVariable 示例
以下示例创建了一个使用 @PathVariable 的 Spring Boot Web 应用程序。该应用程序从 URL 接收数据，并从该 URL 构建文本响应给客户端。
build.gradle
...
src
├───main
│ ├───java
│ │ └───com
│ │ └───zetcode
│ │ │ Application.java
│ │ └───controller
│ │ MyController.java
│ └───resources
└───test
└───java
这是 Spring Boot 应用程序的项目结构。
plugins {
id 'org.springframework.boot' version '3.1.1'
id 'io.spring.dependency-management' version '1.1.0'
id 'java'
}
group = 'com.zetcode'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
}
这是 Gradle 构建文件。spring-boot-starter-web 是一个用于构建使用 Spring MVC 的 Web 应用程序的启动器。它使用 Tomcat 作为默认的嵌入式容器。
package com.zetcode.controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class MyController {
@RequestMapping(path="/{name}/{age}")
public String getMessage(@PathVariable("name") String name,
@PathVariable("age") String age) {
return String.format("%s is %s years old", name, age);
}
}
控制器处理来自客户端的请求。它从请求的 URL 中读取两个值。
@RestController
public class MyController {
我们有一个 RESTful Web 应用程序。
@RequestMapping(path="/{name}/{age}")
public String getMessage(@PathVariable("name") String name,
@PathVariable("age") String age) {
使用 @PathVariable 注解，我们将请求 URL 模板路径变量绑定到方法变量。例如，对于 /Paul/28 URL，Paul 值绑定到 name 变量，而 28 值绑定到 age 变量。
return String.format("%s is %s years old", name, age);
我们构建消息并返回它。
package com.zetcode;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
Application 是设置 Spring Boot 应用程序的入口点。 @SpringBootApplication 注解启用自动配置和组件扫描。
$ ./gradlew bootRun
我们启动 Spring Boot 应用程序。
$ curl localhost:8080/Robert/39 Robert is 39 years old
我们使用 curl 工具创建一个对应用程序的请求。应用程序用消息响应；这些值是从 URL 中使用 @PathVariable 提取的。
在本文中，我们使用 Spring Boot 框架创建了一个 RESTful Web 应用程序。我们已经演示了 @PathVariable 的用法。