com.mingsoft.basic.servlet

类 BaseServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.mingsoft.basic.servlet.BaseServlet

所有已实现的接口:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

直接已知子类:

CodeServlet, DownloadServlet, IndexServlet, ProxyServlet, QrcodeServlet, UploadServlet

public abstract class BaseServlet
extends javax.servlet.http.HttpServlet

基础通用servlet

版本:

版本号：100-000-000
创建日期：2012-03-15
历史修订：

作者:

王天培QQ:78750478

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
org.apache.log4j.Logger	logger

构造器概要

构造器

构造器和说明
BaseServlet()

方法概要

方法

限定符和类型	方法和说明
protected Map<String,Object>	assemblyRequestMap(javax.servlet.http.HttpServletRequest request) 将请求的request的参数重新组装。
void	destroy() 执行清理操作
protected AppEntity	getApp(javax.servlet.http.HttpServletRequest request, IAppBiz appBiz) 根据地址来查询对应的站点信息，依赖于websiteBiz
protected Object	getBean(javax.servlet.ServletContext sc, String beanName) 通过spring的webapplicationcontext上下文对象读取bean对象
protected String	getDomain(javax.servlet.http.HttpServletRequest request) 获取请求域名，域名不包括http请求协议头
protected int	getInt(javax.servlet.http.HttpServletRequest request, String fieldName) 根据字段获取请求参数中的整型值
protected int	getInt(javax.servlet.http.HttpServletRequest request, String fieldName, int defaultValue) 根据字段获取请求参数中的整型值
String	getIpAddr(javax.servlet.http.HttpServletRequest request) 获取用户真实IP
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, com.mingsoft.base.constant.e.BaseSessionEnum key) 获取session
protected Object	getSession(javax.servlet.http.HttpServletRequest request, SessionConstEnum key) 获取session
protected String	getString(javax.servlet.http.HttpServletRequest request, String fieldName) 根据字段获取请求参数中的字符串值
protected String	getUrl(javax.servlet.http.HttpServletRequest request) 获取项目路径
void	init() 使过滤器为处理做准备
boolean	isMobileDevice(javax.servlet.http.HttpServletRequest request) 根据当前请求的特征，判断该请求是否来自手机终端，主要检测特殊的头信息，以及user-Agent这个header
protected void	outJson(javax.servlet.http.HttpServletResponse resp, com.mingsoft.base.constant.e.BaseEnum code, boolean flag, String msg) 输出json数据
protected void	outJson(javax.servlet.http.HttpServletResponse resp, com.mingsoft.base.constant.e.BaseEnum code, boolean flag, String msg, String data) 输出json数据
protected void	outJson(javax.servlet.http.HttpServletResponse response, Object jsonDataStr) 输出json数据字符串
protected void	outString(javax.servlet.http.HttpServletResponse response, Object dataStr) 输出String数据字符串
String	readStreamParameter(javax.servlet.http.HttpServletRequest request) 获取请求的数据流，主要提供给微信平台接口使用
protected void	removeSession(javax.servlet.http.HttpServletRequest request, com.mingsoft.base.constant.e.BaseSessionEnum key) 移除session的值
protected void	sendHtml(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String html) 输出html文本
protected void	setCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, CookieConstEnum key, Object value) 设置Cookie的attr中的值
protected void	setSession(javax.servlet.http.HttpServletRequest request, com.mingsoft.base.constant.e.BaseSessionEnum key, Object obj) 设置session
protected void	setSession(javax.servlet.http.HttpServletRequest request, SessionConstEnum key, Object obj) 设置session

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

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

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

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

logger

public org.apache.log4j.Logger logger

构造器详细资料

BaseServlet

public BaseServlet()

方法详细资料

destroy

public void destroy()

执行清理操作

指定者:

destroy 在接口中 javax.servlet.Servlet

覆盖:

destroy 在类中 javax.servlet.GenericServlet

init

public void init()
          throws javax.servlet.ServletException

使过滤器为处理做准备

覆盖:

init 在类中 javax.servlet.GenericServlet

抛出:

javax.servlet.ServletException

sendHtml

protected void sendHtml(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response,
            String html)

输出html文本

参数:

request - HttpServletRequest对象

response - HttpServletResponse 对象

html - html文本内容

getIpAddr

public String getIpAddr(javax.servlet.http.HttpServletRequest request)

获取用户真实IP

参数:

request - HttpServletRequest对象

返回:

返回用户IP

readStreamParameter

public String readStreamParameter(javax.servlet.http.HttpServletRequest request)

获取请求的数据流，主要提供给微信平台接口使用

参数:

request - HttpServletRequest对象

返回:

返回请求的数据流，例如：微信平台会返回JSON或xml字符串

outString

protected void outString(javax.servlet.http.HttpServletResponse response,
             Object dataStr)

输出String数据字符串

参数:

response - HttpServletResponse 对象

dataStr - 数据对象

outJson

protected void outJson(javax.servlet.http.HttpServletResponse response,
           Object jsonDataStr)

输出json数据字符串

参数:

response - HttpServletResponse 对象

jsonDataStr - json数据对象

setSession

protected void setSession(javax.servlet.http.HttpServletRequest request,
              SessionConstEnum key,
              Object obj)

