SpringMVC-常用注解

30次阅读

共计 7565 个字符,预计需要花费 19 分钟才能阅读完成。

@Controller

在 SpringMVC 中,控制器 Controller 负责处理由 DispatcherServlet 分发的请求,它把用户请求的数据经过业务处理层处理之后封装成一个 Model,然后再把该 Model 返回给对应的 View 进行展示。在 SpringMVC 中提供了一个非常简便的定义 Controller 的方法,无需继承特定的类或实现特定的接口,只需使用 @Controller 标记一个类是 Controller,然后使用 @RequestMapping 和 @RequestParam 等一些注解用以定义 URL 请求和 Controller 方法之间的映射,这样的 Controller 就能被外界访问到。此外 Controller 不会直接依赖于 HttpServletRequest 和 HttpServletResponse 等 HttpServlet 对象,它们可以通过 Controller 的方法参数灵活的获取到。

@Controller 用于标记在一个类上,使用它标记的类就是一个 SpringMVC Controller 对象。分发处理器将会扫描使用了该注解的类的方法,并检测该方法是否使用了 @RequestMapping 注解。@Controller 只是定义了一个控制器类,而使用 @RequestMapping 注解的方法才是真正处理请求的处理器。单单使用 @Controller 标记在一个类上还不能真正意义上的说它就是 SpringMVC 的一个控制器类,因为这个时候 Spring 还不认识它。那么要如何做 Spring 才能认识它呢?这个时候就需要把这个控制器类交给 Spring 来管理。有两种方式:

在 SpringMVC 的配置文件中定义 MyController 的 bean 对象。
在 SpringMVC 的配置文件中告诉 Spring 该到哪里去找标记为 @Controller 的 Controller 控制器。

<bean class=”com.host.app.web.controller.MyController”/>

< context:component-scan base-package = “com.host.app.web” />

@RestController

相当于 @Controller+@ResponseBody 两个注解的结合,返回 json 数据不需要在方法前面加 @ResponseBody 注解了,使用 @RestController 这个注解,就不能返回 jsp,html 页面,视图解析器无法解析 jsp,html 页面

@RequestMapping

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

RequestMapping 注解有六个属性,下面分成三类进行说明

1、value,method;

value:指定请求的实际地址,指定的地址可以是 URI Template 模式;

method:指定请求的 method 类型,GET、POST、PUT、DELETE 等;

2、consumes,produces

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

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

3、params,headers

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

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

@Resource 和 @Autowired

@Resource 和 @Autowired 都是注入时使用,@Resource 并不是 Spring 的注解,需要导入 javax.annotation.Resource,Spring 支持该注解的注入。

@Autowired

@Autowired 为 Spring 提供的注解,需要导入 org.springframework.beans.factory.annotation.Autowired; 只按照 byType 注入。@Autowired 注解是按照类型(byType)装配依赖对象,默认情况下它要求依赖对象必须存在,如果允许 null 值,可以设置它的 required 属性为 false。如果想使用按照名称(byName)来装配,可以结合 @Qualifier 注解一起使用。

如 @Autowired @Qualifier(“userDao”) private UserDao userDao;

@Resource

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

@Resource(name=”userDao”) private UserDao userDao;

@Resource 装配顺序:

如果同时指定了 name 和 type,则从 Spring 上下文中找到唯一匹配的 bean 进行装配,找不到则抛出异常。

如果指定了 name,则从上下文中查找名称(id)匹配的 bean 进行装配,找不到则抛出异常。

如果指定了 type,则从上下文中找到匹配的唯一 bean 进行装配,找不到或是找到多个,都会抛出异常。

如果既没有指定 name,又没有指定 type,则自动按照 byName 方式进行装配;如果没有匹配,则回退为一个原始类型进行匹配,如果匹配则自动装配。

@Resource 的作用相当于 @Autowired,只不过 @Autowired 按照 byType 自动注入。

@ModelAttribute 和 @SessionAttributes

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

@SessionAttributes 即将值放到 session 作用域中,写在 class 上面。

