Servlet3与Servlet4

短命女 2022-03-10 12:44 213阅读 0赞

# Servlet3 #

## Servlet 3.0 新特性 ##

*  异步处理支持：有了该特性，Servlet 线程不再需要一直阻塞，直到业务处理完毕才能再输出响应，最后才结束该 Servlet 线程。在接收到请求之后，Servlet 线程可以将耗时的操作委派给另一个线程来完成，自己在不生成响应的情况下返回至容器。针对业务处理较耗时的情况，这将大大减少服务器资源的占用，并且提高并发处理速度。
 *  新增的注解支持：该版本新增了若干注解，用于简化 Servlet、过滤器（Filter）和监听器（Listener）的声明，这使得 web.xml 部署描述文件从该版本开始不再是必选的了。
 *  可插性支持：熟悉 Struts2 的开发者一定会对其通过插件的方式与包括 Spring 在内的各种常用框架的整合特性记忆犹新。将相应的插件封装成 JAR 包并放在类路径下，Struts2 运行时便能自动加载这些插件。现在 Servlet 3.0 提供了类似的特性，开发者可以通过插件的方式很方便的扩充已有 Web 应用的功能，而不需要修改原有的应用

## 消息异步 ##

Servlet 3.0 之前，一个普通 Servlet 的主要工作流程大致如下：

1.  Servlet 接收到请求之后，可能需要对请求携带的数据进行一些预处理
2.  调用业务接口的某些方法，以完成业务处理；
3.  最后，根据处理的结果提交响应，Servlet 线程结束。

Servlet2.x详细说明：

其中第二步的业务处理通常是最耗时的，这主要体现在数据库操作，以及其它的跨网络调用等，在此过程中，Servlet 线程一直处于阻塞状态，直到业务方法执行完毕。在处理业务的过程中，Servlet 资源一直被占用而得不到释放，对于并发较大的应用，这有可能造成性能的瓶颈。对此，在以前通常是采用私有解决方案来提前结束 Servlet 线程，并及时释放资源。

Servlet3优化改进：

1.  Servlet 接收到请求之后，可能首先需要对请求携带的数据进行一些预处理
2.  接着，Servlet 线程将请求转交给一个异步线程来执行业务处理，线程本身返回至容器，此时 Servlet 还没有生成响应数据，异步线程处理完业务以后，可以直接生成响应数据（异步线程拥有 ServletRequest 和 ServletResponse 对象的引用），或者将请求继续转发给其它 Servlet。如此一来， Servlet 线程不再是一直处于阻塞状态以等待业务逻辑的处理，而是启动异步线程之后可以立即返回。

**web.xml**  
servlet3为filter和servlet增加了异步支持标签，`<async-supported>`，默认是false，需要手动开启

<servlet> 
        <servlet-name>DemoServlet</servlet-name> 
        <servlet-class>footmark.servlet.Demo Servlet</servlet-class> 
        <async-supported>true</async-supported> 
    </servlet>

**注解**  
注解增加了属性`asyncSupported`支持异步

@WebFilter(urlPatterns = "/demo",asyncSupported = true) 
    public class DemoFilter implements Filter{...}

异步Demo如下：

@WebServlet(urlPatterns = "/demo", asyncSupported = true)
    public class AsyncDemoServlet extends HttpServlet { 
        @Override
        public void doGet(HttpServletRequest req, HttpServletResponse resp)
        throws IOException, ServletException { 
            resp.setContentType("text/html;charset=UTF-8");
            PrintWriter out = resp.getWriter();
            out.println("进入Servlet的时间：" + new Date() + ".");
            out.flush();
     
            //在子线程中执行业务调用，并由其负责输出响应，主线程退出
            AsyncContext ctx = req.startAsync();
            new Thread(new Executor(ctx)).start();
     
            out.println("结束Servlet的时间：" + new Date() + ".");
            out.flush();
        }
    }
     
    public class Executor implements Runnable { 
        private AsyncContext ctx = null;
        public Executor(AsyncContext ctx){ 
            this.ctx = ctx;
        }
     
        public void run(){ 
            try { 
                //等待十秒钟，以模拟业务方法的执行
                Thread.sleep(10000);
                PrintWriter out = ctx.getResponse().getWriter();
                out.println("业务处理完毕的时间：" + new Date() + ".");
                out.flush();
                ctx.complete();	//告诉context，这个子线程完毕
            } catch (Exception e) { 
                e.printStackTrace();
            }
        }
    }

为了监听异步事件，Servlet3提供了`AsyncListener`事件监听器

