Spring MVC @RequestMapping Annotation示例

 

Spring MVC @RequestMapping Annotation示例

Controller，Methods，Headers，Params，@ RequestParam，@ PathVariable

 

@RequestMapping是最广泛使用的Spring MVC注释之一。org.springframework.web.bind.annotation.RequestMapping注释用于将Web请求映射到特定的处理程序类和/或处理程序方法。

@RequestMapping可以应用于控制器类以及方法。今天，我们会考虑这个注释与例子和其他注释的各种使用@PathVariable和@RequestParam。

目录[ 隐藏 ]

• 1 Spring @RequestMapping
• 2 Spring @PathVariable
• 3 Spring @RequestParam
  • 3.1 Spring RestMapping测试程序

Spring @RequestMapping

Spring @PathVariable

Spring @RequestParam

1. @RequestMapping with Class：我们可以将它与类定义一起使用来创建基URI。例如：

   
   @Controller
   @RequestMapping("/home")
   public class HomeController {
   
   }
   

   现在/ home是将使用此控制器的URI。这个概念与Web应用程序的servlet上下文非常相似。

2. @RequestMapping with Method：我们可以使用它与方法一起提供将使用处理程序方法的URI模式。例如：

   
   @RequestMapping(value="/method0")
   @ResponseBody
   public String method0(){
   	return "method0";
   }
   

   上面的注释也可以写成@RequestMapping("/method0")。在旁注中，我使用@ResponseBody发送此Web请求的String响应，这样做是为了使示例简单。像我一直这样，我将在Spring MVC应用程序中使用这些方法，并使用简单的程序或脚本对它们进行测试。

3. 带有多个URI的@RequestMapping：我们可以使用单个方法来处理多个URI，例如：

   
   @RequestMapping(value={"/method1","/method1/second"})
   @ResponseBody
   public String method1(){
   	return "method1";
   }
   

   如果您将查看RequestMapping注释的源代码，您将看到它的所有变量都是数组。我们可以为处理程序方法的URI映射创建String数组。

4. 使用HTTP方法进行@RequestMapping：有时我们希望基于所使用的HTTP方法执行不同的操作，即使请求URI保持不变。我们可以使用@RequestMapping方法变量来缩小将调用此方法的HTTP方法。例如：

   
   @RequestMapping(value="/method2", method=RequestMethod.POST)
   @ResponseBody
   public String method2(){
   	return "method2";
   }
   	
   @RequestMapping(value="/method3", method={RequestMethod.POST,RequestMethod.GET})
   @ResponseBody
   public String method3(){
   	return "method3";
   }
   

5. 带标题的@RequestMapping：我们可以指定应该存在的标题来调用处理程序方法。例如：

   
   @RequestMapping(value="/method4", headers="name=pankaj")
   @ResponseBody
   public String method4(){
   	return "method4";
   }
   	
   @RequestMapping(value="/method5", headers={"name=pankaj", "id=1"})
   @ResponseBody
   public String method5(){
   	return "method5";
   }
   

6. @RequestMapping with Produces and Consumes：我们可以使用header Content-Type并Accept找出请求内容以及它想要响应的mime消息。为了清楚起见，@RequestMapping提供产生和消耗的变量，我们可以指定请求内容类型方法将被调用针对和响应的内容类型。例如：

   
   @RequestMapping(value="/method6", produces={"application/json","application/xml"}, consumes="text/html")
   @ResponseBody
   public String method6(){
   	return "method6";
   }
   

   上面的方法只能使用Content-Type作为text / html消息，并且能够生成application / json和application / xml类型的消息。

7. @RequestMapping with @PathVariable：RequestMapping注释可用于处理动态URI，其中一个或多个URI值用作参数。我们甚至可以为URI动态参数指定正则表达式以仅接受特定类型的输入。它与@PathVariable注释一起使用，通过它我们可以将URI变量映射到方法参数之一。例如：

   
   @RequestMapping(value="/method7/{id}")
   @ResponseBody
   public String method7(@PathVariable("id") int id){
   	return "method7 with id="+id;
   }
   	
   @RequestMapping(value="/method8/{id:[\\d]+}/{name}")
   @ResponseBody
   public String method8(@PathVariable("id") long id, @PathVariable("name") String name){
   	return "method8 with id= "+id+" and name="+name;
   }
   

