JAVA实现通用日志记录方法

前言：

之前想在filter层直接过滤httpServerletRequest请求进行日志处理，但是之后再getWriter()的 时候报already been call异常。查了下，才发现原来流形式的只能读取一次。。就好像食物，吃了就没了。。 所以在filter和inteceptor里面是没法通过获取request的流来进行日志记录的。

于是还是准备用通用的方法:controller层aop进行切面记录日志。

使用Aop记录操作日志

第一步：添加Aop

/**
 * 统一日志处理Handler
 * @author Mingchenchen
 *
 */
public class LogAopHandler {
  @Autowired
  private AuditLogDao auditLogDao;

  /**
   * controller层面记录操作日志
   * 注意此处是aop:around的 因为需要得到请求前的参数以及请求后接口返回的结果
   * @throws Throwable 
   */
  public Object doSaveLog(ProceedingJoinPoint joinPoint) throws Throwable { 
    MethodSignature method = (MethodSignature) joinPoint.getSignature();
    String methodName = method.getName();
    Object[] objects = joinPoint.getArgs();
    String requestBody = null;
    if (objects!=null && objects.length>0) {
      for (Object object : objects) {
        if (object == null) {
          requestBody = null;//POST接口参数为空 比如删除XXX
        }else if (object instanceof String) {
          requestBody = (String) object;//有些接口直接把参数转换成对象了
        }else {
          requestBody = JSONObject.toJSONString(object);
        }
      }
    }

    //只记录POST方法的日志
    boolean isNeedSaveLog = false;
    //此处不能用getAnnotationByType 是JAVA8的特性,因为注解能够重名,所以得到的是数组
    RequestMapping annotation = method.getMethod().getAnnotation(RequestMapping.class);
    for (RequestMethod requestMethod : annotation.method()) {
      if (requestMethod==RequestMethod.POST) {
        isNeedSaveLog = true;
      }
    }

    JSONObject requestBodyJson = null;
    try {
      requestBodyJson = JSONObject.parseObject(requestBody);
    } catch (Exception e) {
      //do nothing 即POST请求没传body
    }
    HttpServletRequest request = RequestContextUtil.getRequestByCurrentContext();
    String userName = RequestContextUtil.getUserNameByCurrentContext();
    if (StringUtil.isEmpty(userName)) {
      try {
        userName = DmsCache.get(requestBodyJson.getString("userName")).getName();
      } catch (Exception e) {
        userName = RequestContextUtil.getAsynUserInfoByAutoDeploy().getName();
      }
    }

    //得到request的参数后让方法执行它 
    //注意around的情况下需要返回result 否则将不会返回值给请求者
    Object result = joinPoint.proceed(objects);
    try {
      JSONObject resultJson = JSONObject.parseObject(result.toString());
      if (isNeedSaveLog) {//如果是POST请求 则记录日志
        LogTypeEnum logTypeEnum = LogTypeEnum.getDesByMethodName(methodName);
        if (logTypeEnum != null) {
          AuditLogEntity auditLogEntity = new AuditLogEntity();
          auditLogEntity.setUuid(StringUtil.createRandomUuid());
          auditLogEntity.setOperator(userName);
          auditLogEntity.setRequestIp(request.getRemoteAddr());
          auditLogEntity.setRequestUrl(request.getRequestURI().replace("/cloud-master", ""));
          auditLogEntity.setEventType(logTypeEnum.getKey());
          auditLogEntity.setEventDesc(logTypeEnum.getDescription());
          auditLogEntity.setRequest(requestBody);
          int isSuccess = "200".equals(resultJson.getString("code")) ? 1 : 0;
          auditLogEntity.setSuccessFlag(isSuccess);
          auditLogEntity.setResponse(result.toString());
          auditLogEntity.setCreateTime(new Date());
          auditLogDao.insert(auditLogEntity);
        }
      }
    } catch (Exception e) {
      e.printStackTrace();
    }
    return result;
  } 
}

