@RequestMapping 简介

本文介绍Spring框架中的RequestMapping注解,详细解析其六大属性,并通过示例展示如何使用这些属性来精确控制HTTP请求。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

简介:

@RequestMapping

RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。

RequestMapping注解有六个属性,下面我们把她分成三类进行说明。

1、 value, method;

value:     指定请求的实际地址,指定的地址可以是URI Template 模式(后面将会说明);

method:  指定请求的method类型, GET、POST、PUT、DELETE等;

 

2、 consumes,produces;

consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;

produces:    指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;

 

3、 params,headers;

params: 指定request中必须包含某些参数值是,才让该方法处理。

headers: 指定request中必须包含某些指定的header值,才能让该方法处理请求。

 

示例:

1、value  / method 示例

默认RequestMapping("....str...")即为value的值;

复制代码
@Controller
@RequestMapping("/appointments")
public class AppointmentsController {

    private AppointmentBook appointmentBook;
    
    @Autowired
    public AppointmentsController(AppointmentBook appointmentBook) {
        this.appointmentBook = appointmentBook;
    }

    @RequestMapping(method = RequestMethod.GET)
    public Map<String, Appointment> get() {
        return appointmentBook.getAppointmentsForToday();
    }

    @RequestMapping(value="/{day}", method = RequestMethod.GET)
    public Map<String, Appointment> getForDay(@PathVariable @DateTimeFormat(iso=ISO.DATE) Date day, Model model) {
        return appointmentBook.getAppointmentsForDay(day);
    }

    @RequestMapping(value="/new", method = RequestMethod.GET)
    public AppointmentForm getNewForm() {
        return new AppointmentForm();
    }

    @RequestMapping(method = RequestMethod.POST)
    public String add(@Valid AppointmentForm appointment, BindingResult result) {
        if (result.hasErrors()) {
            return "appointments/new";
        }
        appointmentBook.addAppointment(appointment);
        return "redirect:/appointments";
    }
}
复制代码

value的uri值为以下三类:

A) 可以指定为普通的具体值;

B)  可以指定为含有某变量的一类值(URI Template Patterns with Path Variables);

C) 可以指定为含正则表达式的一类值( URI Template Patterns with Regular Expressions);

 

example B)

@RequestMapping(value="/owners/{ownerId}", method=RequestMethod.GET)
public String findOwner(@PathVariable String ownerId, Model model) {
  Owner owner = ownerService.findOwner(ownerId);  
  model.addAttribute("owner", owner);  
  return "displayOwner"; 
}

example C)

@RequestMapping("/spring-web/{symbolicName:[a-z-]+}-{version:\d\.\d\.\d}.{extension:\.[a-z]}")
  public void handle(@PathVariable String version, @PathVariable String extension) {    
    // ...
  }
}

2 consumes、produces 示例

cousumes的样例:

@Controller
@RequestMapping(value = "/pets", method = RequestMethod.POST, consumes="application/json")
public void addPet(@RequestBody Pet pet, Model model) {    
    // implementation omitted
}

方法仅处理request Content-Type为“application/json”类型的请求。

produces的样例:

@Controller
@RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, produces="application/json")
@ResponseBody
public Pet getPet(@PathVariable String petId, Model model) {    
    // implementation omitted
}

方法仅处理request请求中Accept头中包含了"application/json"的请求,同时暗示了返回的内容类型为application/json;

 

 

3 params、headers 示例

params的样例:

复制代码
@Controller
@RequestMapping("/owners/{ownerId}")
public class RelativePathUriTemplateController {

  @RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, params="myParam=myValue")
  public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {    
    // implementation omitted
  }
}
复制代码

仅处理请求中包含了名为“myParam”,值为“myValue”的请求;

 

 

headers的样例:

复制代码
@Controller
@RequestMapping("/owners/{ownerId}")
public class RelativePathUriTemplateController {

@RequestMapping(value = "/pets", method = RequestMethod.GET, headers="Referer=http://www.ifeng.com/")
  public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {    
    // implementation omitted
  }
}
复制代码

仅处理request的header中包含了指定“Refer”请求头和对应值为“http://www.ifeng.com/”的请求;

 

### Spring Boot 中 @PutMapping 的使用方法及示例 #### 1. @PutMapping 注解简介 `@PutMapping` 是 Spring Boot 提供的一个注解,专门用于将 HTTP PUT 请求映射到特定的处理方法上。它是 `@RequestMapping(method = RequestMethod.PUT)` 的简化形式,能够更直观地表达该方法的作用[^4]。 #### 2. 使用场景 `@PutMapping` 主要用于更新资源的操作。通过此注解,开发者可以轻松实现 RESTful 风格的服务接口设计,支持客户端发送数据来修改服务器端的数据记录[^3]。 #### 3. 基本语法 以下是 `@PutMapping` 的基本语法结构: ```java @PutMapping(value = "/url", consumes = "content-type", produces = "media-type") public ResponseEntity<?> methodName(@RequestBody Object requestBody) { // 方法体 } ``` - **value**: 定义 URL 路径。 - **consumes**: 指定允许的内容类型(如 application/json)。 - **produces**: 指定返回的内容类型。 - **@RequestBody**: 绑定请求体中的 JSON 数据到 Java 对象中[^1]。 #### 4. 示例代码 以下是一个完整的例子,展示如何在 Controller 层中使用 `@PutMapping`: ```java // 启动类 @SpringBootApplication public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } } // 控制器类 @RestController @RequestMapping("/api") public class DemoController { // 处理 PUT 请求 @PutMapping("/resource") public String updateResource(@RequestBody String data) { // 执行更新逻辑 System.out.println("接收到的数据:" + data); return "Resource updated successfully"; } } ``` 上述代码展示了如何创建一个简单的 Spring Boot 应用程序,并定义了一个 `/api/resource` 接口,用于接收 PUT 请求并更新资源[^2]。 #### 5. 测试案例 可以通过 Postman 或其他工具向服务发起如下请求进行测试: - **URL**: http://localhost:8080/api/resource - **Method**: PUT - **Body**: {"key": "value"} 如果一切正常运行,则会返回 `"Resource updated successfully"`[^2]。 #### 6. 注意事项 - 确保项目已引入 Spring Web 依赖项,这是使用 `@PutMapping` 和其他相关注解的前提条件之一[^3]。 - 如果需要验证传入参数的有效性,可结合 JSR 380 标准(如 Hibernate Validator),利用注解如 `@NotNull`, `@Size` 等完成校验工作。 --- ### 问题
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值