Spring MVC 入门（四）Spring MVC 的常用注解

1. @Controller 注解

        org.springframework.stereotype.Controller 注解类型用于指示 Spring 类的实例是一个控制器，使用 @Controller 注解的类不需要继承特定的父类或者实现特定的接口，可以支持同时处理多个请求动作，更加灵活。
        @Controller 用于标记一个类，使用它标记的类就是一个 SpringMVC Controller 对象，即一个控制器类。
        Spring 使用扫描机制查找应用程序中所有基于注解的控制器类。分发处理器会扫描使用了该注解的类的方法，并检测该方法是否使用了 @RequestMapping 注解，而使用 @RequestMapping 注解的方法才是真正处理请求的处理器。为了保证 Spring 能找到控制器就需要完成两件事：

• 在 Spring MVC 的配置文件的头文件中引入 spring-context。
• 使用 <context:component-scan/> 元素，该元素的功能为：启动包扫描功能，以便注册带有 @Controller、@Service、@repository、@Component 等注解的类称为 Spring 的 Bean。base-package 属性指定了需要扫描的类包，类包及其递归子包中所有的类都会被处理。

        Spring MVC 中用于参数绑定的注解有很多，都在 org.springframework.web.bind.annotation 包中，根据处理的 request 的不同内容部分可以分为四类：

• 处理 request body 部分的注解：@RequestParam、@RequestBody。
• 处理 request uri 部分的注解：@PathVariable。
• 处理 request header 部分的注解：@RequestHeader、@CookieValue。
• 处理 attribute 类型的注解：@SessionAttributes、@ModelAttribute。

2. @RequestMapping 注解

        org.springframework.web.bind.annotation.RequestMapping 注解类型指示 Spring 用哪一个类或方法来处理请求动作，该注解可用于类或方法。严格来说，@RequestMapping并不属于参数绑定注解。
        @RequestMapping可以用来注释一个控制器类，在这种情况下，所有方法都将映射为相对于类级别的请求，表示该控制器处理的所有请求都被映射到value属性所指示的路径下。
        使用 @RequestMapping 注解可以指定如下属性：
2.1 value 属性
        @RequestMapping 用来映射一个请求和一种方法。可以使用 @RequestMapping 注释一个方法或类，value属性将 URL 映射到方法上。例如：

    @RequestMapping(value = "/hello")
    public String hello(){
        return "hello!world";
    }

        由于 value 属性是 @RequestMapping 注释的默认属性，因此，如果只有唯一的属性，则可以省略属性名。
2.2 method 属性
        该属性用来指示该方法仅仅处理哪些 HTTP 请求方式。

@RequestMapping(value = "/hello" , method = RequestMethod.POST)

        以上代码 method = RequestMethod.POST 表示该方法只支持 POST 请求。
        method 属性也可同时支持多个 HTTP 请求方式。如：

@RequestMapping(value = "/hello" , method = {RequestMethod.POST,RequestMethod.GET})

        如果没有指定 method 属性值，则请求处理方法可以处理任意的 HTTP 请求方式。
2.3 consumes 属性
        该属性指定处理请求的提交内容类型（Content-Type）。

@RequestMapping(value = "/hello" , method = RequestMethod.POST , consumes = "application/json")

        表示方法仅处理 request Content-Type 为 “application/json”类型的请求。
2.4 produces 属性
        该属性指定返回的内容类型，返回的内容类型必须是 request 请求头（Accept） 中所包含的类型。

@RequestMapping(value = "/hello" , method = RequestMethod.POST , produces = "application/json")

        方法仅处理 request 请求中 Accept 头中包含了 “application/json” 的请求，同时指明了返回的内容类型为 application/json。
2.5 params 属性
        该属性指定 request 中必须包含某些参数值时，才让该方法处理。

@RequestMapping(value = "/hello" , method = RequestMethod.POST , params = "myParam=myValue")

        方法仅处理其中名为 “myParam”、值为 “myValue” 的请求。
2.6 headers 属性
        该属性指定 request 中必须包含某些指定的 header 值，才能让该方法处理请求。

@RequestMapping(value = "/hello" , method = RequestMethod.POST , headers = "Referer=https://www.baidu.com")

        方法仅处理 request 的 header 中包含了指定 “Referer” 请求头和对应值为 “https://www.baidu.com” 的请求。

3. 参数绑定注解

3.1 @RequestParam 注解

        org.springframework.web.bind.annotation.RequestParam 注解类型用于将指定的请求参数赋值给方法中的形参。

属性	类型	是否必要	说明
name	String	否	指定请求头绑定的名称
value	String	否	name 属性的别名
required	boolean	否	指示参数是否必须绑定
defaultValue	String	否	如果没有传递参数而是用的默认值

        请求处理方法参数的可选类型为 Java 基本数据类型和 String 。

    @RequestMapping(value = "/login")
    public ModelAndView login(
            @RequestParam("loginname") String loginname,
            @RequestParam("password") String password
    ){
        ModelAndView mv = new ModelAndView();
        return mv;
    }

        以上代码会将请求中的 loginname 参数的值赋给 loginname变量，password参数的值赋给 password 变量。

3.2 @PathVariable 注解

        org.springframework.web.bind.annotation.PathVariable 注解类型可以非常方便地获得请求 URL 中的动态参数。 @PathVariable 注解只支持一个属性 value ， 类型为 String，表示绑定的名称，如果省略则默认绑定同名参数。

