目录
(3) 既然String类型的返回值不能携带数据,那么在方法中是如何将数据带入视图页面的呢?
在Spring 2.5之前,只能使用实现 Controller接口的方式来开发一个控制器,上一章的入门案例就是使用的此种方式。在Spring 2.5之后,新增加了基于注解的控制器以及其他一些常用注解,这些注解的使用极大地减少了程序员的开发工作。接下来,本章将对Spring MVC中的常用核心类及其常用注解进行详细的讲解。
一、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>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc-config.xml</param-value>
</init-param>
<!--表示容器在启动时立即加载Servlet-->
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springmvc</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
在上述代码中,<load-on-startup>元素和<init-param>元素都是可选的。如果<init-param>元素存在并且通过其子元素配置了Spring MVC配置文件的路径,则应用程序在启动时会加载配置路径下的配置文件;如果没有通过<init-param>元素配置,则应用程序会默认去WEB-INF目录下寻找以servletName-servlet.xml方式命名的配置文件,这里的servletName指的springmvc
二、@Controller注解类型
org.springframework.stereotype.Controller注解类型用于指示Spring类的实例是一个控制器,其注解形式为@Controller。该注解在使用时不需要再实现Controller接口,只需要将@Controller注解加入到控制器类上,然后通过Spring的扫描机制找到标注了该注解的控制器即可。
@Controller注解在控制器类中的使用示例如下:
package com.itheima.controller;
import org.springframework.stereotype.Controller;
...
@Controller
public class FirstController{
...
}
为了保证Spring 能够找到控制器类,还需要在Spring MVC的配置文件中添加相应的扫描配置信息,具体如下。
(1)在配置文件的声明中引入spring-context。
(2)使用<context:component-scan>元素指定需要扫描的类包。
一个完整的配置文件示例如下:
<?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.itheima.controller" />
</beans>
在文件中,<context:component-scan>元素的属性 base-package 指定了需要扫描的类包为com.itheima.controller。在运行时,该类包及其子包下所有标注了注解的类都会被Spring 所处理。
与实现了Controller 接口的方式相比,使用注解的方式显然更加简单。同时,Controller 接口的实现类只能处理一个单一的请求动作,而基于注解的控制器可以同时处理多个请求动作,在使用上更加的灵活。因此,在实际开发中通常都会使用基于注解的形式。
注意:使用注解方式时,程序的运行需要依赖Spring的AOP包,因此需要向lib目录中添加spring-aop-4.3.6.RELEASE.jar,否则程序运行时会报错!
三、@RequestMapping注解类型
1、@RequestMapping 注解的使用
Spring通过@Controller注解找到相应的控制器类后,还需要知道控制器内部对每一个请求是如何处理的,这就需要使用@RequestMapping注解类型,它用于映射一个请求或一个方法。使用时,可以标注在一个方法或一个类上。
(1)标注在方法上
当标注在一个方法上时,该方法将成为一个请求处理方法,它会在程序接收到对应的 URL请求时被调用。使用@RequestMapping注解标注在方法上的示例如下。
package com.itheima.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
...
@Controller
public class FirstController{
@RequestMapping(value="/firstController")
public ModelAndView handleRequest(HttpServletRequest request,
HttpServletResponse response) {
...
return mav;
}
}
此时,可以通过地址:http://localhost:8080/chapter12/firstController访问该方法!
(2)标注在类上
当标注在一个类上时,该类中的所有方法都将映射为相对于类级别的请求,表示该控制器所处理的所有请求都被映射到value属性值所指定的路径下。使用@RequestMapping注解标注在类上的示例如下。
package com.itheima.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
...
@Controller
@RequestMapping(value="/hello")
public class FirstController{
@RequestMapping(value="/firstController")
public ModelAndView handleRequest(HttpServletRequest request,
HttpServletResponse response) {
...
return mav;
}
}
由于在类上添加了@RequestMapping注解,并且其value属性值为“/hello”,所以上述代码方法的请求路径将变为:http://localhost:8080/chapter12/hello/firstController。如果该类中还包含其他方法,那么在其他方法的请求路径中也需要加入“/hello”。
2、@RequestMapping注解的属性
@RequestMapping注解除了可以指定value属性外,还可以指定其他一些属性,如下表所示。
表中所有属性都是可选的,但其默认属性是value。当value是其唯一属性时,可以省略属性名。例如,下面两种标注的含义相同:
@RequestMapping(value="/firstController")
@RequestMapping("/firstController")
3、组合注解
Spring框架的4.3版本中,引入了新的组合注解,来帮助简化常用的HTTP方法的映射,并更好的表达被注解方法的语义。Spring的4.3版本中的组合注解及其描述如下所示:
- @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){
...
}
4、请求处理方法的参数和返回类型
(1)参数类型
在控制器类中,每一个请求处理方法都可以有多个不同类型的参数,以及一个多种类型的返回结果。在请求处理方法中,可以出现的参数类型如下:
- javax.servlet.ServletRequest / javax.servlet.http.HttpServletRequest
- javax.servlet.ServletResponse / javax.servlet.http.HttpServletResponse
- javax.servlet.http.HttpSession
- org.springframework.web.context.request.WebRequest或
- org.springframework.web.context.request.NativeWebRequest
- java.util.Locale
- java.util.TimeZone (Java 6+) / java.time.ZoneId (on Java 8)
- java.io.InputStream / java.io.Reader
- java.io.OutputStream / java.io.Writer
- org.springframework.http.HttpMethod
- java.security.Principal
- @PathVariable、@MatrixVariable、@RequestParam、@RequestHeader、@RequestBody、@RequestPart、@SessionAttribute、@RequestAttribute注解
- HttpEntity<?>
- java.util.Map / org.springframework.ui.Model /org.springframework.ui.ModelMap
- org.springframework.web.servlet.mvc.support.RedirectAttributes
- org.springframework.validation.Errors /org.springframework.validation.BindingResult
- org.springframework.web.bind.support.SessionStatus
- org.springframework.web.util.UriComponentsBuilder
(2)返回类型
请求处理方法的返回类型:
由于ModelAndView类型未能实现数据与视图之间的解耦,所以在企业开发时,方法的返回类型通常都会使用String。
(3) 既然String类型的返回值不能携带数据,那么在方法中是如何将数据带入视图页面的呢?
通过Model参数类型,即可添加需要在视图中显示的属性,其示例代码如下:
@RequestMapping(value="/firstController")
public String handleRequest(HttpServletRequest request,
HttpServletResponse response, Model model) {
model.addAttribute("msg", "这是我的第一个Spring MVC程序");
return "/WEB-INF/jsp/first.jsp";
}
String类型除了可以返回上述代码中的视图页面外,还可以进行重定向与请求转发
1.redirect 重定向。例如,在修改用户信息操作后,将请求重定向到用户查询方法的实现代码如下:
@RequestMapping(value="/update")
public String update(HttpServletRequest request,HttpServletResponse response, Model model){
...
return "redirect:queryUser";
}
2.forward 请求转发。例如,用户执行修改操作时,转发到用户修改页面的实现代码如下:
@RequestMapping(value="/toEdit")
public String update(HttpServletRequest request,HttpServletResponse response, Model model){
...
return "forward:editUser";
}
四、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”,在访问时视图解析器会自动的增加前缀和后缀。
五、基于注解的Spring MVC应用
1.搭建项目环境
创建Web项目,引入chapter11项目所有JAR包及文件,并添加Spring AOP所需的JAR包;
2.修改配置文件
在配置文件中添加注解扫描配置,并定义视图解析器;
<?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:aop="http://www.springframework.org/schema/aop"
xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
<--指定需要扫描的包-->
<context:component-scan base-package="com.itheima.controller"></context:component-scan>
<--定义视图解析器-->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<--设置前缀-->
<property name="prefix" value="/WEB-INF/jsp/"></property>
<--设置后缀-->
<property name="suffix" value=".jsp"></property>
</bean></beans>
3.修改Controller类
修改FirstController类,在类和方法上添加相应注解;
@Controller
@RequestMapping("/hello")
public class FirstController {@RequestMapping("/firstController")
public String handleRequest(HttpServletRequest request, HttpServletResponse response,Model model) throws Exception {
//向模型对象中添加数据
model.addAttribute("msg", "这是我的第一个springmvc程序!");
//返回视图页面
return "first";
}}
4.启动项目,测试应用
部署并启动项目,访问地址http://localhost:8080/chapter12/hello/firstController。