Servlet 3.0简单介绍(转)+补充
作为web应用开发关键的Java API之一,Servlet规范自从诞生之日起,除了添加诸如过滤器和web应用事件之类的功能之外,它还鲜有任何重大的变革之举。然而,新的Servlet 3.0规范的发布将对开发人员构建Java web应用程序的方式产生重大的影响。
本文将向读者简要介绍Servlet 3.0中引入的各种新特性。然后,我们将通过示例代码详细讲解Servlet 3.0的过滤器和监听器的用法。同时,我们还将讨论如何将框架及其他程序库插入一个web应用中。 本文最后简要讨论Servlet 3.0对异步处理的支持,以及对现有API的重要改进之处。
一、Servlet 3.0新特性简述
Servlet 3.0规范为使用它的开发人员实现了以下目标:
- 简单性
- 减轻开发工作量
- 遵循web 2.0原则
为了使开发过程更加轻松,Servlet 3.0引入了注释。类似于EJB 3.1的改变,注释的引入使得web部署描述符web.xml成为可选项。
可插性
每当我们使用第三方框架如Struts、JSF或者Spring的时候,我们需要在web.xml中为相应的Servlet添加相应的条目,这使得web部署描述符变得繁琐并且难以维护。 Servlet 3.0中引入的可插性使得web应用程序更加模块化,也更加易于维护。由于可插性是通过web片段来实现的,所以它使得开发人员不必再在web.xml中建立太多的Servlet配置条目。
异步处理
新的Servlet规范中的另一项重大变化是支持异步处理,这对于AJAX应用程序来说是一个非常有用的特性。当Servlet创建发送请求的线程的时候,它通常必须等待诸如数据库或者消息连接等资源返回响应,之后它才能在这个线程中执行其他操作。异步处理通过允许线程执行其它的操作而避免了这样的阻塞式请求。
除了上面提到的特性之外,新规范还对现有的API做了改进处理,相关内容将在本文末尾部分进行详细介绍。
注意:为了运行使用Servlet 3.0开发的Servlet,我们的servlet 容器应该运行在Java SE 6或更高版本中。
内容导航
二、使用Servlet3.0的前提条件
1.使用servlet3.0新标准jar包
2.JDK必须在1.6以上版本
3.编译器的编译级别为6.0
4.在web.xml文件中,使用3.0规范
5.使用支持servlet3.0特性的wen容器,比如tomcat7
三、Servlet中的注释
Servlet 3.0中的重大革新之一是支持注释。通过使用注释定义Servlet和过滤器,就无需在web部署描述符(web.xml)中建立Servlet/过滤器条目了。
@WebServlet
为了在web应用中定义Servlet组件,我们可以使用@WebServlet。我们可以将其用于继承类javax.servlet.http.HttpServlet的类。注释@WebServlet具有许多属性。例如name、urlPatterns和initParams,我们可以通过它们来定义Servlet的行为。对于url模式,我们必须规定注释本身,或者规定注释的属性。
我们可以利用@WebServlet定义一个简单的Servlet,如下所示:
Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/
@WebServlet(name = "GetQuoteServlet", urlPatterns = {"/getquote"} )
public class GetQuoteServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
PrintWriter out = response.getWriter();
try {
String symbol = request.getParameter("symbol");
out.println("<h1>Stock Price is</h1>" +StockQuoteBean.getPrice(symbol);
} finally {
out.close();
}
}
}
public class StockQuoteBean {
private StockQuoteServiceEntity serviceEntity = new StockQuoteServiceEntity();
public double getPrice(String symbol) {
if(symbol !=null ) {
return serviceEntity.getPrice(symbol);
} else {
return 0.0;
}
}
}
我们可以修改这个Servlet,让它使用注释属性处理来自多个url的请求。
Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/
@WebServlet(name = "GetQuoteServlet", urlPatterns ={"/getquote", "/stockquote"} )
public class GetQuoteServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
PrintWriter out = response.getWriter();
try {
String symbol = request.getParameter("symbol");
out.println("<h1>Stock Price is</h1>" +StockQuoteBean.getPrice(symbol);
} finally {
out.close();
}
}
}
@WebFilter
我们可以使用注释@WebFilter来定义过滤器。这个注释还具有可选参数。我们可以在任何实现了javax.servlet.Filter接口的类上使用@WebFilter。类似于@WebServlet注释,我们也必须为这个注释指定url模式。
Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/
@WebFilter(filterName = "AuthenticateFilter", urlPatterns = {"/stock.jsp","/getquote"})
public class AuthenticateFilter implements Filter {
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
String username = ((HttpServletRequest) request).getParameter("uname");
String password = ((HttpServletRequest) request).getParameter("password");
if (username == null || password == null) {
((HttpServletResponse) response).sendRedirect("index.jsp"); }
if (username.equals("admin") && password.equals("admin")) {
chain.doFilter(request, response); }
else {
((HttpServletResponse) response).sendRedirect("index.jsp"); }
}
public void destroy() {
}
public void init(FilterConfig filterConfig) {
}
}
@WebInitParam
我们可以使用注释@WebInitParam把init参数指定为Servlet或者过滤器。另外,我们还可以使用注释@WebFilter和@WebServlet 的initParam属性来规定init参数。
Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/
@WebServlet(name = "GetQuoteServlet", urlPatterns = {"/getquote"})
@WebInitParam(name = "default_market", value = "NASDAQ")
public class GetQuoteServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
response.setContentType("text/html;charset=UTF-8");
PrintWriter out = response.getWriter();
try {
String market = getInitParameter("default_market");
String symbol = request.getParameter("symbol");
out.println("<h1>Stock Price in " + market + " is</h1>" +StockQuoteBean.getPrice(symbol, market));
} finally {
out.close();
}
}
}
下面是一个将注释@WebInitParam用作@WebServlet和@WebFilter initParams 属性的一部分的例子:
Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/
@WebServlet(name = "GetQuoteServlet",
urlPatterns = {"/getquote"},
initParams={@WebInitParam(name="default_market", value="NASDAQ")}
)
public class GetQuoteServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
response.setContentType("text/html;charset=UTF-8");
PrintWriter out = response.getWriter();
try {
String market = getInitParameter("default_market");
String symbol = request.getParameter("symbol");
out.println("<h1>Stock Price in " + market + " is</h1>" +StockQuoteBean.getPrice(symbol, market));
} finally {
out.close();
}
}
}
@WebListener
我们可以将注释@WebListener用于充当给定web应用上下文中各种web应用事件的监听器的类。我们可以使用@WebListener来标注一个实现ServletContextListener、ServletContextAttributeListener、ServletRequestListener、ServletRequestAttributeListener、HttpSessionListener和HttpSessionAttributeListener的类。下面是一个使用ServletContextListener的例子:
Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/
@WebListener
public class QuoteServletContextListener implements ServletContextListener {
public void contextInitialized(ServletContextEvent sce) {
ServletContext context = sce.getServletContext();
context.setInitParameter(“default_market”, “NASDAQ”);
}
public void contextDestroyed(ServletContextEvent sce) {
}
}
@MultipartConfig
使用注释@MultipartConfig可以为Servlet指定多部分组成的MIME类型请求。MIME附件是从该请求对象中读取的。
内容导航
四、元数据和通用注释
除了上面描述的特定于Servlet的注释之外,Servlet 3.0还支持所有定义为JSR 175(Java元数据规范)和JSR 250(用于Java平台通用注释) 的一部分的注释,包括:
- 与安全有关的注释,诸如@DeclareRoles 和@RolesAllowed
- 使用EJB的注释,诸如@EJB和@EJBs
- 用于资源注入的注释,诸如@resource和@Resources
- 使用JPA的注释,诸如@PersistenceContext、@PersistenceContexts、@PersistenceUnit和@PersistenceUnits
- 生命周期注释,诸如@PostConstruct 和@PreDestroy
- 提供web服务索引的注释,诸如@WebServiceRef 和@WebServiceRefs
五、注释,还是web.xml?
注释的引入使得web部署描述符(web.xml)成为配置web组件时的可选项,而非强制性的。然而,如果您必须对配置进行修改或者更新的话,您可能仍然会使用部署描述符。容器将根据描述符web.xml中的metadata-complete元素的值来决定使用web.xml或者注释。如果该属性的值为true,那么容器就不会处理注释和web片段;部署描述符是所有的元数据信息的唯一来源。只有当该元素metadata-complete不存在或其值不为true时才,容器才会处理注释和web片段。
内容导航
六、针对Web框架的可插性
就像前面所说的那样,Servlet 3.0的某些改进使得我们可以将框架和程序库插入一个web应用。这个特性减少了配置的数量,并为web应用程序提供了更好的模块性。 Servlet 3.0是通过web模块部署描述符片段(或者简称web片段)来实现可插性的。
Web片段是框架JAR的META-INF目录中的web.xml文件的一部分。web片段提供了web应用的逻辑划分,而不必编辑特定框架组件的web部署描述符。
用于web片段的元素(标签)跟用于部署描述符的元素(标签)几乎完全一样,只是根元素(父标签)除外。Web片段的根元素应该为web-fragment,并且该文件应该名为web-fragment.xml。容器只会从WEB-INF\lib文件夹中的JAR文件中查找web-fragment.xml文件。 如果lib目录中的JAR文件含有任何web-fragment.xml文件,容器将加载所需的类,并进行处理。
恰如Servlet名称应该在给定web.xml文件中保持唯一性一样,web片段也应如此。此外,Servlet名称必须在整个web应用中保持唯一,包括web.xml连同其他一切web片段。
作为一个例子,以下web-fragment.xml将被放到框架的jars\META-INF目录中:
Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/
web-fragment.xml
<web-fragment>
<servlet>
<servlet-name>ControllerServlet</servlet-name>
<servlet-class>com.app.control.ControllerServlet</servlet-class>
</servlet>
<listener>
<listener-class>com.listener.AppServletContextListener</listener-class>
</listener>
</web-fragment>
框架的JAR 文件被放置于WEB-INF\lib文件夹下面。Servlet 3.0规范没有定义web-fragment.xml和注释的配置顺序,不过它定义了web.xml和web-fragment.xml的配置次序,如下所示:
1. 绝对顺序
2. 相对顺序
图 1. Servlet 3.0中的绝对顺序:您可以利用web.xml文件中的元素来实现绝对顺序
您可以利用web.xml文件中的元素来实现绝对顺序,如图1所示。这个元素具有一个子元素,它可以用来规定web片段的名称,并且按照web片段的绝对顺序进行处理。如果多个web片段具有相同的名称,容器会忽略重复的web片段。
Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/
web.xml
<web-app>
<name>DemoApp</name>
<absolute-ordering>
<name>WebFragment1</name>
<name>WebFragment2</name>
</absolute-ordering>
...
</web-app>
图 2. Servlet 3.0中的相对顺序:您可以利用web-fragment.xml文件中的元素来实现相对顺序
您可以利用web-fragment.xml文件中的 元素来实现相对顺序,如图2所示。 只有当web.xml中没有元素时,容器才会查看此元素。web片段的顺序是由、和元素决定的。如果某web片段具有一个子元素的话,该文件就会被移动到已排序文档列表的开头部分。同样,如果某web片段具有一个子元素的话,该文档就会被移动到已排序文档列表的末尾部分。
为了更好的理解相对顺序,可以考察一些例子。下面的示例假定三个JAR文件都具有一个web-fragment.xml文件。
Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/
web-fragment.xml
<web-fragment>
<name>WebFragment1</name>
<ordering><after>WebFragment2</after></ordering>
...
</web-fragment>
web-fragment.xml
<web-fragment>
<name>WebFragment2</name>
..
</web-fragment>
web-fragment.xml
<web-fragment>
<name>WebFragment3</name>
<ordering><before><others/></before></ordering>
..
</web-fragment>
文件将按以下顺序进行处理:
1. WebFragment3
2. WebFragment2
3. WebFragment1
持有WebFragment3的JAR文件将首先处理,这是因为元素的缘故。这个设置能够确保该文档位于列表最前面。接下来,将会处理带有WebFragment2的JAR文件,因为带有WebFragment1的JAR文件使用了元素,所以它会被压入被处理文档清单的底部。嵌套在和元素之内的元素确保相应的文档分别被推到列表的顶部和底部。
如果web.xml遇到了和这两个元素,那么它会忽略元素;它只会考虑绝对顺序,因为那个元素会首先出现。同样,如果元素首先出现,然后才出现元素,那么容器就会忽略元素,因为它只考虑相对顺序。 如果部署描述符中没有(在web.xml中)和(在web-fragment.xml中),那么就被认为这些文档不依赖于任何顺序。
内容导航
七、Servlet中的异步处理
在许多情况下,Servlet必须与处理数据的资源打交道。这种资源可能是数据库资源、web服务或者一个消息资源。与这些资源进行交互的时候,Servlet必须等待一段时间,直到从资源获取响应之后,该Servlet才能生成一个响应。这使得Servlet对资源的调用成为一个阻塞式的调用,所以效率很低。Servlet 3.0通过引入异步处理来解决这个问题。异步处理允许线程发出一个资源调用,然后返回到容器,而无需等待。 该线程进而可以执行其他任务,这使得Servlet 3.0的性能有了很大的提升。管理来自资源的响应的AsyncContext决定从资源收到的响应是交由同一个线程处理,还是交由容器中的其他资源来处理。 AsyncContext具有多种执行异步处理的方法。
我们可以通过@WebServlet和@WebFilter注释的asyncSupported属性来支持Servlet 3.0的异步处理。这个属性具有一个布尔值,默认情况下为false。要想在Servlet中启用异步处理功能,可以在该Servlet或者过滤器中将这个属性的值设为true。
当同comet相结合的时候,Servlet的异步处理就会成为AJAX 应用程序的理想解决方案。在Servlet的init方法中,线程可以启动任何数据库操作或者向一个队列读/写消息。在doGet或者doPost方法中,我们可以启动异步处理,然后AsyncContext将在AsyncEvent和AsyncListener的帮助下管理与数据库或者消息操作有关的线程。
内容导航
八、现有API的改进
Servlet 3.0规范不仅引入了新的概念/技术,而且还对现有API进行了相应的改进。
HttpServletRequest
为了支持multipart/form-data MIME类型,已经为HttpServletRequest接口添加了下列方法:
- Iterable getParts()
- Part getPart(String name)
Cookies
为了消除某些类型的跨站点脚本攻击,Servlet 3.0支持HttpOnly cookies。HttpOnly cookies不会暴露给客户端脚本代码。为了支持HttpOnly cookies,已经为Cookie类添加了以下方法:
- void setHttpOnly(boolean isHttpOnly)
- boolean isHttpOnly()
ServletContext
由于为ServletContext API添加了以下方法,所以Servlet 3.0允许Servlet和管理器以编程方式添加到一个上下文中:
- addServlet(String servletName, String className)
- addServlet(String servletName, Servlet servlet)
- addServlet(String servletName, Classxtends Servl servletClass)
- addFilter(String filterName, String className)
- addFilter(String filterName, Filter filter)
- addFilter(String filterName, Classxtends FiltfilterClass)
- setInitParameter (String name, String Value)——此方法可用于设置上下文的初始化参数。
九、Servlet 3.0规范小结
如您所见,Servlet 3.0规范提供了许多有趣的特性,包括通过注释简化开发工作、通过引入web片段减少了框架的配置,同时还引入了异步处理来提高响应性。我们相信,这个版本一定会吸引更多的开发人员投入它的怀抱。