1、Spring MVC的请求流程
在请求离开浏览器时,会带有用户所请求内容的信息,至少会包含请求的URL,但是还可能带有其他信息。
- 请求的第一站是前端控制器DispatcherServlet。SpringMVC所有的请求都会通过这个前端控制器,前端控制器是常用的Web应用程序模式,在这里是一个单实例的Servlet将请求委托给应用程序的其他组件来执行实际的处理。
- DispatcherServlet的任务是将请求转发给控制器(Controller)。为了达到此目的,DispatcherServlet需要查询一个或多个处理器映射器(handler mapping)来确定请求所需要的控制器是哪一个(因为控制器会有很多),处理器映射器会根据请求所携带的URL信息进行决策。
- 一旦选择了合适的控制器,DispatcherServlet会将请求发送给选中的控制器。到了控制器,请求会卸下其负载(用户 提交的信息)并耐心等待控制器处理这些信息。
- 控制器在完成逻辑处理后,通常会产生一些信息,这些信息需要返回给用户并在浏览器上显示。这些信息被称为模型(model)。不过,仅仅给用户返回原始的信息是不够的——这些信息需要以用户友好的方式进行格式化,一般会是HTML。所以,信息需要发送给一个视图(view),通常是JSP。
- 控制器做的最后一件事就是将模型数据打包,并且标识出用于渲染输出的视图名。然后发送回DispatcherServlet。
- 而返回给DispatcherServlet的视图名并不直接表示某个特定的JSP,可能并不是JSP。相反,它仅仅传递的是一个逻辑名称,这个名称用来查找产生结果的真正视图。这就需要使用视图解析器对逻辑视图名进行解析。
- 解析完之后就会找到相关视图对数据进行渲染,在这里交付模型数据,之后对用户响应。
2、配置DispatcherServlet
按照传统方式,像DispatcherServlet这样的Servlet会配置在web.xml文件中。但是借助Servlet3.1和Spring3.1的功能增强,这里使用Java将DispatcherServlet配置在Servlet容器中。
package spittr.config; import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer; import spittr.web.WebConfig; public class SpitterWebInitializer extends AbstractAnnotationConfigDispatcherServletInitializer { @Override protected Class<?>[] getRootConfigClasses() { return new Class<?>[] { RootConfig.class }; } @Override protected Class<?>[] getServletConfigClasses() { return new Class<?>[] { WebConfig.class }; } @Override protected String[] getServletMappings() { return new String[] { "/" }; } }
这里我们创建的应用的名称为Spittr。要理解上述代码是如何工作的,可能只需要知道扩展AbstractAnnotationConfigDispatcherServletInitializer的任意类都会自动地配置DispatcherServlet和Spring应用上下文,Spring的应用上下文位于应用程序的Servlet上下文之中。
AbstractAnnotationConfigDispatcherServletInitializer剖析: 在Servlet3.0环境中,容器会在类路径中查找实现了javax.servlet.ServletContainerInitializer接口的类,如果能发现的话,就用它来配置Servlet容器。Spring提供了这个接口的实现,名为SpringServletContainerInitializer,这个类反过来会查找WebApplicationInitializer的类并将配置的任务交给它们来完成。Spring3.2引入了一个便利的WebApplicationInitializer基础实现,即AbstractAnnotationConfigDispatcherServletInitializer。因为我们的SpitterWebInitializer扩展了AbstractAnnotationConfigDispatcherServletInitializer(同时也就实现了WebApplicationInitializer),因此部署到Servlet3.0容器中的时候,容器会自动发现它,并用它来配置Servlet上下文。
这里的第一个方法getServletMappings(),它会将一个或多个路径映射到DispatcherServlet上。本例中,它映射的是“/”,这表示它会是应用的默认Servlet。会处理进入应用的所有请求。其他两个方法在后面说明。 注意:这里使用的是Java方式,和web.xml方式不同在于,应用启动时,容器会在类路径下查找ServletContainerInitializer的实现(SpringServletContainerInitializer),此实现又查找WebApplicationInitializer的实现(AbstractAnnotationConfigDispatcherServletInitializer),这个类会创建DispatcherServlet和ContextLoaderListener,而这里应用的配置类SpitterWebInitializer继承了AbstractAnnotationConfigDispatcherServletInitializer。
两个应用上下文
当DispatcherServlet启动的时候,会创建Spring应用上下文,并加载配置文件或配置类中所声明的bean。在上述代码中的getServletConfigClasses()方法中,我们要求DispatcherServlet加载应用上下文时,使用定义在WebConfig配置类中的bean(相关代码在后面给出)。 但是在Spring Web应用中,通常还会有另外一个应用上下文。这个上下文是由ContextLoaderListener创建的。一般情况是,我们希望DispatcherServlet加载包含Web组件的bean,如控制器、视图解析器以及处理器映射器,而ContextLoaderListener要加载应用中其他的bean。这些bean通常是驱动应用后端的中间层和数据层组件(如IoC容器)。
实际上,AbstractAnnotationConfigDispatcherServletInitializer会同时创建DispatcherServlet和ContextLoaderListener。getServletConfigClasses()方法返回的带有@Configuration注解的类将会用来定义DispatcherServlet应用上下文中的bean。getRootConfgiClasses()方法返回的带有@Configuration注解的类将会用来配置ContextLoaderListener创建应用上下文中的bean。 当然我们也可以使用传统的web.xml配置,但是其实没有必要,而这种配置方式下的应用必须部署到支持Servlet3.0的服务器中才能正常工作。
启用Spring MVC
@Configuration @EnableWebMvc //启用Spring MVC @ComponentScan("spittr.web") //组件扫描 public class WebConfig extends WebMvcConfigurerAdapter { @Bean public ViewResolver viewResolver() { InternalResourceViewResolver resolver = new InternalResourceViewResolver(); resolver.setPrefix("/WEB-INF/views/"); resolver.setSuffix(".jsp"); return resolver; } @Override public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) { configurer.enable(); } @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { super.addResourceHandlers(registry); } }
WebConfig类还扩展了WebMvcConfigurerAdapter并重写了其configureDefaultServletHandling()方法。通过调用enable()方法,我们要求DispatcherServlet将对静态资源的请求转发到Servlet容器中默认的Servlet上,而不是使用DispatcherServlet本身来处理此类请求。
3. 编写基本的控制器
在Spring MVC中,控制器只是方法上添加了@RequestMapping注解的类,这个注解声明了它们所要处理的请求。这里控制器尽可能简单,假设控制器类要处理对“/”的请求,并渲染应用的首页。
package spittr.web; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; @Controller public class HomeController { @RequestMapping(value = "/", method = RequestMethod.GET) public String home(){ return "home"; } }
很显然,这个类带有@Controller注解,表示这个类是一个控制器。@Controller是一个构造型(stereotype)的注解,基于@Component注解。在这里,它的目的就是辅助实现组件扫描。因为这个类带有@Controller注解,因此组件扫描的时候会自动找到此类,并将其声明为一个bean。
HomeController有一个方法home()方法,带有@RequestMapping注解。它的value属性指定了这个方法所要处理的请求路径,method属性细化了它所处理的HTTP方法。在本例中,当收到对“/”的HTTP GET请求时,就会调用此方法处理。 这里home()方法返回的是一个视图的逻辑名,之后DispatcherServlet会调用视图解析器对其进行解析,找到真正的视图“/WEB-INF/views/home.jsp”
4、接受请求的输入
三种输入方式:查询参数(Query Parameter)。 表单参数(Form Parameter)。 路径变量(Path Variable)。
这里只记录了查询参数:
@RequestMapping(method=RequestMethod.GET) public List<Spittle> spittles( @RequestParam(value="max", defaultValue=MAX_LONG_AS_STRING) long max, @RequestParam(value="count", defaultValue="20") int count) { return spittleRepository.findSpittles(max, count); }
因为查询参数都是String类型的,因此defaultValue属性需要String类型的值。因此,使用Long.MAX_VALUE是不行的。我们可以将Long.MAX_VALUE转换为名为MAX_LONG_AS_STRING的String类型常量:
private static final String MAX_LONG_AS_STRING = "9223372036854775807"; 尽管defaultValue属性给定的是String类型的值,但是当绑定到方法的max参数时,它会转换为Long类型。 业务逻辑需要的int类型不要改变,Controller层接受的参数也是int,尽量利用Spring的自动转换机制。