1.  异步线程开始时，调用 AsyncListener 的 `onStartAsync(AsyncEvent event)`方法；
2.  异步线程出错时，调用 AsyncListener 的 `onError(AsyncEvent event)`方法；
3.  异步线程执行超时，则调用 AsyncListener 的 `onTimeout(AsyncEvent event)`方法；
4.  异步执行完毕时，调用 AsyncListener 的 `onComplete(AsyncEvent event)` 方法；

要注册一个 AsyncListener，只需将准备好的 AsyncListener 对象传递给 AsyncContext 对象的 addListener() 方法即可

AsyncContext ctx = req.startAsync(); 
    ctx.addListener(new AsyncListener() {  
        public void onComplete(AsyncEvent asyncEvent) throws IOException {  
            // 做一些业务操作
        } 
        ... 
    });

## 注解支持 ##

### @WebServlet ###

@WebServlet 用于将一个类声明为 Servlet，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为 Servlet。该注解具有下表给出的一些常用属性（以下所有属性均为可选属性，但是 vlaue 或者 urlPatterns 通常是必需的，且二者不能共存，如果同时指定，通常是忽略 value 的取值）：

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th>类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>name</td> 
   <td>String</td> 
   <td>指定 Servlet 的 name 属性，等价于 <code>&lt;servlet-name&gt;</code>。如果没有显式指定，则该 Servlet 的取值即为类的全限定名。</td> 
  </tr> 
  <tr> 
   <td>value</td> 
   <td>String[]</td> 
   <td>该属性等价于 urlPatterns 属性。两个属性不能同时使用。</td> 
  </tr> 
  <tr> 
   <td>urlPatterns</td> 
   <td>String[]</td> 
   <td>指定一组 Servlet 的 URL 匹配模式。等价于<code>&lt;url-pattern&gt;</code>标签。</td> 
  </tr> 
  <tr> 
   <td>loadOnStartup</td> 
   <td>int</td> 
   <td>指定 Servlet 的加载顺序，等价于 <code>&lt;load-on-startup&gt;</code> 标签。</td> 
  </tr> 
  <tr> 
   <td>initParams</td> 
   <td>WebInitParam[]</td> 
   <td>指定一组 Servlet 初始化参数，等价于 <code>&lt;init-param&gt;</code> 标签。</td> 
  </tr> 
  <tr> 
   <td>asyncSupported</td> 
   <td>boolean</td> 
   <td>声明 Servlet 是否支持异步操作模式，等价于 <code>&lt;async-supported&gt;</code> 标签。</td> 
  </tr> 
  <tr> 
   <td>description</td> 
   <td>String</td> 
   <td>该 Servlet 的描述信息，等价于 <code>&lt;description&gt;</code> 标签。</td> 
  </tr> 
  <tr> 
   <td>displayName</td> 
   <td>String</td> 
   <td>该 Servlet 的显示名，通常配合工具使用，等价于<code>&lt;display-name&gt;</code>标签。</td> 
  </tr> 
 </tbody> 
</table>

监听使用如下：

@WebServlet(urlPatterns = { "/simple"}, asyncSupported = true, 
    loadOnStartup = -1, name = "SimpleServlet", displayName = "ss", 
    initParams = { @WebInitParam(name = "username", value = "tom")} 
    ) 
    public class SimpleServlet extends HttpServlet{  … }

### @WebInitParam ###

该注解通常不单独使用，而是配合 @WebServlet 或者 @WebFilter 使用。它的作用是为 Servlet 或者过滤器指定初始化参数，这等价于 web.xml 中 和 的 子标签。@WebInitParam 具有下表给出的一些常用属性：

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th>类型</th> 
   <th>是否可选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>name</td> 
   <td>String</td> 
   <td>否</td> 
   <td>指定参数的名字，等价于<code>&lt;param-name&gt;</code>。</td> 
  </tr> 
  <tr> 
   <td>value</td> 
   <td>String</td> 
   <td>否</td> 
   <td>指定参数的值，等价于<code>&lt;param-value&gt;</code>。</td> 
  </tr> 
  <tr> 
   <td>description</td> 
   <td>String</td> 
   <td>是</td> 
   <td>关于参数的描述，等价于 <code>&lt;description&gt;</code>。</td> 
  </tr> 
 </tbody> 
</table>

### @WebFilter ###