@PathVariable

用于将请求 URL 中的模板变量映射到功能处理方法的参数上,即取出 uri 模板中的变量作为参数。如:@RequestMapping(value=”/user/{userId}/roles/{roleId}”,method = RequestMethod.GET)public String login(@PathVariable(“userId”) String userId, @PathVariable(“roleId”) String roleId){}

@requestParam

@requestParam 主要用于在 SpringMVC 后台控制层获取参数,类似一种是 request.getParameter(“name”),它有三个常用参数:defaultValue = “0”, required = false, value = “isApp”;defaultValue 表示设置默认值,required 铜过 boolean 设置是否是必须要传入的参数,value 值表示接受的传入的参数类型。

@ResponseBody

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

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

@Component

相当于通用的注解,当不知道一些类归到哪个层时使用,但是不建议。

@Repository

用于注解 dao 层,在 daoImpl 类上面注解。

@RequestMapping 的一些高级用法

params 属性
@RequestMapping (value= “/testParams” , params={ “param1=value1” , “param2” , “!param3”})public String testParams() {}

params 属性指定了三个参数,这些参数都是针对请求参数而言的,分别表示参数 param1 的值必须等于 value1,参数 param2 必须存在,参数 param3 必须不存在,只有当请求 /testParams.do 并且满足指定的三个参数条件的时候才能访问到该方法。

headers 属性
@RequestMapping (value= “testHeaders” , headers={ “host=localhost” , “Accept”})public String testHeaders() {}

headers 属性的用法和功能与 params 属性相似。在上面的代码中当请求 /testHeaders.do 的时候只有当请求头包含 Accept 信息,且请求的 host 为 localhost 的时候才能正确的访问到 testHeaders 方法。

@RequestMapping 标记的处理器方法支持的方法参数和返回类型

支持的方法参数类型

HttpServlet 对象

主要包括 HttpServletRequest、HttpServletResponse 和 HttpSession 对象。** 这些参数 Spring 在调用处理器方法的时候会自动给它们赋值,所以当在处理器方法中需要使用到这些对象的时候,可以直接在方法上给定一个方法参数的申明,然后在方法体里面直接用就可以了。但是有一点需要注意的是在使用 HttpSession 对象的时候,如果此时 HttpSession 对象还没有建立起来的话就会有问题。

Spring 自己的 WebRequest 对象

使用该对象可以访问到存放在 HttpServletRequest 和 HttpSession 中的属性值。

InputStream、OutputStream、Reader 和 Writer

InputStream 和 Reader 是针对 HttpServletRequest 而言的,可以从里面取数据;OutputStream 和 Writer 是针对 HttpServletResponse 而言的,可以往里面写数据。

@PathVariable、@RequestParam、@CookieValue 和 @RequestHeader 标记的参数
使用 @ModelAttribute 标记的参数
java.util.Map、Spring 封装的 Model 和 ModelMap 

这些都可以用来封装模型数据,用来给视图做展示。

实体类

可以用来接收上传的参数。

Spring 封装的 MultipartFile 

用来接收上传文件的。

Spring 封装的 Errors 和 BindingResult 对象

这两个对象参数必须紧接在需要验证的实体对象参数之后,它里面包含了实体对象的验证结果。

支持的返回类型

一个包含模型和视图的 ModelAndView 对象
一个模型对象

这主要包括 Spring 封装好的 Model 和 ModelMap,以及 java.util.Map,当没有视图返回的时候视图名称将由 RequestToViewNameTranslator 来决定。

一个 View 对象

这个时候如果在渲染视图的过程中模型的话就可以给处理器方法定义一个模型参数,然后在方法体里面往模型中添加值。

一个 String 字符串

这往往代表的是一个视图名称。这个时候如果需要在渲染视图的过程中需要模型的话就可以给处理器方法一个模型参数,然后在方法体里面往模型中添加值就可以了。

返回值是 void 

