Controller包下的常用注解

1. 使用@Controller注解定义一个Controller控制器

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

  不使用@ResponseBody注解的情况下，只使用@Controller标记的情况下，客户端获得的是一个视图。可以使用String类型或者使用ModelAndView来返回一个视图。代码示例如下：

    @RequestMapping("/modelAjax")
    public ModelAndView modelAjax(){
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.setViewName("ajax");
        return modelAndView;
    }

    @RequestMapping("/ajax")
    public String ajax(){
        return "ajax";
    }

2.使用@RequestMapping来映射@Request请求与处理器

  可以使用@RequestMapping来映射URL到控制器类，或者是到Controller控制器的处理方法上。当@RequestMapping标记在Controller类上的时候，里面使用@RequestMapping标记的方法的请求地址都是相对于类上的@RequestMapping而言的；当Controller类上没有标记@RequestMapping注解时，方法上的@RequestMapping都是绝对路径。

  @RequestMapping注解中各个参数的作用如下

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
    //指定映射名称
    String name() default "";
    
    //@AliasFor在同一个注解使用时，互为别名，即path和value这两个属性互为别名。
    //这里value和path都是用来定义url的值
    @AliasFor("path")
    String[] value() default {};

    @AliasFor("value")
    String[] path() default {};
    
    //指定请求的传递方式，分为GET、POST、PUT、DELETE等
    RequestMethod[] method() default {};
    
    //指定request中必须包含某些参数值是，才让该方法处理
    String[] params() default {};
    
    //指定request中必须包含某些指定的header值，才能让该方法处理请求
    String[] headers() default {};
    
    //指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;
    String[] consumes() default {};

    // 指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回
    String[] produces() default {};
}

3.@responseBody注解的作用是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据

4.@PathVariable

  当使用@RequestMapping URI template 样式映射时， 即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。

 代码示例

    //url示例：http://localhost:8081/findAjax/2
    @RequestMapping("findAjax/{id}")
    @ResponseBody
    public List<User> ajax(@PathVariable("id") Integer id){

}

5.@RequestParam

  如果参数前写了@RequestParam(xxx)，那么前端必须有对应的xxx名字才行(不管其是否有值，当然可以通过设置该注解的required属性来调节是否必须传)，如果没有xxx名的话，那么请求会出错，报400。如果参数前不写@RequestParam(xxx)的话，那么就前端可以有可以没有对应的xxx名字才行，如果有xxx名的话，那么就会自动匹配；没有的话，请求也能正确发送。

  @RequestParam 从request里面拿取值，支持下面四种参数

• defaultValue 如果本次请求没有携带这个参数，或者参数为空，那么就会启用默认值
• name 绑定本次参数的名称，要跟URL上面的一样
• required 这个参数是不是必须的
• value 跟name一样的作用，是name属性的一个别名

    //url示例：http://localhost:8081/findAjax?id=2
    @RequestMapping(value ="/findAjax")
    @ResponseBody
    public List<User> ajax(@RequestParam("id") Integer id){

}

6.@RequestBody

 @RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的)；GET方式无请求体，所以使用@RequestBody接收数据时，前端不能使用GET方式提交数据，而是用POST方式进行提交。在后端的同一个接收方法里，@RequestBody与@RequestParam()可以同时使用，@RequestBody最多只能有一个，而@RequestParam()可以有多个。一个请求，只有一个RequestBody；一个请求，可以有多个RequestParam。当同时使用@RequestParam（）和@RequestBody时，@RequestParam（）指定的参数可以是普通元素、 数组、集合、对象等等(即:当，@RequestBody 与@RequestParam()可以同时使用时，原SpringMVC接收 参数的机制不变，只不过RequestBody 接收的是请求体里面的数据；而RequestParam接收的是key-value里面的参数，所以它会被切面进行处理从而可以用普通元素、数组、集合、对象等接收)。即：如果参数时放在请求体中，传入后台的话，那么后台要用@RequestBody才能接收到；如果不是放在请求体中的话，那么后台接收前台传过来的参数时，要用@RequestParam来接收，或则形参前 什么也不写也能接收。

6. @QueryParam

 @QueryParam 是 JAX-RS 本来就提供的，和Spring的RequestParam作用一致

7.@PathParam

  这个注解是和spring的pathVariable是一样的，也是基于模板的，但是这个是jboss包下面的一个实现，上面的是spring的一个实现，都要导包

8.@RequestHeader、@CookieValue

  @RequestHeader 注解，可以把Request请求header部分的值绑定到方法的参数上

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