@WebFilter 用于将一个类声明为过滤器，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为过滤器。该注解具有下表给出的一些常用属性 ( 以下所有属性均为可选属性，但是 value、urlPatterns、servletNames 三者必需至少包含一个，且 value 和 urlPatterns 不能共存，如果同时指定，通常忽略 value 的取值 )：

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th>类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>filterName</td> 
   <td>String</td> 
   <td>指定过滤器的 name 属性，等价于 <code>&lt;filter-name&gt;</code></td> 
  </tr> 
  <tr> 
   <td>value</td> 
   <td>String[]</td> 
   <td>该属性等价于 urlPatterns 属性。但是两者不应该同时使用。</td> 
  </tr> 
  <tr> 
   <td>urlPatterns</td> 
   <td>String[]</td> 
   <td>指定一组过滤器的 URL 匹配模式。等价于<code>&lt;url-pattern&gt;</code>标签。</td> 
  </tr> 
  <tr> 
   <td>servletNames</td> 
   <td>String[]</td> 
   <td>指定过滤器将应用于哪些 Servlet。取值是 @WebServlet 中的 name 属性的取值，或者是web.xml 中<code>&lt;servlet-name&gt;</code> 的取值。</td> 
  </tr> 
  <tr> 
   <td>dispatcherTypes</td> 
   <td>DispatcherType</td> 
   <td>指定过滤器的转发模式。具体取值包括：ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。</td> 
  </tr> 
  <tr> 
   <td>initParams</td> 
   <td>WebInitParam[]</td> 
   <td>指定一组过滤器初始化参数，等价于 <code>&lt;init-param&gt;</code>标签。</td> 
  </tr> 
  <tr> 
   <td>asyncSupported</td> 
   <td>boolean</td> 
   <td>声明过滤器是否支持异步操作模式，等价于<code>&lt;async-supported&gt;</code> 标签。</td> 
  </tr> 
  <tr> 
   <td>description</td> 
   <td>String</td> 
   <td>该过滤器的描述信息，等价于 <code>&lt;description&gt;</code>标签。</td> 
  </tr> 
  <tr> 
   <td>displayName</td> 
   <td>String</td> 
   <td>该过滤器的显示名，通常配合工具使用，等价于 <code>&lt;display-name&gt;</code>标签。</td> 
  </tr> 
 </tbody> 
</table>

### @WebListener ###

该注解用于将类声明为监听器，被 @WebListener 标注的类必须实现以下至少一个接口：

*  ServletContextListener
 *  ServletContextAttributeListener
 *  ServletRequestListener
 *  ServletRequestAttributeListener
 *  HttpSessionListener
 *  HttpSessionAttributeListener

这个接口只有一个默认`value`属性  
一个简单示例如下：

@WebListener("This is only a demo listener") 
    public class SimpleListener implements ServletContextListener{ ...}

如此，则不需要在 web.xml 中配置`<listener>` 标签了。它等价的 web.xml 中的配置形式如下：

<listener> 
        <listener-class>footmark.servlet.SimpleListener</listener-class> 
    </listener>

### @MultipartConfig ###

该注解主要是为了辅助 Servlet 3.0 中 HttpServletRequest 提供的对上传文件的支持。该注解标注在 Servlet 上面，以表示该 Servlet 希望处理的请求的 MIME 类型是 multipart/form-data。另外，它还提供了若干属性用于简化对上传文件的处理。具体如下：

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th>类型</th> 
   <th>是否可选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>fileSizeThreshold</td> 
   <td>int</td> 
   <td>是</td> 
   <td>当数据量大于该值时，内容将被写入文件。</td> 
  </tr> 
  <tr> 
   <td>location</td> 
   <td>String</td> 
   <td>是</td> 
   <td>存放生成的文件地址。</td> 
  </tr> 
  <tr> 
   <td>maxFileSize</td> 
   <td>long</td> 
   <td>是</td> 
   <td>允许上传的文件最大值。默认值为 -1，表示没有限制。</td> 
  </tr> 
  <tr> 
   <td>maxRequestSize</td> 
   <td>long</td> 
   <td>是</td> 
   <td>针对该 multipart/form-data 请求的最大数量，默认值为 -1，表示没有限制。</td> 
  </tr> 
 </tbody> 
</table>

## 可插性支持 ##

Servlet 3.0 引入了称之为“Web 模块部署描述符片段”的 web-fragment.xml 部署描述文件，该文件必须存放在 JAR 文件的 META-INF 目录下，该部署描述文件可以包含一切可以在 web.xml 中定义的内容。JAR 包通常放在 WEB-INF/lib 目录下，除此之外，所有该模块使用的资源，包括 class 文件、配置文件等，只需要能够被容器的类加载器链加载的路径上，比如 classes 目录等。

