ServletAPI文档中文版.docx

1、ServletAPI文档中文版Servlet API文档中文版、javax.servlet.Servlet 接口servlet 抽象集是javax.servlet.Servlet 接口，它规定了必须由Servlet类实现由servlet引擎识别和管理的方法集。Servlet接口的基本目标是提供生命期方法init() 、service。和 destroy。方法。servlet 接口中的方法void in it(ServletC onfit con fig)throws ServletExcepti on 在servlet被载入后和实施服务前由servlet引擎进行？次性调用。如果init()产

2、生溢出 UnavailableException ，贝U servle 退出服务。返回传递到servlet 的init() 方ServletConfig getServletConfig() 法的 ServletConfig 对象void service(ServletRequest request, ServletResp onseresponse)throws ServletException,IOException 处理 request 对象中描述的请求，使用response对象返回请求结果String getServletInfo() 返回描述 servlet 的一个字符串void d

3、estory() 当servlet 将要卸载时由servlet引擎调用类(协议无关版本)、javax.servlet.GenericServletGenericServlet 是一种与协议无关的servlet，是一种跟本不对请求提供服务的servlet ，而是简单地从init()方法启动后台线程并在destory()中杀 死。它可以用于模拟操作系统的端口监控进程。servlet API 提供了 Servlet 接口的直接实现，称为 GenericServlet 。 此类提供除了 service()方法外所有接口中方法的缺省实现。这意味着通过简单 地扩展GenericServlte 可以编写一个

4、基本的servlet 。除了 Servlet 接口外，GenericServlet 也实现了 ServletConfig 接口，处理初始化参数和servlet上下文，提供对授权传递到init()方法中的 ServletCo nfig 对象的方法。Gen ericServlet 类中的方法void destory() 编飞组成单词“ destory ”的一个注册入口Stri ng getl ni tParameter(Stri ng n ame)返回具有指定名称的初始化参数值。通过凋用 config.getlnitParameter(name) 实现。Enu merati on get In i

5、tParameterNames() 返回此 servet 已编码的所有初始化参数的？个枚举类型值。调用config.getInitParameterNames() 获得列表。如果未提供初始化参数，则返回？个空的枚举类型值(但不是null)ServletConfig getServletConfig() 返回传递到 init()方法的ServletCo nfig 对象ServletContext getServletContext() 返回在 config 对象中引用的ServletCo ntextStri ng getServletI nfo() 返回空字符串void in it(Servle

6、tC onfig con fig)throws ServletExcepti on 在一实例变量中保存config对象。编写组成单词“ init ”的注册入口 ,然后调用方法 ini t()void init()throws ServletException 可以被跳过以处理 servlet 初始化.在config对象被保存后in it(ServletCo nfig con fig) 的结尾处自动被调用.servlet 作者经常会忘记调用super.i ni t(co nfig)void log(String msg) 编写注册 servlet 的入口 .为此调用 servlet 上下文的lo

7、g()方法.servlet的名字被加到消息文本的开头。void log(String msg,Throwable t) 编写一个入口和 servlet 注册的栈轨迹。此方法也是 ServletC on text 中相应方法的一个副本。abstract void service(Request request,Resp onse resp on se)throws ServletException,IOException 由servlet 引擎调用为请求对象描述的请求提供服务。这是GenericServlet中唯一的抽象方法。因此它也是唯一必须被子类 所覆盖的方法。String getServl

8、etName() 返回在 Web应用发布描述器(web.xml)中指 定的servlet 的名字。三、javax.servlet.http.HttpServlet 类(HTTP版本)虽然servlet API允许扩展到其它协议，但最终所有的servlet均在 Web 环境下实施操作，只有几种 servlet 直接扩展了 GenericServlet。对servlet 更一般的是扩展其HTTP子类HttpServlet。HttpServlet 类通过调用指定到HTTP!青求方法的方法实现service。, 亦即对 DELETEHEADGETOPTIONSPOSTPUT和 TRACE 分别调用 d

