BaseAction (net.mingsoft:ms-base 1.0.6 API)

java.lang.Object
- com.mingsoft.base.action.BaseAction

直接已知子类:: ErrorAction

public abstract class BaseAction
extends Object

字段概要

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

protected org.apache.log4j.Logger LOG

protected String managerPath
管理基础路径

字段
限定符和类型	字段和说明
`protected org.apache.log4j.Logger`	`LOG`
`protected String`	`managerPath` 管理基础路径

构造器概要

构造器
构造器和说明

BaseAction()

构造器
构造器和说明
`BaseAction()`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`protected Map<String,Object>`	`assemblyRequestMap(javax.servlet.http.HttpServletRequest request)` 已过时。
`protected String`	`assemblyRequestUrlParams(javax.servlet.http.HttpServletRequest request)` 将请求的request的参数重新组装。
`protected String`	`assemblyRequestUrlParams(javax.servlet.http.HttpServletRequest request, String[] filter)` 已过时。
`protected Object`	`getBean(javax.servlet.ServletContext sc, String beanName)` 通过spring的webapplicationcontext上下文对象读取bean对象
`protected Object`	`getBean(String beanName)` 通过spring的webapplicationcontext上下文对象读取bean对象
`protected Boolean`	`getBoolean(javax.servlet.http.HttpServletRequest request, String param)` 获取布尔值
`protected String`	`getCookie(javax.servlet.http.HttpServletRequest request, BaseCookieEnum key)` 获取Cookie的值
`protected String`	`getDomain(javax.servlet.http.HttpServletRequest request)` 获取请求域名，域名不包括http请求协议头
`protected String`	`getHost(javax.servlet.http.HttpServletRequest request)` 读取服务器主机信息
`protected String`	`getHostIp()` 读取服务器主机ip信息
`protected Integer`	`getInt(javax.servlet.http.HttpServletRequest request, String param)` 获取整型值
`protected Integer`	`getInt(javax.servlet.http.HttpServletRequest request, String param, int def)` 获取整型值
`protected Integer`	`getIntBase64(javax.servlet.http.HttpServletRequest request, String param)` 获取base64机密的整型值
`String`	`getIp(javax.servlet.http.HttpServletRequest request)` 获取请求客户端ip
`String`	`getMACAddress(String ip)` 获取对应ip地址的mac地址
`protected Map<String,String>`	`getMapByProperties(ResourceBundle rb)`
`protected Map<String,String>`	`getMapByProperties(String filePath)` 根据属性配置文件返回map
`protected Integer`	`getPageNo(javax.servlet.http.HttpServletRequest request)` 获取当前页码,默认参数名称pageNo
`protected Integer`	`getPageSize(javax.servlet.http.HttpServletRequest request)` 获取当前一页显示数量,默认参数名称pageSize 默认10条
`protected Integer`	`getPageSize(javax.servlet.http.HttpServletRequest request, int pageSize)` 获取当前一页显示数量,默认参数名称pageSize
`protected String`	`getRealPath(javax.servlet.http.HttpServletRequest request, String filePath)` 获取当期项目物理路径
`protected String`	`getResString(String key)` 读取国际化资源文件
`protected String`	`getResString(String key, ResourceBundle rb)` 读取国际化资源文件，优先模块对应的资源文件，如果模块资源文件找不到就会优先基础层
`protected String`	`getResString(String key, ResourceBundle rb, String... fullStrs)` 读取国际化资源文件，优先模块对应的资源文件，如果模块资源文件找不到就会优先基础层
`protected String`	`getResString(String key, String... fullStrs)` 读取国际化资源文件
`protected Object`	`getSession(javax.servlet.http.HttpServletRequest request, BaseSessionEnum key)` 获取session的值
`protected String`	`getUrl(javax.servlet.http.HttpServletRequest request)` 获取项目路径
`boolean`	`isMobileDevice(javax.servlet.http.HttpServletRequest request)` 根据当前请求的特征，判断该请求是否来自手机终端，主要检测特殊的头信息，以及user-Agent这个header
`protected void`	`outJson(javax.servlet.http.HttpServletResponse response, BaseEntity entity)` 将BaseEntity以json字符串格式输出
`protected void`	`outJson(javax.servlet.http.HttpServletResponse response, BaseEnum code, boolean flag)` 输出json数据
`protected void`	`outJson(javax.servlet.http.HttpServletResponse response, BaseEnum code, boolean flag, String msg)` 输出json数据
`protected void`	`outJson(javax.servlet.http.HttpServletResponse response, BaseEnum code, boolean flag, String msg, Object data)` 输出json数据
`protected void`	`outJson(javax.servlet.http.HttpServletResponse response, boolean flag)` 输出json数据
`protected void`	`outJson(javax.servlet.http.HttpServletResponse response, boolean flag, String msg)` 输出json数据
`protected void`	`outJson(javax.servlet.http.HttpServletResponse response, List list)` 将list以json字符串格式输出
`protected void`	`outJson(javax.servlet.http.HttpServletResponse response, List list, String... filters)` 将list以json字符串格式输出，可以设置过滤属性字断
`protected void`	`outJson(javax.servlet.http.HttpServletResponse response, List list, String dateFmt)` 将list以json字符串格式输出
`protected void`	`outJson(javax.servlet.http.HttpServletResponse response, Object jsonDataStr)` 输出json数据字符串
`protected void`	`outJson(javax.servlet.http.HttpServletResponse response, Object obj, String... filters)` 将object以json字符串格式输出，可以设置过滤属性字断
`protected void`	`outString(javax.servlet.http.HttpServletResponse response, Object dataStr)` 输出String数据字符串
`protected String`	`readStreamParameter(javax.servlet.http.HttpServletRequest request)` 已过时。
`protected void`	`redirect(javax.servlet.http.HttpServletResponse response, String path)`
`protected void`	`removeSession(javax.servlet.http.HttpServletRequest request, BaseSessionEnum key)` 移除session的值
`protected void`	`setCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, BaseCookieEnum key, Object value)` 设置Cookie值
`protected void`	`setCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, BaseCookieEnum key, Object value, int maxAge)` 设置Cookie值
`protected void`	`setSession(javax.servlet.http.HttpServletRequest request, BaseSessionEnum key, Object value)` 设置session的值

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

