Spring Webflux 源码阅读之 support包

Spring WebFlux安装的支持类。

AbstractAnnotationConfigDispatcherHandlerInitializer

getConfigClasses()需要具体实现类。更多的模板和定制方法由AbstractDispatcherHandlerInitializer提供。


public abstract class AbstractAnnotationConfigDispatcherHandlerInitializer
        extends AbstractDispatcherHandlerInitializer {

    /**
     * 创建要提供给DispatcherHandler的应用程序上下文。
     * 返回的上下文被委托给Spring的DispatcherHandler.DispatcherHandler(ApplicationContext)。因此,它通常包含控制        
         * 器,视图解析器和其他Web相关的bean。
     * 该实现创建一个AnnotationConfigApplicationContext,为其提供由getConfigClasses()返回的带注释的类。
     */
    @Override
    protected ApplicationContext createApplicationContext() {
        AnnotationConfigApplicationContext servletAppContext = new AnnotationConfigApplicationContext();
        Class<?>[] configClasses = getConfigClasses();
        if (!ObjectUtils.isEmpty(configClasses)) {
            servletAppContext.register(configClasses);
        }
        return servletAppContext;
    }

    /**
     * 为应用程序上下文指定@Configuration或者@Component类。
     * 返回dispatcher servlet应用程序上下文的配置类
     */
    protected abstract Class<?>[] getConfigClasses();

}

AbstractDispatcherHandlerInitializer

WebApplicationInitializer实现的基类,在Servlet上下文中注册一个DispatcherHandler,并将其包装在一个ServletHttpHandlerAdapter中。

大多数应用程序应该考虑扩展Spring Java配置,AbstractAnnotationConfigDispatcherHandlerInitializer子类。


public abstract class AbstractDispatcherHandlerInitializer implements WebApplicationInitializer {

    /**
     * 默认的servlet名字. 可以通过覆盖{@link #getServletName}来自定义.
     */
    public static final String DEFAULT_SERVLET_NAME = "dispatcher-handler";

    /**
     * 默认的servlet映射。. 可以通过覆盖{@link #getServletMapping()}.来自定义
     */
    public static final String DEFAULT_SERVLET_MAPPING = "/";

