采用切面的方式去管理全局的日志

  1. 定义切面注解
package cn.ivg.retail.common.annotate;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.core.annotation.AliasFor;

import cn.ivg.retail.common.enumerate.OperationEnum;

/**
 * 
 * 
 * 
 * Module:
 * 
 * Log.java
 * 
 * @author xz
 * @version 1.0
 * @date 2019年9月19日 上午8:53:35
 * @description: 日志注解
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD }) // 只能在方法上使用此注解
public @interface IvgLog {

	public static final int ADD = 1; // 新增
	public static final int EDIT = 2; // 修改
	public static final int DELETE = 3; // 删除
	public static final int IMPORT = 4; // 导入
	public static final int EXPORT = 5; // 导出
	
	/**
	 * 日志描述,这里使用了@AliasFor 别名。spring提供的
	 * 
	 * @return
	 */
	@AliasFor("value")
	OperationEnum value();

	/**
	 * 日志描述
	 * 
	 * @return
	 */
	@AliasFor("desc")
	String desc() default "";

	/**
	 * 业务模块
	 * 
	 * @return
	 */
	@AliasFor("businesstype")
	String businesstype() default "";

	/**
	 * 操作类型 1-新建 2-修改 3-删除
	 * 
	 * @return
	 */
	@AliasFor("operatetype")
	int operatetype() default 1;
}

2. 操作类型的枚举

package cn.ivg.retail.common.enumerate;

/**
 * 
 * 
 * 
 * Module:
 * 
 * OperationEnum.java
 * 
 * @author xz
 * @version 1.0
 * @date 2019年9月19日 上午10:03:30
 * @description: 日志枚举类
 */
public enum OperationEnum {
	LOGINLOG(0, "登陆日志"), OPERATIONLOG(1, "操作日志"), THIRDPARTYLOG(2, "第三方对接日志");
    
    private  int value  = 0;;

    private  String label = null;

     OperationEnum(int value, String label) {
        this.value = value;
        this.label = label;
    }


    /**
	 * @description 是否包含该枚举值
	 * @param type
	 * @return
	 */
    public static boolean contain(Integer type) {
        OperationEnum[] types = OperationEnum.values();
        if (type == null) {
            return false;
        }
        for (OperationEnum ete : types) {
            if (ete.getValue() == type.intValue()) {
                return true;
            }
        }
        return false;
    }

    public static boolean notContain(Integer type) {
        return !contain(type);
    }

    public int getValue() {
        return value;
    }

    public void setValue(int value) {
        this.value = value;
    }

    public String getLabel() {
        return label;
    }

    public void setLabel(String label) {
        this.label = label;
    }
}

3.日志切面,本次采用后置日志切面记录接口请求的开始和返回,并把日志写入kafka内容, 后续采用生产消费的模式讲日志写入到mysql数据库或者es全文检索数据

package cn.ivg.retail.tools.aspect;

import java.lang.reflect.Method;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import java.util.StringTokenizer;
import java.util.concurrent.Executor;

import javax.servlet.http.HttpServletRequest;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.CodeSignature;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.kafka.core.KafkaTemplate;
import org.springframework.stereotype.Component;
import org.springframework.validation.BeanPropertyBindingResult;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;

import cn.hutool.core.util.IdUtil;
import cn.ivg.retail.common.annotate.IvgLog;
import cn.ivg.retail.common.entity.IvgResponse;
import cn.ivg.retail.common.enumerate.OperationEnum;
import cn.ivg.retail.common.exception.IvgBizException;
import cn.ivg.retail.service.ivgcommonservice.bo.LogLoginBo;
import cn.ivg.retail.service.ivgcommonservice.bo.LogOperationBo;


/**
 * 
 * 
 * 
 * Module:
 * 
 * SysLogAspect.java
 * 
 * @author xz
 * @version 1.0
 * @date 2019年9月19日 上午8:42:46
 * @description: 日志切面,本次采用后置日志切面记录接口请求的开始和返回,并把日志写入kafka内容, 后续采用生产消费的模式讲日志写入到mysql数据库或者es全文检索数据
 */
