Java - servlet 3.0

概述

web 三大组件：servlet、filter、listener。
servlet 3.0 之前需要在 web.xml 中配置
比如集成 SSM 框架时：SpringMVC 的 DispatcherServlet 需要在 web.xml 中配置、Spring 的 ContextLoadListener 也需要在 web.xml 中配置

servlet 3.0 标准以后，为我们提供了注解的方式来配置上面提到的 web 相关的组件，并且提供了运行时的可插拔插件能力

servlet 3.0 属于 jsr 315 系列的规范，需要 tomcat 7.0 以上的支持：

jsr，是Java Specification Requests的缩写，意思是Java规范提案，是指向 JCP(Java Community Process) 提出新增一个标准化技术规范的正式请求。

注解

在第 8 章节（Annotations and pluggability）中，提供了一系列的注解来完成以前的手动编码操作，比如注册一个 servlet：

• servlet 3.0 以前需要在 web.xml 中配置路径映射：

<servlet>
	<servlet-name>HelloServlet</servlet-name>
	<servlet-class>com.hoticket.servlet.HelloServlet</servlet-class>
</servlet>

<servlet-mapping>
	<servlet-name>HelloServlet</servlet-name>
	<url-pattern>/hello</url-pattern>
</servlet-mapping>

配置初始化参数：

<servlet>
	<servlet-name>HelloServlet</servlet-name>
	<servlet-class>com.hoticket.servlet.HelloServlet</servlet-class>
	<init-param>
		<param-name>message</param-name>
		<param-value>hello world</param-value>
	</init-param>
</servlet>

通过 getServletConfig().getInitParameter("message") 获得参数名对应的值。

• servlet 3.0 之后，使用注解 @WebServlet 即可完成上面的配置

@WebServlet(value = "/hello", initParams = {
        @WebInitParam(name = "message", value = "hello world")
})
public class HelloServlet extends HttpServlet {
	...
}

对应的配置 listeners、filters 也有相应的注解 @WebListener、@WebFilter

ServletContainerInitializer

在 servlet 3.0 规范的 8.2.4 章节（Shared libraries / runtimes pluggability）中，我们知道在容器/应用启动的时候会去扫描当前应用里面的每一个 jar 包的 ServletContainerInitializer 的实现，这个实现必须绑定在 META-INF/services 目录下的一个叫做 javax.servlet.ServletContainerInitializer 的文件，文件内容就是 ServletContainerInitializer 的实现类的全类名。

除了 ServletContainerInitializer 我们还可以添加一个注解 HandlesTypes。这个注解添加到 ServletContainerInitializer 的实现类上用于显式的表示感兴趣的类，注解的 value 中指定类的子类或者实现类会包含。当调用 onStartup 方法的时候，会把这些感兴趣的类作为参数传进去。

• 这里我们定义几个类：

public interface HelloService {
}

// 子类
public interface HelloServiceExt extends HelloService {
}

// 抽象类
public abstract class AbstractHelloService implements HelloService {
}

// 实现类
public class HelloServiceImpl implements HelloService {
}

在 @HandlesTypes 注解中传入 HelloService 接口：

/**
 * 按上述规则，加入到类路径下
 */
@HandlesTypes(value = {HelloService.class})
public class MyServletContainerInitializer implements ServletContainerInitializer {

    /**
     * 应用启动的时候会加载运行
     *
     * @param c		集合中的类就是上面 @HandlesTypes 中指定类的子类或实现类
     * @param ctx 	当前 web 应用的 ServletContext
     * @throws ServletException
     */
    @Override
    public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException {
		for (Class<?> clazz : c) {
            System.out.println(clazz);
        }
    }
}

项目结构如下：

控制台输出（不包含注解中指定的类）：

class com.hoticket.servlet.service.AbstractHelloService
interface com.hoticket.servlet.service.HelloServiceExt
class com.hoticket.servlet.service.HelloServiceImpl

使用 ServletContext 注册三大组件

• 定义 servlet

public class UserServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.setCharacterEncoding("UTF-8");
        resp.getWriter().write("userServlet");
    }
}

• 定义 filter

public class UserFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("userFilter");
        chain.doFilter(request, response);
    }

    @Override
    public void destroy() {

    }
}

• 定义 listener

public class UserListener implements ServletContextListener {

    /**
     * 监听 ServletContext 的初始化
     * @param sce
     */
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("ServletContext init");
    }

    /**
     * 监听 ServletContext 的销毁
     * @param sce
     */
    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("ServletContext destroy");
    }
}

• 运行时插件化能力：ServletContainerInitializer

public class MyServletContainerInitializer implements ServletContainerInitializer {

    /**
     * 应用启动的时候会加载运行
     *
     * @param c
     * @param ctx 当前 web 应用的 ServletContext
     * @throws ServletException
     */
    @Override
    public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException {

        // 注册 servlet
        ServletRegistration.Dynamic userServlet = ctx.addServlet("userServlet", UserServlet.class);
        userServlet.addMapping("/user");

        // 注册 listener
        ctx.addListener(UserListener.class);

        // 注册 filter
        FilterRegistration.Dynamic userFilter = ctx.addFilter("userFilter", UserFilter.class);
        userFilter.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), true, "/*");
    }
}

启动项目，即可在控制台看到输出：

// 项目启动输出
ServletContext init
// 请求 /user 输出，因为上面添加 filter 映射的时候配置了在请求之后也匹配，所以会打印两次
userFilter
userFilter
// 停止项目输出
ServletContext destroy

在两个地方可以获得 ServletContext，一个是 ServletContainerInitializer 中的 onStartUp 方法，一个是 ServletContextListener 中的 contextInitialized 时。

Registration

ServletRegistration

FilterRegistration