SpringMVC中 -- @RequestMapping的作用及用法

一、@RequestMapping 简介
　　在Spring MVC 中使用 @RequestMapping 来映射请求，也就是通过它来指定控制器可以处理哪些URL请求，相当于Servlet中在web.xml中配置

    <servlet>
        <servlet-name>servletName</servlet-name>
        <servlet-class>ServletClass</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>servletName</servlet-name>
        <url-pattern>url</url-pattern>
    </servlet-mapping>

　　的映射作用一致。

　　RequestMapping注解类的源码：

    @Target({ElementType.METHOD, ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Mapping
    public @interface RequestMapping {
        String[] value() default {};

        RequestMethod[] method() default {};

        String[] params() default {};

        String[] headers() default {};

        String[] consumes() default {};

        String[] produces() default {};
    }

　　1）在@Target中有两个属性，分别为 ElementType.METHOD 和 ElementType.TYPE ，也就是说 @RequestMapping 可以在方法和类的声明中使用
　　2）方法均返回数组，也就是可以定义多个属性值

二、@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值，才能让该方法处理请求。

三、@RequestMapping 域用法
　　value的uri值为以下三类：
　　　　A） 可以指定为普通的具体值；
　　　　B) 可以指定为含有某变量的一类值(URI Template Patterns with Path Variables):/owners/{ownerId}
　　　　C) 可以指定为含正则表达式的一类值( URI Template Patterns with Regular Expressions):/spring-web/{symbolicName:[a-z-]+}-{version:\d\.\d\.\d}.{extension:\.[a-z]}
　　method:
　　　　Http规范定义了多种请求资源的方式，最基本的有四种，分别为：GET（查）、POST（增）、PUT（改）、DELETE（删），而URL则用于定位网络上的资源相当于地址的作用，配合四种请求方式，可以实现对URL对应的资源的增删改查操作。
　　consumes:
　　　　consumes="application/json"方法仅处理request Content-Type为“application/json”类型的请求。
　　produces:
　　　　produces="application/json"方法仅处理request请求中Accept头中包含了"application/json"的请求，同时暗示了返回的内容类型为application/json;
　　params:
　　　　params="myParam=myValue"仅处理请求中包含了名为“myParam”，值为“myValue”的请求；
　　headers:
　　　　headers="Referer=http://www.ifeng.com/" 仅处理request的header中包含了指定“Refer”请求头和对应值为“http://www.ifeng.com/”的请求；
四、@RequestParam @RequestBody @PathVariable 等参数绑定注解详解
　　handler method 参数绑定常用的注解,我们根据他们处理的Request的不同内容部分分为四类：（主要讲解常用类型）
　　　　A、处理requet uri 部分（这里指uri template中variable，不含queryString部分）的注解： @PathVariable;
　　　　B、处理request header部分的注解： @RequestHeader, @CookieValue;
　　　　C、处理request body部分的注解：@RequestParam, @RequestBody;
　　　　D、处理attribute类型是注解： @SessionAttributes, @ModelAttribute;
　　1、 @PathVariable
　　　　当使用@RequestMapping URI template 样式映射时， 即 someUrl/{paramId}, 这时的paramId可通过 @Controller

        @RequestMapping("/owners/{ownerId}")
        public class RelativePathUriTemplateController {
            @RequestMapping("/pets/{petId}")
            public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {
                // implementation omitted
            }
        }

　　　　上面代码把URI template 中变量 ownerId的值和petId的值，绑定到方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致，需要在@PathVariable("name")指定uri template中的名称。
　　2、 @RequestHeader、@CookieValue
　　　　@RequestHeader 注解，可以把Request请求header部分的值绑定到方法的参数上。

        Host                    localhost:8080
        Accept                  text/html,application/xhtml+xml,application/xml;q=0.9
        Accept-Language         fr,en-gb;q=0.7,en;q=0.3
        Accept-Encoding         gzip,deflate
        Accept-Charset          ISO-8859-1,utf-8;q=0.7,*;q=0.7
        Keep-Alive              300 
        @RequestMapping("/displayHeaderInfo.do")
        public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,
        @RequestHeader("Keep-Alive") long keepAlive)  {
            //...
        }

　　　　上面的代码，把request header部分的 Accept-Encoding的值，绑定到参数encoding上了， Keep-Alive header的值绑定到参数keepAlive上。