- 字段详细资料
  - managerPath
```
@Value(value="${managerPath}")
protected String managerPath
```
    管理基础路径
  - LOG
```
protected final org.apache.log4j.Logger LOG
```
- 构造器详细资料
  - BaseAction
```
public BaseAction()
```
- 方法详细资料
  - getPageNo
```
protected Integer getPageNo(javax.servlet.http.HttpServletRequest request)
```
    获取当前页码,默认参数名称pageNo
    
    参数:
    
    request - HttpServletRequest对象
    
    返回:
    
    默认1,如果存在pageNo参数就返回相应的值
  - getPageSize
```
protected Integer getPageSize(javax.servlet.http.HttpServletRequest request)
```
    获取当前一页显示数量,默认参数名称pageSize 默认10条
    
    参数:
    
    request - HttpServletRequest对象
    
    返回:
    
    默认10,如果存在pageNo参数就返回相应的值
  - getPageSize
```
protected Integer getPageSize(javax.servlet.http.HttpServletRequest request,
                              int pageSize)
```
    获取当前一页显示数量,默认参数名称pageSize
    
    参数:
    
    request - HttpServletRequest对象
    
    pageSize - 一页显示条数
    
    返回:
    
    默认10,如果存在pageNo参数就返回相应的值
  - getInt
```
protected Integer getInt(javax.servlet.http.HttpServletRequest request,
                         String param)
```
    获取整型值
    
    参数:
    
    request - HttpServletRequest对象
    
    param - 参数名称
    
    返回:
    
    返回整型值，没找到返回null
  - getInt
```
protected Integer getInt(javax.servlet.http.HttpServletRequest request,
                         String param,
                         int def)
```
    获取整型值
    
    参数:
    
    request - HttpServletRequest对象
    
    param - 参数名称
    
    def - 默认值，如果参数不存在或不符合规则就用默认值替代
    
    返回:
    
    返回整型值
  - getIntBase64
