SpringMVC源码-免配置原理解析

[toc]

Servlet简单的介绍

Servlet是sun公司提供的一门用于开发动态web资源的技术。
　　Sun公司在其API中提供了一个servlet接口，用户若想用发一个动态web资源(即开发一个Java程序向浏览器输出数据)，需要完成以下2个步骤：
　　1. 编写一个Java类，实现servlet接口。
　　2. 把开发好的Java类部署到web服务器中。
　　按照一种约定俗成的称呼习惯，通常我们也把实现了servlet接口的java程序，称之为Servlet

Servlet与SpringMVC关系

SpringMVC是基于Servlet封装的MVC框架

建立传统web项目

1. 选择webapp

1.png

2.创建的mavenweb工厂 发现没有java目录，则创建java目录

2.png 3.png

3. 相关Servlet配置信息

1）基于XML方式

定义一个servlet类

public class MyServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.getWriter().print(" this is MyServlet");
    }
}

在web.xml中加入配置

<servlet>
    <servlet-name>MyServlet</servlet-name>
    <servlet-class>com.xxx.servlet.MyServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>MyServlet</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

2）基于注解方式

@WebServlet("/")
public class MyServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.getWriter().print(" this is MyServlet");
    }
}

4. ServletContainerInitializert配置

定义基类HandleType（SpringMVC默认使用WebApplicationInitializer）

public class MyHandlesType {
}

定义子类HandleType

public class SpringHandlesType extends MyHandlesType {
}

定义子类HandleType

public class PayHandlesType extends MyHandlesType {
}

Servlet初始化类（SpringMVC默认使用SpringServletContainerInitializer）

@HandlesTypes(value = MyHandlesType.class)
public class MyServletContainerInitializer implements ServletContainerInitializer {

    /**
     * @param set   获取到所有继承MyHandlesType所有子类型（也就是感兴趣类型）
     * @param servletContext
     * @throws ServletException
     */
    public void onStartup(Set<Class<?>> set, ServletContext servletContext) throws ServletException {
        // 1.打印所有感兴趣的类型
        for (Class<?> c : set) {
            System.out.println(c);
        }
        // 2.servletContext 手动注册过滤器、servlet、监听器
        // PayServlet为HttpServlet实现类
        ServletRegistration.Dynamic payServlet = servletContext.addServlet("payServlet", new PayServlet());
        payServlet.addMapping("/pay");
    }
}

5. 指定ServletContainerInitializer

1. 创建META-INF/services 目录
2. 在META-INF/services 目录创建文件javax.servlet.ServletContainerInitializer
3. javax.servlet.ServletContainerInitializer文件内容指定MyServletContainerInitializer包名+类名（例如：com.xxx.config.MyServletContainerInitializer）

建立无配置文件web项目

不需要定义自定HandleType、ServletContainerInitializer 和 HttpServlet实现类，因为spring-web的Jar中已经定义了，只需要让ServletContainerInitializer加载mvc配置、web配置，实现的方法就是

1）定义SpringMVC配置

@Configuration
@EnableWebMvc
@ComponentScan("com.xxx.controller")
public class MyMvcConfig {
    // @Configuration 当前类属于配置类，相当于XML
    // @EnableWebMvc 开启SpringMVC注解方式
    // @ComponentScan 指定扫包范围
}

2）定义web服务配置，代替web.xml

public class WebInitializer implements WebApplicationInitializer {
    public void onStartup(javax.servlet.ServletContext servletContext) throws ServletException {
        // 1.   创建SpringMVC容器
        AnnotationConfigWebApplicationContext app = new AnnotationConfigWebApplicationContext();
        // 2. 注册我们的配置文件
        app.register(MyMvcConfig.class);
        // 注册我们的
        DispatcherServlet dispatcherServlet = new DispatcherServlet(app);
        ServletRegistration.Dynamic dynamic = servletContext.addServlet("dispatcherServlet", dispatcherServlet);
        dynamic.addMapping("/");
        // 最优先启动
        dynamic.setLoadOnStartup(1);
    }
}

注意事项

问题1

注意：Servlet是单例的，是线程不安全的，每次请求到服务器中不会重新创建servlet实例。

@WebServlet("/")
public class MyServlet extends HttpServlet {
    private Integer count = 0;

    public MyServlet() {
        System.out.println("<<<MyServlet被实例化...>>>");
    }

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        count++;
        try {
            Thread.sleep(50);
        } catch (Exception e) {
        }
        resp.getWriter().print(" this is MyServlet  count:" + count);
    }
}

访问三次服务，输出的结果：

.......
<<<MyServlet被实例化...>>>
.......
this is MyServlet count:1
this is MyServlet count:2
this is MyServlet count:3

问题2

ServletContainerInitializer

1. 在web容器启动时为提供给第三方组件机会做一些初始化的工作，例如注册servlet或者filtes等，servlet规范中通过ServletContainerInitializer实现此功能。
2. 每个框架要使用ServletContainerInitializer就必须在对应的jar包的META-INF/services 目录创建一个名为javax.servlet.ServletContainerInitializer的文件，文件内容指定具体的ServletContainerInitializer实现类。
3. Servlet容器启动会扫描，当前应用里面每一个jar包的ServletContainerInitializer的实现

来源：蚂蚁课堂