springmvc基础篇02-常用的注解

1、@Controller：定义一个控制器，springmvc的控制器是采用单例模式的，每个访问是在函数上做出响应。struts是在类上做出响应。

package com.cqvie.handler;

import org.springframework.stereotype.Controller;

@Controller
public class HelloWorld {

    @RequestMapping("/helloworld")
    public String sayHello() {
        System.out.println("Hello World!");
        return "success";
    }
    
}

2、@RequestMapping：指明请求映射，可以加在controller上表示全局，也可以加载函数上。

@RequestMapping("/hello")
public class HelloController {

    @RequestMapping
    public String hello() {
        return "Hello World";
    }

    @RequestMapping("/info")
    public Map<String, String> getInfo(@RequestParam String name) {
        Map<String, String> map = new HashMap<>();
        map.put("name", name);
        return map;
    }

属性：

2.1 value 指定请求的实际地址；

2.2 method 指定请求的method类型， GET、POST、PUT、DELETE等；

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

2.4 produces 指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；

2.5 params 指定request中必须包含某些参数值是，才让该方法处理；

2.6 headers 指定request中必须包含某些指定的header值，才能让该方法处理请求。

3、@RequestParam 请求参数与接收参数不同名称的时候使用

public Map<String, String> getInfo(@RequestParam String name) {
        Map<String, String> map = new HashMap<>();
        map.put("name", name);
        return map;
    }

属性：

3.1 name 绑定的形参

3.2 value 绑定的形参和name没什么区别

3.3 required 指定是否必输

3.4 defaultValue 默认值

4、@RequestBody

作用：

i) 该注解用于读取Request请求的body部分数据，使用系统默认配置的HttpMessageConverter进行解析，然后把相应的数据绑定到要返回的对象上；

ii) 再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。

使用时机：

A) GET、POST方式提时，根据request header Content-Type的值来判断:

application/x-www-form-urlencoded，可选（即非必须，因为这种情况的数据@RequestParam, @ModelAttribute也可以处理，当然@RequestBody也能处理）；
multipart/form-data, 不能处理（即使用@RequestBody不能处理这种格式的数据）；
其他格式，必须（其他格式包括application/json, application/xml等。这些格式的数据，必须使用@RequestBody来处理）；

B) PUT方式提交时，根据request header Content-Type的值来判断:

application/x-www-form-urlencoded，必须；
multipart/form-data, 不能处理；
其他格式，必须；

说明：request的body部分的数据编码格式由header部分的Content-Type指定；

5、@ResponseBody

作用：

该注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区。

使用时机：返回的数据不是html标签的页面，而是其他某种格式的数据时（如json、xml等）使用

6、@RestController

作用为@Controller和@ResponseBody的叠加，即可以声明一个控制器，同时这个控制器返回json格式的数据。

7、@CookieValue：用于获取请求的Cookie值，

 @RequestMapping("/cookievalue")
    public String getCookie(@CookieValue("LANG") String cookie){
        return cookie;
    }

属性：

7.1 value或name属性用来获取具体的某个信息

7.2 require 表明是否必须

7.3 defaultValue 默认值

8、@ModelAttribute：用于把参数保存到model中，可以注解方法或参数，注解在方法上的时候，该方法将在处理器方法执行之前执行，然后把返回的对象存放在 session（前提时要有@SessionAttributes注解）或模型属性中，@ModelAttribute(“attributeName”) 在标记方法的时候指定，若未指定，则使用返回类型的类名称（首字母小写）作为属性名称。　

 @RequestMapping("/modelTest.do")
    public String getUsers(@ModelAttribute("user") UserEntity user){
        System.out.println(user.getUsername());
        return "/index";
    }

如上代码中，使用了@ModelAttribute("user")注解，在执行控制器前执行，然后将生成一个名称为user的model数据，在控制器中我们通过注解在参数上的@ModelAttribute获取参数，然后将model应用到控制器中，在jsp页面中我们同样可以使用它，

 <body>
    ${user.username}
 </body>

9、@SessionAttributes

　　@ModelAttribute注解作用在方法上或者方法的参数上，表示将被注解的方法的返回值或者是被注解的参数作为Model的属性加入到Model中，然后Spring框架自会将这个Model传递给ViewResolver。Model的生命周期只有一个http请求的处理过程，请求处理完后，Model就销毁了。

如果想让参数在多个请求间共享，那么可以用到要说到的@SessionAttribute注解

SessionAttribute只能作用在类上

@Controller
@RequestMapping("sc")
@SessionAttributes("name")
public class SessionController {
    @RequestMapping("session")
    public String sessions(Model model,HttpSession session){
        model.addAttribute("name", "winclpt");
        session.setAttribute("myName", "chke");
        return "session";
}

上面的代码将Model中的name参数保存到了session中（如果Model中没有name参数，而session中存在一个name参数，那么SessionAttribute会讲这个参数塞进Model中）

SessionAttribute有两个参数：

　　String[] value：要保存到session中的参数名称

　　Class[] typtes：要保存的参数的类型，和value中顺序要对应上

所以可以这样写：@SessionAttributes(types = {User.class,Dept.class},value={“attr1”,”attr2”})

原理理解：它的做法大概可以理解为将Model中的被注解的attrName属性保存在一个SessionAttributesHandler中，在每个RequestMapping的方法执行后，这个SessionAttributesHandler都会将它自己管理的“属性”从Model中写入到真正的HttpSession；同样，在每个RequestMapping的方法执行前，SessionAttributesHandler会将HttpSession中的被@SessionAttributes注解的属性写入到新的Model中。

　　如果想删除session中共享的参数，可以通过SessionStatus.setComplete()，这句只会删除通过@SessionAttribute保存到session中的参数

10、@PathViriable 接收路径参数可以实现restfull风格

@RequestMapping("/{myname}/pathVariable2.do")
    public String pathVariable2(@PathVariable(value = "myname") String name){
        System.out.println("myname = "+name);
        return "index";
    }

springmvc基础篇02-常用的注解

猜你喜欢