```
protected Integer getIntBase64(javax.servlet.http.HttpServletRequest request,
                               String param)
```
    获取base64机密的整型值
    
    参数:
    
    request - HttpServletRequest对象
    
    param - 参数名称
    
    返回:
    
    返回base64的整型值,没找到返回null
  - getBoolean
```
protected Boolean getBoolean(javax.servlet.http.HttpServletRequest request,
                             String param)
```
    获取布尔值
    
    参数:
    
    request - HttpServletRequest对象
    
    param - 参数名称
    
    返回:
    
    返回布尔值，没找到返回null
  - getSession
```
protected Object getSession(javax.servlet.http.HttpServletRequest request,
                            BaseSessionEnum key)
```
    获取session的值
    
    参数:
    
    request - HttpServletRequest对象
    
    key - 枚举类中的值
    
    返回:
    
    session中获取的对象
  - setSession
```
protected void setSession(javax.servlet.http.HttpServletRequest request,
                          BaseSessionEnum key,
                          Object value)
```
    设置session的值
    
    参数:
    
    request - HttpServletRequest对象
    
    key - 枚举类中的值
  - removeSession
```
protected void removeSession(javax.servlet.http.HttpServletRequest request,
                             BaseSessionEnum key)
```
    移除session的值
    
    参数:
    
    request - HttpServletRequest对象
    
    key - 枚举类中的值
  - getCookie
```
protected String getCookie(javax.servlet.http.HttpServletRequest request,
                           BaseCookieEnum key)
```
    获取Cookie的值
    
    参数:
    
    request - HttpServletRequest对象
    
    key - 枚举类中的值
    
    返回:
    
    Cookie中获取的对象
  - setCookie
```
protected void setCookie(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         BaseCookieEnum key,
                         Object value)
```
    设置Cookie值
    
    参数:
    
    request - HttpServletRequest对象
    
    response - HttpServletResponse对象
    
    key - 枚举类中的值
    
    value - 存储对象
  - setCookie
```
protected void setCookie(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         BaseCookieEnum key,
                         Object value,
                         int maxAge)
```
    设置Cookie值
    
    参数:
    
    request - HttpServletRequest对象
    
    response - HttpServletResponse对象
    
    key - 枚举类中的值
    
    value - 存储对象
    
    maxAge - cookie生命周期以秒为单位
  - outJson
```
protected void outJson(javax.servlet.http.HttpServletResponse response,
                       BaseEnum code,
                       boolean flag,
                       String msg,
                       Object data)
```
    输出json数据
    
    参数:
    
    response - HttpServletResponse对象
    
    code - 模块编号
    
    flag - 成功状态,true:成功、false:失败
    
    msg - 提示信息
    
    data - 数据
  - outJson
```
protected void outJson(javax.servlet.http.HttpServletResponse response,
                       BaseEnum code,
                       boolean flag,
                       String msg)
```
    输出json数据
    
    参数:
    
    response - HttpServletResponse对象
    
    code - 模块编号
    
    flag - 成功状态,true:成功、false:失败
    
    msg - 提示信息
  - outJson
```
protected void outJson(javax.servlet.http.HttpServletResponse response,
                       boolean flag,
                       String msg)
```
    输出json数据
    
    参数:
    
    response - HttpServletResponse对象
    
    code - 模块编号
    
    flag - 成功状态,true:成功、false:失败
    
    msg - 提示信息
  - outJson
```
protected void outJson(javax.servlet.http.HttpServletResponse response,
                       BaseEnum code,
                       boolean flag)
```
    输出json数据
    
    参数:
    
    response - HttpServletResponse对象
    
    code - 模块编号
    
    flag - 成功状态,true:成功、false:失败
  - outJson
```
protected void outJson(javax.servlet.http.HttpServletResponse response,
                       boolean flag)
```
    输出json数据
    
    参数:
    
    response - HttpServletResponse对象
    
    flag - 成功状态,true:成功、false:失败
  - outJson
```
protected void outJson(javax.servlet.http.HttpServletResponse response,
                       Object jsonDataStr)
```
    输出json数据字符串
    
    参数:
    
    response - HttpServletResponse对象
    
    jsonDataStr - 字符串
  - outJson
```
protected void outJson(javax.servlet.http.HttpServletResponse response,
                       BaseEntity entity)
```
    将BaseEntity以json字符串格式输出
    
    参数:
    
    response -
    
    entity - 实体对象
  - outJson