设置session

参数:

request - HttpServletRequest 对象

key - 键SessionConst里面定义

obj - 对象

getSession

protected Object getSession(javax.servlet.http.HttpServletRequest request,
                SessionConstEnum key)

获取session

参数:

request - HttpServletRequest 对象

key - 键SessionConst里面定义

setSession

protected void setSession(javax.servlet.http.HttpServletRequest request,
              com.mingsoft.base.constant.e.BaseSessionEnum key,
              Object obj)

设置session

参数:

request - HttpServletRequest 对象

key - 键SessionConst里面定义

obj - 对象

getSession

protected Object getSession(javax.servlet.http.HttpServletRequest request,
                com.mingsoft.base.constant.e.BaseSessionEnum key)

获取session

参数:

request - HttpServletRequest 对象

key - 键SessionConst里面定义

removeSession

protected void removeSession(javax.servlet.http.HttpServletRequest request,
                 com.mingsoft.base.constant.e.BaseSessionEnum key)

移除session的值

参数:

request - HttpServletRequest对象

key - 枚举类中的值

setCookie

protected void setCookie(javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response,
             CookieConstEnum key,
             Object value)

设置Cookie的attr中的值

参数:

request - HttpServletRequest对象

response - HttpServletResponse 对象

key - 枚举类中的值

value - 存储对象

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对象

返回:

返回域名地址

outJson

protected void outJson(javax.servlet.http.HttpServletResponse resp,
           com.mingsoft.base.constant.e.BaseEnum code,
           boolean flag,
           String msg)

输出json数据

参数:

resp - HttpServletRequest对象

code - 模块编号

flag - 成功状态,true:成功、false:失败

msg - 提示信息

outJson

protected void outJson(javax.servlet.http.HttpServletResponse resp,
           com.mingsoft.base.constant.e.BaseEnum code,
           boolean flag,
           String msg,
           String data)

输出json数据

参数:

resp - HttpServletRequest对象

code - 模块编号

flag - 成功状态,true:成功、false:失败

msg - 提示信息

data - 返回数据

getString

protected String getString(javax.servlet.http.HttpServletRequest request,
               String fieldName)

根据字段获取请求参数中的字符串值

参数:

request - HttpServletRequest对象

fieldName - 字段名称

返回:

返回请求到的字符串，获取不到返回null

getInt

protected int getInt(javax.servlet.http.HttpServletRequest request,
         String fieldName)

根据字段获取请求参数中的整型值

参数:

request - HttpServletRequest对象

fieldName - 字段名称

返回:

返回请求到的整型值，获取不到返回0，也有例外，具体更具业务来定

getInt

protected int getInt(javax.servlet.http.HttpServletRequest request,
         String fieldName,
         int defaultValue)

根据字段获取请求参数中的整型值

参数:

request - HttpServletRequest对象

fieldName - 字段名称

defaultValue - 默认值

返回:

返回请求到的整型值，获取不到返回默认值

getBean

protected Object getBean(javax.servlet.ServletContext sc,
             String beanName)

通过spring的webapplicationcontext上下文对象读取bean对象

参数:

sc - 上下文servletConext对象

beanName - 要读取的bean的名称

返回:

返回读取的对象，获取不到返回null

getRealPath

protected String getRealPath(javax.servlet.http.HttpServletRequest request,
                 String filePath)

获取当期项目物理路径

参数:

request - HttpServletRequest对象

filePath - 相对文件夹

返回:

返回当前项目的物理路径

getResString

protected String getResString(String key)

读取国际化资源文件

参数:

key - 资源文件键值

返回:

返回键对应的值

getResString

protected String getResString(String key,
                  ResourceBundle rb)

读取国际化资源文件

参数:

key - 资源文件键值

rb - 资源文件对象

返回:

返回键对应的值

getResString

protected String getResString(String key,
                  ResourceBundle rb,
                  String... fullStrs)

读取国际化资源文件

参数:

key - 资源文件键值

fullStrs - 需填充的值

返回:

返回键对应的值

getResString

protected String getResString(String key,
                  String... fullStrs)

读取国际化资源文件

参数:

key - 资源文件键值

fullStrs - 需填充的值

返回:

返回键对应的值

getApp

protected AppEntity getApp(javax.servlet.http.HttpServletRequest request,
               IAppBiz appBiz)

根据地址来查询对应的站点信息，依赖于websiteBiz

参数:

request - HttpServletRequest对象

appBiz - 站点业务层

返回:

返回站点实体

isMobileDevice

public boolean isMobileDevice(javax.servlet.http.HttpServletRequest request)

根据当前请求的特征，判断该请求是否来自手机终端，主要检测特殊的头信息，以及user-Agent这个header

参数:

request - HttpServletRequest对象

返回:

如果命中手机特征规则，则返回对应的特征字符串

assemblyRequestMap

protected Map<String,Object> assemblyRequestMap(javax.servlet.http.HttpServletRequest request)

将请求的request的参数重新组装。主要是将空值的替换成null,因为requestMap空值是"",这样处理有利于外部判断, 同时将获取到的值映射到页面上

参数:

request - HttpServletRequest对象

返回:

返回处理过后的数据