第二步:在spring的xml中声明

  <!-- 记录操作日志 -->
  <bean id="operationLogAop" class="com.ming.learn.core.aop.LogAopHandler"/>
   <aop:config>
    <aop:aspect id="logAOP" ref="operationLogAop">
     <aop:pointcut id="target" expression="execution(* com.ming.learn..*Controller.*(..))"/>
     <aop:around method="doSaveLog" pointcut-ref="target"/>
    </aop:aspect>
   </aop:config>

如此一来，核心步骤就完成了，剩下的就是自己组装需要记录的东西了。

第三步:写Dao、Entity、Mapper

import java.util.Date;

import javax.persistence.Column;
import javax.persistence.Id;
import javax.persistence.Table;

/**
 * 日志审计
 * @author Mingchenchen
 *
 */
@Table(name="audit_log")
public class AuditLogEntity {
  @Id
  private String uuid;

  @Column(name="event_type")
  private String eventType;//事件类型

  @Column(name="event_desc")
  private String eventDesc;//事件中文描述

  @Column(name="operator")
  private String operator;//操作者

  @Column(name="request_ip")
  private String requestIp;//客户端地址

  @Column(name="request_url")
  private String requestUrl;//请求地址

  @Column(name="request")
  private String request;//请求body

  @Column(name="response")
  private String response;//请求返回值

  @Column(name="create_time")
  private Date createTime;

  public String getUuid() {
    return uuid;
  }

  public void setUuid(String uuid) {
    this.uuid = uuid;
  }

  public String getEventType() {
    return eventType;
  }

  public void setEventType(String eventType) {
    this.eventType = eventType;
  }

  public String getEventDesc() {
    return eventDesc;
  }

  public void setEventDesc(String eventDesc) {
    this.eventDesc = eventDesc;
  }

  public String getOperator() {
    return operator;
  }

  public void setOperator(String operator) {
    this.operator = operator;
  }

  public String getRequestIp() {
    return requestIp;
  }

  public void setRequestIp(String requestIp) {
    this.requestIp = requestIp;
  }

  public String getRequestUrl() {
    return requestUrl;
  }

  public void setRequestUrl(String requestUrl) {
    this.requestUrl = requestUrl;
  }

  public String getRequest() {
    return request;
  }

  public void setRequest(String request) {
    this.request = request;
  }

  public String getResponse() {
    return response;
  }

  public void setResponse(String response) {
    this.response = response;
  }

  public Date getCreateTime() {
    return createTime;
  }

  public void setCreateTime(Date createTime) {
    this.createTime = createTime;
  }
}

第四步:根据Controller的方法名称定制响应的事件类型

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * 操作日志类型
 * @author Mingchenchen
 *
 */
public enum LogTypeEnum {
  //用户
  COMMON_LOGIN("login","login","登录");
  //其他

  private String methodName;//方法名称与controller一致
  private String key;//保存到数据库的事件类型
  private String description;//保存到数据库的描述
  private LogTypeEnum(String methodName,String key,String description){
    this.methodName = methodName;
    this.key = key;
    this.description = description;
  }
  public String getMethodName() {
    return methodName;
  }
  public void setMethodName(String methodName) {
    this.methodName = methodName;
  }
  public String getKey() {
    return key;
  }
  public void setKey(String key) {
    this.key = key;
  }
  public String getDescription() {
    return description;
  }
  public void setDescription(String description) {
    this.description = description;
  }

  /**
   * 根据方法名返回
   * @param methodName
   * @return
   */
  public static LogTypeEnum getDesByMethodName(String methodName){
    return innerMap.map.get(methodName);
  }

  /**
   * 内部类 用户保存所有的enum 无须通过Enum.values()每次遍历
   * @author Mingchenchen
   *
   */
  private static class innerMap{
    private static Map<String, LogTypeEnum> map = new ConcurrentHashMap<>(128);

