`
HttpServletRequest 常用方法
HttpServletRequest继承了ServletRequest,补充了大量的get方法。所以这里把ServletRequest和HttpServletRequset的Api写在一起了
ServletRequest Api
返回值 | 方法名 | 描述 |
---|---|---|
Object | getAttribute(String name) | 以 Object 形式返回指定属性的值,如果不存在给定名称的属性,则返回 null 。 |
Enumeration | getAttributeNames() | 返回包含此请求可用属性的名称的 Enumeration 。如果该请求没有可用的属性,则此方法返回一个空的 Enumeration 。 |
String | getCharacterEncoding() | 返回此请求正文中使用的字符编码的名称。如果该请求未指定字符编码,则此方法返回 null |
void | setCharacterEncoding(String env) | 重写此请求正文中使用的字符编码的名称。必须在使用 getReader() 读取请求参数或读取输入之前调用此方法。否则,此方法没有任何效果。 |
int | getContentLength() | 返回请求正文的长度(以字节为单位),并使输入流可以使用它,如果长度未知,则返回 -1。对于 HTTP servlet,返回的值与 CGI 变量 CONTENT_LENGTH 的值相同。 |
String | getContentType() | 返回请求正文的 MIME 类型,如果该类型未知,则返回 null 。对于 HTTP servlet,返回的值与 CGI 变量 CONTENT_TYPE 的值相同。 |
ServletInputStream | getInputStream() | 使用 ServletInputStream 以二进制数据形式获取请求正文。可调用此方法或getReader读取正文,而不是两种方法都调用。 |
String | getParameter(String name) | 以 String 形式返回请求参数的值,如果该参数不存在,则返回 null 。请求参数是与请求一起发送的额外信息。对于 HTTP servlet,参数包含在查询字符串或发送的表单数据中。 |
Enumeration | getParameterNames() | 返回包含此请求中所包含参数的名称的 String 对象的 Enumeration 。如果该请求没有参数,则此方法返回一个空的 Enumeration 。 |
String[] | getParameterValues(String name) | 返回包含给定请求参数拥有的所有值的 String 对象数组,如果该参数不存在,则返回 null 。 |
Map<K, V> | getParameterMap() | 返回此请求的参数的 java.util.Map。请求参数是与请求一起发送的额外信息。对于 HTTP servlet,参数包含在查询字符串或发送的表单数据中。 |
String | getProtocol() | 以 protocol/majorVersion.minorVersion 的形式(例如 HTTP/1.1)返回请求使用的协议的名称和版本。对于 HTTP servlet,返回的值与 CGI 变量 SERVER_PROTOCOL 的值相同。 |
String | getScheme() | 返回用于发出此请求的方案的名称,例如 http 、https 或 ftp 。不同方案具有不同的构造 URL 的规则,这一点已在 RFC 1738 中注明。 |
String | getServerName() | 返回请求被发送到的服务器的主机名。它是 Host 头值 “:”(如果有)之前的那部分的值,或者解析的服务器名称或服务器 IP 地址。 |
int | getServerPort() | 返回请求被发送到的端口号。它是 Host 头值 “:”(如果有)之后的那部分的值,或者接受客户端连接的服务器端口。 |
BufferedReader | getReader() | 使用 BufferedReader 以字符数据形式获取请求正文。读取器根据正文上使用的字符编码转换字符数据。可调用此方法或 getInputStream 读取正文,而不是两种方法都调用。 |
String | getRemoteAddr() | 返回发送请求的客户端或最后一个代理的 Internet Protocol (IP) 地址。对于 HTTP servlet,返回的值与 CGI 变量 REMOTE_ADDR 的值相同。 |
String | getRemoteHost() | 返回发送请求的客户端或最后一个代理的完全限定名称。如果引擎无法或没有选择解析主机名(为了提高性能),则此方法返回以点分隔的字符串形式的 IP 地址。对于 HTTP servlet,返回的值与 CGI 变量 REMOTE_HOST 的值相同。 |
void | setAttribute(String name, Object o) | 存储此请求中的属性。在请求之间重置属性。此方法常常与 RequestDispatcher 一起使用。 |
void | removeAttribute(String name) | 从此请求中移除属性。此方法不是普遍需要的,因为属性只在处理请求期间保留。 |
Locale | getLocale() | 基于 Accept-Language 头,返回客户端将用来接受内容的首选 Locale 。如果客户端请求没有提供 Accept-Language 头,则此方法返回服务器的默认语言环境。 |
Enumeration | getLocales() | 返回 Locale 对象的 Enumeration ,这些对象以首选语言环境开头,按递减顺序排列,指示基于 Accept-Language 头客户端可接受的语言环境。如果客户端请求没有提供 Accept-Language 头,则此方法返回包含一个 Locale 的 Enumeration ,即服务器的默认语言环境。 |
boolean | isSecure() | 返回一个 boolean 值,指示此请求是否是使用安全通道(比如 HTTPS)发出的。 |
RequestDispatcher | getRequestDispatcher(String path) | 返回一个 RequestDispatcher 对象,它充当位于给定路径上的资源的包装器。可以使用 RequestDispatcher 对象将请求转发给资源,或者在响应中包含资源。资源可以是动态的,也可以是静态的。 |
String | getRealPath(String path) | 从 Java Servlet API 的版本 2.1 起,请改用 ServletContext#getRealPath |
int | getRemotePort() | 返回发送请求的客户端或最后一个代理的 Internet Protocol (IP) 源端口。 |
String | getLocalName() | 返回接收请求的 Internet Protocol (IP) 接口的主机名。 |
String | getLocalAddr() | 返回接收请求的接口的 Internet Protocol (IP) 地址。 |
int | getLocalPort() | 返回接收请求的接口的 Internet Protocol (IP) 端口号。 |
HttpServletRequest
返回值 | 方法名 | 描述 |
---|---|---|
Cookies | getCookies() | 返回包含客户端随此请求一起发送的所有 Cookie 对象的数组。 |
long | getDateHeader(String name) | 以表示 Date 对象的 long 值的形式返回指定请求头的值。 |
String | getHeader(String name) | 以 String 的形式返回指定请求头的值。 |
Enumeration | getHeaders(String name) | 以 String 对象的 Enumeration 的形式返回指定请求头的所有值。 |
Enumeration | getHeaderNames() | 返回此请求包含的所有头名称的枚举。如果该请求没有头,则此方法返回一个空枚举。 |
int | getIntHeader(String name) | 以 int 的形式返回指定请求头的值。 |
String | getMethod() | 返回用于发出此请求的 HTTP 方法的名称,例如 GET、POST 或 PUT。返回的值与 CGI 变量 REQUEST_METHOD 的值相同。 |
String | getPathInfo() | 返回与客户端发出此请求时发送的 URL 相关联的额外路径信息。额外路径信息位于 servlet 路径之后但在查询字符串之前,并且将以 “/” 字符开头。 |
String | getPathTranslated() | 返回在 servlet 名称之后但在查询字符串之前的额外路径信息,并将它转换为实际路径。返回的值与 CGI 变量 PATH_TRANSLATED 的值相同。 |
String | getContextPath() | 返回请求 URI 指示请求上下文的那一部分。请求 URI 中首先出现的总是上下文路径。路径以 “/” 字符开头但不以 “/” 字符结束。对于默认(根)上下文中的 servlet,此方法返回 “”。容器不会解码此字符串。 |
String | getQueryString() | 返回包含在请求 URL 中路径后面的查询字符串。如果 URL 没有查询字符串,则此方法返回 null 。返回的值与 CGI 变量 QUERY_STRING 的值相同。 |
String | getRequestedSessionId() | 返回客户端指定的会话 ID。此值可能不同于此请求的当前有效会话的 ID。如果客户端没有指定会话 ID,则此方法返回 null 。 |
String | getRequestURL() | 重新构造客户端用于发出请求的 URL。返回的 URL 包含一个协议、服务器名称、端口号、服务器路径,但是不包含查询字符串参数。 |
String | getServletPath() | 返回此请求调用 servlet 的 URL 部分。此路径以 “/” 字符开头,包括 servlet 名称或到 servlet 的路径,但不包括任何额外路径信息或查询字符串。返回的值与 CGI 变量 SCRIPT_NAME 的值相同。 |
HttpSession | getSession(boolean create) | 返回与此请求关联的当前 HttpSession ,如果没有当前会话并且 create 为 true,则返回一个新会话。 |
HttpSession | getSession() | 返回与此请求关联的当前会话,如果该请求没有会话,则创建一个会话。 |
boolean | isRequestedSessionIdValid() | 检查请求的会话 ID 是否仍然有效。 |
boolean | isRequestedSessionIdFromCookie() | 检查请求的会话 ID 是否是作为 cookie 进入的。 |
boolean | isRequestedSessionIdFromURL() | 检查请求的会话 ID 是否是作为请求 URL 的一部分进入的。 |