8. @RequestMapping使用@RequestParam获取URL参数：有时我们在请求URL中获取参数，主要是在GET请求中。我们可以使用@RequestMapping和@RequestParam注释来检索URL参数并将其映射到方法参数。例如：

   
   @RequestMapping(value="/method9")
   @ResponseBody
   public String method9(@RequestParam("id") int id){
   	return "method9 with id= "+id;
   }
   

   要使此方法起作用，参数名称应为“id”，并且应为int类型。

9. @RequestMapping默认方法：如果某个方法的值为空，则它作为控制器类的默认方法。例如：

   
   @RequestMapping()
   @ResponseBody
   public String defaultMethod(){
   	return "default method";
   }
   

   正如您在上面已经看到的那样映射/home到的HomeController，此方法将用于默认的URI请求。

10. @RequestMapping回退方法：我们可以为控制器类创建一个回退方法，以确保我们捕获所有客户端请求，即使没有匹配的处理程序方法。当没有请求的处理程序方法时，它可以向用户发送自定义404响应页面。

    
    @RequestMapping("*")
    @ResponseBody
    public String fallbackMethod(){
    	return "fallback method";
    }
    

Spring RestMapping测试程序

我们可以使用Spring RestTemplate来测试上面的不同方法，但今天我将使用cURL命令来测试这些方法，因为这些方法很简单并且没有太多数据流动。

 

我创建了一个简单的shell脚本springTest.sh来调用所有上述方法并打印它们的输出。它看起来像下面。

#!/bin/bash

echo "curl http://localhost:9090/SpringRequestMappingExample/home/method0";
curl http://localhost:9090/SpringRequestMappingExample/home/method0;
printf "\n\n*****\n\n";

echo "curl http://localhost:9090/SpringRequestMappingExample/home";
curl http://localhost:9090/SpringRequestMappingExample/home;
printf "\n\n*****\n\n";

echo "curl http://localhost:9090/SpringRequestMappingExample/home/xyz";
curl http://localhost:9090/SpringRequestMappingExample/home/xyz;
printf "\n\n*****\n\n";

echo "curl http://localhost:9090/SpringRequestMappingExample/home/method1";
curl http://localhost:9090/SpringRequestMappingExample/home/method1;
printf "\n\n*****\n\n";

echo "curl http://localhost:9090/SpringRequestMappingExample/home/method1/second";
curl http://localhost:9090/SpringRequestMappingExample/home/method1/second;
printf "\n\n*****\n\n";

echo "curl -X POST http://localhost:9090/SpringRequestMappingExample/home/method2";
curl -X POST http://localhost:9090/SpringRequestMappingExample/home/method2;
printf "\n\n*****\n\n";

echo "curl -X POST http://localhost:9090/SpringRequestMappingExample/home/method3";
curl -X POST http://localhost:9090/SpringRequestMappingExample/home/method3;
printf "\n\n*****\n\n";

echo "curl -X GET http://localhost:9090/SpringRequestMappingExample/home/method3";
curl -X GET http://localhost:9090/SpringRequestMappingExample/home/method3;
printf "\n\n*****\n\n";

echo "curl -H "name:pankaj" http://localhost:9090/SpringRequestMappingExample/home/method4";
curl -H "name:pankaj" http://localhost:9090/SpringRequestMappingExample/home/method4;
printf "\n\n*****\n\n";

echo "curl -H "name:pankaj" -H "id:1" http://localhost:9090/SpringRequestMappingExample/home/method5";
curl -H "name:pankaj" -H "id:1" http://localhost:9090/SpringRequestMappingExample/home/method5;
printf "\n\n*****\n\n";

echo "curl -H "Content-Type:text/html" http://localhost:9090/SpringRequestMappingExample/home/method6";
curl -H "Content-Type:text/html" http://localhost:9090/SpringRequestMappingExample/home/method6;
printf "\n\n*****\n\n";