9、oDelete()、 doHead()、doGet() 、doOptions() 、doPost() 、doPut() 和 doTrace() 方法，将 请求和响应对象置入其HTTP指定子类。HttpServlet 类中的方法Void doGet(HttpServletRequest request,HttpServletResponse response)throws ServletException,IOException 由 servlet 引擎调用用处理 一个HTTPGET请求。输入参数、HTTP头标和输入流可从request对象、response 头标和 response 对象的输出

10、流中获得。Void doPost(HttpServletRequest request,HttpServletResponse response)throws ServletException,IOException 由 servlet 引擎调用用处理 一个HTTPPOST#求。输入参数、HTTP头标和输入流可从request对象、response 头标和 response 对象的输出流中获得。Void doPut(HttpServletRequest request,HttpServletResponse response)throws ServletException,IOExceptio

11、n 由 servlet 引擎调用用处理 一个HTTP PUT青求。本方法中请求URI指出被载入的文件位置。Void doDelete(HttpServletRequest request,HttpServletResponse response)throws ServletException,IOException 由 servlet 引擎调用用处理 一个HTTP DELETE!求。请求URI指出资源被删除。Void doOptions(HttpServletRequest request,HttpServletResponse response)throws ServletException

12、,IOException 由 servlet 引擎调用用处理 一个HTTPOPTION请求。返回一个 Allow响应头标表明此servlet 支持的HTTP 方法。一个 servlet 不需要覆盖此方法，因为 HttpServlet 方法已经实现规范 所需的功能。Void doTrace(HttpServletRequest request,HttpServletResponse response)throws ServletException,IOException 由 servlet 引擎调用用处理 一个HTTP TRAC请求。使得请求头标被反馈成响应关标。一个 servlet不需要覆盖此

13、方法，因为HttpServlet方法已经实现HTTP规范所需的功能。Void service(HttpServletRequest request,HttpServletResponse response)throws ServletException,IOException Service(Request request,Response response)调用的一个立即方法，带有指定HTTPi青求和响应。 此方法实际上将请求导向 doGet() 、 doPost() 等等。不应该覆盖此方法。Void service(Request request,Response response)thr

14、ows ServletException,IOException 将请求和响应对象置入其指定的 HTTP子类，并调用指定HTTP的service()方法。四、 javax.servlet.ServletRequest 类(协议无关版本)ServletRequest 接口封装了客户端请求的细节。它与协议无关，并有一 个指定HTTP的子接口。ServletRequest 主要处理：1.找到客户端的主机名和 IP 地址2.检索请求参数3.取得和设置属性4.取得输入和输出流ServletRequest 类中的方法Object getAttribute(String name) 返回具有指定名字的请求属

15、性，如 果不存在则返回 null 。属性可由 servlet 引擎设置或使用 setAttribute() 显式 加入。Enumeration getAttributeName() 返回请求中所有属性名的枚举。 如果 不存在属性，则返回一个空的枚举。String getCharacteEncoding() 返回请求所用的字符编码。Int getContentLength() 指定输入流的长度，如果未知则返回 -1。ServletInputStream getInputStream()throws IOException 返回与请 求相关的 (二进制) 输入流。 可以调用 getInputStr

16、eam() 或 getReader() 方法之一。String getParameter(String name) 返回指定输入参数，如果不存在， 返回 null 。Enumeration getParameterName() 返回请求中所有参数名的一个可能 为空的枚举。String getParameterValues(String name) 返回指定输入参数名的取 值数组，如果取值不存在则返回 null 。它在参数具有多个取值的情况下十分有 用。String getScheme()返回请求URI的子串，但不包含第一个冒号前的内 容。String getServerName() 返回处理请

17、求的服务器的主机名。Stri ng getServerPort() 返回接收主机正在侦听的端口号。BufferedReader getReader()throws lOException 返回与请求相关输入 数据的一个字符解读器。此方法与 get In putStream()只可分别调用，不能同时 使用。String getRemoteAddr() 返回客户端主机的数字型IP地址。Stri ng getRemoteHost() 如果知道，返回客户端主机名。void setAttribute(Stri ng n ame,Object obj) 以指定名称保存请求中指定对象的引用。void rem

