Servlet中文API文檔-個人整理版

Servlet中文API文檔-個人整理版
————————————————
原文鏈接：https://blog.csdn.net/qq_34418607/java/article/details/86741514

說明：servlet抽象集是javax.servlet.Servlet接口，它規定了必須由Servlet類實現由servlet引擎識別和管理的方法集。

方法：

方法名 參數 返回值 功能說明
init ServletConfit config void 在servlet被載入后和實施服務前由servlet引擎進行N次性調用。如果init()產生溢出UnavailableException，則 servle退出服務。
getServletConfig – ServletConfig 返回傳遞到servlet的init()方法的ServletConfig對象
service ServletRequest request, ServletResponse response void 處理request對象中描述的請求，使用response對象返回請求結果
getServletInfo – String 返回描述servlet的一個字符串
destory – void 當servlet將要卸載時由servlet引擎調用
二、HttpServlet
說明：雖然servlet API允許擴展到其它協議，但最終所有的servlet均在Web環境下實施操作，只有幾種servlet直接擴展了GenericServlet。對servlet更一般的是擴展其HTTP子類HttpServlet。 HttpServlet 類通過調用指定到HTTP請求方法的方法實現service()，亦即對DELETE、HEAD、GET、OPTIONS、POST、PUT和 TRACE，分別調用doDelete()、doHead()、doGet()、doOptions()、doPost()、doPut()和 doTrace()方法，將請求和響應對象置入其HTTP指定子類。

方法

方法名 參數 返回值 功能說明
doGet HttpServletRequest request,HttpServletResponse response Void 由servlet引擎調用用處理一個HTTP GET請求。輸入參數、HTTP頭標和輸入流可從request對象、response頭標和response對象的輸出流中獲得。
doPost HttpServletRequest request,HttpServletResponse response Void 由servlet引擎調用用處理一個HTTP POST請求。輸入參數、HTTP頭標和輸入流可從request對象、response頭標和response對象的輸出流中獲得。
doPut HttpServletRequest request,HttpServletResponse response Void 由servlet引擎調用用處理一個HTTP PUT請求。本方法中請求URI指出被載入的文件位置。
doDelete HttpServletRequest request,HttpServletResponse response Void 由servlet引擎調用用處理一個HTTP DELETE請求。請求URI指出資源被刪除。
doOptions HttpServletRequest request,HttpServletResponse response Void 由servlet引擎調用用處理一個HTTP OPTIONS請求。返回一個Allow響應頭標表明此servlet支持的HTTP方法。一個servlet不需要覆蓋此方法，因為 HttpServlet方法已經實現規范所需的功能。
doTrace HttpServletRequest request,HttpServletResponse response Void 由servlet引擎調用用處理一個HTTP TRACE請求。使得請求頭標被反饋成響應關標。一個servlet不需要覆蓋此方法，因為HttpServlet方法已經實現HTTP規范所需的功能。
service HttpServletRequest request,HttpServletResponse response Void Service(Request request,Response response)調用的一個立即方法，帶有指定HTTP請求和響應。此方法實際上將請求導向doGet()、doPost()等等。不應該覆蓋此方法。
service Request request,Response response Void 將請求和響應對象置入其指定的HTTP子類，並調用指定HTTP的service()方法。
三、ServletRequest
說明：ServletRequest接口封裝了客戶端請求的細節。它與協議無關，並有一個指定HTTP的子接口。
ServletRequest主要處理：
1.找到客戶端的主機名和IP地址
2.檢索請求參數
3.取得和設置屬性
4.取得輸入和輸出流

方法：