@Aspect
@Component
public class SysLogAspect {

	private static final Logger log = LoggerFactory.getLogger(SysLogAspect.class);

	

	@Autowired
	private Executor taskExecutor;

	@Autowired
	private KafkaTemplate<String, Object> kafkaTemplate;

	// 定义切点 @Pointcut
	// 在注解的位置切入代码
	@Pointcut("@annotation(cn.ivg.retail.common.annotate.IvgLog)")
	public void logPoinCut() {
	}

	@Around("logPoinCut()")
	public Object doAround(ProceedingJoinPoint point) throws Throwable {
		IvgResponse<?> result = null;
		Throwable throwable = null;
		IvgBizException ivg = null;
		// 耗时
		long useTime = 0;
		// 此处捕捉了异常,所有必须有返回值,不然页面收不到返回消息体
		try {
			long startTime = System.currentTimeMillis();
			Object proceed = point.proceed();
			long endTime = System.currentTimeMillis();
			useTime = endTime - startTime;
			if (proceed != null) {

				result = (IvgResponse<?>) proceed;
			}
		} catch (Throwable e) {
			result = new IvgResponse<>();
			Throwable fillInStackTrace = e.fillInStackTrace();

			if (fillInStackTrace instanceof IvgBizException) {
				// 自定义异常
				ivg = (IvgBizException) fillInStackTrace;
				result.setSuccess(false);
				result.setCode(ivg.getCode());
				result.setMsg(ivg.getMsg());
			} else {
				// 其他异常
				result.setSuccess(false);
				result.setCode(500);
				result.setMsg(e.toString());
			}
			throwable = e;
		}

		MethodSignature signature = (MethodSignature) point.getSignature();
		// 获取切入点所在的方法
		Method method = signature.getMethod();
		// 获取操作--方法上的ViLog的值
		IvgLog logEvict = method.getAnnotation(IvgLog.class);
		if (logEvict != null) {

			ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder
					.getRequestAttributes();
			HttpServletRequest request = servletRequestAttributes.getRequest();
			OperationEnum value = logEvict.value();
			if (OperationEnum.LOGINLOG.equals(value)) {
				// 记录登陆日志,加入到线程池中等待执行
				try {
					recordLoginLog(point, result, request);
				} catch (Exception e) {
					e.printStackTrace();
				}
			} else if (OperationEnum.OPERATIONLOG.equals(value)) {
				// 记录操作日志
				try {
					recordOperationLog(point, result, logEvict, useTime);
				} catch (Exception e) {
					e.printStackTrace();
				}
			} else if (OperationEnum.THIRDPARTYLOG.equals(value)) {
				// 第三方对接日志
			}
		}
		// 假如报了异常此处需要给前端返回异常信息
		if (!result.getSuccess()) {
			if (throwable != null) {

				throw throwable;
			}
		}
		return result;
	}

	/**
	 * 记录登陆日志
	 * 
	 * @throws Throwable
	 */
	private void recordLoginLog(JoinPoint point, IvgResponse<?> result, HttpServletRequest request) {
		LogLoginBo logLogin = new LogLoginBo();
		// String remoteAddr = request.getRemoteAddr();// 得到来访者的IP地址
		String remoteAddr = getRealIp(request);
		String Agent = request.getHeader("User-Agent");
		StringTokenizer st = new StringTokenizer(Agent, ";");
		// 得到用户的浏览器名
		String userbrowser = "";
		if (st.hasMoreTokens()) {
			userbrowser = st.nextToken();
		}
		// 得到用户的操作系统名
		String useros = "";
		if (st.hasMoreTokens()) {
			useros = st.nextToken();
		}
		Map<String, Object> nameAndValue = getNameAndValue(point);// 请求参数
		Object object = nameAndValue.get("loginDto");
		JSONObject loginDto = JSON.parseObject(JSON.toJSONString(object));

		logLogin.setFid(IdUtil.fastSimpleUUID());
		logLogin.setUserName(loginDto.get("username") + "");
		logLogin.setPassword(loginDto.get("password") + "");
		logLogin.setEquipmentType(loginDto.get("loginType") + "");
		logLogin.setLoginStatus(result.getSuccess() ? "成功" : "失败");
		logLogin.setIpAddress(remoteAddr);
		logLogin.setBrowserInfo(userbrowser);
		logLogin.setOsInfo(useros);
		logLogin.setSoftVersion(serverVersion);
		logLogin.setRemark(result.getMsg());
		logLogin.setCreateDate(new Date());

		JSONObject parseObject = JSON.parseObject(JSON.toJSONString(result.getData()));
		if (parseObject != null) {

			logLogin.setTenantId(parseObject.getString("tenantId"));
		}
		
		pushToKafka("login-log", JSON.toJSONString(logLogin));
	}

