我们在Servlet解析(二)中讨论了Servlet UML 类图中的Servlet接口,本篇我们将继续讨论ServletRequest、ServletResponse、ServletConfig。除此之外还有Servlet异常、Servlet上下文。
ServletRequest和ServletResponse
ServletRequest和ServletResponse接口都在javax.servlet包中定义。ServletRequest接口中的常用方法如下:
ServletResponse接口中的常用方法如下:
上面所列的方法,不需要全部记下来,只需要大致了解即可。关键是要理解请求和响应对象能够提供哪些方法,只要理解了交互的过程及请求对象和响应对象所起的作用,当我们需要用到某个方法时,完全可以在API文档中进行查找。
ServletConfig
在javax.servlet包中,定义了ServletConfig接口。Servlet容器使用ServletConfig对象在Servlet初始化期间向它传递配置信息,一个Servlet只有一个ServletConfig对象。在这个接口中,定义了下面四个方法:
Servlet异常
在javax.servlet包中定义了两个异常类,ServletException和UnavailableException。
1)ServletException类
ServletException类定义了一个通用的异常,可以被 init ()、service()和doXXX()方法抛出,这个类提供了下面4个构造方法和1个实例方法:
2)UnavailableException类
UnavailableException类是ServletException类的子类,该异常被Servlet抛出,用于向Servlet容器指示这个Servlet永久地或者暂时地不可用。这个类提供了下面2个构造方法和2个实例方法:
ServletContext接口
一个ServletContext对象表示了一个Web应用程序的上下文。Servlet容器在Servlet初始化期间,向其传递ServletConfig对象,可以通过ServletConfig对象的getServletContext()方法来得到ServletContext对象。也可以通过GenericServlet类的getServletContext()方法得到ServletContext对象,不过GenericServlet类的getServletContext()也是调用ServletConfig对象的getServletContext()方法来得到这个对象的。
ServletContext接口定义了下面的这些方法,Servlet容器提供了这个接口的实现。
上面4个方法用于读取、移除和设置共享属性,任何一个Servlet都可以设置某个属性,而同一个Web应用程序的另一个Servlet可以读取这个属性,不管这些Servlet是否为同一个客户进行服务。
public ServletContext getContext(java.lang.String uripath)
该方法返回服务器上与指定的URL相对应的ServletContext对象。给出的uripath参数必须以斜杠(/)开始,被解释为相对于服务器文档根的路径。出于安全方面的考虑,如果调用该方法访问一个受限制的ServletContext对象,那么该方法将返回null。
public String getContextPath()
该方法用于返回Web应用程序的上下文路径。上下文路径总是以斜杠(/)开头,但结束没有斜杠(/)。在默认(根)上下文中,这个方法返回空字符串""。
可以为Servlet上下文定义初始化参数,这些参数被整个Web应用程序所使用。可以在部署描述符(web.xml)中使用
上面两个方法用于返回Servlet容器支持的Java Servlet API的主版本和次版本号。例如,对于遵从Servlet 2.4版本的容器,getMajorVersion()方法返回2,getMinorVersion()方法返回4。
public java.lang.String getMimeType(java.lang.String file)
该方法返回指定文件的MIME类型,如果类型是未知的,这个方法将返回null。MIME类型的检测是根据Servlet容器的配置,也可以在Web应用程序的部署描述符中指定。
public RequestDispatcher getRequestDispatcher(java.lang.String path)
该方法返回一个RequestDispatcher对象,作为指定路径上的资源的封装。可以使用RequestDispatcher对象将一个请求转发(forward)给其他资源进行处理,或者在响应中包含(include)资源。要注意的是,传入的参数path必须以斜杠(/)开始,被解释为相对于当前上下文根(context root)的路径。
public RequestDispatcher getNamedDispatcher(java.lang.String name)
该方法与getRequestDispatcher()方法类似。不同之处在于,该方法接受一个在部署描述符中以
public java.lang.String getRealPath(java.lang.String path)
在一个Web应用程序中,资源用相对于上下文路径的路径来引用,这个方法可以返回资源在服务器文件系统上的真实路径(文件的绝对路径)。返回的真实路径的格式应该适合于运行这个Servlet容器的计算机和操作系统(包括正确的路径分隔符)。如果Servlet容器不能够将虚拟路径转换为真实的路径,这个方法将会返回null。
该方法返回被映射到指定路径上的资源的URL。传入的参数path必须以斜杠(/)开始,被解释为相对于当前上下文根(context root)的路径。这个方法允许Servlet容器从任何来源为Servlet生成一个可用的资源。资源可以是在本地或远程文件系统上,在数据库中,或者在WAR文件中。如果没有资源映射到指定的路径上,该方法将返回null。
public java.io.InputStream getResourceAsStream(java.lang.String path)
该方法与getResource()方法类似,不同之处在于,该方法返回资源的输入流对象。另外,使用getResourceAsStream()方法,元信息(如内容长度和内容类型)将丢失,而使用getResource()方法,元信息是可用的。
public java.util.Set getResourcePaths(java.lang.String path)
该方法返回资源的路径列表,参数path必须以斜杠(/)开始,指定用于匹配资源的部分路径。例如,一个Web应用程序包含了下列资源:
/welcome.html
/catalog/index.html
/catalog/products.html
/catalog/offers/books.html
/catalog/offers/ music .html
/customer/login.jsp
/WEB-INF/web.xml
/WEB-INF/classes/com.acme.OrderServlet.class
如果调用getResourcePaths(”/”),将返回[/welcome.html, /catalog/, /customer/, /WEB-INF/]。如果调用getResourcePaths(“/catalog/”),将返回[/catalog/index.html,/catalog/products.html, /catalog/offers/]。
public java.lang.String getServerInfo()
该方法返回运行Servlet的容器的名称和版本。
public java.lang.String getServletContextName()
该方法返回在部署描述符中使用
ServletContext接口提供了上面两个记录日志的方法,第一个方法用于记录一般的日志,第二个方法用于记录指定异常的栈跟踪信息。
一个简单示例:统计访问次数
很多网站都有统计访问次数的功能,我们可以使用ServletContext对象来保存访问的次数。我们知道一个Web应用程序只有一个ServletContext对象,而且该对象可以被Web应用程序中的所有Servlet所访问,因此使用ServletContext对象来保存一些需要在Web应用程序中共享的信息是再合适不过了。
要在ServletContext对象中保存共享信息,可以调用该对象的setAttribute()方法,要获取共享信息,可以调用该对象的getAttribute()方法。针对本例,我们可以调用setAttribute()方法将访问计数保存到上下文对象中,新增一次访问时,调用getAttribute()方法从上下文对象中取出访问计数加1,然后再调用setAttribute()方法保存回上下文对象中。
我们接着继续以MyDemo为web工程,在com.shan.web包下建立CounterServlet类,即在MyDemo\src\com\shan\web目录下新建CounterServlet. java ,代码如下所示。
程序调用getServletContext()方法(从GenericServlet类间接继承而来)得到Web应用程序的上下文对象。为了避免线程安全的问题,使用了synchronized关键字对context对象进行同步。通过调用上下文对象的getAttribute()方法获取counter属性的值。并判断count是否为null,如果为null,则将它的初始值设为1。当这个Servlet第一次被访问的时候,在上下文对象中还没有保存counter属性,所以获取该属性的值将返回null。如果count不为null,则将count加1。通过将count作为counter属性的值保存到ServletContext对象中。
编写完上述代码之后,需要对代码进行编译,执行如下语句:
javac -classpath D:\apache-tomcat-7.0.33\lib\servlet-api.jar -d classes src\com\shan\web\CounterServlet.java
将编译后的classes文件夹复制到D:\apache-tomcat-7.0.33\webapps\MyDemo文件夹中。接下来还需要修改web.xml文件,修改后的文件如下:
将web.xml文件复制到D:\apache-tomcat-7.0.33\webapps\MyDemo\WEB-INF文件夹下。启动Tomcat,在浏览器中输入http:localhost:8080/MyDemo/count.do即可看到结果。
交替刷新两个浏览器中的页面,可以看到访问次数也在交替增长,说明利用ServletContext保存属性,可以在多个客户端之间共享属性。但要注意,不同的Web应用程序具有不同的Servlet上下文,所以在不同的Web应用程序之间不能利用ServletContext来共享属性。另外,访问次数在重启 Tomcat 服务器后,将重新从1开始,为了永久保存访问次数,可以将这个值保存到文件或数据库中。