        //配置给定的ServletContext(servlets, filters, listeners context-params and attributes )来初始化此Web应用程序
    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        registerDispatcherHandler(servletContext);
    }

    /**
     * 针对给定的servlet上下文注册一个DispatcherHandler。
     *此方法将创建一个DispatcherHandler,并使用从createApplicationContext()返回的应用程序上下文对其进行初始化。创        
         * 建的处理程序将被包装在一个ServletHttpHandlerAdapter servlet中,其名称由getServletName()返回,将其映射到从
         *getServletMapping()返回的模式。
     *进一步的自定义可以通过覆盖customizeRegistration(ServletRegistration.Dynamic)或
         *  createDispatcherHandler(ApplicationContext)来实现。
     */
    protected void registerDispatcherHandler(ServletContext servletContext) {
        String servletName = getServletName();
        Assert.hasLength(servletName, "getServletName() must not return empty or null");

        ApplicationContext applicationContext = createApplicationContext();
        Assert.notNull(applicationContext,
                "createApplicationContext() did not return an application " +
                "context for servlet [" + servletName + "]");

        refreshApplicationContext(applicationContext);
        registerCloseListener(servletContext, applicationContext);

        WebHandler dispatcherHandler = createDispatcherHandler(applicationContext);
        Assert.notNull(dispatcherHandler,
                "createDispatcherHandler() did not return a WebHandler for servlet [" + servletName + "]");

        ServletHttpHandlerAdapter handlerAdapter = createHandlerAdapter(dispatcherHandler);
        Assert.notNull(handlerAdapter,
                "createHttpHandler() did not return a ServletHttpHandlerAdapter for servlet [" + servletName + "]");

        ServletRegistration.Dynamic registration = servletContext.addServlet(servletName, handlerAdapter);
        Assert.notNull(registration,
                "Failed to register servlet with name '" + servletName + "'." +
                "Check if there is another servlet registered under the same name.");

        registration.setLoadOnStartup(1);
        registration.addMapping(getServletMapping());
        registration.setAsyncSupported(true);

        customizeRegistration(registration);
    }

    /**
     * Return the name under which the {@link ServletHttpHandlerAdapter} will be registered.
     * Defaults to {@link #DEFAULT_SERVLET_NAME}.
     * @see #registerDispatcherHandler(ServletContext)
     */
    protected String getServletName() {
        return DEFAULT_SERVLET_NAME;
    }

    /**
     * 创建要提供给DispatcherHandler的应用程序上下文。
     * 返回的上下文被委托给Spring的DispatcherHandler.DispatcherHandler(ApplicationContext)。因此,它通常包含控制
         * 器,视图解析器和其他Web相关的bean。
     */
    protected abstract ApplicationContext createApplicationContext();

    /**
     * 如有必要,刷新给定的应用程序上下文。
     */
    protected void refreshApplicationContext(ApplicationContext context) {
        if (context instanceof ConfigurableApplicationContext) {
            ConfigurableApplicationContext cac = (ConfigurableApplicationContext) context;
            if (!cac.isActive()) {
                cac.refresh();
            }
        }
    }

    /**
     * 使用指定的ApplicationContext创建DispatcherHandler(或其他类型的WebHandler派生调度程序)。
     */
    protected WebHandler createDispatcherHandler(ApplicationContext applicationContext) {
        return new DispatcherHandler(applicationContext);
    }

    /**
     *创建一个ServletHttpHandlerAdapter。 默认实现返回一个ServletHttpHandlerAdapter和提供的webHandler。
     */
    protected ServletHttpHandlerAdapter createHandlerAdapter(WebHandler webHandler) {
        HttpHandler httpHandler = new HttpWebHandlerAdapter(webHandler);
        return new ServletHttpHandlerAdapter(httpHandler);
    }

    /**
     * Specify the servlet mapping for the {@code ServletHttpHandlerAdapter}.
     * <p>Default implementation returns {@code /}.
     * @see #registerDispatcherHandler(ServletContext)
     */
    protected String getServletMapping() {
        return DEFAULT_SERVLET_MAPPING;
    }

    /**
     *一旦registerDispatcherHandler(ServletContext)完成,可以选择执行进一步的注册自定义配置定制。
     *
     */
    protected void customizeRegistration(ServletRegistration.Dynamic registration) {
    }

    /**
     * Register a {@link ServletContextListener} that closes the given application context
     */
    protected void registerCloseListener(ServletContext servletContext, ApplicationContext applicationContext) {
        if (applicationContext instanceof ConfigurableApplicationContext) {
            ConfigurableApplicationContext context = (ConfigurableApplicationContext) applicationContext;
            ServletContextDestroyedListener listener = new ServletContextDestroyedListener(context);
            servletContext.addListener(listener);
        }
    }


    private static class ServletContextDestroyedListener implements ServletContextListener {

        private final ConfigurableApplicationContext applicationContext;

        public ServletContextDestroyedListener(ConfigurableApplicationContext applicationContext) {
            this.applicationContext = applicationContext;
        }

        @Override
        public void contextInitialized(ServletContextEvent sce) {
        }

        @Override
        public void contextDestroyed(ServletContextEvent sce) {
            this.applicationContext.close();
        }
    }

AbstractServletHttpHandlerAdapterInitializer

在Servlet上下文中注册ServletHttpHandlerAdapter的WebApplicationInitializer实现的基类。


public abstract class AbstractServletHttpHandlerAdapterInitializer implements WebApplicationInitializer {

