Spring MVC常用注解

---

Spring MVC常用注解

@Controller

控制器Controller负责处理由DispatcherServlet分发的请求，它把用户请求的数据经过业务处理层处理之后封装成一个Model ，然后再把该Model返回给对应的View进行展示。在SpringMVC 中提供了一个非常简便的定义Controller 的方法，你无需继承特定的类或实现特定的接口，只需使用@Controller标记一个类是Controller

@RequestMapping

@RequestMapping注解的属性有哪些

@Target({ElementType.METHOD, ElementType.TYPE}) // 可以在方法和类的声明中使用
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {

    String name() default "";// 指定映射的名称

    @AliasFor("path")
    String[] value() default {}; // 指定请求路径的地址

    @AliasFor("value")
    String[] path() default {}; // 指定请求路径的地址

	// 指定请求的方式，是一个RequsetMethod数组，可以配置多个方法
    RequestMethod[] method() default {};
	
	// 指定参数的类型
    String[] params() default {};
	
	// 指定请求头内容
    String[] headers() default {};
	
	// 指定数据请求的格式
    String[] consumes() default {};
	
	// 指定返回的内容类型
    String[] produces() default {};
}

各个注解属性的作用

@RequestMapping(name = “”)

1、name
此处name属性，相当于方法的注释，使方法更易理解

@RequestMapping(value = "login",name = "用户登录")
@ResponseBody
public String login() {
	return "success";
}

官方文档说：它能让你非常方便的在JSP页面上使用它，形如这样子可以直接通过静态页面调用：

<%@ taglib uri="http://www.springframework.org/tags" prefix="s" %>
...
<a href="${s:mvcUrl('PAC#getAddress').arg(0,'US').buildAndExpand('123')}">Get Address</a>

@RequestMapping(value=“user”)

2、value

@Controller
@RequestMapping("user")   //此处如果不省略，则为@RequestMapping(value="user")
public class UserController { 
    @RequestMapping("login")
    @ResponseBody
    public String login() {
		return "success";
	}
}

指定请求的实际地址，指定的地址可以是URI 模板模式（Template Pattern）；
由于value属性是@RequestMapping注释的默认属性，因此如果只有唯一的属性，则可以省略该属性名，如果有超过一个属性，则必须写上value属性名称。
即如下两个标注含义一样
@RequestMapping(value=“login”)
@RequestMapping(“login”)