*  编写一个类继承自 HttpServlet，将该类放在 classes 目录下的对应包结构中，修改 web.xml，在其中增加一个 Servlet 声明。这是最原始的方式；
 *  编写一个类继承自 HttpServlet，并且在该类上使用 @WebServlet 注解将该类声明为 Servlet，将该类放在 classes 目录下的对应包结构中，无需修改 web.xml 文件。
 *  编写一个类继承自 HttpServlet，将该类打成 JAR 包，并且在 JAR 包的 META-INF 目录下放置一个 web-fragment.xml 文件，该文件中声明了相应的 Servlet 配置。

<?xml version="1.0" encoding="UTF-8"?>
    <web-fragment xmlns=http://java.sun.com/xml/ns/javaee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="3.0" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-fragment_3_0.xsd" metadata-complete="true">
        <servlet>
            <servlet-name>fragment</servlet-name>
            <servlet-class>footmark.servlet.FragmentServlet</servlet-class>
        </servlet>
        <servlet-mapping>
            <servlet-name>fragment</servlet-name>
            <url-pattern>/fragment</url-pattern>
        </servlet-mapping>
    </web-fragment>

web-fragment.xml 包含了两个可选的顶层标签， 和 ，如果希望为当前的文件指定明确的加载顺序，通常需要使用这两个标签， 主要用于标识当前的文件，而 则用于指定先后顺序。

<web-fragment...>
        <name>FragmentA</name>
        <ordering>
            <after>
                <name>FragmentB</name>
                <name>FragmentC</name>
            </after>
        <before>
            <others/>
        </before>
        </ordering>
        ...
    </web-fragment>

## ServletContext 的性能增强 ##

该对象支持在运行时动态部署 Servlet、过滤器、监听器，以及为 Servlet 和过滤器增加 URL 映射等。以 Servlet 为例，过滤器与监听器与之类似。ServletContext 为动态配置 Servlet 增加了如下方法：

*  ServletRegistration.Dynamic addServlet(String servletName,Class<? extends Servlet> servletClass)
 *  ServletRegistration.Dynamic addServlet(String servletName, Servlet servlet)
 *  ServletRegistration.Dynamic addServlet(String servletName, String className)
 *  <T extends Servlet> T createServlet(Class clazz)
 *  ServletRegistration getServletRegistration(String servletName)
 *  Map<String,? extends ServletRegistration> getServletRegistrations()

其中前三个方法的作用是相同的，只是参数类型不同而已；通过 createServlet() 方法创建的 Servlet，通常需要做一些自定义的配置，然后使用 addServlet() 方法来将其动态注册为一个可以用于服务的 Servlet。两个 getServletRegistration() 方法主要用于动态为 Servlet 增加映射信息，这等价于在 web.xml( 抑或 web-fragment.xml) 中使用 <servlet-mapping> 标签为存在的 Servlet 增加映射信息。

以上 ServletContext 新增的方法要么是在 ServletContextListener 的 contexInitialized 方法中调用，要么是在 ServletContainerInitializer 的 onStartup() 方法中调用。

ServletContainerInitializer 也是 Servlet 3.0 新增的一个接口，容器在启动时使用 JAR 服务 API(JAR Service API) 来发现 ServletContainerInitializer 的实现类，并且容器将 WEB-INF/lib 目录下 JAR 包中的类都交给该类的 onStartup() 方法处理，我们通常需要在该实现类上使用 @HandlesTypes 注解来指定希望被处理的类，过滤掉不希望给 onStartup() 处理的类。

## HttpServletRequest 对文件上传的支持 ##

之前上次文件必须借助第三方jar来实现，比如Apache的IO包  
Servlet 3.0 已经提供了这个功能，而且使用也非常简单。

*  Part getPart(String name)
 *  Collection getParts()

前者用于获取请求中给定 name 的文件，后者用于获取所有的文件。每一个文件用一个 javax.servlet.http.Part 对象来表示。该接口提供了处理文件的简易方法，比如 write()、delete() 等。至此，结合 HttpServletRequest 和 Part 来保存上传的文件变得非常简单，如下所示：

Part photo = request.getPart("photo"); 
    photo.write("/tmp/photo.jpg"); 
    // 可以将两行代码简化为 request.getPart("photo").write("/tmp/photo.jpg") 一行。

开发者可以配合前面提到的 @MultipartConfig 注解来对上传操作进行一些自定义的配置，比如限制上传文件的大小，以及保存文件的路径等。

# Servlet4 #

Servlet 4.0 的主要新功能为服务器推送和全新 API，该 API 可在运行时发现 servlet 的 URL 映射。