    /**
     * The default servlet name. Can be customized by overriding {@link #getServletName}.
     */
    public static final String DEFAULT_SERVLET_NAME = "http-handler-adapter";


    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        registerHandlerAdapter(servletContext);
    }

    /**
     * Register a {@link ServletHttpHandlerAdapter} against the given servlet context.
     * <p>This method will create a {@code HttpHandler} using {@link #createHttpHandler()},
     * and use it to create a {@code ServletHttpHandlerAdapter} with the name returned by
     * {@link #getServletName()}, and mapping it to the patterns
     * returned from {@link #getServletMappings()}.
     * <p>Further customization can be achieved by overriding {@link
     * #customizeRegistration(ServletRegistration.Dynamic)} or
     * {@link #createServlet(HttpHandler)}.
     * @param servletContext the context to register the servlet against
     */
    protected void registerHandlerAdapter(ServletContext servletContext) {
        String servletName = getServletName();
        Assert.hasLength(servletName, "getServletName() must not return empty or null");

        HttpHandler httpHandler = createHttpHandler();
        Assert.notNull(httpHandler,
                "createHttpHandler() did not return a HttpHandler for servlet [" + servletName + "]");

        ServletHttpHandlerAdapter servlet = createServlet(httpHandler);
        Assert.notNull(servlet,
                "createHttpHandler() did not return a ServletHttpHandlerAdapter for servlet [" + servletName + "]");

        ServletRegistration.Dynamic registration = servletContext.addServlet(servletName, servlet);
        Assert.notNull(registration,
                "Failed to register servlet with name '" + servletName + "'." +
                "Check if there is another servlet registered under the same name.");

        registration.setLoadOnStartup(1);
        registration.addMapping(getServletMappings());
        registration.setAsyncSupported(true);

        customizeRegistration(registration);
    }

    /**
     * Return the name under which the {@link ServletHttpHandlerAdapter} will be registered.
     * Defaults to {@link #DEFAULT_SERVLET_NAME}.
     * @see #registerHandlerAdapter(ServletContext)
     */
    protected String getServletName() {
        return DEFAULT_SERVLET_NAME;
    }

    /**
     * Create the {@link HttpHandler}.
     */
    protected abstract HttpHandler createHttpHandler();

    /**
     * Create a {@link ServletHttpHandlerAdapter}  with the specified .
     * <p>Default implementation returns a {@code ServletHttpHandlerAdapter} with the provided
     * {@code httpHandler}.
     */
    protected ServletHttpHandlerAdapter createServlet(HttpHandler httpHandler) {
        return new ServletHttpHandlerAdapter(httpHandler);
    }

    /**
     * Specify the servlet mapping(s) for the {@code ServletHttpHandlerAdapter} &mdash;
     * for example {@code "/"}, {@code "/app"}, etc.
     * @see #registerHandlerAdapter(ServletContext)
     */
    protected abstract String[] getServletMappings();

    /**
     * Optionally perform further registration customization once
     * {@link #registerHandlerAdapter(ServletContext)} has completed.
     * @param registration the {@code DispatcherServlet} registration to be customized
     * @see #registerHandlerAdapter(ServletContext)
     */
    protected void customizeRegistration(ServletRegistration.Dynamic registration) {
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,681评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,710评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,623评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,202评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,232评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,368评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,795评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,461评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,647评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,476评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,525评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,226评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,785评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,857评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,090评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,647评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,215评论 2 341

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,570评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,714评论 6 342
  • application的配置属性。 这些属性是否生效取决于对应的组件是否声明为Spring应用程序上下文里的Bea...
    新签名阅读 5,350评论 1 27
  • 这些属性是否生效取决于对应的组件是否声明为 Spring 应用程序上下文里的 Bean(基本是自动配置的),为一个...
    发光的鱼阅读 1,416评论 0 14
  • 什么是Spring Spring是一个开源的Java EE开发框架。Spring框架的核心功能可以应用在任何Jav...
    jemmm阅读 16,431评论 1 133