MvcRequest (AJAXJS-Base 1.2.6 API)

java.lang.Object
- javax.servlet.ServletRequestWrapper
- - javax.servlet.http.HttpServletRequestWrapper
  - - com.ajaxjs.web.mvc.MvcRequest

所有已实现的接口:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
```
public class MvcRequest
extends javax.servlet.http.HttpServletRequestWrapper
```
通过 HttpServletRequestWrapper （装饰模式的应用）增强 HttpServletRequest的功能。

作者:

sp42 frank@ajaxjs.com

字段概要

字段
限定符和类型字段和说明

static String CALLBACK_PARAM
全局的 callback 参数名
- 从接口继承的字段 javax.servlet.http.HttpServletRequest
  BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

字段
限定符和类型	字段和说明
`static String`	`CALLBACK_PARAM` 全局的 callback 参数名

构造器概要

构造器
构造器和说明

MvcRequest(javax.servlet.http.HttpServletRequest req)
创建一个 MVC 请求对象。

构造器
构造器和说明
`MvcRequest(javax.servlet.http.HttpServletRequest req)` 创建一个 MVC 请求对象。

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static void`	`clean()` 清空 request 和 response
`String`	`getBasePath()` 返回协议+主机名+端口+项目前缀（如果为 80 端口的话就默认不写 80）
`<T> T`	`getBean(Class<T> clz)` 支持自动获取请求参数并封装到 Bean 内
`String`	`getFolder()` 目录部分
`static javax.servlet.http.HttpServletRequest`	`getHttpServletRequest()` 获取请求对象
`static javax.servlet.http.HttpServletResponse`	`getHttpServletResponse()` 获取上下文中 response 对象
`String`	`getIdOnly(String key)` 返回 SQL 类型安全的参数，必须为数字
`String`	`getIp()` 获取请求 ip
`Map<String,Object>`	`getMap()`
`static MvcRequest`	`getMvcRequest()` 获取请求对象
`String`	`getParameter(String key, String defaultValue)` 获取参数的值。
`Map<String,Object>`	`getPutRequestData()` 获取 PUT 请求所提交的内容。
`String`	`getRequestURI()` 绑定 JSP 时候，获取原请求的 uri，而非模版所在的 uri
`String`	`getRoute()` 获取资源 URI，忽略项目前缀和最后的文件名（如 index.jsp）分析 URL 目标资源（最原始的版本）
`String`	`getValueFromPath(String value, String param)` 去取 url 上的值
`boolean`	`hasParameter(String key)` 如果有这个参数返回 true。
`static String`	`mappath(javax.servlet.ServletContext cxt, String relativePath)` 获取磁盘真實地址
`String`	`mappath(String relativePath)` 输入一个相对地址，补充成为绝对地址相对地址转换为绝对地址，并转换斜杠
`void`	`saveToReuqest(Map<String,Object> map)` 保存到 request
`static void`	`setHttpServletRequest(javax.servlet.http.HttpServletRequest req)` 保存一个 request 对象
`static void`	`setHttpServletResponse(javax.servlet.http.HttpServletResponse resp)` 保存一个 response 对象

从类继承的方法 javax.servlet.http.HttpServletRequestWrapper
authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, login, logout, upgrade

从类继承的方法 javax.servlet.ServletRequestWrapper
getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 javax.servlet.ServletRequest
getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

- 字段详细资料
  - CALLBACK_PARAM
```
public static final String CALLBACK_PARAM
```
    全局的 callback 参数名
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - MvcRequest
```
public MvcRequest(javax.servlet.http.HttpServletRequest req)
```
    创建一个 MVC 请求对象。构造方法会自动加入 UTF-8 编码。
    
    参数:
    
    req - 原始请求对象
- 方法详细资料
  - getRequestURI
```
public String getRequestURI()
```
    绑定 JSP 时候，获取原请求的 uri，而非模版所在的 uri
    
    指定者:
    
    getRequestURI 在接口中 javax.servlet.http.HttpServletRequest
    
    覆盖:
    
    getRequestURI 在类中 javax.servlet.http.HttpServletRequestWrapper
  - getRoute
```
public String getRoute()
```
    获取资源 URI，忽略项目前缀和最后的文件名（如 index.jsp）分析 URL 目标资源（最原始的版本）
    
    返回:
    
    请求路径
  - getFolder
```
public String getFolder()
```
    目录部分
    
    返回:
    
    目录
  - getPutRequestData
```
public Map<String,Object> getPutRequestData()
```
    获取 PUT 请求所提交的内容。 Servlet 不能获取 PUT 请求内容，所以这里写一个方法
    
    返回:
    
    参数、值集合
  - getValueFromPath
```
public String getValueFromPath(String value,
                               String param)