	/**
	 * 记录操作日志
	 */
	private void recordOperationLog(JoinPoint point, IvgResponse<?> result, IvgLog logEvict, long useTime) {
		LogOperationBo logOperation = new LogOperationBo();
		logOperation.setFid(IdUtil.fastSimpleUUID());
		
		logOperation.setBusinessType(logEvict.businesstype());
		logOperation.setOperateType(logEvict.operatetype());
		logOperation.setOperateResource(logEvict.desc());

		Map<String, Object> nameAndValue = getNameAndValue(point);// 请求参数
		logOperation.setRequestValue(JSON.toJSONString(nameAndValue));
		logOperation.setResponseValue(JSON.toJSONString(result));
		logOperation.setRemark(result.getMsg());
		logOperation.setTimeConsuming(useTime + "ms");
		logOperation.setCreateDate(new Date());
		logOperation.setOperationStatus(result.getSuccess() ? "成功" : "失败");
		
		
		System.out.println(JSON.toJSONString(logOperation));
		pushToKafka("operation-log", JSON.toJSONString(logOperation));
	}

	/**
	 * 记录第三方接口日志
	 */
	private void recordThirdpartyLog(JoinPoint point, IvgResponse<?> result, HttpServletRequest request) {

	}

	/**
	 * 
	 * 
	 * @param topic
	 * @param context
	 * @description 推送kafka
	 */
	private void pushToKafka(String topic, String context) {
		// 此处采用异步操作,因为kafka可能会连接失败!
		taskExecutor.execute(new Runnable() {
			@Override
			public void run() {
				kafkaTemplate.send(topic, context);
			}
		});
	}

	/**
	 * @description 获取请求参数
	 * @param joinPoint
	 * @return
	 */
	Map<String, Object> getNameAndValue(JoinPoint joinPoint) {
		Map<String, Object> param = new HashMap<String, Object>();
		Object[] paramValues = joinPoint.getArgs();
		String[] paramNames = ((CodeSignature) joinPoint.getSignature()).getParameterNames();
		for (int i = 0; i < paramNames.length; i++) {
			if (!(paramValues[i] instanceof BeanPropertyBindingResult)) {
				if (paramValues[i] instanceof HashMap) {
					Map<String, Object> map = (Map<String, Object>) paramValues[i];
					map.forEach((key, value) -> {
						param.put(key, value);
					});
				} else {
					param.put(paramNames[i], paramValues[i]);
				}
			}
		}
		return param;
	}

	/**
	 * 获取真实ip
	 * 
	 * @param request
	 * @return
	 */
	public String getRealIp(HttpServletRequest request) {
		// 这个一般是Nginx反向代理设置的参数
		String ip = request.getHeader("X-Real-IP");
		if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
			ip = request.getHeader("X-Forwarded-For");
		}
		if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
			ip = request.getHeader("Proxy-Tenant-IP");
		}
		if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
			ip = request.getHeader("WL-Proxy-Tenant-IP");
		}
		if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
			ip = request.getRemoteAddr();
		}
		// 处理多IP的情况(只取第一个IP)
		if (ip != null && ip.contains(",")) {
			String[] ipArray = ip.split(",");
			ip = ipArray[0];
		}
		return ip;
	}
}