    static{
      //初始化整个枚举类到Map
      for (LogTypeEnum logTypeEnum : LogTypeEnum.values()) {
        map.put(logTypeEnum.getMethodName(), logTypeEnum);
      }
    }
  }
}

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。

# java实现日志记录  # JAVA日志记录  # java实现随机数生成器  # java项目打包成可执行jar用log4j将日志写在jar所在目录操作  # java启动jar包将日志打印到文本的简单操作  # Java中 log4j日志级别配置详解  # Java实时监控日志文件并输出的方法详解  # Java项目如何引入日志生成器及其日志分级  # 返回值  # 的是  # 遍历  # 吃了  # 才发现  # 不能用  # 转换成  # 第二步  # 第三步  # 大家多多  # 则将  # 为空  # 第四步  # 客户端  # 准备用  # 情况下  # 完成了  # 就好像  # 请求者  # 就没了 

相关文章： 大连 网站制作,大连天途有线官网？  建站之星IIS配置教程：代码生成技巧与站点搭建指南  如何通过.red域名打造高辨识度品牌网站？  官网网站制作腾讯审核要多久,联想路由器newifi官网  如何高效配置IIS服务器搭建网站？  如何用景安虚拟主机手机版绑定域名建站？  如何用5美元大硬盘VPS安全高效搭建个人网站？  微网站制作教程,我微信里的网站怎么才能复制到浏览器里？  建站之星后台搭建步骤解析：模板选择与产品管理实操指南  教学网站制作软件,学习*后期制作的网站有哪些？  网站制作网站,深圳做网站哪家比较好？  如何安全更换建站之星模板并保留数据？  免费制作小说封面的网站有哪些,怎么接网站批量的封面单？  linux top下的 minerd 木马清除方法  高防服务器：AI智能防御DDoS攻击与数据安全保障  如何快速辨别茅台真假？关键步骤解析  广州网站设计制作一条龙,广州巨网网络科技有限公司是干什么的？  青岛网站建设如何选择本地服务器？  网站制作怎么样才能赚钱,用自己的电脑做服务器架设网站有什么利弊，能赚钱吗？  高防服务器租用如何选择配置与防御等级？  如何通过西部建站助手安装IIS服务器？  如何登录建站主机？访问步骤全解析  大连网站设计制作招聘信息,大连投诉网站有哪些？  网站制作公司排行榜,抖音怎样做个人官方网站  建站上市公司网站建设方案与SEO优化服务定制指南  建站之星安装步骤有哪些常见问题？  建站主机数据库如何配置才能提升网站性能？  ,交易猫的商品怎么发布到网站上去？  浅谈Javascript中的Label语句  如何用低价快速搭建高质量网站？  桂林网站制作公司有哪些,桂林马拉松怎么报名？  建站主机选虚拟主机还是云服务器更好？  网站制作公司排行榜,四大门户网站排名？  子杰智能建站系统｜零代码开发与AI生成SEO优化指南  如何快速搭建高效WAP手机网站吸引移动用户？  家庭建站与云服务器建站，如何选择更优？  如何选择高效可靠的多用户建站源码资源？  建站之星安装后界面空白如何解决？  c# 在高并发下使用反射发射（Reflection.Emit）的性能  如何用AWS免费套餐快速搭建高效网站？  简历在线制作网站免费版,如何创建个人简历？  如何做网站制作流程,*游戏网站怎么搭建？  h5网站制作工具有哪些,h5页面制作工具有哪些？  表情包在线制作网站免费,表情包怎么弄？  建站之星代理如何优化在线客服效率？  动图在线制作网站有哪些,滑动动图图集怎么做？  C++中的Pimpl idiom是什么，有什么好处？（隐藏实现）  成都网站制作价格表,现在成都广电的单独网络宽带有多少的，资费是什么情况呢？  建站之星代理费用多少？最新价格详情介绍  湖南网站制作公司,湖南上善若水科技有限公司做什么的？