方法名 參數 返回值 功能說明
getAttribute String name Object 返回具有指定名字的請求屬性，如果不存在則返回null。屬性可由servlet引擎設置或使用setAttribute()顯式加入。
getAttributeName – Enumeration 返回請求中所有屬性名的枚舉。如果不存在屬性，則返回一個空的枚舉。
getCharacteEncoding – String 返回請求所用的字符編碼。
getContentLength – Int 指定輸入流的長度，如果未知則返回-1。
getInputStream – ServletInputStream 返回與請求相關的（二進制）輸入流。可以調用getInputStream()或getReader()方法之一。
getParameter String name String 返回指定輸入參數，如果不存在，返回null。
getParameterName – Enumeration 返回請求中所有參數名的一個可能為空的枚舉。
getParameterValues String name String[] 返回指定輸入參數名的取值數組，如果取值不存在則返回null。它在參數具有多個取值的情況下十分有用。
getProtocol – String 返回請求使用協議的名稱和版本。
getScheme – String 返回請求URI的子串，但不包含第一個冒號前的內容。
getServerName – String 返回處理請求的服務器的主機名。
getServerPort – String 返回接收主機正在偵聽的端口號。
getReader – BufferedReader 返回與請求相關輸入數據的一個字符解讀器。此方法與getInputStream()只可分別調用，不能同時使用。
getRemoteAddr – String 返回客戶端主機的數字型IP地址。
getRemoteHost – String 如果知道，返回客戶端主機名。
setAttribute String name,Object obj void 以指定名稱保存請求中指定對象的引用。
removeAttribute String name void 從請求中刪除指定屬性
getLocale – Locale 如果已知，返回客戶端的第一現場或者為null。
getLocales – Enumeration 如果已知，返回客戶端的第一現場的一個枚舉，否則返回服務器第一現場。
isSecure – boolean 如果請求使用了如HTTPS安全隧道，返回true
getRequestDispatcher String name RequestDispatcher 返回指定源名稱的RequsetDispatcher對象。
四、HttpServletRequest
說明：

HttpServletRequest類主要處理：
1.讀取和寫入HTTP頭標
2.取得和設置cookies
3.取得路徑信息
4.標識HTTP會話。

方法：

方法名 參數 返回值 功能說明
getAuthType – String 如果servlet由一個鑒定方案所保護，如HTTP基本鑒定，則返回方案名稱。
getContextPath – String 返回指定servlet上下文（web應用）的URL的前綴。
getCookies – Cookie[] 返回與請求相關cookie的一個數組。
getDateHeader String name Long 將輸出轉換成適合構建Date對象的long類型取值的getHeader()的簡化版。
getHeader String name String 返回指定的HTTP頭標指。如果其由請求給出，則名字應為大小寫不敏感。
getHeaderNames – Enumeration 返回請求給出的所有HTTP頭標名稱的權舉值。
getHeaders String name Enumeration 返回請求給出的指定類型的所有HTTP頭標的名稱的枚舉值，它對具有多取值的頭標非常有用。
getIntHeader String name int 將輸出轉換為int取值的getHeader()的簡化版。
getMethod – String 返回HTTP請求方法（例如GET、POST等等）
getPathInfo – String 返回在URL中指定的任意附加路徑信息。
getPathTranslated – String 返回在URL中指定的任意附加路徑信息，被子轉換成一個實際路徑。
getQueryString – String 返回查詢字符串，即URL中?后面的部份。
getRemoteUser – String 如果用戶通過鑒定，返回遠程用戶名，否則為null。
getRequestedSessionId – String 返回客戶端的會話ID
getRequestURI – String 返回URL中一部分，從“/”開始，包括上下文，但不包括任意查詢字符串。
getServletPath – String 返回請求URI上下文后的子串
getSession – HttpSession 調用getSession(true)的簡化版。
getSession boolean HttpSession 返回當前HTTP會話，如果不存在，則創建一個新的會話，create參數為true。
getPrincipal – Principal 如果用戶通過鑒定，返回代表當前用戶的java.security.Principal對象，否則為null。
isRequestedSessionIdFromCookie – boolean 如果請求的會話ID由一個Cookie對象提供，則返回true，否則為false。
isRequestedSessionIdFromURL – boolean 如果請求的會話ID在請求URL中解碼，返回true，否則為false
isRequestedSessionIdValid – boolean 如果客戶端返回的會話ID仍然有效，則返回true。
isUserInRole String role Boolean 如果當前已通過鑒定用戶與指定角色相關，則返回true，如果不是或用戶未通過鑒定，則返回false。
五、ServletResponse
說明：ServletResponse對象將一個servlet生成的結果傳到發出請求的客戶端。ServletResponse操作主要是作為輸出流及其內容類型和長度的包容器，它由servlet引擎創建.