　　　　@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。

        JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84  
        @RequestMapping("/displayHeaderInfo.do")
        public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie)  {
            //...
        }

　　　　即把JSESSIONID的值绑定到参数cookie上。
3、@RequestParam, @RequestBody
　　@RequestParam
　　　　A） 常用来处理简单类型的绑定，通过Request.getParameter() 获取的String可直接转换为简单类型的情况（ String--> 简单类型的转换操作由ConversionService配置的转换器来完成）；因为使用request.getParameter()方式获取参数，所以可以处理get 方式中queryString的值，也可以处理post方式中 body data的值；
　　　　B）用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容，提交方式GET、POST；
　　　　C) 该注解有两个属性： value、required； value用来指定要传入值的id名称，required用来指示参数是否必须绑定；

        @Controller
        @RequestMapping("/pets")
        @SessionAttributes("pet")
        public class EditPetForm {
            @RequestMapping(method = RequestMethod.GET)
            public String setupForm(@RequestParam("petId") int petId, ModelMap model) {
                Pet pet = this.clinic.loadPet(petId);
                model.addAttribute("pet", pet);
                return "petForm";
            }
        }

　　@RequestBody
　　　　该注解常用来处理Content-Type: 不是application/x-www-form-urlencoded编码的内容，例如application/json, application/xml等；
　　　　它是通过使用HandlerAdapter 配置的HttpMessageConverters来解析post data body，然后绑定到相应的bean上的。
　　　　因为配置有FormHttpMessageConverter，所以也可以用来处理 application/x-www-form-urlencoded的内容，处理完的结果放在一个MultiValueMap<String, String>里，这种情况在某些特殊需求下使用，详情查看FormHttpMessageConverter api;

        @RequestMapping(value = "/something", method = RequestMethod.PUT)
        public void handle(@RequestBody String body, Writer writer) throws IOException {
            writer.write(body);
        }

4、@SessionAttributes, @ModelAttribute
　　@SessionAttributes:
　　该注解用来绑定HttpSession中的attribute对象的值，便于在方法中的参数里使用。
　　该注解有value、types两个属性，可以通过名字和类型指定要使用的attribute 对象；

        @Controller
        @RequestMapping("/editPet.do")
        @SessionAttributes("pet")
        public class EditPetForm {
            // ...
        }

　　@ModelAttribute
　　该注解有两个用法，一个是用于方法上，一个是用于参数上；
　　用于方法上时： 通常用来在处理@RequestMapping之前，为请求绑定需要从后台查询的model；
　　用于参数上时： 用来通过名称对应，把相应名称的值绑定到注解的参数bean上；要绑定的值来源于：
　　　　A） @SessionAttributes 启用的attribute 对象上；
　　　　B） @ModelAttribute 用于方法上时指定的model对象；
　　　　C） 上述两种情况都没有时，new一个需要绑定的bean对象，然后把request中按名称对应的方式把值绑定到bean中。

        @ModelAttribute
        public Account addAccount(@RequestParam String number) {
            return accountManager.findAccount(number);
        }

　　这种方式实际的效果就是在调用@RequestMapping的方法之前，为request对象的model里put（“account”， Account）；

        @RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)
        public String processSubmit(@ModelAttribute Pet pet) {  

        }

首先查询 @SessionAttributes有无绑定的Pet对象，若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象，若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。
五、补充讲解：
问题： 在不给定注解的情况下，参数是怎样绑定的？
通过分析AnnotationMethodHandlerAdapter和RequestMappingHandlerAdapter的源代码发现，方法的参数在不给定参数的情况下：
若要绑定的对象是简单类型： 调用@RequestParam来处理的。
若要绑定的对象是复杂类型： 调用@ModelAttribute来处理的。
这里的简单类型指Java的原始类型(boolean, int 等)、原始类型对象（Boolean, Int等）、String、Date等ConversionService里可以直接String转换成目标对象的类型；

    @RequestMapping ({"/", "/home"})
    public String showHomePage(String key){
        logger.debug("key="+key);
        return "home";
    }

这种情况下，就调用默认的@RequestParam来处理。

    @RequestMapping (method = RequestMethod.POST)
    public String doRegister(User user){
        if(logger.isDebugEnabled()){
            logger.debug("process url[/user], method[post] in "+getClass());
            logger.debug(user);
        }
        return "user";
    }

