@RequestMapping注解及属性详解

Posted 2022-11-06 nhdlb

 

@RequestMapping 注解：

@RequestMapping 是 Spring Web 应用程序中最常被用到的注解之一。这个注解会将 HTTP 请求映射到 MVC 和 REST 控制器的处理方法上。

Request Mapping 基础用法 

在 Spring MVC 应用程序中，RequestDispatcher (在 Front Controller 之下) 这个 servlet 负责将进入的 HTTP 请求路由到控制器的处理方法。 

在对 Spring MVC 进行的配置的时候, 你需要指定请求与处理方法之间的映射关系。 

要配置 Web 请求的映射，就需要你用上 @RequestMapping 注解。 

@RequestMapping 注解可以在控制器类的级别和/或其中的方法的级别上使用。 

在类的级别上的注解会将一个特定请求或者请求模式映射到一个控制器之上。之后你还可以另外添加方法级别的注解来进一步指定到处理方法的映射关系。 

下面是一个同时在类和方法上应用了 @RequestMapping 注解的示例： 

@RestController  
@RequestMapping("/home")  
public class IndexController   
    @RequestMapping("/")  
    String get()   
        //mapped to hostname:port/home/  
        return "Hello from get";  
      
    @RequestMapping("/index")  
    String index()   
        //mapped to hostname:port/home/index/  
        return "Hello from index";  
      
 

如上述代码所示，到 /home 的请求会由 get() 方法来处理，而到 /home/index 的请求会由 index() 来处理。 

@RequestMapping 来处理多个 URI 

你可以将多个请求映射到一个方法上去，只需要添加一个带有请求路径值列表的 @RequestMapping 注解就行了。

@RestController  
@RequestMapping("/home")  
public class IndexController   
  
    @RequestMapping(value =   
        "",  
        "/page",  
        "page*",  
        "view/*,**/msg"  
    )  
    String indexMultipleMapping()   
        return "Hello from index multiple mapping.";  
      
  

如你在这段代码中所看到的，@RequestMapping 支持统配符以及ANT风格的路径。前面这段代码中，如下的这些 URL 都会由 indexMultipleMapping() 来处理： 

localhost:8080/home
localhost:8080/home/
localhost:8080/home/page
localhost:8080/home/pageabc
localhost:8080/home/view/
localhost:8080/home/view/view

　　

 

@RequestParam

带有 @RequestParam 的 @RequestMapping 

@RequestParam 注解配合 @RequestMapping 一起使用，可以将请求的参数同处理方法的参数绑定在一起。 

@RequestParam 注解使用的时候可以有一个值，也可以没有值。这个值指定了需要被映射到处理方法参数的请求参数, 代码如下所示： 

@RestController  
@RequestMapping("/home")  
public class IndexController   
  
    @RequestMapping(value = "/id")  
    String getIdByValue(@RequestParam("id") String personId)   
        System.out.println("ID is " + personId);  
        return "Get ID from query string of URL with value element";  
      
    @RequestMapping(value = "/personId")  
    String getId(@RequestParam String personId)   
        System.out.println("ID is " + personId);  
        return "Get ID from query string of URL without value element";  
      
 

@RequestParam 的 defaultValue 取值就是用来给取值为空的请求参数提供一个默认值的。 

@RestController  
@RequestMapping("/home")  
public class IndexController   
    @RequestMapping(value = "/name")  
    String getName(@RequestParam(value = "person", defaultValue = "John") String personName)   
        return "Required element of request param";  
      
 

在这段代码中，如果 person 这个请求参数为空，那么 getName() 处理方法就会接收 John 这个默认值作为其参数。 

 

 

@RequestMapping属性：

method ：

Spring MVC 的 @RequestMapping 注解能够处理 HTTP 请求的方法, 比如 GET, PUT, POST, DELETE 以及 PATCH。 
所有的请求默认都会是 HTTP GET 类型的。 

对请求的映射不仅仅不局限在标示的方法的返回值对请求url上，还可以对请求的其属性做出约定，如请求的method，是get还是post。如果做出了method的条件限定，当请求的url即使映射上了，method不符合的话也不能生成物理视图并转发到目标页面。你需要在 @RequestMapping 中使用 method 来声明 HTTP 请求所使用的方法类型：

