本文主要從三個(gè)部分?jǐn)⑹鲫P(guān)于一般平臺(tái)日志模塊的實(shí)現(xiàn)
- 開發(fā)工具:springMvc4.3、jdk8、mybatis3.3
- 概述
這里的日志主要是記錄用戶在平臺(tái)上的操作、以及操作結(jié)果。實(shí)現(xiàn)思路，則重點(diǎn)記錄
用戶發(fā)送請(qǐng)求中的部分?jǐn)?shù)據(jù)，以及執(zhí)行后返回的結(jié)果在寫入響應(yīng)body前拿到controller返回?cái)?shù)據(jù)。將這兩個(gè)部分的數(shù)據(jù)保存到對(duì)應(yīng)的日志表中
- 表結(jié)構(gòu)如下：
-- ----------------------------------------------------------------
-- 用戶操作日志表
-- ----------------------------------------------------------------
DROP TABLE IF EXISTS `LOG`;
CREATE TABLE `LOG` (
`ID` INT(12) NOT NULL AUTO_INCREMENT COMMENT '日志編號(hào)',
`LOG_MODULE` VARCHAR(50) COMMENT '操作模塊',
`REQUEST_IP` VARCHAR(20) COMMENT '請(qǐng)求IP',
`USER_ID` INT(11) NOT NULL COMMENT '用戶編號(hào)',
`ROLE_NAME` VARCHAR(50) COMMENT '角色名稱',
`USER_NAME` VARCHAR(50) COMMENT '用戶名稱',
`LOG_ACTION` VARCHAR(50) COMMENT '操作行為',
`LOG_RESULT` VARCHAR(20) DEFAULT NULL COMMENT '請(qǐng)求結(jié)果',
`LOG_TIME` TIMESTAMP COMMENT '請(qǐng)求時(shí)間',
PRIMARY KEY (`ID`)
) ENGINE=INNODB AUTO_INCREMENT=1 DEFAULT CHARSET=UTF8;
-- ----------------------------------------------
-- 用戶日志記錄的請(qǐng)求初始如下
-- ----------------------------------------------
DROP TABLE IF EXISTS `LOG_ACTION`;
CREATE TABLE `LOG_ACTION` (
`ID` INT(11) NOT NULL AUTO_INCREMENT COMMENT '權(quán)限ID',
`ACTION_URI` VARCHAR(100) COMMENT 'URI',
`ACTION_MODULE` VARCHAR(100) COMMENT '操作所屬的模塊',
`ACTION_DESC` VARCHAR(200) COMMENT '動(dòng)作描述',
UNIQUE INDEX index_action(ACTION_URI),
PRIMARY KEY (`ID`)
) ENGINE=INNODB AUTO_INCREMENT=1 DEFAULT CHARSET=UTF8;
-- 可插入如下初始數(shù)據(jù)
insert into log_action(action_uri,action_Module,action_desc) values ('/abc/bcd.do','用戶中心','新建用戶');
....等
- 相關(guān)說明：LOG表是用于記錄日志，log_action表則是記錄那些請(qǐng)求時(shí)需要日志模塊記錄的
- 代碼模塊
- 注意：關(guān)于實(shí)體類LogAction（平臺(tái)日志的uri對(duì)應(yīng)的描述）、RequestModel（要保存日志的詳細(xì)信息）。他們的實(shí)體類和對(duì)應(yīng)的mybatis dao操作這里不再額外敘述
- 平臺(tái)啟動(dòng)緩存數(shù)據(jù)類
/**
* Copyright: Copyright (c) 2017 LanRu-Caifu
* @author
* @ClassName: ActionUrlCache.java
* @Description: 緩存初始化需要攔截請(qǐng)求保存到日志
* @version: v1.0.0
*/
public final class ActionUrlCache {
private ActionUrlCache(){}
//緩存地區(qū)服務(wù)地址
private static final ConcurrentHashMap<String, String> actionCache = new ConcurrentHashMap<>();
//獲取緩存
public static ConcurrentHashMap<String, String> getActionCache(){
return actionCache;
}
//添加服務(wù)地址
public static void addService(String k ,String v){
//重復(fù)覆蓋
actionCache.put(k,v);
}
//是否存在指定的key
public static boolean isExist(String k){
return actionCache.containsKey(k);
}
//判讀當(dāng)前緩存是否為空
public static boolean isEmpyt(){
return actionCache.size()<=0;
}
。。。省略
}
- 這里的初始化數(shù)據(jù)可自定義（繼承springInitializingBean 接口），保存需要在之后查找的方式
/**
* Copyright: Copyright (c) 2017 LanRu-Caifu
* @author
* @ClassName: InitServiceUrl.java
* @Description: 平臺(tái)啟動(dòng)初始化某些數(shù)據(jù)
* @version: v1.0.0
*/
@Component
public class InitServiceUrl implements InitializingBean {
private static final Logger LOGGER = Logger.getLogger(InitServiceUrl.class);
@Resource
private LogActionService lAS;
//初始化方法
@Override
public void afterPropertiesSet() throws Exception {
List<LogAction> logActions = lAS.getAllAction();
if(null == logActions){
LOGGER.error("沒有配置日志攔截信息");
return ;
}
for(LogAction logAction:logActions){
ActionUrlCache.addService(logAction.getActionUri(), logAction.getActionDesc());
}
}
}
- 在攔截器中獲取請(qǐng)求中的部分?jǐn)?shù)據(jù)封裝到日志記錄實(shí)體類requestMoudel。
@Repository
public class AccessInterceptor implements HandlerInterceptor {
private static final Logger LOGGER = Logger.getLogger(AccessInterceptor.class);
。。。省略部分
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
。。。省略部分
String request_uri = request.getRequestURI();
//該uri存在預(yù)設(shè)，且為springmvc Controller處理
if (ActionUrlCache.isExist(request_uri) && handler instanceof HandlerMethod) {
RequestModel requestModel = new RequestModel();
requestModel.setRequestIp(getIpAddr(request));//ip
requestModel.setUserName(user.getUserName());
requestModel.setUserId(user.getUserId());;
requestModel.setUri(request_uri);
Role role = (Role)request.getSession().getAttribute("role");
requestModel.setRoleName(role != null?role.getRoleName():null);
requestModel.setLogTime(TimeUtil.getCurrentDate());//日期
RequestModel.setRequestModel(requestModel);
}
return true;
}
。。。省略部分
- 下面這個(gè)類是在響應(yīng)寫入body時(shí)的提前處理，可以獲取Controller中的。需要實(shí)現(xiàn)spring的ResponseBodyAdvice接口，且需要注入spring容器
/**
* Copyright: Copyright (c) 2017 LanRu-Caifu
* @author xzg
* @ClassName: LogResponseBodyAdvice.java
* @Description: 在響應(yīng)寫入body時(shí)的提前處理，可以獲取Controller中的返回?cái)?shù)據(jù)
* @version: v1.0.0
*/
@ControllerAdvice
public class LogResponseBodyAdvice implements ResponseBodyAdvice<Object>{
@Resource
private OperateLogService operateLogService;
@Override
public Object beforeBodyWrite(Object result, MethodParameter returnType, MediaType selectedContentType,
Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
//獲取在ApiInterceptor對(duì)指定請(qǐng)求參數(shù)放如到線程局部變量的對(duì)象
RequestModel model = RequestModel.getRequestModel();
//移除線程局部變量,釋放內(nèi)存
RequestModel.removeRequestModel();
//保存日志
operateLogService.saveLog(model, result);
return result;
}
。。。省略
- 一下為用到的接口，具體實(shí)現(xiàn)類以及操作數(shù)據(jù)庫(kù)的DAO這里不再敘述
日志url服務(wù)接口，獲取平臺(tái)初始化的數(shù)據(jù)
public interface LogActionService {
public List<LogAction> getAllAction();
}
日志操作接口，保存日志信息。RequestModel為日志信息的實(shí)體類
public interface LogModuleService {
public Result getLog(Map<String,Object> params);
public void addLog(RequestModel rm);
}
作為處理響應(yīng)時(shí)的操作日志方法
public interface OperateLogService {
public void saveLog(RequestModel model,Object result);
}
