springmvc常用注解

来源:互联网 发布:淘宝如何拉黑店铺 编辑:程序博客网 时间:2024/06/03 21:13

   一直在使用springmvc,今天来总结一下在项目中经常使用到的注解,可以对知识有一个很好的梳理。

1、@Controller

  用于标记在一个类上,使用它标记的一个类就是一个SpringMVC Controller对象。DispatcherServlet(前端控制器)会扫描使用了该注解的类的方法。@Controller只是定义了一个控制器类,并不能处理请求(真正处理请求的是@RequestMapping,这个后面会讲到)。

  在类上标记@Controller,这时还不能说是一个真正的控制器,这个时候spring还不认识它。我们需要将控制器交给spring管理。有两种管理方式:

<!--单一扫描bean--><bean class="com.tgb.ssm.HelloController"/><!-- 配置controller扫描 --><context:component-scan base-package="com.tgb.ssm.controller" />

查看@Controller注解源码:

package org.springframework.stereotype;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;@Target({ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)@Documented@Componentpublic @interface Controller {    String value() default "";}

@Target({ElementType.TYPE}) 说明该注解只能用在类上


2、@RequestMapping

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

下面是@RequestMapping注解的源码:

@Target({ElementType.METHOD, ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)@Documented@Mappingpublic @interface RequestMapping {    String name() default "";    @AliasFor("path")    String[] value() default {};    @AliasFor("value")    String[] path() default {};    RequestMethod[] method() default {};    String[] params() default {};    String[] headers() default {};    String[] consumes() default {};    String[] produces() default {};}

可以看出有六个属性:

1)、value:

指定请求的实际地址;

2)、method:

     指定请求的类型(get、post、delete、put等)。

3)、params:

     指定request中必须包含某些参数值,才让该方法处理。

4)、headers:

     指定request中必须包含某些指定的请求头信息。

5)、consumes:

     指定处理请求的提交内容类型(Content-Type),例如application/json, text/html。

6)、produces:

     指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回。


3、@PathVariable

     用于将请求URL中的模板变量映射到功能处理方法的参数上,即取出uri模板中的变量作为参数。URL中{xxx}占位符可以通过@PathVariable("xxx")绑定到操作方法的入参中。

@RequestMapping("delete/{id}")public String delete(@PathVariable("id")String id){    userService.delete(id);    return "user";}

4、@RequestParam

  用于将请求参数区数据映射到功能处理方法的参数上  

@Target({ElementType.PARAMETER})@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface RequestParam {    @AliasFor("name")    String value() default "";    @AliasFor("value")    String name() default "";    boolean required() default true;    String defaultValue() default "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n";}
1)、value

   值为请求参数参数名

2)、required

   参数是否必须。默认为true,表示请求参数中必须包含对应的参数,若不存在,将抛出异常。

3)、default

   请求默认参数值。


4、@ResponseBody 

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

使用时机:返回的数据不是html标签的页面,而是其他某种格式的数据时(如json、xml等)使用;


5、@RequestBody

  常用来处理content-type不是默认的application/x-www-form-urlcoded编码的内容,比如说:application/json或者是application/xml等。一般情况下来说常用其来处理application/json类型。







原创粉丝点击