服务器推送是最直观的 HTTP/2 强化功能，通过 PushBuilder 接口在 servlet 中公开。服务器推送功能还在 JavaServer Faces API 中实现，并在 RenderResponsePhase 生命周期内调用，以便 JSF 页面可以利用其增强性能。

全新 servlet 映射发现接口 HttpServletMapping 使框架能够获取有关激活给定 servlet 请求的 URL 信息。这可能对框架尤为有用，这些框架需要这一信息来运行内部工作。

在接下来的部分，我将概述服务器推送及其如何在 Java servlet 中运行，包括 JSF 2.3 中的服务器推送。我还将展示一个交换示例，重点介绍全新 servlet 映射发现功能。

## 服务器推送 ##

服务器推送使服务器能预测客户端请求的资源需求。然后，在完成请求处理之前，它可以将这些资源发送到客户端。

要了解服务器推送的好处，可以考虑一个包含图像和其他依赖项（比如 CSS 和 JavaScript 文件）的网页。客户端发出一个针对该网页的请求。服务器然后分析所请求的页面，确定呈现它所需的资源，并主动将这些资源发送到客户端的缓存。

在执行所有这些操作的同时，服务器仍在处理原始网页请求。客户端收到响应时，它需要的资源已经位于缓存中。

### PushBuilder ###

多数来自原始 HttpServletRequest 实例的请求标头，只添加到 PushBuilder 实例中。由于正确运行服务器推送并不需要某些标头，因此不包括以下标头：

*  条件标头
 *  Range 标头
 *  Expect 标头
 *  Authorization 标头
 *  Referrer 标头

@Override
    protected void doGet(HttpServletRequest request, 
                         HttpServletResponse response) 
                         throws ServletException, IOException { 
     
       PushBuilder pushBuilder = request.newPushBuilder();
     
    }

设置推送资源并推送

PushBuilder pushBuilder = request.newPushBuilder();
     
    if (pushBuilder != null) { 
       pushBuilder.path("images/hero-banner.jpg").push();
       pushBuilder.path("css/menu.css").push();
       pushBuilder.path("js/marquee.js").push();
    }

## HttpServletMapping 接口 ##

Servlet 4.0 的全新 servlet 映射发现 API 使服务器能够对 URL（可调用 servlet）执行运行时检查。例如，对 file.ext, /path 和 /path/file.ext 的请求将通过 URL 模式 /path/\* 和 \*.ext 激活 servlet。

*  getMatchValue() 返回部分 URI 路径，该路径会导致请求匹配。
 *  getPattern() 返回 URL 模式的 String 表示形式。
 *  getServletName() 返回 servlet 名称的 String 表示形式。
 *  getMappingMatch() 返回匹配的类型，表示为 MappingMatch 枚举值，该枚举值将为以下值之一`CONTEXT_ROOT`、`DEFAULT、EXACT`、`EXTENSION` 或 `PATH`。

运行时映射发现：

@WebServlet({ "/path/*", "*.ext"})
    public class ServletMapping extends HttpServlet { 
     
        protected void doGet(HttpServletRequest request,
                             HttpServletResponse response) 
                             throws IOException { 
     
            HttpServletMapping mapping = request.getHttpServletMapping();
            String mapping = mapping.getMappingMatch().name();
            String value = mapping.getMatchValue();
            String pattern = mapping.getPattern();
            String servletName = mapping.getServletName();
       }
     
    }

## 细微重构变化 ##

*  Trailer 响应标头支持发送方在分块消息的末尾包含额外字段。这用于提供在发送消息主体时可能会动态生成的元数据，例如，消息完整性检查、数字签名或后期处理状态。
 *  Servlet 4.0 添加了 GenericFilter 和 HttpFilter 抽象类，这些抽象类通过最低限度地实现生命周期方法 init() 和 destroy()，简化了编写过滤器。
 *  Servlet 4.0 还集成了全新的 HTTP Trailer，支持发送方在分块消息的末尾包含额外的字段。

> ServletContext 接口采用了一些新方法：  
> addJspFile() 可将带有给定 JSP 文件的 servlet 添加到 servlet 上下文中。  
> getSessionTimeout() 和 setSessionTimeout() 可提供对会话超时的访问权限。  
> getRequestCharacterEncoding() 和 setRequestCharacterEncoding() 可为当前的 servlet 上下文提供访问权限，并改变默认的请求字符编码。

*  HttpServletRequest 接口上的 isRequestedSessionIdFromUrl() 方法已被弃用。  
    由于升级到 Java SE 8，默认方法已被添加到侦听器接口中。