spring碎碎念(三)

springMVC 通过org.springframework.servlet.DispatcherServlet来运行。

DispatcherServlet可以处理多种处理器,不仅仅限于执行实现了org.springframework.web.servlet.Controller接口以及拥有org.springframework.stereotype.Controller注解的类。

总原理图:


处理器原理图:


预处理原理图:


处理链派发原理图:



处理器原理图:


异常处理原理图:


视图渲染原理图


完成处理原理图




DispatcherServlet的入口:

1、web.xml:

2、web-fragment.xml

3、javax.servlet.ServletContainerInitializer

4、自己实现org.springframework.web.WebApplicationInitializer

DispatcherServlet必须要一个WebApplicationContext的实例,以便对自己进行配置。默认情况下DispatcherServlet将创建一个org.springframework.web.context.support.XmlWebApplicationContext的实例。


web.xml例子:

<web-app version="3.0"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation=http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd
metadata-complete="true">
<servlet>
<servlet-name>bookstore</servlet-name>
<servlet-class>
org.springframework.web.servlet.DispatcherServlet
</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>bookstore</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>

web-fragment.xml例子:

从spring3.0开始,支持web-fragment.xml配置方式:

<web-fragment version="3.0"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-fragment_3_0.xsd">
<servlet>
<servlet-name>bookstore</servlet-name>
<servlet-class>
org.springframework.web.servlet.DispatcherServlet
</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>bookstore</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-fragment>

用ServletContainerInitializer启动:

package com.apress.prospringmvc.bookstore.web;
import java.util.Set;
// javax.servlet imports omitted.
import org.springframework.web.servlet.DispatcherServlet;
public class BookstoreServletContainerInitializer
implements ServletContainerInitializer {
@Override
public void onStartup(Set<Class<?>> classes, ServletContext servletContext)
throws ServletException {
ServletRegistration.Dynamic registration;
registration = servletContext.addServlet("dispatcher", DispatcherServlet.class);
registration.setLoadOnStartup(1);
registration.addMapping("/*");
}
}
通过WebApplicationInitializer启动:

package com.apress.prospringmvc.bookstore.web;
// javax.servlet imports omitted
import org.springframework.web.WebApplicationInitializer;
import org.springframework.web.servlet.DispatcherServlet;
public class BookstoreWebApplicationInitializer implements WebApplicationInitializer {

@Override
public void onStartup(ServletContext servletContext) throws ServletException {
ServletRegistration.Dynamic registration
registration = servletContext.addServlet("dispatcher",
DispatcherServlet.class);
registration.addMapping("/*");
registration.setLoadOnStartup(1);
}
}

注意,使用上述特性,将大大延长启动时间,spring框架将在classpath下扫描所有WebApplicationInitializer实现,当应用程序很大时,启动时间是无法忍受的。也就是说:不用。

配置Dispatcherservlet:

配置DispatcherServlet分两步:一、通过在直接DispatcherServlet内部设定properties配置servlet的行为(the declaration)。二、设定在应用程序上下文组件(initialization)。

默认的DispatcherServlet都有默认的属性设置,但可以通过override和继承更改设置。通过org.springframework.web.servlet.config.annotation.EnableWebMvc注解启用@MVC注解,也有默认配置。

DispatcherServlet的属性:

属性默认值描述
cleanupAfterIncludetrue设定为True,则在一个Include request之后,清除Request属性。
contextAttributenull是否存储一个servlet的上下文,当上下文创建后还需在servlet之外使用时有用。
contextClassorg.springframework.web.context.support.XmlWebApplicationContext设置org.springframework.web.context.WebApplicationContext的类型,以供servlet构造时使用。设置后使用给定的contextConfigLocation。如果创建应用程序时不需要相关上下文信息,则不需要设置。
contextConfigLocation[servlet-name]-servlet.xml指定配置文件的路径。
contextIdnull指定程序上下文的Id。例如在日志中记录上下文或者通过System.out输出,需要设置此属性。

contextInitializers

contextInitializerClasses

null

使用一个可选的org.springframework.context.ApplicationContextInitializer类来实现一些在应用程序上下文中的初始化逻辑。如载入一个指定的Profile。