方法

方法名 參數 返回值 功能說明
flushBuffer – void 發送緩存到客戶端的輸出內容。因為HTTP需要頭標在內容前被發送，調用此方法發送狀態行和響應頭標，以確認請求。
getBufferSize – int 返回響應使用的緩存大小。如果緩存無效則返加0。
getCharacterEncoding – String 返回響應使用字符解碼的名字。除非顯式設置，否則為ISO-8859-1
getLocale – Locale 返回響應使用的現場。除非用setLocale()修改，否則缺省為服務器現場。
getOutputStream – OutputStream 返回用於將返回的二進制輸出寫入客戶端的流，此方法和getWrite()方法二者只能調用其一。
getWriter – Writer 返回用於將返回的文本輸出寫入客戶端的一個字符寫入器，此方法和getOutputStream()二者只能調用其一。
isCommitted – boolean 如果狀態和響應頭標已經被發回客戶端，則返回true，在響應被確認后發送響應頭標毫無作用。
reset – void 清除輸出緩存及任何響應頭標。如果響應已得到確認，則引發事件IllegalStateException。
setBufferSize int nBytes void 設置響應的最小緩存大小。實際緩存大小可以更大，可以通過調用getBufferSize()得到。如果輸出已被寫入，則產生IllegalStateException。
setContentLength int length void 設置內容體的長度。
setContentType String type void 設置內容類型。在HTTP servlet中即設置Content-Type頭標。
setLocale Locale locale void 設置響應使用的現場。在HTTP servlet中，將對Content-Type頭標取值產生影響。
六、HttpServletResponse
說明：HttpServletResponse加入表示狀態碼、狀態信息和響應頭標的方法，它還負責對URL中寫入一Web頁面的HTTP會話ID進行解碼。

方法：

方法名 參數 返回值 功能說明
addCookie Cookie cookie void 將一個Set-Cookie頭標加入到響應。
addDateHeader String name,long date void 使用指定日期值加入帶有指定名字（或代換所有此名字頭標）的響應頭標的方法。
setHeader String name,String value void 設置具有指定名字和取值的一個響應頭標。
addIntHeader String name,int value void 使用指定整型值加入帶有指定名字的響應頭標（或代換此名字的所有頭標）。
containsHeader String name boolean 如果響應已包含此名字的頭標，則返回true。
encodeRedirectURL String url String 如果客戶端不知道接受cookid，則向URL加入會話ID。第一種形式只對在sendRedirect()中使用的URL進行調用。其他被編碼的 URLs應被傳遞到encodeURL()
encodeURL String url String
sendError int status void 設置響應狀態碼為指定值（可選的狀態信息）。HttpServleetResponse定義了一個完整的整數常量集合表示有效狀態值。
sendError int status,String msg void
setStatus int status void 設置響應狀態碼為指定指。只應用於不產生錯誤的響應，而錯誤響應使用sendError()。
七、ServletContext
說明：一個servlet上下文是servlet引擎提供用來服務於Web應用的接口。Servlet上下文具有名字（它屬於Web應用的名字）唯一映射到文件系統的一個目錄。 一個servlet可以通過ServletConfig對象的getServletContext()方法得到servlet上下文的引用，如果servlet直接或間接調用子類GenericServlet，則可以使用getServletContext()方法。