```
protected void outJson(javax.servlet.http.HttpServletResponse response,
                       List list)
```
    将list以json字符串格式输出
    
    参数:
    
    response - HttpServletResponse对象
    
    list - 记录集合
  - outJson
```
protected void outJson(javax.servlet.http.HttpServletResponse response,
                       List list,
                       String... filters)
```
    将list以json字符串格式输出，可以设置过滤属性字断
    
    参数:
    
    response -
    
    list - 记录集合
    
    filters - 需要过滤调的属性字断,当只过滤一个属性的时候需要使用new String[]传递
  - outJson
```
protected void outJson(javax.servlet.http.HttpServletResponse response,
                       Object obj,
                       String... filters)
```
    将object以json字符串格式输出，可以设置过滤属性字断
    
    参数:
    
    response -
    
    list - 记录集合
    
    filters - 需要过滤调的属性字断,当只过滤一个属性的时候需要使用new String[]传递
  - outJson
```
protected void outJson(javax.servlet.http.HttpServletResponse response,
                       List list,
                       String dateFmt)
```
    将list以json字符串格式输出
    
    参数:
    
    response - HttpServletResponse对象
    
    list - 记录集合
    
    dateFmt - 日期格式化
  - redirect
```
protected void redirect(javax.servlet.http.HttpServletResponse response,
                        String path)
```
    参数:
    
    response - HttpServletResponse对象
    
    path - 日期格式化
  - outString
```
protected void outString(javax.servlet.http.HttpServletResponse response,
                         Object dataStr)
```
    输出String数据字符串
    
    参数:
    
    response - HttpServletResponse对象
    
    dataStr - 字符串
  - getUrl
```
protected String getUrl(javax.servlet.http.HttpServletRequest request)
```
    获取项目路径
    
    参数:
    
    request - HttpServletRequest对象
    
    返回:
    
    返回项目路径，例如：http://www.ip.com/projectName 后面没有反斜杠，后面接地址或参数必须加/
  - getDomain
```
protected String getDomain(javax.servlet.http.HttpServletRequest request)
```
    获取请求域名，域名不包括http请求协议头
    
    参数:
    
    request - HttpServletRequest对象
    
    返回:
    
    返回域名地址
  - getHost
```
protected String getHost(javax.servlet.http.HttpServletRequest request)
```
    读取服务器主机信息
    
    参数:
    
    request - HttpServletRequest对象
    
    返回:
    
    返回主机信息
  - getHostIp
```
protected String getHostIp()
```
    读取服务器主机ip信息
    
    返回:
    
    返回主机IP，异常将会获取不到ip
  - getResString
```
protected String getResString(String key)
```
    读取国际化资源文件
    
    参数:
    
    key - 键值
    
    返回:
    
    返回获取到的字符串
  - getResString
```
protected String getResString(String key,
                              ResourceBundle rb)
```
    读取国际化资源文件，优先模块对应的资源文件，如果模块资源文件找不到就会优先基础层
    
    参数:
    
    key - 键值
    
    rb - 模块对应资源文件
    
    返回:
    
    返回获取到的字符串
  - getResString
```
protected String getResString(String key,
                              String... fullStrs)
```
    读取国际化资源文件
    
    参数:
    
    key - 键值
    
    fullStrs - 需填充的值
    
    返回:
    
    返回获取到的字符串
  - getResString
```
protected String getResString(String key,
                              ResourceBundle rb,
                              String... fullStrs)
```
    读取国际化资源文件，优先模块对应的资源文件，如果模块资源文件找不到就会优先基础层
    
    参数:
    
    key - 键值
    
    rb - 模块对应资源文件
    
    返回:
    
    返回获取到的字符串
  - getBean
```
protected Object getBean(javax.servlet.ServletContext sc,
                         String beanName)
```
    通过spring的webapplicationcontext上下文对象读取bean对象
    
    参数:
    
    sc - 上下文servletConext对象
    
    beanName - 要读取的bean的名称
    
    返回:
    
    返回获取到的对象。获取不到返回null
  - getBean
