平台用户操作日志模块设计

本文主要从三个部分叙述关于一般平台日志模块的实现

• 开发工具:springMvc4.3、jdk8、mybatis3.3

1. 概述

这里的日志主要是记录用户在平台上的操作、以及操作结果。实现思路，则重点记录
用户发送请求中的部分数据，以及执行后返回的结果在写入响应body前拿到controller返回数据。将这两个部分的数据保存到对应的日志表中

2. 表结构如下：

-- ----------------------------------------------------------------
-- 用户操作日志表
-- ----------------------------------------------------------------
DROP TABLE IF EXISTS `LOG`;
CREATE TABLE `LOG` (
  `ID` INT(12) NOT NULL AUTO_INCREMENT COMMENT '日志编号',
  `LOG_MODULE` VARCHAR(50)  COMMENT '操作模块',
  `REQUEST_IP` VARCHAR(20) COMMENT '请求IP',
  `USER_ID` INT(11) NOT NULL  COMMENT '用户编号',
  `ROLE_NAME` VARCHAR(50)   COMMENT '角色名称',
  `USER_NAME` VARCHAR(50)   COMMENT '用户名称',
  `LOG_ACTION` VARCHAR(50)   COMMENT  '操作行为',
  `LOG_RESULT` VARCHAR(20) DEFAULT NULL COMMENT '请求结果',
  `LOG_TIME` TIMESTAMP  COMMENT  '请求时间',
  PRIMARY KEY (`ID`)
) ENGINE=INNODB AUTO_INCREMENT=1 DEFAULT CHARSET=UTF8;
-- ----------------------------------------------
-- 用户日志记录的请求初始如下
-- ----------------------------------------------
DROP TABLE IF EXISTS `LOG_ACTION`;
CREATE TABLE `LOG_ACTION` (
  `ID` INT(11) NOT NULL AUTO_INCREMENT COMMENT '权限ID',
  `ACTION_URI` VARCHAR(100)  COMMENT 'URI',
  `ACTION_MODULE` VARCHAR(100)   COMMENT '操作所属的模块',
  `ACTION_DESC` VARCHAR(200)  COMMENT '动作描述',
  UNIQUE INDEX index_action(ACTION_URI),
  PRIMARY KEY (`ID`)
) ENGINE=INNODB AUTO_INCREMENT=1 DEFAULT CHARSET=UTF8;
--  可插入如下初始数据
insert into log_action(action_uri,action_Module,action_desc) values ('/abc/bcd.do','用户中心','新建用户');
....等

• 相关说明：LOG表是用于记录日志，log_action表则是记录那些请求时需要日志模块记录的

3. 代码模块

• 注意：关于实体类LogAction（平台日志的uri对应的描述）、RequestModel（要保存日志的详细信息）。他们的实体类和对应的mybatis dao操作这里不再额外叙述
• 平台启动缓存数据类

/**
 * Copyright: Copyright (c) 2017 LanRu-Caifu
 * @author 
 * @ClassName: ActionUrlCache.java
 * @Description: 缓存初始化需要拦截请求保存到日志
 * @version: v1.0.0
 */
public final class ActionUrlCache {

private ActionUrlCache(){}
    
    //缓存地区服务地址
    private static final ConcurrentHashMap<String, String> actionCache = new ConcurrentHashMap<>();
    //获取缓存
    public static ConcurrentHashMap<String, String> getActionCache(){
        
        return actionCache;
    }
    //添加服务地址
    public static void  addService(String k ,String v){
        //重复覆盖
        actionCache.put(k,v);
    }
    //是否存在指定的key
    public static boolean isExist(String k){
        return actionCache.containsKey(k);
    }
    //判读当前缓存是否为空
    public static boolean isEmpyt(){
        return actionCache.size()<=0;
    }
    。。。省略
}

• 这里的初始化数据可自定义（继承springInitializingBean 接口），保存需要在之后查找的方式

/**
 * Copyright: Copyright (c) 2017 LanRu-Caifu
 * @author 
 * @ClassName: InitServiceUrl.java
 * @Description: 平台启动初始化某些数据
 * @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());
        }
    }
}

• 在拦截器中获取请求中的部分数据封装到日志记录实体类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存在预设，且为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;
        }
。。。省略部分

• 下面这个类是在响应写入body时的提前处理，可以获取Controller中的。需要实现spring的ResponseBodyAdvice接口，且需要注入spring容器

/**
 * Copyright: Copyright (c) 2017 LanRu-Caifu
 * @author xzg
 * @ClassName: LogResponseBodyAdvice.java
 * @Description: 在响应写入body时的提前处理，可以获取Controller中的返回数据
 * @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对指定请求参数放如到线程局部变量的对象  
        RequestModel model = RequestModel.getRequestModel();  
        //移除线程局部变量,释放内存  
        RequestModel.removeRequestModel();  
        //保存日志  
        operateLogService.saveLog(model, result);  
        return result;  
    }  
。。。省略

• 一下为用到的接口，具体实现类以及操作数据库的DAO这里不再叙述

日志url服务接口，获取平台初始化的数据
public interface LogActionService {
    public List<LogAction> getAllAction();
}

 日志操作接口，保存日志信息。RequestModel为日志信息的实体类
public interface LogModuleService {
    public Result getLog(Map<String,Object> params);
    public void addLog(RequestModel rm);
}

作为处理响应时的操作日志方法
public interface OperateLogService {
    public void saveLog(RequestModel model,Object result);
}