detectAllHandlerAdapterstrue探测在上下文中的所有org.springframework.web.servlet.HandlerAdapters。如果设定为false,则只探测一个名为handlerAdapter的HandlerAdapter。

detectAllHandlerExceptionResolvers

true探测上下文中org.springframework.web.servlet.HandlerExceptionResolvers。如果设定为false,则只探测名为handlerExceptionResolver的HandlerExceptionResolver。
detectAllHandlerMappingstrue

探测上下文中org.springframework.web.servlet.HandlerMappings.

如设定为false,则只探测名为handlerMapping.的HandlerMapping。

detectAllViewResolverstrue探测上下文中org.springframework.web.servlet.ViewResolvers,如设定为false,则只探测名为viewResolver的ViewResolver
dispatchOptionsRequestfalse是否处理HTTP OPTIONS类请求,如果设定为true,则处理相应请求。
dispatchTraceRequestfalse是否处理HTTP TRACE请求,如设定为true,则处理相应请求。
environmentorg.springframework.web.context.support.StandardServletEnvironment

设定servlet所使用的org.springframework.core.env.Environment

环境(environment)指定激活那个profile以及定义一些特殊的属性。

namespace[servletname]-servlet使用命名空间(namespace)来设定应用程序上下文。
publishContexttrue指定应用程序的上下文是否发送到javax.servlet.ServletContext中,作为产品级应用,建议设为false。
publishEventstrue

指定请求过后,是否解除一个org.springframework.web.context.support.ServletRequestHandledEvent

你可以通过org.springframework.context.ApplicationListener去处理这些事件。

threadContextInheritablefalse指定是否暴露LocaleContext和RequestAttributes给当前请求处理的子线程

应用程序上下文:

spring的DispatcherServlet需要一个org.springframework.web.context.WebApplicationContext来获取需要的组件,从而对自身进行配置。你可以在自己让构造函数自己创建他,也可以在自己的构造函数中覆盖。在一个XML配置的程序中,只能采取第一种(没其他办法可以创建上下文)。如果是java程序中配置,那么选择第二种。

使用java程序配置,需要引导程序不使用xml配置(xml配置是默认的)。你需要org.springframework.web.context.support.AnnotationConfigWebApplicationContext类来启动程序,并对程序进行配置。

示例代码:

package com.apress.prospringmvc.bookstore.web;
// javax.servlet imports omitted.
import org.springframework.web.WebApplicationInitializer;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support
.AnnotationConfigWebApplicationContext;
import org.springframework.web.servlet.DispatcherServlet;
import com.apress.prospringmvc.bookstore.web.config.WebMvcContextConfiguration;
public class BookstoreWebApplicationInitializer
implements WebApplicationInitializer {     
    @Override
    public void onStartup(final ServletContext servletContext) throws ServletException {    
        registerDispatcherServlet(servletContext);
    }
    private void registerDispatcherServlet(final ServletContext servletContext) {
        WebApplicationContext dispatcherContext = createContext(WebMvcContextConfiguration.class);
        DispatcherServlet dispatcherServlet = new DispatcherServlet(dispatcherContext);
        ServletRegistration.Dynamic dispatcher;
        dispatcher = servletContext.addServlet("dispatcher", dispatcherServlet);
        dispatcher.setLoadOnStartup(1);
        dispatcher.addMapping("/");
    }
    private WebApplicationContext createContext(final Class<?>... annotatedClasses) {
        AnnotationConfigWebApplicationContext context
        context = new AnnotationConfigWebApplicationContext();
        context.register(annotatedClasses);
        return context;
    }
}





例二:云环境的Context:

package org.cloudfoundry.reconfiguration.spring;
// Other imports omitted
import org.cloudfoundry.runtime.env.CloudEnvironment;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.Ordered;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.EnumerablePropertySource;
import org.springframework.core.env.PropertiesPropertySource;
import org.springframework.core.env.PropertySource;
public final class CloudApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext>,
Ordered {
    private static final Log logger =LogFactory.getLog(CloudApplicationContextInitializer.class);
    private static final int DEFAULT_ORDER = 0;
    private ConfigurableEnvironment springEnvironment;
    private CloudEnvironment cloudFoundryEnvironment;
    public CloudApplicationContextInitializer() {
        cloudFoundryEnvironment = new CloudEnvironment();
    }
    @Override
    public void initialize(ConfigurableApplicationContext applicationContext) {
        if (!cloudFoundryEnvironment.isCloudFoundry()) {
            logger.info("Not running on Cloud Foundry.”)
            return;
        }
        try {
            logger.info("Initializing Spring Environment for Cloud Foundry");
            springEnvironment = applicationContext.getEnvironment();
            addPropertySource(buildPropertySource());
            addActiveProfile("cloud");
        } catch (Throwable t) {
            // be safe
            logger.error("Unexpected exception on initialization: "+ t.getMessage(), t);
        }
    }
    //other method implement
}
部件解析:

当一个servlet配置完成后,将收到一个servlet容器发出的初始化请求。当初始化发生,就需要提供相关的组件。一些组件通过类型被探测,另外一些通过名称被探测。在有些情况下,通过类型探测并不是我们所需要的,因此,要通过名称探测。

下表列出了在请求处理中的被探测的一些component/bean的名称,下表也包含一些DispatcherServlet是否对多实例自动探测:

组件默认的Bean Name探测多实例
org.springframework.web.multipart.MultipartResolvermultipartResolverNo
org.springframework.web.servlet.LocaleResolverlocaleResolverNo
org.springframework.web.servlet.ThemeResolverthemeResolverNo
org.springframework.web.servlet.HandlerMappinghandlerMappingYes
org.springframework.web.servlet.HandlerAdapterhandlerAdapterYes
org.springframework.web.servlet.HandlerExceptionResolverhandlerExceptionResolverYes
org.springframework.web.servlet.RequestToViewNameTranslatorrequestToViewNameTranslatorNo
org.springframework.web.servlet.ViewResolverviewResolverYes
org.springframework.web.servlet.FlashMapManagerflashMapManagerNo

组件探测的原理图:



Dispatcher Servlet的默认配置:

如下表:

组件默认实现
MultipartResolver无,需明确指定
LocaleResolverorg.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver
ThemeResolverorg.springframework.web.servlet.theme.FixedThemeResolver
HandlerMappingorg.springframework.web.servlet.handler.BeanNameUrlHandlerMapping
org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping
HandlerAdapterorg.springframework.web.servlet.mvc.HttpRequestHandlerAdapter
org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter
org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter
HandlerExceptionResolverorg.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerExceptionResolver
org.springframework.web.servlet.mvc.annotation.ResponseStatusExceptionResolver
org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver
RequestToViewNameTranslatororg.springframework.web.servlet.view.DefaultRequestToViewNameTranslator
ViewResolverorg.springframework.web.servlet.view.InternalResourceViewResolver
FlashMapManagerorg.springframework.web.servlet.support.SessionFlashMapManager

spring @MVC 默认:

在spring中,有一系列的@Enable 注解,@MVC(org.springframework.web.servlet.config.annotation.EnableWebMvc)是其中之一。启用这个注解,覆盖了部分DispatcherServlet的默认配置,相关的实际配置可以在org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport类中找到,这个配置在注解启用时,将被注册。

下表是@MVC的默认配置,加粗蓝色的是与DispatcherServlet不同的部分:

组件默认实现
MultipartResolver无,需明确指定
LocaleResolverorg.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver
ThemeResolverorg.springframework.web.servlet.theme.FixedThemeResolver
HandlerMappingorg.springframework.web.servlet.handler.BeanNameUrlHandlerMapping
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping
HandlerAdapterorg.springframework.web.servlet.mvc.HttpRequestHandlerAdapter
org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter
HandlerExceptionResolverorg.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver
org.springframework.web.servlet.mvc.annotation.ResponseStatusExceptionResolver
org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver
RequestToViewNameTranslatororg.springframework.web.servlet.view.DefaultRequestToViewNameTranslator
ViewResolverorg.springframework.web.servlet.view.InternalResourceViewResolver
FlashMapManagerorg.springframework.web.servlet.support.SessionFlashMapManager

与DispatcherServlet相比,变化似乎不大,但是新组件提供了十分重要初始化代码。spring的@MVC组件使你可以编写更加灵活的处理方法。

Spring MCV 的组件:

1、HandlerMapping:

HandlerMapping决定了那个处理器处理Request输入。理所当然的,你可以用URL来映射输入。不过,你可以采用不同的HandlerMapping的实现来采取不同的映射策略。

API org.springframework.web.servlet.HandlerMapping由一个方法组成,有DispatcherServlet来调用,从而决定由那个org.springframework.web.servlet.HandlerExecutionChain来执行。你可以注册多个Handler Mapping,servlet将在列队里依次调用他们,直到有一个方法返回了非NULL。

Handler Mapping的API:

package org.springframework.web.servlet;
import javax.servlet.http.HttpServletRequest;
public interface HandlerMapping {
    HandlerExecutionChain getHandler(HttpServletRequest request)
    throws Exception;
}

Handler Mapping的实现(继承结构的类图):



AbstractHandlerMapping那一只稍微复杂点,AbstractUrlHandlerMapping比较常用。

一个Url由四部分组成:

1、域名。

2、应用程序名

3、servlet名

4、servlet的内部路径。

例如:http://www.example.org/bookstore/app/home

第一部分域名:www.example.org

第二部分应用程序名:bookstore

第三部分servlet名:app

第四部分内部路径:home

如果应用程序名为空的话,那么就是服务器的Root。而servlet名称可以简单设为“/"

默认情况下,Handler Mapping的实现采取servlet内部的上下文的相对路径。将alwaysUseFullPath属性设置未True,则改变这个默认行为。

通过设置defaultHandler,则当无Handler被发现时,使用这个默认的Handler。这个属性是可选的,设置这个属性时要小心,尤其是multiple handler处理链中。仅仅最后一个Handler Mapping时设置这个属性,否则处理链将被打破。

BeanNameUrlHandlerMapping:

org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping作为DispatcherServlet的默认策略。这个实现把任何以"/"开头的Bean名称作为一个可能的处理器。一个Bean可以拥有多个名称,bean的名称可以拥有通配符(wildcard),例如“*”。

BeanNameUrlHandlerMapping采用ant样式的表达式将Url映射到Bean名称。映射时,采取以下算法:

1、采取精确匹配,发现后,退出。

2、搜寻所有注册的Path,找出最匹配的。

3、如果未找到,则以“/*"作为名称匹配或者使用默认的处理器(default handler,如果设置的话)

注意:bean的名称与Xml中的Id不同,Bean的名称可以包含诸如/.之类的字符。bean的名称可以通过org.springframework.context.annotation.Bean注解来提供,一个bean可以有多个名称,且名称可以设置为ant 规则的表达式。

一个例子:

package com.apress.prospringmvc.bookstore.web.config;
import java.util.Properties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.apress.prospringmvc.bookstore.web.IndexController;
@Configuration
public class WebMvcContextConfiguration {
    @Bean(name = { "/index.htm" })
    public IndexController indexController() {
        return new IndexController();
    }
}

SimpleUrlHandlerMapping:

这个Handler Mapping精确匹配,实现为org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping。

一个例子:

package com.apress.prospringmvc.bookstore.web.config;
// Other imports omitted see Listing 4-8
import org.springframework.web.servlet.HandlerMapping;
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
@Configuration
public class WebMvcContextConfiguration {
    @Bean
    public IndexController indexController() {
        return new IndexController();
    }
    @Bean
    public HandlerMapping simpleUrlHandlerMapping() {
        SimpleUrlHandlerMapping urlMapping = new SimpleUrlHandlerMapping();
        Properties mappings = new Properties();
        mappings.put("/index.htm", "indexController");
        urlMapping.setMappings(mappings);
        return urlMapping;
    }
}
如果有许多的Controller,那么相关的配置数量将是非常可观的,所以最好将所有的Mapping放在一个地方。

ControllerBeanNameHandlerMapping:

ControllerBeanNameHandlerMapping与org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping十分相似,但有一个重要的不同,他不需要Bean名称以”/"开头,映射时,自动加上“/"映射,并且作为可选项,可以加上尾缀。

例子:

package com.apress.prospringmvc.bookstore.web.config;
// Other imports omitted see Listing 4-8
import org.springframework.web.servlet.HandlerMapping;
import org.springframework.web.servlet.mvc.support.ControllerBeanNameHandlerMapping;
@Configuration
public class WebMvcContextConfiguration {
    @Bean(name = "index")
    public IndexController indexController() {
        return new IndexController();
    }
    @Bean
    public HandlerMapping controllerBeanNameHandlerMapping() {
        ControllerBeanNameHandlerMapping mapping;
        mapping = new ControllerBeanNameHandlerMapping();
        mapping.setUrlSuffix(".htm");
        return mapping;
    }
}
ControllerClassNameHandlerMapping:

这个Handler Mapping查找上下文中所有的Controller,把类名作为Bean名称加到Url Mapping中。

例如,对于com.apress.prospringmvc.bookstore.web.IndexController类,他将创建一个/index 的url。他将类名称的controller部分去掉,并小写(除非有配置)。

下面是一个例子,注意,这个Handler Mapping不支持后缀。

package com.apress.prospringmvc.bookstore.web.config;
// Other imports omitted see Listing 4-8
import org.springframework.web.servlet.HandlerMapping;
import org.springframework.web.servlet.mvc.support.ControllerClassNameHandlerMapping;
@Configuration
public class WebMvcContextConfiguration {
    @Bean
    public IndexController indexController() {
        return new IndexController();
    }
    @Bean
    public HandlerMapping controllerClassNameHandlerMapping() {
        return new ControllerClassNameHandlerMapping();
    }
}
这一设置对于有大量Controller的情况十分有用,为配置提供了便利,可以节约大量时间。

DefaultAnnotationHandlerMapping 和 RequestMappingHandlerMapping:

这两个Handler Mapping是最复杂也是最强大的两个Handler Mapping。他们在上下文中搜寻拥有org.springframework.web.bind.annotation.RequestMapping注解的Bean。RequestMapping注解可以用在类层次上,也可以用在方法层次上。

如果要将com.apress.prospringmvc.bookstore.web.IndexController 类映射到  /index.htm上,你需要添加annotation,如下例:

package com.apress.prospringmvc.bookstore.web;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
@Controller
public class IndexController {
    @RequestMapping(value = "/index.htm")
    public ModelAndView indexPage() {
        return new ModelAndView("/WEB-INF/views/index.jsp");
    }
}
配置类:

package com.apress.prospringmvc.bookstore.web.config;
// Other imports omitted see Listing 4-8
@Configuration
public class WebMvcContextConfiguration {
    @Bean
    public IndexController indexController() {
        return new IndexController();
    }
}

DefaultAnnotationHandlerMapping是默认注册的Handler Mapping。但如果你要使用RequestMappingHandlerMapping,你就需要实际注册他,或者使用org.springframework.web.servlet.config.annotation.EnableWebMvc注解激活它。这个Handler Mapping比默认的要灵活和强大的多,具体用法将以后详述。

HandlerAdapter:

org.springframework.web.servlet.HandlerAdapter是DispatcherServlet于Handler Mapping之间的粘合器。他将实际的执行逻辑从servlet中分离出去,从而为DispatcherServlet提供了无限的扩展性。

HandlerAdapter API的代码:

package org.springframework.web.servlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public interface HandlerAdapter {
    boolean supports(Object handler);
    ModelAndView handle(HttpServletRequest request,HttpServletResponse response,Object handler) throws Exception;
    long getLastModified(HttpServletRequest request, Object handler);
}

API中,supports方法被每个一个servlet上下文中的每一个handler调用,并决定哪一个adapter可以被选择的handler所执行。如果相应的adapter能够被执行,那么所选中的handler就会实际执行,并返回一个org.springframework.web.servlet.ModelAndView对象。不过,有些实现总是返回null,以表示相关结果已返回客户端。

如果请求是GET或者HEAD,那么getLastModified返回资源是什么时候最后被更新的(-1表示资源永远是重新生成的)。结果将在请求头中以Last-Modified字段返回,并与请求头中的If-Modified-Since字段比较。如果发生了改动,那么Response结果将返回客户端,否则,返回304(Not Modified)。这一特性对于访问服务端静态资源,节约带宽十分有用。


HandlerAdapter的类图:


P94



评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值