@RestController  
@RequestMapping("/home")  
public class IndexController   
    @RequestMapping(method = RequestMethod.GET)  
    String get()   
        return "Hello from get";  
      
    @RequestMapping(method = RequestMethod.DELETE)  
    String delete()   
        return "Hello from delete";  
      
    @RequestMapping(method = RequestMethod.POST)  
    String post()   
        return "Hello from post";  
      
    @RequestMapping(method = RequestMethod.PUT)  
    String put()   
        return "Hello from put";  
      
    @RequestMapping(method = RequestMethod.PATCH)  
    String patch()   
        return "Hello from patch";  
      
 

 

produces：

它的作用是指定返回值类型，不但可以设置返回值类型还可以设定返回值的字符编码；

@Controller  
@RequestMapping(value = "/pets/petId", produces="MediaType.APPLICATION_JSON_VALUE"+";charset=utf-8")  
@ResponseBody  
public Pet getPet(@PathVariable String petId, Model model)       
    // implementation omitted  
 

 

consumes：

 指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;

 

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

 

header：

根据请求中的消息头内容缩小 请求映射 的范围；

 

@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
  

 

@RestController  
@RequestMapping("/home")  
public class IndexController   
    @RequestMapping(value = "/head", headers =   
        "content-type=text/plain"  
    )  
    String post()   
        return "Mapping applied along with headers";  
      

@RestController  
@RequestMapping("/home")  
public class IndexController   
    @RequestMapping(value = "/head", headers =   
        "content-type=text/plain",  
        "content-type=text/html"  
    ) String post()   
        return "Mapping applied along with headers";  
      

 

params ：

params 元素可以进一步帮助我们缩小请求映射的定位范围（定义传参的值，当值为定义的值时，进入方法运行，否则不运行）。使用 params 元素，你可以让多个处理方法处理到同一个URL 的请求, 而这些请求的参数是不一样的。你可以用 myParams = myValue 这种格式来定义参数，也可以使用通配符来指定特定的参数值在请求中是不受支持的。

 

@RestController  
@RequestMapping("/home")  
public class IndexController   
    @RequestMapping(value = "/fetch", params =   
        "personId=10"  
    )  
    String getParams(@RequestParam("personId") String id)   
        return "Fetched parameter using params attribute = " + id;  
      
    @RequestMapping(value = "/fetch", params =   
        "personId=20"  
    )  
    String getParamsDifferent(@RequestParam("personId") String id)   
        return "Fetched parameter using params attribute = " + id;  
      

 

 

@RequestMapping 快捷方式 ：

Spring 4.3 引入了方法级注解的变体，也被叫做 @RequestMapping 的组合注解。组合注解可以更好的表达被注解方法的语义。它们所扮演的角色就是针对 @RequestMapping 的封装，而且成了定义端点的标准方法。 
例如，@GetMapping 是一个组合注解，它所扮演的是 @RequestMapping(method =RequestMethod.GET) 的一个快捷方式。 
方法级别的注解变体有如下几个： 

@GetMapping
@PostMapping
@PutMapping
@DeleteMapping
@PatchMapping

如下代码展示了如何使用组合注解：

@RestController  
@RequestMapping("/home")  
public class IndexController   
    @GetMapping("/person")  
    public @ResponseBody ResponseEntity < String > getPerson()   
        return new ResponseEntity < String > ("Response from GET", HttpStatus.OK);  
      
    @GetMapping("/person/id")  
    public @ResponseBody ResponseEntity < String > getPersonById(@PathVariable String id)   
        return new ResponseEntity < String > ("Response from GET with id " + id, HttpStatus.OK);  
      
    @PostMapping("/person")  
    public @ResponseBody ResponseEntity < String > postPerson()   
        return new ResponseEntity < String > ("Response from POST method", HttpStatus.OK);  
      
    @PutMapping("/person")  
    public @ResponseBody ResponseEntity < String > putPerson()   
        return new ResponseEntity < String > ("Response from PUT method", HttpStatus.OK);  
      
    @DeleteMapping("/person")  
    public @ResponseBody ResponseEntity < String > deletePerson()   
        return new ResponseEntity < String > ("Response from DELETE method", HttpStatus.OK);  
      
    @PatchMapping("/person")  
    public @ResponseBody ResponseEntity < String > patchPerson()   
        return new ResponseEntity < String > ("Response from PATCH method", HttpStatus.OK);  
      
  

在这段代码中，每一个处理方法都使用 @RequestMapping 的组合变体进行了注解。尽管每个变体都可以使用带有方法属性的 @RequestMapping 注解来互换实现, 但组合变体仍然是一种最佳的实践 — 这主要是因为组合注解减少了在应用程序上要配置的元数据，并且代码也更易读。 

 

文章转载至：https://blog.csdn.net/sunshine_yg/article/details/80493604