SpringMVC常用注解及其作用整理

1. @Controller

       该注解用于标记在一个类上，使用它标记的类就是一个SpringMVC的Controller对象。用于分发处理器将会扫描使用了该注解的类的方法，并检测该方法是否使用了 @RequestMapping 注解。@Controller 注解只是定义了一个控制器类，而使用 @RequstMapping 注解的方法才是真正处理请求的处理器。

       @Contoller 标记在一个类上还不能真正意义上说它就是SpringMVC的一个控制器，还需要将其交给Spring容器来进行管理：

< context:component-scan base-package = "com.sztxtech" /> 

       此外，Controller 不会直接依赖于 HttpServletRequest 和 HttpServletResponse 等 HttpServlet 对象，它们可以通过 Controller 的方法参数灵活的获取到。

2. @RequestMapping

       该注解是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有方法的请求都是以该地址作为父路径的。

       返回值会通过视图解析器解析为实际的物理视图，对于 InternalResourceViewResolver 视图解析器，会做如下的解析：通过 prefix + returnVal + suffix 这样的方式得到实际的物理视图，然后做转发操作。

       RequestMapping 注解有以下属性：

              (1) value ：指定请求的实际地址；

              (2) method：指定请求的方法类型，包括 GET、POST、PUT、DELETE 等；

    /**
     * Rest 风格的 URL（以 CRUD 为例）：
     *         新增：/order POST
     *         修改：/order/1 PUT
     *         获取：/order/1 GET
     *         删除：/order/1 DELETE
     * @param id
     * @return
     */
    @RequestMapping(value = "/testRestPut/{id}", method = RequestMethod.PUT)
    public String testRestPut(@PathVariable int id) {
        System.out.println("testRestPut:" + id);
        return SUCCESS;
    }
    
    @RequestMapping(value = "/testRestDelete/{id}", method = RequestMethod.DELETE)
    public String testRestDelete(@PathVariable int id) {
        System.out.println("testRestDelete:" + id);
        return SUCCESS;
    }
    
    @RequestMapping(value = "/testRestPost/{id}", method = RequestMethod.POST)
    public String testRestPost(@PathVariable int id) {
        System.out.println("testRestPost:" + id);
        return SUCCESS;
    }
    
    @RequestMapping("/testRestGet")
    public String testRestGet() {
        System.out.println("testRestGet");
        return SUCCESS;
    }

              (3) consumes：指定处理请求的提交内容类型（Content-Type）；例如，application/json,text/html。

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

              (5) params：指定 request 中必须包含某些参数值时，才让该方法处理此 request 请求；

              (6) headers：指定 request 中必须包含某些指定的 header 值，才能让该方法处理此 request 请求；

                     @RequestMapping("/hello/?/xxx") 的 Ant 路径，匹配符：

                     ？：匹配文件名的一个字符；

                     * ：匹配文件名的所有字符；

                     ** ：匹配多层路径；

 

                           @RequestMapping("/testPojo") POJO类用法：

@RequestMapping("/testPojo")
public String testPojo(User user){
    System.out.println("test Pojo : " + user);
    return "success";
}

                           @RequestMapping("/testPojo") Map用法：