18、oveAttribute(Stri ng name) 从请求中删除指定属性Locale getLocale() 如果已知，返回客户端的第一现场或者为 null。Enumeration getLocales() 如果已知，返回客户端的第一现场的一个枚举，否则返回服务器第一现场。boolean isSecure() 如果请求使用了如HTTPS全隧道，返回trueRequestDispatcher getRequestDispatcher(Stri ng n ame) 返回指定源名称的 RequsetDispatcher 对象。Trackback:http:/tb.blog.csd n.n et/T

19、rackBack.aspx?Postld=1681301五、javax.servlet.http.HttpServletRequest 接口( HTTP版本)HttpServletRequest 类主要处理：1读取和写入HTTP头标2.取得和设置cookies3.取得路径信息4.标识HTTP会话。HttpServletRequest 接口中的方法String getAuthType() 如果 servlet 由一个鉴定方案所保护，如 HTTP 基本鉴定，则返回方案名称。String getContextPath() 返回指定 servlet 上下文( web 应用)的 URL 的前缀。Cook

20、ie getCookies() 返回与请求相关 cookie 的一个数组。Long getDateHeader(String name) 将输出转换成适合构建 Date 对象的 long 类型取值的 getHeader() 的简化版。String getHeader(String name)返回指定的HTTP头标指。如果其由请 求给出，则名字应为大小写不敏感。Enumeration getHeaderNames() 返回请求给出的所有HTTP头标名称的权举值。Enumeration getHeaders(String name) 返回请求给出的指定类型的所 有HTTP头标的名称的枚举值，它对具

21、有多取值的头标非常有用。int getIntHeader(String name) 将输出转换为 int 取值的 getHeader() 的简化版。String getMethod() 返回 HTTP请求方法(例如 GET POST等等)String getPathInfo() 返回在URL中指定的任意附加路径信息。String getPathTranslated() 返回在URL中指定的任意附加路径信息，被子转换成一个实际路径。String getQueryString() 返回查询字符串，即URL中？后面的部份。String getRemoteUser() 如果用户通过鉴定，返回远程用户名

22、，否则为 null 。String getRequestedSessionId() 返回客户端的会话 IDString getRequestURI() 返回URL中一部分，从“ /”开始，包括上下文，但不包括任意查询字符串。String getServletPath() 返回请求 URI 上下文后的子串HttpSession getSession() 调用 getSession(true) 的简化版。HttpSession getSession(boolean create) 返回当前 HTTP会话，如果不存在，则创建一个新的会话， create 参数为 true 。Principal get

23、Principal() 如果用户通过鉴定，返回代表当前用户的 java.security.Principal 对象，否则为 null 。boolean isRequestedSessionIdFromCookie() 如果请求的会话 ID 由一 个 Cookie 对象提供，则返回 true ，否则为 false 。boolean isRequestedSessionIdFromURL() 如果请求的会话 ID 在请求 URL中解码，返回true，否则为falseboolean isRequestedSessionIdValid() 如果客户端返回的会话 ID 仍然 有效，则返回 true 。B

24、oolean isUserInRole(String role) 如果当前已通过鉴定用户与指定角色相关，则返回 true ，如果不是或用户未通过鉴定，则返回 false 。六、 javax.servlet.ServletResponse 接口(协议无关版本)ServletResponse 对象将一个 servlet 生成的结果传到发出请求的客户 端。ServletResponse操作主要是作为输出流及其内容类型和长度的包容器，它 由 servlet 引擎创建 .ServletResponse 接口中的方法void flushBuffer()throws IOException 发送缓存到客户端

