JAVA实现通用日志记录方法

2024-02-20 19:08:03 42

前言：

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

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

使用Aop记录操作日志

第一步：添加Aop

/**
*统一日志处理Handler
*@authorMingchenchen
*
*/
publicclassLogAopHandler{
@Autowired
privateAuditLogDaoauditLogDao;

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

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

JSONObjectrequestBodyJson=null;
try{
requestBodyJson=JSONObject.parseObject(requestBody);
}catch(Exceptione){
//donothing即POST请求没传body
}
HttpServletRequestrequest=RequestContextUtil.getRequestByCurrentContext();
StringuserName=RequestContextUtil.getUserNameByCurrentContext();
if(StringUtil.isEmpty(userName)){
try{
userName=DmsCache.get(requestBodyJson.getString("userName")).getName();
}catch(Exceptione){
userName=RequestContextUtil.getAsynUserInfoByAutoDeploy().getName();
}
}

//得到request的参数后让方法执行它
//注意around的情况下需要返回result否则将不会返回值给请求者
Objectresult=joinPoint.proceed(objects);
try{
JSONObjectresultJson=JSONObject.parseObject(result.toString());
if(isNeedSaveLog){//如果是POST请求则记录日志
LogTypeEnumlogTypeEnum=LogTypeEnum.getDesByMethodName(methodName);
if(logTypeEnum!=null){
AuditLogEntityauditLogEntity=newAuditLogEntity();
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);
intisSuccess="200".equals(resultJson.getString("code"))?1:0;
auditLogEntity.setSuccessFlag(isSuccess);
auditLogEntity.setResponse(result.toString());
auditLogEntity.setCreateTime(newDate());
auditLogDao.insert(auditLogEntity);
}
}
}catch(Exceptione){
e.printStackTrace();
}
returnresult;
}
}

第二步:在spring的xml中声明

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

第三步:写Dao、Entity、Mapper

importjava.util.Date;

importjavax.persistence.Column;
importjavax.persistence.Id;
importjavax.persistence.Table;

/**
*日志审计
*@authorMingchenchen
*
*/
@Table(name="audit_log")
publicclassAuditLogEntity{
@Id
privateStringuuid;

@Column(name="event_type")
privateStringeventType;//事件类型

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

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

@Column(name="request_ip")
privateStringrequestIp;//客户端地址

@Column(name="request_url")
privateStringrequestUrl;//请求地址

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

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

@Column(name="create_time")
privateDatecreateTime;

publicStringgetUuid(){
returnuuid;
}

publicvoidsetUuid(Stringuuid){
this.uuid=uuid;
}

publicStringgetEventType(){
returneventType;
}

publicvoidsetEventType(StringeventType){
this.eventType=eventType;
}

publicStringgetEventDesc(){
returneventDesc;
}

publicvoidsetEventDesc(StringeventDesc){
this.eventDesc=eventDesc;
}

publicStringgetOperator(){
returnoperator;
}

publicvoidsetOperator(Stringoperator){
this.operator=operator;
}

publicStringgetRequestIp(){
returnrequestIp;
}

publicvoidsetRequestIp(StringrequestIp){
this.requestIp=requestIp;
}

publicStringgetRequestUrl(){
returnrequestUrl;
}

publicvoidsetRequestUrl(StringrequestUrl){
this.requestUrl=requestUrl;
}

publicStringgetRequest(){
returnrequest;
}

publicvoidsetRequest(Stringrequest){
this.request=request;
}

publicStringgetResponse(){
returnresponse;
}

publicvoidsetResponse(Stringresponse){
this.response=response;
}

publicDategetCreateTime(){
returncreateTime;
}

publicvoidsetCreateTime(DatecreateTime){
this.createTime=createTime;
}
}

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

importjava.util.Map;
importjava.util.concurrent.ConcurrentHashMap;

/**
*操作日志类型
*@authorMingchenchen
*
*/
publicenumLogTypeEnum{
//用户
COMMON_LOGIN("login","login","登录");
//其他

privateStringmethodName;//方法名称与controller一致
privateStringkey;//保存到数据库的事件类型
privateStringdescription;//保存到数据库的描述
privateLogTypeEnum(StringmethodName,Stringkey,Stringdescription){
this.methodName=methodName;
this.key=key;
this.description=description;
}
publicStringgetMethodName(){
returnmethodName;
}
publicvoidsetMethodName(StringmethodName){
this.methodName=methodName;
}
publicStringgetKey(){
returnkey;
}
publicvoidsetKey(Stringkey){
this.key=key;
}
publicStringgetDescription(){
returndescription;
}
publicvoidsetDescription(Stringdescription){
this.description=description;
}

/**
*根据方法名返回
*@parammethodName
*@return
*/
publicstaticLogTypeEnumgetDesByMethodName(StringmethodName){
returninnerMap.map.get(methodName);
}

/**
*内部类用户保存所有的enum无须通过Enum.values()每次遍历
*@authorMingchenchen
*
*/
privatestaticclassinnerMap{
privatestaticMapmap=newConcurrentHashMap<>(128);

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

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

JAVA实现通用日志记录方法

热门推荐

随机推荐