@RequestMapping("/testMap")
public String testPojo(Map

                           @RequestMapping("/testPojo") ModelAndView用法：

@RequestMapping("/testModelAndView")
public String testModelAndView(){
    String viewName = SUCCESS;
    ModelAndView modelAndView = new ModelAndView(viewName);
    modelAndView.addObject("time", new Date());
    return modelAndView;
}

3. @Resource 和 @Autowired

       这两个注解都是做 bean 的注入时使用的，实际上 @Resource 并不是 Spring 的注解，它的包是 javax.annontation.Resource，需要导入；但是Spring支持该注解的注入。

       二者在使用上的异同点比较如下：

       (1) 相同点： 都可以写在属性和setter()方法上。若二者都写着属性上，那么就不需要再写 setter() 方法了。

       (2) 不同点：

              @Autowired 是Spring提供的注解，所在包：org.springframework.beans.factory.annotation.Autowired；

public class HelloWorld{
    // 下面两种@Autowired只要使用一种即可
    @Autowired
    private UserDao userDao; // 用于字段上
    
    @Autowired
    public void setUserDao(UserDao userDao) { // 用于属性的方法上
        this.userDao = userDao;
    }
}

         @Autowired 注解是按照类型（byType）装配依赖对象的，默认情况下它要求依赖对象必须存在，如果允许 null 值，可以设置它的 required 属性为 false。如果想使用按照名称（buName）来装配，可以结合 @Qualifier 注解一起使用。例如：

public class Helloworld{
    @Autowired
    @Qualifier("userDao")
    private UserDao userdao;
}

         @Resource 注解默认按照 byName 自动注入，由J2EE提供，所在包：javax.annotation.Resource；该注解有两个重要的属性：name 和 type；而Spring将 @Resource 注解的 name 属性解析为 bean 的名字，而 type 属性则被解析为 bean 的类型。所以，如果使用 name 属性，则使用 byName 的自动注入策略，而使用 type 属性时则使用 byType 自动注入策略。如果既不指定 name 也不指定 type 属性，这时将通过反射机制使用 byName 自动注入策略。

public class HelloWorld{
    // 下面两种@Resource只要使用一种即可
    @Resource(name="userDao")
    private UserDao userDao; // 用于字段上
    
    @Resource(name="userDao")
    public void setUserDao(UserDao userDao) { // 用于属性的setter方法上
        this.userDao = userDao;
    }
}

         备注：最好是将 @Resource 放在 setter() 方法上，因为这样更符合面向对象的思想，通过set、get 去操作属性，而不是直接去操作属性。

4. @PathVariable

       该注解用于将请求 URL 中的模板变量映射到功能处理方法的参数上，即取出 url 模板中的变量作为参数。例如：

@Controller  
public class TestController {  
     @RequestMapping(value="/user/{userId}/roles/{roleId}",method = RequestMethod.GET)  
     public String getLogin(@PathVariable("userId") String userId,  
         @PathVariable("roleId") String roleId){  
         System.out.println("User Id : " + userId);  
         System.out.println("Role Id : " + roleId);  
         return "hello";  
     }  
     @RequestMapping(value="/product/{productId}",method = RequestMethod.GET)  
     public String getProduct(@PathVariable("productId") String productId){  
           System.out.println("Product Id : " + productId);  
           return "hello";  
     }  
     @RequestMapping(value="/javabeat/{regexp1:[a-z-]+}",  
           method = RequestMethod.GET)  
     public String getRegExp(@PathVariable("regexp1") String regexp1){  
           System.out.println("URI Part 1 : " + regexp1);  
           return "hello";  
     }  
}

5. @CookieValue

       该注解用于获取Cookie 中的值；该注解有以下属性：value：参数名称；required：是否必须；defaultValue：默认值。

    /**
     * 获取 Session
     * JSESSIONID=411A032E02A2594698F6E3F4458B9CE4
     */
    @RequestMapping("/testCookieValue")
    public String testCookieValue(@CookieValue("JSESSIONID") String sessionId) {
        System.out.println("JSESSIONID = " + sessionId);
        return "success";
    }

6. @RequestParam

       该注解用于将请求参数区的数据映射到功能处理方法的参数上。例如：

    /**
     * @RequestParam("id") 带参映射
     * @param id
     * @return
     */
    @RequestMapping("/testRequestParam")
    public String testRequestParam(@RequestParam("id") int id) {
        System.out.println("testRequestParam  " + id);
        return "success";
    }

7. @SessionAttribute

       该注解用于将值放到 session 作用域中，写在 class 上面。该注解除了可以通过属性名指定需要放到绘画中的属性外（value属性值），还可以通过模型属性的对象类型指定那些模型属性需要放到会话中（type属性值）；例如：

import java.util.Map;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.SessionAttributes;

import com.sztxtech.model.User;

@SessionAttributes(value = {"user"}, types = {String.class})
@RequestMapping("/springmvc")
@Controller
public class SessionAttributesTest {
    
    /**
     * @SessionAttributes
     *         除了可以通过属性名指定需要放到会话中的属性外（value 属性值），
     *         还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中（types 属性值）。
     * 注意： 该注解只能放在类的上面，不能放在方法上面
     * 
     * @return
     */
    @RequestMapping("/testSessionAttributes")
    public String testSessionAttributes(Map map) {
        User user = new User(1, "刘邦", "qwe", "123", "辽宁");
        map.put("user", user);
        map.put("school", "重庆");
        return "success";
    }
}

8. @ModelAttribute

       该注解表示的是：该 Controller 的所有方法在调用前，先执行 @ModelAttribute 方法，可用于注解和方法参数中，可以把这个 @ModelAttribute 特性应用在 BaseController 类当中，所有的 Controller 继承 BaseController 类，即可实现在调用 Controller 时，先执行 @ModelAttribute 方法。

import java.util.Map;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

import com.sxtxtech.model.User;

@Controller
@RequestMapping("/springmvc")
public class ModelAttributeTest {

    private static final String SUCCESS = "success";
    
    /**
     * 1.有 @ModelAttribute 标记的方法，会在每个目标方法执行之前被 SpringMVC 调用
     * 2.@ModelAttribute注解也可以修饰目标方法POJO类形的入参，其value的属性值有如下作用：
     *     1）SpringMVC会使用value属性值在implicitModel中查找对应的对象，若存在则直接传入到目标方法的入参中
     *     2）SpringMVC会以value为key,POJO类型的对象为value，存入的request中
     * 
     * @param id
     * @param map
     */
    @ModelAttribute
    public void getUser(@RequestParam(value = "id", required = false) int id,
            Map map) {
        //模拟数据库中获取对象
        User user = new User(1, "刘邦", "123", "023", "重庆");
        System.out.println("从数据库中获取一个对象：" + user);
        map.put("abc", user);
    }
    
    /**
     * 运行流程：
     *         1.执行@ModelAttribute注解修饰的方法，从数据库中取出对象，把对象放入Map中，键为：user；
     *         2.SpringMVC从Map中取出User对象，并把表单的请求参数赋值给该User对象的对应属性；
     *         3.SpringMVC把上述对象传入目标方法的参数。
     * 
     * 注意：在@ModelAttribute修饰的方法中，放入到Map时的键需要和目标方法入参类型的第一个字母小写的字符串一致
     * 
     * @param user
     * @return
     */
    @RequestMapping("/testModelAttribute")
    public String testModelAttribute(@ModelAttribute("abc") User user) {
        System.out.println("修改：" + user);
        return SUCCESS;
    }
}

9. @ResponseBody

       该注解用于将 Controller 的方法返回的对象通过适当的 HttpMessageConverter 转换为指定格式后，写入到 Response 对象的 body 数据区。使用在，返回的数据不是 html 标签的页面，而是某种格式的数据，例如 json、xml 等。

       如果响应的是字符串，则直接将字符串写到客户端；如果是一个对象，则会将对象转化为 json 串，然后写到客户端。这里需要注意的是，如果返回对象，按 UTF-8 编码。如果返回 String，页面可能会出现乱码。因此在注解中可以手动修改编码格式，如：@RequestMapping(value="/user/query", produces="text/html;charset=utf-8")，前面是请求路径，后面是编码格式。

public class UserController{
	@Autowired
	UserService userService;
	
	@RequestMapping("getReceiveAddressByMemberId")
	@ResponseBody
	public List getReceiveAddressByMemberId(String memberId){
		List list = userService.getReceiveAddressByMemberId(memberId);
		return list;
	}
	
	@RequestMapping("getAllUser")
	@ResponseBody
	public List getAllUser(){
		List umsMembers = userService.getAllUser();
		return umsMembers;
	}
	
	@RequestMapping("index")
	@ResponseBody
	public String index(){
		return "hello user";
	}
}

10.  @RequestBody

       该注解用于获取请求体的内容

/**
 * 接受请求参数
 *
 */
@RequestMapping(path="/hello")
public String sayHello(@RequestBody String body){
    System.out.println("aaaaaa");
    System.out.println(body);

    return "success";
}