@RequestMapping(value = "/pathVariableTest/{userID}")
public void pathVariableTest(@PathVariable Integer userID){ }

        加入请求的 URL 为 “http://localhost:8080/pathVariableTest/2020”，则自动将 URL 中模板变量 {userID} 绑定到通过 @PathVariable 注解的同名参数上，即 userID 变量将被赋值为 2020。

3.3 @RequestHeader 注解

        org.springframework.web.bind.annotation.RequestHeader 注解类型用于将请求的头信息区数据映射到功能处理方法的参数上。
使用 @RequestHeader 注解可指定如下属性：

属性	类型	是否必要	说明
name	String	否	指定请求头绑定的名称
value	String	否	name 属性的别名
required	boolean	否	指示参数是否必须绑定
defaultValue	String	否	如果没有传递参数而是用的默认值

如下例所示：

@RequestMapping(value = "/requestHeaderTest")
public void requestHeaderTest(
        @RequestHeader("User-Agent") String userAgent,
        @RequestHeader(value = "Accept") String[] accepts
){}

以上配置自动将请求头 “User-Agent” 的值赋到 userAgent 变量上，并将 “Accept” 请求头的值赋到 accepts 参数上。

3.4 @CookieValue 注解

        org.springwork.web.bind.annotation.CookieValue 用于将请求的 Cookie 数据映射到功能处理方法的参数上。
使用 @CookieValue 注解可指定如下属性：

属性	类型	是否必要	说明
name	String	否	指定请求头绑定的名称
value	String	否	name 属性的别名
required	boolean	否	指示参数是否必须绑定
defaultValue	String	否	如果没有传递参数而是用的默认值

如下例所示：

@RequestMapping(value = "/cookieValueTest")
public void cookieValueTest(
        @CookieValue(value = "JSESSIONID",defaultValue = "") String sessionID
){}

以上配置会自动将 JSESSIONID 值设置到 sessionID 参数上，defaultValue 表示 Cookie 中没有 JSEESSIONID 时默认为空。

3.5 @SessionAttributes 注解

        org.springframework.web.bind.annotation.SessionAttributes 注解类型允许我们有选择地指定 Model 中的哪些属性需要转存到 HttpSession 对象当中。
使用 @SessionAttributes 注解可指定如下属性：

属性	类型	是否必要	说明
name	String[]	否	Model 中属性的名称，即存储在 HttpSession 当中的属性名称
value	String[]	否	names 属性的别名
type	Class<?>[]	否	指示参数是否必须绑定

        @SessionAttributes 注解只能声明在类上，而不能声明在方法上。
        @SessionAttributes 还可以设置多个对象到 HttpSession 当中：

@SessionAttributes(types = {User.class,Dept.class} , value = {"user" , "dept"})

        types 属性用来指定放入 HttpSession 当中的对象类型。

3.6 @ModelAttribute 注解

        org.springframework.web.bind.annotation.ModelAttribute 注解类型将请求参数绑定到 Model 对象。
        @ModelAttribute 注解只支持一个属性 value， 类型为 String，表示绑定的属性名称。
        注：被@ModelAttribute 注释的方法会在 Controller 每个方法执行前被执行，因此，在一个 Controller 映射到多个 URL 时，要谨慎使用。
@ModelAttribute 注解的使用方式有很多种：

3.6.1 @ModelAttribute(value="") 注释返回具体类的方法

//使用@ModelAttribute注释的value属性，来指定model属性的名称，model属性的值就是方法的返回值
@ModelAttribute("loginname")
public String userModel1(
        @RequestParam("loginname") String loginname
){
    return loginname;
}
@RequestMapping(value = "/login1")
public String login1(){
    return "result";
}

3.6.2 @ModelAttribute 注释 void 返回值的方法

//model属性名称和值由model.addAttribute()实现，前提是要在方法中加入一个Model类型的参数
@ModelAttribute
public void userModel2(
        @RequestParam("loginname") String loginname ,
        @RequestParam("password") String password,
        Model model
){
    model.addAttribute("loginname" , loginname);
    model.addAttribute("password" , password);
}
@RequestMapping(value = "/login2")
public String login2(){
    return "result2";
}

3.6.3 @ModelAttribute 注释返回具体类的方法

//model属性的名称没有被指定，它由返回类型隐含表示，如这个方法返回 User 类型，那么这个model属性名称是user。
@ModelAttribute
public User userModel3(
        @RequestParam("loginname") String loginname ,
        @RequestParam("password") String password){
    return find(loginname,password);
}
@RequestMapping(value = "/login3")
public String login3(){
    return "result3";
}

3.6.4 @ModelAttribute 和 Request Mapping 同时注释一个方法

@Controller
public class ModelAttribute4Controller{
    //此时login4方法的返回值并不是一个视图名称，而是model属性的值，
    //视图名称是@RequestMapping的value值"/login4"。
    //Model的属性名称由@ModelAttribute(value="")指定，
    //相当于在request中封装了username(key)=admin(value)
    @RequestMapping(value = "/login4")
    @ModelAttribute(value = "username")
    public String login4(){
        return "admin";
    }
}

3.6.5 @ModelAttribute注释一个方法的参数

//model属性名称就是value值，即"user",model属性对象就是方法的返回值。
@ModelAttribute("user")
public User userModel5(
        @RequestParam("loginname") String loginname,
        @RequestParam("password") String password){
    User user = new User();
    user.setLoginname(loginname);
    user.setPassword(password);
    return user;
}
//@ModelAttribute("user") User user注释方法参数，
// 参数user的值就是userModel5()方法中的model属性。
@RequestMapping(value = "/login5")
public String login5(@ModelAttribute("user") User user){
    user.setUsername("管理员");
    return "result5";
}