牛客网后端项目实战（二十四）：统一记录日志

针对业务需求记录日志 => 系统需求
统一记录日志，可能会想到封装一个记日志的组件，在每个业务中调用，但是这样实现不利于维护，这里就需要AOP技术。

AOP 示例

新建一个aspect包，然后新建AlphaAspect类。

• 使用@Component和@Aspect注解修饰类
• 使用@Pointcut定义连接点，execution固定关键字，*表示任何方法返回值都行，com.neu.langsam.community.service.*表示service包下所有类，再.*表示所有方法，（…)表示所有的参数都要处理，也可以指定明确的方法
• 五种注解实现五种通知，前四个实现大同小异，around表示前后都执行，实现方法就是传入joinPoint，调用joinPoint的proceed方法，也就是业务方法，在调用前后写需要织入的逻辑。

// 体会Spring AOP的语法
package com.nowcoder.community.aspect;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

@Component
@Aspect
public class AlphaAspect {
	
	// 定义切点
    @Pointcut("execution(* com.nowcoder.community.service.*.*(..))")  //描述哪些方法是处理目标
    // * 表示方法的返回值类型是任意的；
    public void pointcut(){

    }

	// 在切点pointcut()前记日志
    @Before("pointcut()")
    public void before(){
        System.out.println("before");
    }

	// 在切点后记日志
    @After("pointcut()")
    public void after(){
        System.out.println("after");
    }

	// 在切点pointcut()返回值后记日志
    @AfterReturning("pointcut()")
    public void AfterReturning(){
        System.out.println("AfterReturning");
    }
	
	// 在切点pointcut()抛异常时记日志
    @AfterThrowing("pointcut()")
    public void AfterThrowing(){
        System.out.println("AfterThrowing");
    }

	// 在切点pointcut()前、后记日志
    @Around("pointcut()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable{
        System.out.println("around before");
        Object o=joinPoint.proceed(); // 参数连接点joinPoint 指织入的部位
        							  // joinPoint.proceed() 调用要处理的目标组件的方法
        System.out.println("around after");
        return o;
    }
}

   @Pointcut("execution(* com.neu.langsam.community.service.*.*(..))")
       * 表示方法的返回值类型是任意的；
       * com.neu.langsam.community.service.*.*(..) 表示 com.neu.langsam.community.service 包下所有的 组件/类 、 所有的 方法、所有的参数、所有的返回值都要处理

实现统一日志

实现比较简单，我们在用户访问每个服务的时候记录用户[1.1.1.1]，在[xxx]访问了[com.neu.langsam.community.service.xxx()].

使用ServletRequestAttributes获取request，从而获取ip，然后调用日志记录。

package com.nowcoder.community.aspect;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.text.SimpleDateFormat;
import java.util.Date;

@Component
@Aspect
public class ServiceLogAspect {

    private static final Logger logger = LoggerFactory.getLogger(ServiceLogAspect.class);

    @Pointcut("execution(* com.nowcoder.community.service.*.*(..))")
    public void pointcut() {

    }

    @Before("pointcut()")
    public void before(JoinPoint joinPoint) {
        // 用户[1.2.3.4],在[xxx],访问了[com.nowcoder.community.service.xxx()].
        // 1. 获取 用户IP，通过Request
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        String ip = request.getRemoteHost();  // 用户IP
        // 2. 获取访问时间
        String now = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date());
        // 3. 获取用户调用的组件方法
        String target = joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName();
        logger.info(String.format("用户[%s],在[%s],访问了[%s].", ip, now, target));
    }
}

 String target = joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName();
joinPoint.getSignature().getDeclaringTypeName() 得到类名；
joinPoint.getSignature().getName() 得到方法名

参考文章：
https://blog.csdn.net/weixin_42700635/article/details/106629583