25、的输出内容。因为HTTP需要头标在内容前被发送，调用此方法发送状态行和响应头标， 以确认请求。int getBufferSize() 返回响应使用的缓存大小。如果缓存无效则返加 0。String getCharacterEncoding() 返回响应使用字符解码的名字。除非 显式设置，否则为 ISO-8859-1Locale getLocale() 返回响应使用的现场。除非用 setLocale() 修改， 否则缺省为服务器现场。OutputStream getOutputStream()throws IOException 返回用于将返回 的二进制输出写入客户端的流，此方法和 getWrit

26、e() 方法二者只能调用其一。Writer getWriter()throws IOException 返回用于将返回的文本输出写 入客户端的一个字符写入器，此方法和 getOutputStream() 二者只能调用其一。boolean isCommitted() 如果状态和响应头标已经被发回客户端，则返 回 true ，在响应被确认后发送响应头标毫无作用。void reset() 清除输出缓存及任何响应头标。如果响应已得到确认，则 引发事件 IllegalStateException 。void setBufferSize(int nBytes) 设置响应的最小缓存大小。实际缓存 大小可以更

27、大，可以通过调用 getBufferSize() 得到。如果输出已被写入，则产 生 IllegalStateException 。void setContentLength(int length) 设置内容体的长度。void setContentType(String type) 设置内容类型。在 HTTP servlet 中即设置 Content-Type 头标。void setLocale(Locale locale) 设置响应使用的现场。 在 HTTPservlet 中，将对 Content-Type 头标取值产生影响。七、javax.servlet.http.HttpServletRe

28、sponse 接口( HTTP版本)HttpServletResponse 加入表示状态码、状态信息和响应头标的方法， 它还负责对URL中写入一 Web页面的HTTP会话ID进行解码。HttpServletResponse 接口中的方法void addCookie(Cookie cookie) 将一个 Set-Cookie 头标加入到响应。void addDateHeader(String name,long date) 使用指定日期值加入带 有指定名字(或代换所有此名字头标)的响应头标的方法。void setHeader(String name,String value) 设置具有指定名字和

29、取值 的一个响应头标。void addIntHeader(String name,int value) 使用指定整型值加入带有 指定名字的响应头标(或代换此名字的所有头标)。boolean containsHeader(String name) 如果响应已包含此名字的头标， 则返回 true 。String encodeRedirectURL(String url) 如果客户端不知道接受cookid，则向URL加入会话ID。第一种形式只对在 sendRedirect()中使用的URL 进行调用。其他被编码的URLs应被传递到encodeURL()String encodeURL(String

30、url)void sendError(int status) 设置响应状态码为指定值(可选的状态信 息)。 HttpServleetResponse 定义了一个完整的整数常量集合表示有效状态值。void sendError(int status,String msg)void setStatus(int status) 设置响应状态码为指定指。只应用于不产 生错误的响应，而错误响应使用 sendError() 。八、 javax.servlet.ServletContext 接口一个servlet上下文是servlet引擎提供用来服务于 Web应用的接口。 Servlet上下文具有名字(它属于

31、Web应用的名字)唯一映射到文件系统的一个 目录。一个 servlet 可以通过 ServletConfig 对象的 getServletContext() 方 法得到 servlet 上下文的引用，如果 servlet 直接或间接调用子类 GenericServlet ，则可以使用 getServletContext() 方法。Web应用中servlet可以使用servlet上下文得到：1. 在调用期间保存和检索属性的功能， 并与其他 servlet 共享这些属性。2读取Web应用中文件内容和其他静态资源的功能。3.互相发送请求的方式。4.记录错误和信息化消息的功能。ServletConte

32、xt 接口中的方法Object getAttribute(String name) 返回 servlet 上下文中具有指定名字 的对象，或使用已指定名捆绑一个对象。 从Web应用的标准观点看，这样的对象是全局对象，因为它们可以被同一 servlet 在另一时刻访问。或上下文中任意 其他 servlet 访问。设置 servlet 上下文中void setAttribute(String name,Object obj) 具有指定名字的对象。Enumeration getAttributeNames() 返回保存在 servlet 上下文中所有 属性名字的枚举。ServletContext getContext(String uripath) 返回映射到另一 URL的serv