Web應用中servlet可以使用servlet上下文得到：
1.在調用期間保存和檢索屬性的功能，並與其他servlet共享這些屬性。
2.讀取Web應用中文件內容和其他靜態資源的功能。
3.互相發送請求的方式。
4.記錄錯誤和信息化消息的功能。
方法：

方法名 參數 返回值 功能說明
getAttribute String name Object 返回servlet上下文中具有指定名字的對象，或使用已指定名捆綁一個對象。從Web應用的標准觀點看，這樣的對象是全局對象，因為它們可以被同一 servlet在另一時刻訪問。或上下文中任意其他servlet訪問。
setAttribute String name,Object obj void 設置servlet上下文中具有指定名字的對象。
getAttributeNames Enumeration 返回保存在servlet上下文中所有屬性名字的枚舉。
getContext String urlPath ServletContext 返回映射到另一URL的servlet上下文。在同一服務器中URL必須是以“/”開頭的絕對路徑。
getInitParameter String name String 返回指定上下文范圍的初始化參數值。此方法與ServletConfig方法名稱不一樣，后者只應用於已編碼的指定servlet。此方法應用於上下文中所有的參數。
getInitParameterNames – Enumeration 返回（可能為空）指定上下文范圍的初始化參數值名字的枚舉值。
getMajorVersion – int 返回此上下文中支持servlet API級別的最大和最小版本號。
getMinorVersion – int
getMimeType String fileName String 返回指定文件名的MIME類型。典型情況是基於文件擴展名，而不是文件本身的內容（它可以不必存在）。如果MIME類型未知，可以返回null。
getNameDispatcher String name RequestDispatcher 返回具有指定名字或路徑的servlet或JSP的RequestDispatcher。如果不能創建RequestDispatch，返回null。如果指定路徑，必須心“/”開頭，並且是相對於servlet上下文的頂部。
getNameDispatcher String path RequestDispatcher
getRealPath String path String 給定一個URI，返回文件系統中URI對應的絕對路徑。如果不能進行映射，返回null。
getResource String path URL 返回相對於servlet上下文或讀取URL的輸入流的指定絕對路徑相對應的URL，如果資源不存在則返回null。
getResourceAsStream String path InputStream
getServerInfo String 返順servlet引擎的名稱和版本號。
log String message void
log String message,Throwable t void 將一個消息寫入servlet注冊，如果給出Throwable參數，則包含棧軌跡。
removeAttribute String name void 從servlet上下文中刪除指定屬性。
八、HttpSession
說明：HttpSession類似於哈希表的接口，它提供了setAttribute ()和getAttribute()方法存儲和檢索對象。HttpSession提供了一個會話ID關鍵字，一個參與會話行為的客戶端在同一會話的請求中存儲和返回它。servlet引擎查找適當的會話對象，並使之對當前請求可用。

方法：

         方法名 參數 返回值 功能說明
getAttribute String name Object 將會話中一個對象保存為指定名字，返回或刪除前面保存的此名稱對象。
setAttribute String name,Object value void
removeAttribute String name void
getAttributeName – Enumeration 返回捆綁到當前會話的所有屬性名的枚舉值。
getCreationTime – long 返回表示會話創建和最后訪問日期和時間的一個長整型，該整型形式為java.util.Date()構造器中使用的形式。
getLastAccessedTime – long
getId – String 返回會話ID，servlet引擎設置的一個唯一關鍵字。
getMaxInactiveInterval – int 如果沒有與客戶端發生交互，設置和返回會話存活的最大秒數。
setMasInactiveInterval int seconds void
invalidate – void 使得會話被終止，釋放其中任意對象。
isNew – boolean 如果客戶端仍未加入到會話，返回true。當會話首次被創建，會話ID被傳入客戶端，但客戶端仍未進行包含此會話ID的第二次請示時，返回true。
————————————————
原文鏈接：https://blog.csdn.net/qq_34418607/java/article/details/86741514