在前文 第一个 Spring MVC程序 :是使用实现Controller接口的方式来开发一个控制器。在Spring 2.5 之后,新增加了基于注解的控制器以及其他一些常用注解。
1.DispatcherServlet
DispatcherServlet的全名是org.springframework.web.servlet.DispatcherServlet,它在程序中充当着前端控制器的角色。在使用时,只需将其配置在项目的web.xml文件中,其配置代码如下:
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>
org.springframework.web.servlet.DispatcherServlet
</servlet-class>
<!-- 如果<init-param>元素存在并且通过其子元素配置了Spring MVC配置文件的路径,
则应用程序在启动时会加载配置路径下的配置文件,可选配置。
-->
<!--
如果没有通过<init-param>元素配置,
则应用程序会默认去WEB-INF目录下寻找以servletName-servlet.xml方式命名的配置文件,
这里的servletName指下面的springmvc
-->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc-config.xml</param-value>
</init-param>
<!--load-on-startup设置为1 ,则在应用程序启动时会立即加载该Servlet;-->
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springmvc</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
2.@Controller注解类型
org.springframework.stereotype.Controller注解类型用于指示Spring类的实例是一个控制器,其注解形式为@Controller。该注解在使用时不需要再实现Controller接口,只需要将@Controller注解加入到控制器类上,然后通过Spring的扫描机制找到标注了该注解的控制器即可。
为了保证 Spring 能够找到控制器类,还需要在 Spring MVC 的配置文件中添加相应的扫描配置信息,
( 1 )在配置文件的声明中引入 spring-context
( 2 )使用 < context: com ponent -scan >元素指定需要扫描的类包
< context: component -scan> 元素的属性 base-package 指定了需要扫描的类包为 com.lzq.controller 在运行时,该类包及其子包下所有标注了注解的类都会被 Spring 所处理与实现了 Controller 接口的方式相比,使用注解的方式显然更加简单 同时,Controller
接口的实现类只能处理一个单一的请求动作,而基于注解的控制器可以同时处理多个请求动作,在使用上更加的灵活 因此,在实际开发中通常都会使用基于注解的形式。在使用注解的时候需要使用到aop包,所以要将aop包进行导入:
3. @RequestMapping注解类型
Spring通过@Controller注解找到相应的控制器类后,还需要知道控制器内部对每一个请求是如何处理的,这就需要使用@RequestMapping注解类型,它用于映射一个请求或一个方法。使用时,可以标注在一个方法或一个类上。
标注在方法上
当标注在一个方法上时 该方法将成为 个请求处理方法,它会在程序接收到对应的 URL
请求时被调用。
@RequestMapping(value="/firstController")
使用RequestMapping注解后,上述代码中的标记的方法就可以通过地址http://localhost:8080/项目名/firstController
进行访问。
标注在类上
当标注在一个类上时,该类中的所有方法都将映射为相对于类级别的请求 表示该控制器所
处理的所有请求都被映射到value属性值所指定的路径下。
@RequestMapping(value="/hello")
由于在类上添加了RequestMapping注解, 并且其value属性值为 “/hello” ,所以上述代码方法的请求路径将变为http://localhost:8080/项目名/hello/firstController
如果该类中还包含其他方法,那么在其方法请求路径中也需要加入 “/hello”。
RequestMapping注解的属性
@RequestMapping注解除了可以指定 value 属性外,还可以指定其他一些属性,这些属性如下所示:
所有属性都是可选的,但其默认属性是 value, value 是其唯一属性肘,可以省略属性名,例如下面两种标注的含义相同:
@RequestMapping(value="/firstController")
@RequestMapping("/firstController")
组合注解
Spring框架的4.3版本中,引入了新的组合注解,来帮助简化常用的HTTP方法的映射,并更好的表达被注解方法的语义。
- @GetMapping:匹配GET方式的请求;
- @PostMapping:匹配POST方式的请求;
- @PutMapping:匹配PUT方式的请求;
- @DeleteMapping:匹配DELETE方式的请求;
- @PatchMapping:匹配PATCH方式的请求。
以 @GetMapping为例,该组合注解是@RequestMapping(method=RequestMethod.GET)的缩写,它会将HTTP GET映射到特定的处理方法上。在实际开发中,传统@RequestMapping注解使用方式如下。
@RequestMapping(value="/user/{id}",method=RequestMethod.GET)
public String selectUserById(String id){
...
}
使用@GetMapping注解后的简化代码如下:
@GetMapping(value="/user/{id}")
public String selectUserById(String id){
...
}
请求处理万法的参擞类型相返回类型
在控制器类中,每一个请求处理方法都可以有多个不同类型的参数,以及一个多种类型的返回结果。例如在入门案例中,handleRequest()方法的参数就是对应请求的HttpServletRequest和HttpServletResponse两种参数类型。除此之外,还可以使用其他的参数类型,例如在请求处理方法中需要访问HttpSession对象,则可以添加HttpSession作为参数,Spring 会将对象正确地传递给方法。
4. ViewResolver 视图解析器
Spring MVC中的视图解析器负责解析视图。可以通过在配置文件中定义一个ViewResolver来配置视图解析器,其配置示例如下:
<!-- 定义视图解析器 -->
<bean id="viewResolver" class=
"org.springframework.web.servlet.view.InternalResourceViewResolver">
<!-- 设置前缀 -->
<property name="prefix" value="/WEB-INF/jsp/" />
<!-- 设置后缀 -->
<property name="suffix" value=".jsp" />
</bean>
在上述代码中,定义了一个视图解析器,并设置了视图的前缀和后缀属性。这样设置后,方法中所定义的view路径将可以简化。例如,在前文的逻辑视图名只需设置为“first”,而不再需要设置为“/WEB-INF/jsp/first.jsp”,在访问时视图解析器会自动的增加前缀和后缀。
5. 注释实现Spring MVC 程序
1. 创建项目,导入jar包
创建一个web项目,导入jar包,在先前的基础上添加相对应版本的aop包。
2. 修改配置文件
在原先的基础上进行修改配置文件spring-config.xml 添加注解扫描配置,并定义视图解析器,代码如下:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.3.xsd">
<!-- 指定需要扫描的包 -->
<context:component-scan base-package="com.lzq.controller" />
<!-- 定义视图解析器 -->
<bean id="viewResolver" class=
"org.springframework.web.servlet.view.InternalResourceViewResolver">
<!-- 设置前缀 -->
<property name="prefix" value="/WEB-INF/jsp/" />
<!-- 设置后缀 -->
<property name="suffix" value=".jsp" />
</bean>
</beans>
3. 修改Conyroller类
修改 FirstController 类,在类和方法上添加相应注解,代码如下:
package com.lzq.controller;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping(value = "/hello")
public class FirstController {
@RequestMapping(value = "/firstController")
public String handleRequest(HttpServletRequest request,
HttpServletResponse response, Model model)throws Exception {
model.addAttribute("msg", "mvc注释");
return "first";
}
}
使用了 @Controller 注解来标注控制器类,并使用了 @RequestMapping 注解标注在类名和方法名上来映射请求方法。在项目启动时,Spring 就会扫描到此类,以及此类中标注了@RequestMapping注解的方法。由于标注在类上的 @RequestMapping 注解的 value 值为“hello",因此类中所有请求方法的路径都需要加上"/hello"。由于类中 handlerRequest()
方法的返回类型为String,而String 类型的返回值又无法携带数据,所以需要通过参数Model 对象的 addAttribute() 方法来添加数据信息。因为在配置文件的视图解析器中定义了视图文件的前缀和后缀名,所以handleRequest()方法只需返回视图名"first" 即可,在访问此方法时,系统会自动访问 “WEB-INF/jsp/" 路径下名称为 first 的 jsp文件。
4. 启动项目,测试
运行这个项目在浏览器当中打开网址 http://localhost:8080/AnnotationMVC/hello/firstController