这种情况一般是我们直接把返回结果写到 HttpServletResponse 中了,如果没有写的话,那么 Spring 将会利用 RequestToViewNameTranslator 来返回一个对应的视图名称。如果视图中需要模型的话,处理方法与返回字符串的情况相同。

@ResponseBody

如果处理器方法被注解 @ResponseBody 标记的话,那么处理器方法的任何返回类型都会通过 HttpMessageConverters 转换之后写到 HttpServletResponse 中,而不会像上面的那些情况一样当做视图或者模型来处理。

上述之外

除以上几种情况之外的其他任何返回类型都会被当做模型中的一个属性来处理,而返回的视图还是由 RequestToViewNameTranslator 来决定,添加到模型中的属性名称可以在该方法上用 @ModelAttribute(“attributeName”) 来定义,否则将使用返回类型的类名称的首字母小写形式来表示。使用 @ModelAttribute 标记的方法会在 @RequestMapping 标记的方法执行之前执行。

@ModelAttribute 和 @SessionAttributes 传递和保存数据

SpringMVC 支持使用 @ModelAttribute 和 @SessionAttributes 在不同的模型(model)和控制器之间共享数据。@ModelAttribute 主要有两种使用方式,一种是标注在方法上,一种是标注在 Controller 方法参数上。

当 @ModelAttribute 标记在方法上的时候,该方法将在处理器方法执行之前执行,然后把返回的对象存放在 session 或模型属性中,属性名称可以使用 @ModelAttribute(“attributeName”) 在标记方法的时候指定,若未指定,则使用返回类型的类名称(首字母小写)作为属性名称。关于 @ModelAttribute 标记在方法上时对应的属性是存放在 session 中还是存放在模型中。
@Controller
@RequestMapping (“/myTest”)public class MyController {
    @ModelAttribute (“hello”) public String getModel() { return “world” ;}

    @ModelAttribute (“intValue”) public int getInteger() { return 10;}

@ModelAttribute (“user”) public User getUser(){ return new User( “user”); }

@RequestMapping (“sayHello”) public void sayHello(
        @ModelAttribute (“hello”) String hello,
        @ModelAttribute (“intValue”) int num,
        @ModelAttribute (“user”) User user, Writer writer, HttpSession session) throws IOException {
             writer.write(“Hello ” + hello + ” , Hello ” + user.getUsername() + num);}
}

当请求 /myTest/sayHello.do 的时候使用 @ModelAttribute 标记的方法会先执行,然后把它们返回的对象存放到模型中。最终访问到 sayHello 方法的时候,使用 @ModelAttribute 标记的方法参数都能被正确的注入值。执行结果如下所示:

Hello world,Hello user10

@SessionAttributes 同理,但是第一次调用时参数还没有加到 session 中,所以 session 中不会有任何属性,等处理器方法执行完成后 Spring 才会把模型中对应的属性添加到 session 中。

@RequestHeader、@CookieValue

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

header:

Host                             localhost:8080

Accept                         text/html,application/xhtml+xml,application/xml;q=0.9

Accept-Language        fr,en-gb;q=0.7,en;q=0.3

Accept-Encoding         gzip,deflate

Accept-Charset            ISO-8859-1,utf-8;q=0.7,*;q=0.7

Keep-Alive                   300

@RequestMapping(“/displayHeaderInfo.do”)

public void displayHeaderInfo(
    @RequestHeader(“Accept-Encoding”) String encoding,

@RequestHeader(“Keep-Alive”) long keepAlive)  {}

上面的代码,把 request header 部分的 Accept-Encoding 的值,绑定到参数 encoding 上了,Keep-Alive header 的值绑定到参数 keepAlive 上。

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

Cookie:JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84

@RequestMapping(“/displayHeaderInfo.do”)
public void displayHeaderInfo(@CookieValue(“JSESSIONID”) String cookie) {}

即把 JSESSIONID 的值绑定到参数 cookie 上。

@RequestBody

@RequestBody 注解将 HTTP 请求正文插入方法中,使用适合的 HttpMessageConverter 将请求体写入某个对象。

正文完
 0