```
protected Object getBean(String beanName)
```
    通过spring的webapplicationcontext上下文对象读取bean对象
    
    参数:
    
    beanName - 要读取的bean的名称
    
    返回:
    
    返回获取到的对象。获取不到返回nul
  - isMobileDevice
```
public boolean isMobileDevice(javax.servlet.http.HttpServletRequest request)
```
    根据当前请求的特征，判断该请求是否来自手机终端，主要检测特殊的头信息，以及user-Agent这个header
    
    参数:
    
    request - HttpServletRequest对象,http请求
    
    返回:
    
    如果命中手机特征规则，则返回对应的特征字符串
  - getMapByProperties
```
protected Map<String,String> getMapByProperties(String filePath)
```
    根据属性配置文件返回map
    
    返回:
    
    返回Map
  - getMapByProperties
```
protected Map<String,String> getMapByProperties(ResourceBundle rb)
```
  - getRealPath
```
protected String getRealPath(javax.servlet.http.HttpServletRequest request,
                             String filePath)
```
    获取当期项目物理路径
    
    参数:
    
    request - HttpServletRequest对象
    
    filePath - 相对路径文件夹
    
    返回:
    
    返回当期项目物理路径
  - assemblyRequestMap
```
@Deprecated
protected Map<String,Object> assemblyRequestMap(javax.servlet.http.HttpServletRequest request)
```
    已过时。
    
    将请求的request的参数重新组装。主要是将空值的替换成null,因为requestMap空值是"",这样处理有利于外部判断, 同时将获取到的值映射到页面上推荐使用BasicUtil类的静态方法
    
    参数:
    
    request - HttpServletRequest对象
    
    返回:
    
    返回处理过后的数据
  - assemblyRequestUrlParams
```
protected String assemblyRequestUrlParams(javax.servlet.http.HttpServletRequest request)
```
    将请求的request的参数重新组装。主要是将空值的替换成null,因为requestMap空值是"",这样处理有利于外部判断, 同时将获取到的值映射到页面上
    
    参数:
    
    request - HttpServletRequest对象
    
    返回:
    
    返回处理过后的数据
  - assemblyRequestUrlParams
```
@Deprecated
protected String assemblyRequestUrlParams(javax.servlet.http.HttpServletRequest request,
                                                      String[] filter)
```
    已过时。
    
    将请求的request的参数重新组装。主要是将空值的替换成null,因为requestMap空值是"",这样处理有利于外部判断, 同时将获取到的值映射到页面上推荐使用BasicUtil类的静态方法
    
    参数:
    
    filter - 需要过滤的字段
    
    request - HttpServletRequest对象
    
    返回:
    
    返回处理过后的数据
  - readStreamParameter
```
@Deprecated
protected String readStreamParameter(javax.servlet.http.HttpServletRequest request)
```
    已过时。
    
    获取请求的数据流，主要提供给微信平台接口使用推荐使用BasicUtil类的静态方法
    
    参数:
    
    request - HttpServletRequest对象
    
    返回:
    
    返回请求的数据流字符串，例如：微信平台会返回JSON或xml字符串
  - getIp
```
public String getIp(javax.servlet.http.HttpServletRequest request)
```
    获取请求客户端ip
    
    参数:
    
    request -
    
    返回:
    
    ip地址
  - getMACAddress
```
public String getMACAddress(String ip)
```
    获取对应ip地址的mac地址
    
    参数:
    
    ip -
    
    返回:
    
    mac地址

类 BaseAction

字段概要

构造器概要

方法概要

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

字段详细资料

managerPath

LOG

构造器详细资料

BaseAction

方法详细资料

getPageNo

getPageSize

getPageSize

getInt

getInt

getIntBase64

getBoolean

getSession

setSession

removeSession

getCookie

setCookie

setCookie

outJson

outJson

outJson

outJson

outJson

outJson

outJson

outJson

outJson

outJson

outJson

redirect

outString

getUrl

getDomain

getHost

getHostIp

getResString

getResString

getResString

getResString

getBean

getBean

isMobileDevice

getMapByProperties

getMapByProperties

getRealPath

assemblyRequestMap

assemblyRequestUrlParams

assemblyRequestUrlParams

readStreamParameter

getIp

getMACAddress