```
    去取 url 上的值
    
    参数:
    
    value - 方法上的路径
    
    param - 参数名称
    
    返回:
    
    值
  - getMap
```
public Map<String,Object> getMap()
```
  - getBean
```
public <T> T getBean(Class<T> clz)
```
    支持自动获取请求参数并封装到 Bean 内
    
    类型参数:
    
    T - Bean 类型
    
    参数:
    
    clz - Bean 的类引用
    
    返回:
    
    Java Bean
  - saveToReuqest
```
public void saveToReuqest(Map<String,Object> map)
```
    保存到 request
    
    参数:
    
    map - 请求参数
  - setHttpServletRequest
```
public static void setHttpServletRequest(javax.servlet.http.HttpServletRequest req)
```
    保存一个 request 对象
    
    参数:
    
    req - 请求对象
  - getHttpServletRequest
```
public static javax.servlet.http.HttpServletRequest getHttpServletRequest()
```
    获取请求对象
    
    返回:
    
    请求对象
  - getMvcRequest
```
public static MvcRequest getMvcRequest()
```
    获取请求对象
    
    返回:
    
    请求对象
  - setHttpServletResponse
```
public static void setHttpServletResponse(javax.servlet.http.HttpServletResponse resp)
```
    保存一个 response 对象
    
    参数:
    
    resp - 响应对象
  - getHttpServletResponse
```
public static javax.servlet.http.HttpServletResponse getHttpServletResponse()
```
    获取上下文中 response 对象
    
    返回:
    
    response 响应对象
  - clean
```
public static void clean()
```
    清空 request 和 response
  - mappath
```
public static String mappath(javax.servlet.ServletContext cxt,
                             String relativePath)
```
    获取磁盘真實地址
    
    参数:
    
    cxt - Web 上下文
    
    relativePath - 相对地址
    
    返回:
    
    绝对地址
  - mappath
```
public String mappath(String relativePath)
```
    输入一个相对地址，补充成为绝对地址相对地址转换为绝对地址，并转换斜杠
    
    参数:
    
    relativePath - 相对地址，例如 /images
    
    返回:
    
    绝对地址
  - getBasePath
```
public String getBasePath()
```
    返回协议+主机名+端口+项目前缀（如果为 80 端口的话就默认不写 80）
    
    返回:
    
    网站名称
  - getIp
```
public String getIp()
```
    获取请求 ip
    
    返回:
    
    客户端 ip
  - hasParameter
```
public boolean hasParameter(String key)
```
    如果有这个参数返回 true。
    
    参数:
    
    key - 键名称
    
    返回:
    
    true 表示为有这个键
  - getParameter
```
public String getParameter(String key,
                           String defaultValue)
```
    获取参数的值。若为 null 时的默认值
    
    参数:
    
    key - 键名称
    
    defaultValue - 若为 null 时的默认值
    
    返回:
    
    参数内容
  - getIdOnly
```
public String getIdOnly(String key)
```
    返回 SQL 类型安全的参数，必须为数字
    
    参数:
    
    key - 键名称
    
    返回:
    
    Id

类 MvcRequest

字段概要

从接口继承的字段 javax.servlet.http.HttpServletRequest

构造器概要

方法概要

从类继承的方法 javax.servlet.http.HttpServletRequestWrapper

从类继承的方法 javax.servlet.ServletRequestWrapper

从类继承的方法 java.lang.Object

从接口继承的方法 javax.servlet.ServletRequest

字段详细资料

CALLBACK_PARAM

构造器详细资料

MvcRequest

方法详细资料

getRequestURI

getRoute

getFolder

getPutRequestData

getValueFromPath

getMap

getBean

saveToReuqest

setHttpServletRequest

getHttpServletRequest

getMvcRequest

setHttpServletResponse

getHttpServletResponse

clean

mappath

mappath

getBasePath

getIp

hasParameter

getParameter

getIdOnly