SpringMVC常用注解说明.docx
- 文档编号:7636391
- 上传时间:2023-01-25
- 格式:DOCX
- 页数:18
- 大小:28.19KB
SpringMVC常用注解说明.docx
《SpringMVC常用注解说明.docx》由会员分享,可在线阅读,更多相关《SpringMVC常用注解说明.docx(18页珍藏版)》请在冰豆网上搜索。
SpringMVC常用注解说明
SpringMVC常用注解:
1、@Controller
在SpringMVC 中,控制器Controller 负责处理由DispatcherServlet 分发的请求,它把用户请求的数据经过业务处理层处理之后封装成一个Model ,然后再把该Model 返回给对应的View 进行展示。
在SpringMVC 中提供了一个非常简便的定义Controller 的方法,你无需继承特定的类或实现特定的接口,只需使用@Controller 标记一个类是Controller ,然后使用@RequestMapping 和@RequestParam 等一些注解用以定义URL 请求和Controller 方法之间的映射,这样的Controller 就能被外界访问到。
此外Controller 不会直接依赖于HttpServletRequest 和HttpServletResponse 等HttpServlet 对象,它们可以通过Controller 的方法参数灵活的获取到。
@Controller 用于标记在一个类上,使用它标记的类就是一个SpringMVCController 对象。
分发处理器将会扫描使用了该注解的类的方法,并检测该方法是否使用了@RequestMapping 注解。
@Controller 只是定义了一个控制器类,而使用@RequestMapping 注解的方法才是真正处理请求的处理器。
单单使用@Controller 标记在一个类上还不能真正意义上的说它就是SpringMVC 的一个控制器类,因为这个时候Spring 还不认识它。
那么要如何做Spring 才能认识它呢?
这个时候就需要我们把这个控制器类交给Spring 来管理。
有两种方式:
(1)在SpringMVC 的配置文件中定义MyController 的bean 对象。
(2)在SpringMVC 的配置文件中告诉Spring 该到哪里去找标记为@Controller 的Controller 控制器。
--方式一-->
--方式二-->
component-scanbase-package="com.host.app.web"/>//路径写到controller的上一层(扫描包详解见下面浅析) 2、@RequestMapping RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。 用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。 RequestMapping注解有六个属性,下面我们把她分成三类进行说明(下面有相应示例)。 1、value,method; value: 指定请求的实际地址,指定的地址可以是URITemplate模式(后面将会说明); 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值,才能让该方法处理请求。 3、@Resource和@Autowired @Resource和@Autowired都是做bean的注入时使用,其实@Resource并不是Spring的注解,它的包是javax.annotation.Resource,需要导入,但是Spring支持该注解的注入。 1、共同点 两者都可以写在字段和setter方法上。 两者如果都写在字段上,那么就不需要再写setter方法。 2、不同点 (1)@Autowired @Autowired为Spring提供的注解,需要导入包org.springframework.beans.factory.annotation.Autowired;只按照byType注入。 publicclassTestServiceImpl{ //下面两种@Autowired只要使用一种即可 @Autowired privateUserDaouserDao;//用于字段上 @Autowired publicvoidsetUserDao(UserDaouserDao){//用于属性的方法上 this.userDao=userDao; } } @Autowired注解是按照类型(byType)装配依赖对象,默认情况下它要求依赖对象必须存在,如果允许null值,可以设置它的required属性为false。 如果我们想使用按照名称(byName)来装配,可以结合@Qualifier注解一起使用。 如下: publicclassTestServiceImpl{ @Autowired @Qualifier("userDao") privateUserDaouserDao; } (2)@Resource @Resource默认按照ByName自动注入,由J2EE提供,需要导入包javax.annotation.Resource。 @Resource有两个重要的属性: name和type,而Spring将@Resource注解的name属性解析为bean的名字,而type属性则解析为bean的类型。 所以,如果使用name属性,则使用byName的自动注入策略,而使用type属性时则使用byType自动注入策略。 如果既不制定name也不制定type属性,这时将通过反射机制使用byName自动注入策略。 publicclassTestServiceImpl{ //下面两种@Resource只要使用一种即可 @Resource(name="userDao") privateUserDaouserDao;//用于字段上 @Resource(name="userDao") publicvoidsetUserDao(UserDaouserDao){//用于属性的setter方法上 this.userDao=userDao; } } 注: 最好是将@Resource放在setter方法上,因为这样更符合面向对象的思想,通过set、get去操作属性,而不是直接去操作属性。 @Resource装配顺序: ①如果同时指定了name和type,则从Spring上下文中找到唯一匹配的bean进行装配,找不到则抛出异常。 ②如果指定了name,则从上下文中查找名称(id)匹配的bean进行装配,找不到则抛出异常。 ③如果指定了type,则从上下文中找到类似匹配的唯一bean进行装配,找不到或是找到多个,都会抛出异常。 ④如果既没有指定name,又没有指定type,则自动按照byName方式进行装配;如果没有匹配,则回退为一个原始类型进行匹配,如果匹配则自动装配。 @Resource的作用相当于@Autowired,只不过@Autowired按照byType自动注入。 4、@ModelAttribute和 @SessionAttributes 代表的是: 该Controller的所有方法在调用前,先执行此@ModelAttribute方法,可用于注解和方法参数中,可以把这个@ModelAttribute特性,应用在BaseController当中,所有的Controller继承BaseController,即可实现在调用Controller时,先执行@ModelAttribute方法。 @SessionAttributes即将值放到session作用域中,写在class上面。 具体示例参见下面: 使用 @ModelAttribute 和 @SessionAttributes 传递和保存数据 5、@PathVariable 用于将请求URL中的模板变量映射到功能处理方法的参数上,即取出uri模板中的变量作为参数。 如: @Controller publicclassTestController{ @RequestMapping(value="/user/{userId}/roles/{roleId}",method=RequestMethod.GET) publicStringgetLogin(@PathVariable("userId")StringuserId, @PathVariable("roleId")StringroleId){ System.out.println("UserId: "+userId); System.out.println("RoleId: "+roleId); return"hello"; } @RequestMapping(value="/product/{productId}",method=RequestMethod.GET) publicStringgetProduct(@PathVariable("productId")StringproductId){ System.out.println("ProductId: "+productId); return"hello"; } @RequestMapping(value="/javabeat/{regexp1: [a-z-]+}", method=RequestMethod.GET) publicStringgetRegExp(@PathVariable("regexp1")Stringregexp1){ System.out.println("URIPart1: "+regexp1); return"hello"; } } 6、@requestParam @requestParam主要用于在SpringMVC后台控制层获取参数,类似一种是request.getParameter("name"),它有三个常用参数: defaultValue="0",required=false,value="isApp";defaultValue表示设置默认值,required铜过boolean设置是否是必须要传入的参数,value值表示接受的传入的参数类型。 7、@ResponseBody 作用: 该注解用于将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式后,写入到Response对象的body数据区。 使用时机: 返回的数据不是html标签的页面,而是其他某种格式的数据时(如json、xml等)使用; 8、@Component 相当于通用的注解,当不知道一些类归到哪个层时使用,但是不建议。 9、@Repository 用于注解dao层,在daoImpl类上面注解。 注: 1、使用 @RequestMapping 来映射 Request 请求与处理器 方式一、通过常见的类路径和方法路径结合访问controller方法 方式二、使用uri模板 @Controller @RequestMapping("/test/{variable1}") publicclassMyController{ @RequestMapping("/showView/{variable2}") publicModelAndViewshowView(@PathVariableStringvariable1,@PathVariable("variable2")intvariable2){ ModelAndViewmodelAndView=newModelAndView(); modelAndView.setViewName("viewName"); modelAndView.addObject("需要放到model中的属性名称","对应的属性值,它是一个对象"); returnmodelAndView; } } URI 模板就是在URI 中给定一个变量,然后在映射的时候动态的给该变量赋值。 如URI 模板http: //localhost/app/{variable1}/index.html ,这个模板里面包含一个变量variable1 ,那么当我们请求http: //localhost/app/hello/index.html 的时候,该URL 就跟模板相匹配,只是把模板中的variable1 用hello 来取代。 这个变量在SpringMVC 中是使用@PathVariable 来标记的。 在SpringMVC 中,我们可以使用@PathVariable 来标记一个Controller 的处理方法参数,表示该参数的值将使用URI 模板中对应的变量的值来赋值。 代码中我们定义了两个URI 变量,一个是控制器类上的variable1 ,一个是showView 方法上的variable2 ,然后在showView 方法的参数里面使用@PathVariable 标记使用了这两个变量。 所以当我们使用/test/hello/showView/2.do 来请求的时候就可以访问到MyController 的showView 方法,这个时候variable1 就被赋予值hello ,variable2 就被赋予值2 ,然后我们在showView 方法参数里面标注了参数variable1 和variable2 是来自访问路径的path 变量,这样方法参数variable1 和variable2 就被分别赋予hello 和2 。 方法参数variable1 是定义为String 类型,variable2 是定义为int 类型,像这种简单类型在进行赋值的时候Spring 是会帮我们自动转换的。 在上面的代码中我们可以看到在标记variable1 为path 变量的时候我们使用的是@PathVariable ,而在标记variable2 的时候使用的是@PathVariable(“variable2”) 。 这两者有什么区别呢? 第一种情况就默认去URI 模板中找跟参数名相同的变量,但是这种情况只有在使用debug 模式进行编译的时候才可以,而第二种情况是明确规定使用的就是URI 模板中的variable2 变量。 当不是使用debug 模式进行编译,或者是所需要使用的变量名跟参数名不相同的时候,就要使用第二种方式明确指出使用的是URI 模板中的哪个变量。 除了在请求路径中使用URI 模板,定义变量之外,@RequestMapping 中还支持通配符“* ”。 如下面的代码我就可以使用/myTest/whatever/wildcard.do 访问到Controller 的testWildcard 方法。 如: @Controller @RequestMapping("/myTest") publicclassMyController{ @RequestMapping("*/wildcard") publicStringtestWildcard(){ System.out.println("wildcard------------"); return"wildcard"; } } 当@RequestParam中没有指定参数名称时,Spring 在代码是debug 编译的情况下会默认取更方法参数同名的参数,如果不是debug 编译的就会报错。 2、使用 @RequestMapping 的一些高级用法 (1)params属性 @RequestMapping(value="testParams",params={"param1=value1","param2","! param3"}) publicStringtestParams(){ System.out.println("testParams..........."); return"testParams"; } 用@RequestMapping 的params 属性指定了三个参数,这些参数都是针对请求参数而言的,它们分别表示参数param1 的值必须等于value1 ,参数param2 必须存在,值无所谓,参数param3 必须不存在,只有当请求/testParams.do 并且满足指定的三个参数条件的时候才能访问到该方法。 所以当请求/testParams.do? param1=value1¶m2=value2 的时候能够正确访问到该testParams 方法,当请求/testParams.do? param1=value1¶m2=value2¶m3=value3 的时候就不能够正常的访问到该方法,因为在@RequestMapping 的params 参数里面指定了参数param3 是不能存在的。 (2)method属性 @RequestMapping(value="testMethod",method={RequestMethod.GET,RequestMethod.DELETE}) publicStringtestMethod(){ return"method"; } 在上面的代码中就使用method 参数限制了以GET 或DELETE 方法请求/testMethod的时候才能访问到该Controller 的testMethod 方法。 (3)headers属性 @RequestMapping(value="testHeaders",headers={"host=localhost","Accept"}) publicStringtestHeaders(){ return"headers"; } headers 属性的用法和功能与params 属性相似。 在上面的代码中当请求/testHeaders.do 的时候只有当请求头包含Accept 信息,且请求的host 为localhost 的时候才能正确的访问到testHeaders 方法。 3、@RequestMapping 标记的处理器方法支持的方法参数和返回类型 1. 支持的方法参数类型 (1 )HttpServlet 对象,主要包括HttpServletRequest 、HttpServletResponse 和HttpSession 对象。 这些参数Spring 在调用处理器方法的时候会自动给它们赋值,所以当在处理器方法中需要使用到这些对象的时候,可以直接在方法上给定一个方法参数的申明,然后在方法体里面直接用就可以了。 但是有一点需要注意的是在使用HttpSession 对象的时候,如果此时HttpSession 对象还没有建立起来的话就会有问题。 (2 )Spring 自己的WebRequest 对象。 使用该对象可以访问到存放在HttpServletRequest 和HttpSession 中的属性值。 (3 )InputStream 、OutputStream 、Reader 和Writer 。 InputStream 和Reader 是针对HttpServletRequest 而言的,可以从里面取数据;OutputStream 和Writer 是针对HttpServletResponse 而言的,可以往里面写数据。 (4 )使用@PathVariable 、@RequestParam 、@CookieValue 和@RequestHeader 标记的参数。 (5 )使用@ModelAttribute 标记的参数。 (6 )java.util.Map 、Spring 封装的Model 和ModelMap 。 这些都可以用来封装模型数据,用来给视图做展示。 (7 )实体类。 可以用来接收上传的参数。 (8 )Spring 封装的MultipartFile 。 用来接收上传文件的。 (9 )Spring 封装的Errors 和BindingResult 对象。 这两个对象参数必须紧接在需要验证的实体对象参数之后,它里面包含了实体对象的验证结果。 2. 支持的返回类型 (1 )一个包含模型和视图的ModelAndView 对象。 (2 )一个模型对象,这主要包括Spring 封装好的Model 和ModelMap ,以及java.util.Map ,当没有视图返回的时候视图名称将由RequestToViewNameTranslator 来决定。 (3 )一个View 对象。 这个时候如果在渲染视图的过程中模型的话就可以给处理器方法定义一个模型参数,然后在方法体里面往模型中添加值。 (4 )一个String 字符串。 这往往代表的是一个视图名称。 这个时候如果需要在渲染视图的过程中需要模型的话就可以给处理器方法一个模型参数,然后在方法体里面往模型中添加值就可以了。 (5 )返回值是void 。 这种情况一般是我们直接把返回结果写到HttpServletResponse 中了,如果没有写的话,那么Spring 将会利用RequestToViewNameTranslator 来返回一个对应的视图名称。 如果视图中需要模型的话,处理方法与返回字符串的情况相同。 (6 )如果处理器方法被注解@ResponseBody 标记的话,那么处理器方法的任何返回类型都会通过HttpMessageConverters 转换之后写到HttpServletResponse 中,而不会像上面的那些情况一样当做视图或者模型来处理。 (7 )除以上几种情况之外的其他任何返回类型都会被当做模型中的一个属性来处理,而返回的视图还是由RequestToViewNameTranslator 来决定,添加到模型中的属性名称可以在该方法上用@ModelAttribute(“attributeName”) 来定义,否则将使用返回类型的类名称的首字母小写形式来表示。 使用@ModelAttribute 标记的方法会在@RequestMapping 标记的方法执行之前执行。 4、使用 @ModelAttribute 和 @SessionAttributes 传递和保存数据 SpringMVC 支持使用 @ModelAttribute 和 @SessionAttributes 在不同的模型(model)和控制器之间共享数据。 @ModelAttribute 主要有两种使用方式,一种是标注在方法上,一种是标注在 Controller 方法参数上。 当 @ModelAttribute 标记在方法上的时候,该方法将在处理器方法执行之前执行,然后把返回的对象存放在 session 或模型属性中,属性名称可以使用 @ModelAttribute(“at
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- SpringMVC 常用 注解 说明
![提示](https://static.bdocx.com/images/bang_tan.gif)