spring mvc的零xml配置原理

spring mvc的零xml配置原理

在tomcat启动的时候,会调用到一个类,叫StandardContext,这里会读取我们配置的web.xml文件,所以可以简单的理解为“tomcat启动的时候默认会调用web.xml”。

<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:applicationContext.xml</param-value>
</context-param> 

在web.xml中,最开始我们在配置mvc的时候都会配置这两个东西。ContextLoaderListener(spring中的类)实现了ServletContextListener(servlet中的类),ServletContextListener能够监听到servlet的生命周期,而一个web应用启动的时候就只有1个servlet,因此相当于监听了整个web应用。web启动后,会触发ServletContextEvent事件,此时就会调用ContextLoaderListener中的contextInitialized方法,这个方法会调用initWebApplicationContext,返回一个WebApplicationContext,在这个方法中,会加载在web.xml中配置的classpath。因此在web.xml中配置的这段实际上的作用是“tomcat来初始化一个spring环境”。

public void contextInitialized(ServletContextEvent event) {
    this.initWebApplicationContext(event.getServletContext());
}
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
    ...
    String configLocationParam = sc.getInitParameter(CONFIG_LOCATION_PARAM);//"contextConfigLocation"(设置配置文件的路径名)
}

那么如果我们想不用xml配置,需要我们自己来初始化spring环境,在一个spring项目中,我们初始化spring的方式是。

@ComponentScan("com.bafan.spring.dependencies")
public class AppConfig {
}

AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

所以思路就是需要我们自己new一个ApplicationContext,然后需要tomcat在启动的时候能调用到它。

web.xml中另一个很重要的需要配置的点就是拦截器,在使用web.xml的时候,配置姿势如下面所示。

<servlet>
    <servlet-name>SpringMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
    <async-supported>true</async-supported>
</servlet>
<servlet-mapping>
    <servlet-name>SpringMVC</servlet-name>
    <!-- 此处可以可以配置成*.do,对应struts的后缀习惯 -->
    <url-pattern>/</url-pattern>
</servlet-mapping>

如果不通过web.xml的方式能够让上面的代码别调用,mvc官方文档中写,可以实现WebApplicationInitializer,然后重写onStartup方法。

/**
 * mvc如何实现0xml配置
 * onStartup方法,tomcat是如何能调用到的
 */
public class BafanWebApplication implements WebApplicationInitializer {

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        System.out.println("tomcat------init---------");
        //spring环境初始化
        AnnotationConfigWebApplicationContext applicationContext = new AnnotationConfigWebApplicationContext();
        applicationContext.register(AppConfig.class);
        applicationContext.setServletContext(servletContext);
        applicationContext.refresh();

        //web环境初始化(servlet的配置)
        DispatcherServlet servlet = new DispatcherServlet(applicationContext);
        ServletRegistration.Dynamic registration = servletContext.addServlet("app", servlet);
        registration.addMapping("*.do");
        registration.setLoadOnStartup(1);
    }
}

在tomcat启动的时候,会调用到我们重写的onStartup方法,在这个方法中,我们初始化了spring的环境,因此就不用xml的方式初始spring的环境了,同时也初始化了web的环境。写了这几行代码就可以不用配置web.xml了。

为什么我们实现了WebApplicationInitializer tomcat就可以调用到我们重写的方法了呢?

  1. WebApplicationInitializer是在org.springframework.web这个包下面的,也就是说这个接口是spring写的,点到这个jar包下。
  2. 它的根目录中的/META-INF/services有一个文件,文件名是javax.servlet.ServletContainerInitializer,文件里面写着org.springframework.web.SpringServletContainerInitializer。根据servlet的规范,tomcat和spring都遵守这个规范,tomcat启动的时候会调用这个方法(servlet的规定)。
  3. 这个方法的上面,加了一个@HandlesTypes(WebApplicationInitializer.class)的注解,@Nullable Set<Class<?>> webAppInitializerClasses的入参中,如果我们自己实现了WebApplicationInitializer这个接口的话,这个入参中会拿到我们所有实现了这个接口类,然后循环调用里面的onStartup方法。
for (WebApplicationInitializer initializer : initializers) {
    initializer.onStartup(servletContext);
}

我们可以自己模拟一下这个过程

1. 在根目录下创建一个/META-INF/services/javax.servlet.ServletContainerInitializer这个文件,里面写com.bafan.spring.web.test.BafanServletContainerInitializer
2. 
@HandlesTypes(A.class)
public class BafanServletContainerInitializer implements ServletContainerInitializer {

    @Override
    public void onStartup(Set<Class<?>> set, ServletContext servletContext) throws ServletException {
        System.out.println("执行了");
    }

}
3. 启动tomcat,这时候set会传进来B和C(都实现了A这个接口)。

PS:

在代码中引入
<dependency>
    <groupId>org.apache.tomcat</groupId>
    <artifactId>tomcat-catalina</artifactId>
    <version>8.5.43</version>
</dependency>
<dependency>
    <groupId>org.apache.tomcat.embed</groupId>
    <artifactId>tomcat-embed-jasper</artifactId>
    <version>8.5.45</version>
</dependency>

/**
 * 如何使用一个jar包的方式用main方法来启动tomcat
 */
public class TomcatServer {

    public static void main(String[] args) {
        Tomcat tomcat = new Tomcat();
        tomcat.setPort(8080);
        tomcat.addWebapp("/", "/Users/maxiaojun/bafan/tomcat");
        try {
            tomcat.start();
            tomcat.getServer().await();
        } catch (LifecycleException e) {
            e.printStackTrace();
        }
    }

}
这样就可以在代码中使用一个方法来启动tomcat,感觉很高大尚。

一个mvc项目,如果什么都不配置的话

@RequestMapping("/query.do")
@ResponseBody
public Map<String, String> query() {
    System.out.println("query controller");
    Map<String, String> map = new HashMap<String, String>();
    map.put("xxx", "xxxx");
    return map;
}
这行代码会报500的错误,因为mvc默认不知道咋对Map(对象也一样)进行解析,所以需要我们配置一下,告诉mvc要用fastjson来解析
@Configuration
@ComponentScan("com.bafan.spring.web")
@EnableWebMvc
public class AppConfig implements WebMvcConfigurer {

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(new FastJsonHttpMessageConverter());
    }

}
实现WebMvcConfigurer,重写configureMessageConverters方法,然后加一下fastjson解析器就ok了。

思考方式:

  1. tomcat启动的时候是怎么初始化的spring环境?
  2. tomcat初始化web环境的时候有哪些比较重要的配置?
  3. 为什么实现了WebApplicationInitializer之后,里面的onStartUp方法就能别调用到?
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,236评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,867评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,715评论 0 340
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,899评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,895评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,733评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,085评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,722评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,025评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,696评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,816评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,447评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,057评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,254评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,204评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,561评论 2 343

推荐阅读更多精彩内容