echo "curl http://localhost:9090/SpringRequestMappingExample/home/method6";
curl http://localhost:9090/SpringRequestMappingExample/home/method6;
printf "\n\n*****\n\n";

echo "curl -H "Content-Type:text/html" -H "Accept:application/json" -i http://localhost:9090/SpringRequestMappingExample/home/method6";
curl -H "Content-Type:text/html" -H "Accept:application/json" -i http://localhost:9090/SpringRequestMappingExample/home/method6;
printf "\n\n*****\n\n";

echo "curl -H "Content-Type:text/html" -H "Accept:application/xml" -i http://localhost:9090/SpringRequestMappingExample/home/method6";
curl -H "Content-Type:text/html" -H "Accept:application/xml" -i http://localhost:9090/SpringRequestMappingExample/home/method6;
printf "\n\n*****\n\n";

echo "curl http://localhost:9090/SpringRequestMappingExample/home/method7/1";
curl http://localhost:9090/SpringRequestMappingExample/home/method7/1;
printf "\n\n*****\n\n";

echo "curl http://localhost:9090/SpringRequestMappingExample/home/method8/10/Lisa";
curl http://localhost:9090/SpringRequestMappingExample/home/method8/10/Lisa;
printf "\n\n*****\n\n";

echo "curl http://localhost:9090/SpringRequestMappingExample/home/method9?id=20";
curl http://localhost:9090/SpringRequestMappingExample/home/method9?id=20;
printf "\n\n*****DONE*****\n\n";

请注意，我已在Tomcat-7上部署了我的Web应用程序，并且它在端口9090上运行.SpringRequestMappingExample是应用程序的servlet上下文。现在，当我通过命令行执行此脚本时，我得到以下输出。

 

pankaj:~ pankaj$ ./springTest.sh 
curl http://localhost:9090/SpringRequestMappingExample/home/method0
method0

*****

curl http://localhost:9090/SpringRequestMappingExample/home
default method

*****

curl http://localhost:9090/SpringRequestMappingExample/home/xyz
fallback method

*****

curl http://localhost:9090/SpringRequestMappingExample/home/method1
method1

*****

curl http://localhost:9090/SpringRequestMappingExample/home/method1/second
method1

*****

curl -X POST http://localhost:9090/SpringRequestMappingExample/home/method2
method2

*****

curl -X POST http://localhost:9090/SpringRequestMappingExample/home/method3
method3

*****

curl -X GET http://localhost:9090/SpringRequestMappingExample/home/method3
method3

*****

curl -H name:pankaj http://localhost:9090/SpringRequestMappingExample/home/method4
method4

*****

curl -H name:pankaj -H id:1 http://localhost:9090/SpringRequestMappingExample/home/method5
method5

*****

curl -H Content-Type:text/html http://localhost:9090/SpringRequestMappingExample/home/method6
method6

*****

curl http://localhost:9090/SpringRequestMappingExample/home/method6
fallback method

*****

curl -H Content-Type:text/html -H Accept:application/json -i http://localhost:9090/SpringRequestMappingExample/home/method6
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json
Content-Length: 7
Date: Thu, 03 Jul 2014 18:14:10 GMT

method6

*****

curl -H Content-Type:text/html -H Accept:application/xml -i http://localhost:9090/SpringRequestMappingExample/home/method6
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 7
Date: Thu, 03 Jul 2014 18:14:10 GMT

method6

*****

curl http://localhost:9090/SpringRequestMappingExample/home/method7/1
method7 with id=1

*****

curl http://localhost:9090/SpringRequestMappingExample/home/method8/10/Lisa
method8 with id= 10 and name=Lisa

*****

curl http://localhost:9090/SpringRequestMappingExample/home/method9?id=20
method9 with id= 20

*****DONE*****

pankaj:~ pankaj$ 

尽管您可能想要检查默认和回退方法，但大多数都是自我理解的。这就是Spring RequestMapping示例，我希望它能帮助您理解这个注释以及它的各种功能。您应该从下面的链接下载示例项目，并尝试不同的方案来进一步探索它。

下载Spring MVC RequestMapping项目

 

转载来源：https://www.journaldev.com/3358/spring-requestmapping-requestparam-pathvariable-example