这种情况下，就调用@ModelAttribute来处理。

2. Java注解：
ThinkingInJava 第20章
3. 新建WEB工程
点这里
新建和配置 web.xml 以及 spring-mvc.xml 文件

啦啦啦

时间： 2024-10-21 15:56:27

SpringMVC中 -- @RequestMapping的作用及用法的相关文章

springmvc中RequestMapping的解析

在研究源码的时候,我们应该从最高层来看,所以我们先看这个接口的定义: package org.springframework.web.servlet; import javax.servlet.http.HttpServletRequest; /**1.定义一个将请求和处理器进行映射的接口.开发人员也可以自己实现这个接口,虽然这是不必须的,因为现在的springmvc中已经提供了大量的实现,最典型的就是BeanNameUrlHandlerMapping,SimpleUrlHandlerMappi

springMVC的@RequestMapping的参数和用法

RequestMapping注解里面包含的参数如图 value: 控制器名字也是url的映射 params:url中的参数,可以是多个 method: http请求的动作. get  post  put delete... headers : 请求头参数 @PathVariable :映射 URL 绑定占位  ( 映射URL路径里面的变量) @Controller //映射 控制器类 @RequestMapping("/hellotest") public class Hello2 {

Spring mvc中@RequestMapping 6个基本用法小结

小结下spring mvc中的@RequestMapping的用法. 1)最基本的,方法级别上应用,例如: Java代码 @RequestMapping(value="/departments") public String simplePattern(){ System.out.println("simplePattern method was called"); return "someResult"; } 则访问http://localho

Spring mvc中@RequestMapping 6个基本用法小结(转载)

小结下spring mvc中的@RequestMapping的用法. 1)最基本的,方法级别上应用,例如: Java代码   @RequestMapping(value="/departments") public String simplePattern(){ System.out.println("simplePattern method was called"); return "someResult"; } 则访问http://local

(转载)Spring mvc中@RequestMapping 6个基本用法小结

小结下spring mvc中的@RequestMapping的用法. 1)最基本的,方法级别上应用,例如: Java代码 @RequestMapping(value="/departments") public String simplePattern(){ System.out.println("simplePattern method was called"); return "someResult"; } 则访问http://localho

Java中volatile的作用以及用法

volatile让变量每次在使用的时候,都从主存中取.而不是从各个线程的“工作内存”. volatile具有synchronized关键字的“可见性”,但是没有synchronized关键字的“并发正确性”,也就是说不保证线程执行的有序性. 也就是说,volatile变量对于每次使用,线程都能得到当前volatile变量的最新值.但是volatile变量并不保证并发的正确性. =========================分割线1===============================

js中return的作用及用法

这里面的return含有一些细节知识: 例如:onClick='return add_onclick()'与 onClick='add_onclick()'的区别 JAVASCRIPT在事件中调用函数时用return返回值实际上是对window.event.returnvalue进行设置. 而该值决定了当前操作是否继续.当返回的是true时,将继续操作.当返回是false时,将中断操作. 而直接执行时(不用return).将不会对window.event.returnvalue进行设置所以会默认

Oracle中存储过程的作用和用法

存储过程是Oracle开发者在数据转换或查询报表时经常使用的方式之一.它就是想编程语言一样一旦运行成功,就可以被用户随时调用,这种方式极大的节省了用户的时间,也提高了程序的执行效率.存储过程在数据库开发中使用比较频繁,它有着普通SQL语句不可替代的作用.所谓存储过程,就是一段存储在数据库中执行某种功能的程序.其中包含一条或多条SQL语句,但是它的定义方式和PL/SQL中的块.包等有所区别.存储过程可以通俗地理解为是存储在数据库服务器中的封装了一段或多段SQL语句的PL/SQL代码块.在数据库中有

php中的set_magic_quotes_runtime()作用和用法

set_magic_quotes_runtime 用来设置php.ini文件中的magic_quotes_runtime值,当遇到反斜杆(\).单引号(').双引号(")这样一些的字符定入到数据库里,又不想被过滤掉,使用这个函数,将会自动加上一个反斜杆(\),保护系统和数据库的安全. magic_quotes_runtime 是php.ini里的环境配置变量,0和false表示关闭本功能,1和true表示打开本功能.当magic_quotes_runtime打开时,所有外部引入的数据库资料或者文