value属性支持通配符匹配：
@RequestMapping(value=“login/*”)；

即：http://localhost:8080/login/1
或者http://localhost:8080/login/hahaha都能够正常访问该接口
此处通过URL：http://localhost:8080/user/login进行访问，将由login()方法进行处理

@RequestMapping(path=“login”)

3、path与value同义，path(value)（path 和 value 互相引用，参见RequestMapping接口源码）
path属性，和1中的value属性使用一致，两者都是用来作为映射使用的。
@RequestMapping(value=“login”)、@RequestMapping(path=“login”)，这两种情况都能对login()方法进行访问

path属性支持通配符匹配：

@RequestMapping(path=“login/*”)；
即：http://localhost:8080/login/1或者http://localhost:8080/login/abc都能够正常访问

@RequestMapping(method = RequestMethod.GET)

4、method
指定请求类型， 如GET、POST、PUT、DELETE等；

@RequestMapping(value = "login",method = RequestMethod.GET)
@ResponseBody
public String login() {
	return "success";
}

以上方法表示，该方法只支持GET请求
此处也可以为
@RequestMapping(value = “login”,method = {RequestMethod.GET,RequestMethod.POST})
说明该方法可以同时支持GET和POST请求。
如果没有method属性，则说明该方法支持全部的HTTP请求。

@RequestMapping(params = “flag”)

5、params
该属性指定，请求中必须包含params属性规定的参数时，才能执行该请求

@RequestMapping(value = "login",params = "flag")
@ResponseBody
public String login() {
	return "success";
}

以上方法，说明请求中必须包含flag参数才能执行该请求，flag参数值不做要求
http://localhost:8080/login?flag=xxx // 正常访问
http://localhost:8080/login // 无法访问

@RequestMapping(value = "login",params = "flag=true")
@ResponseBody
public String login() {
	return "success";
}

以上方法，说明请求中必须包含flag参数，而且参数值必须为true才能执行该请求

http://localhost:8080/login?flag=true // 正常访问
http://localhost:8080/login?flag=false // 无法访问
http://localhost:8080/login // 无法访问

@RequestMapping(headers=“Referer=http://localhost:8080”)

6、headers
①用于HTTP协义交互的信息被称为HTTP报文，客户端发送的HTTP报文被称为请求报文，服务器发回给客户端的HTTP报文称为响应报文，报文由报文头部和报文体组成。
②请求头部（RequestHeaders）：请求头包含许多有关客户端环境和请求正文的信息，例如浏览器支持的语言、请求的服务器地址、客户端的操作系统等。
③响应头部（Rsponse Headers）：响应头也包含许多有用的信息，包括服务器类型、日期、响应内容的类型及编码，响应内容的长度等等。
该属性指定，请求中必须包含某些指定的header值，才能够让该方法处理请求

如Chrome浏览器：
可以通过点击F12（进入开发者模式）---->Network---->Name中点击网页---->右侧查看Headers即可，下边是我电脑中的一个请求头部示例：

Request Headers
    Accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
    Accept-Encoding:gzip, deflate, sdch
    Accept-Language:zh-CN,zh;q=0.8
    Cache-Control:max-age=0
    Connection:keep-alive
    Cookie:JSESSIONID=210075B5E521CWE3CDE938076295A57A
    Host:localhost:8080
    Upgrade-Insecure-Requests:1
    User-Agent:Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.93

// 表示只接收本机发来的请求
@RequestMapping(path = "/login", headers="Referer=http://localhost:8080")
public String login() {
	return "success";
}

以上方法 ，必须满足请求的header中包含了指定的"Referer"请求头和值为"http://localhost:8080"时，才能执行该请求

@RequestMapping(consumes = “application/json”)

7、consumes
指定处理请求的提交内容类型（Content-Type），例如：application/json、text/html时，才能够让该方法处理请求

@RequestMapping(value = "login",consumes = "application/json")
@ResponseBody
public String login() {
	return "success";
}

@RequestMapping(produces = “application/json”)

8、produces
指定返回的内容类型，返回的内容类型必须是request请求头（Accept）中所包含的类型

@RequestMapping(value = "login",produces = "application/json")
@ResponseBody
public String login() {
	return "success";
}

此外，produces属性还可以指定返回值的编码

@RequestMapping(value = “login”,produces = “application/json，charset=utf-8”)
如上，则指明返回utf-8编码

@RequestParam

将请求参数绑定到controller的方法参数上（是springmvc中接收普通参数的注解）

    /**
     * 属性：1. value：请求参数中的名称
            2. required：请求参数中是否必须提供此参数，默认值是true，true为必须提供
            3. defaultValue：默认值
     
     * @param status
     * @return
     */
    @PostMapping("user/add") 
    @ResponseBody
    public List<User> add(@RequestParam(value = "status",required = false,defaultValue = "0")Integer status){
        // TODO
        return null;
    }

@RequestBody

@RequestBody和@RequestParam的作用都是用来将前端传递的参数，直接绑定到后端controller控制器中设置的参数中的
区别在于：

• @RequestBody 限定了前端传递的参数必须为json格式，并且前端不能使用GET方式提交数据，而是用POST方式进行提交,而且@RequestBody 只能有一个。
• @RequestParam()可以有多个,用于接收url中的key-value参数的传递。通常我们用于get方式的请求

@Controller
public class TestController {
    @RequestMapping("/test")
    @ResponseBody
    public Object test(@RequestBody Map<String,Object> requestParam,
                       @RequestParam String phone,//接收url传参
                       @RequestParam String address
                       ) {
        //接收请求体中的json数据这里的Map<String,Object> requestParam 也可以是一个实体类 如User user
        String name = (String)requestParam.get("name");
        Integer age = (Integer)requestParam.get("age");
        //返回数据
        List<Object> list = new ArrayList<>();
        list.add("@RequestBody==="+name);
        list.add("@RequestBody==="+age);
        list.add("@RequestParam======"+phone);
        list.add("@RequestParam======"+address);
        return list;
    }
}

@repository

用于标注数据访问层，也可以说用于标注数据访问组件，即DAO组件

@Component

泛指各种组件，就是说当我们的类不属于各种归类的时候（不属于@Controller,@Services,@repository等的时候），我们就可以使用@Component来标注这个类

@PathVariable

映射 URL 绑定的占位符
带占位符的 URL 是 Spring3.0 新增的功能，该功能在SpringMVC 向 REST 目标挺进发展过程中具有里程碑的意义
通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中：URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的入参中。

@ResponseBody

ResponseBody的作用其实是将java对象转为json格式的数据

---