4.使用示例

 5.日志实体

package cn.ivg.retail.service.ivgcommonservice.bo;

import java.io.Serializable;
import java.util.Date;
@Date
public class LogLoginBo implements Serializable {
   
    private String fid;

	private String password;

   
    private String userName;


    
    private String equipmentType;

   
    private String equipmentSign;

    
    private String softVersion;

    
    private String loginStatus;

    
    private String ipAddress;

   
    private String browserInfo;

    
    private String osInfo;

   
    private String remark;

   
    private Date createDate;

   
    private String creater;

    
    private String tenantId;

   
   
}

 6.建表语句

CREATE TABLE `b_log_operation` (
  `fid` varchar(64) NOT NULL COMMENT '主键id',
  `user_id` varchar(64) NOT NULL COMMENT '用户id 关联b_user.fid',
  `business_type` varchar(64) NOT NULL COMMENT '业务模块',
  `operate_type` int(8) NOT NULL COMMENT '操作类型 1-新建 2-修改 3-删除',
  `operate_resource` varchar(64) NOT NULL COMMENT '操作资源',
  `request_value` text COMMENT '请求值json ',
  `response_value` text COMMENT '返回值json',
  `operation_status` varchar(16) DEFAULT 'N' COMMENT '操作状态 成功 失败',
  `time_consuming` varchar(64) DEFAULT NULL COMMENT '耗时(单位ms)',
  `remark` varchar(2000) DEFAULT 'N' COMMENT '备注 失败原因',
  `create_date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `creater` varchar(64) NOT NULL DEFAULT 'N' COMMENT '记录创建人 关联b_user.fid',
  `tenant_id` varchar(64) DEFAULT 'N' COMMENT '记录所属租户 关联b_tenant.fid',
  PRIMARY KEY (`fid`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='操作日志主表';

7. kafka消费端

package cn.ivg.retail.consumer;

import java.util.Optional;

import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.kafka.annotation.KafkaListener;
import org.springframework.stereotype.Component;

import com.alibaba.fastjson.JSON;

import cn.ivg.retail.dao.entity.domain.LogLogin;
import cn.ivg.retail.dao.entity.domain.LogOperation;
import cn.ivg.retail.dao.mapper.LogLoginMapper;
import cn.ivg.retail.dao.mapper.LogOperationMapper;

@Component
public class KafkaConsumer {
	@Autowired
	private LogLoginMapper logLoginMapper;
	@Autowired
	private LogOperationMapper logOperationMapper;
	@KafkaListener(topics = { "login-log" })
	public void consumerLogin(ConsumerRecord<?, ?> consumerRecord) {
		// 判断是否为null
		Optional<?> kafkaMessage = Optional.ofNullable(consumerRecord.value());
		if (kafkaMessage.isPresent()) {
			// 得到Optional实例中的值
			Object message = kafkaMessage.get();
			if (message != null) {
				LogLogin parseObject = JSON.parseObject(message.toString(), LogLogin.class);
				System.err.println(JSON.toJSONString(parseObject));
				logLoginMapper.insert(parseObject);
			}
		}
	}

	@KafkaListener(topics = { "operation-log" })
	public void consumerOperation(ConsumerRecord<?, ?> consumerRecord) {
		// 判断是否为null
		Optional<?> kafkaMessage = Optional.ofNullable(consumerRecord.value());
		if (kafkaMessage.isPresent()) {
			// 得到Optional实例中的值
			Object message = kafkaMessage.get();
			if (message != null) {
				LogOperation parseObject = JSON.parseObject(message.toString(), LogOperation.class);
				System.err.println(JSON.toJSONString(parseObject));
				logOperationMapper.insert(parseObject);
			}
		}
	}
}

说明:此代码略有删减,可能无法直接使用,需要稍微改造~~~~~~

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值