renren-fast 项目解读：系统日志处理

拼搏现实的明天。 2022-05-14 16:23 246阅读 0赞

## 系统日志处理 ##

1.  系统日志，在系统中主要是使用的是注解日志的形式。通过注解去控制系统日志打印的内容。
2.  基本实现代码：这里通过环绕处理

@Pointcut("@annotation(io.renren.common.annotation.SysLog)")
        public void logPointCut() {
    
        }
    
        @Around("logPointCut()")
        public Object around(ProceedingJoinPoint point) throws Throwable {
            long beginTime = System.currentTimeMillis();
            //执行方法
            Object result = point.proceed();
            //执行时长(毫秒)
            long time = System.currentTimeMillis() - beginTime;
            //保存日志
            saveSysLog(point, time);
            return result;
        }

1.  主要保存信息代码：通过切面获取方法名，方法参数,获取ip地址，用户名，执行时间等，写入到库中。这里使用的是mybatis，插入数据库中。在平常我们也可以修改这里的日志记录，放到mongo中或者其他地方。这里主要还是看实际使用场景选择技术。

private void saveSysLog(ProceedingJoinPoint joinPoint, long time) {
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            Method method = signature.getMethod();
            SysLogEntity sysLog = new SysLogEntity();
            SysLog syslog = method.getAnnotation(SysLog.class);
            if (syslog != null) {
                //注解上的描
                sysLog.setOperation(syslog.value());
            }
            //请求的方法名
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = signature.getName();
            sysLog.setMethod(className + "." + methodName + "()");
            //请求的参数
            Object[] args = joinPoint.getArgs();
            String params = new Gson().toJson(args);
            sysLog.setParams(params);
            //获取request
            HttpServletRequest request = HttpContextUtils.getHttpServletRequest();
            //设置IP地址
            sysLog.setIp(IPUtils.getIpAddr(request));
            //用户名
            String username = ((SysUserEntity) SecurityUtils.getSubject().getPrincipal()).getUsername();
            sysLog.setUsername(username);
            sysLog.setTime(time);
            try {
                joinPoint.proceed();
            } catch (Throwable throwable) {
                throwable.printStackTrace();
            }
            sysLog.setCreateDate(new Date());
            //保存系统日志
            sysLogService.insert(sysLog);
        }

1.  获取request对象。HttpContextUtils：这里使用的Spring的上下文RequestContextHolder来获取的HttpServletRequest，再通过request获取相关请求信息

public static HttpServletRequest getHttpServletRequest() {
    		return ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
    	}

1.  IPUtils：获取真实地址ip。 这里主要是处理代理服务器的问题，通过代理无法获取到真实ip。一般代理的真实地址会放到header中，所以这里的工具类主要是通过获取header中的参数查找真实地址。注意这里，在反向代理中一定要配置，添加真实ip的header

/**
    	 * 获取IP地址
    	 * 
    	 * 使用Nginx等反向代理软件， 则不能通过request.getRemoteAddr()获取IP地址
    	 * 如果使用了多级反向代理的话，X-Forwarded-For的值并不止一个，而是一串IP地址，X-Forwarded-For中第一个非unknown的有效IP字符串，则为真实IP地址
    	 */
    	public static String getIpAddr(HttpServletRequest request) {
        	String ip = null;
            try {
                ip = request.getHeader("x-forwarded-for");
                if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
                    ip = request.getHeader("Proxy-Client-IP");
                }
                if (StringUtils.isEmpty(ip) || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
                    ip = request.getHeader("WL-Proxy-Client-IP");
                }
                if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
                    ip = request.getHeader("HTTP_CLIENT_IP");
                }
                if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
                    ip = request.getHeader("HTTP_X_FORWARDED_FOR");
                }
                if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
                    ip = request.getRemoteAddr();
                }
            } catch (Exception e) {
            	logger.error("IPUtils ERROR ", e);
            }
            return ip;
        }