springboot之整合aop

AOP 的概念
通过上面约定编程的例子， 可以看到，只要按照一定的规则 ，我就可以将你的代码织入事先约 定的流程中。

连接点（join point）： 对应的是具体被拦截的对象，因为 Spring 只能支持方法， 所以被拦截 的对象往往就是指特定的方法，例如，我们前面提到的 HelloServiceimpl 的 sayHello 方法就 是一个连接点， AOP 将通过动态代理技术把它织入对应的流程中 。
切，点（point cut）：有时候，我们的切面不单单应用于单个方法，也可能是多个类的不同方 法，这时，可以通过正则式和指示器的规则去定义，从而适配连接点。 切点就是提供这样一 个功能的概念。
通知（advice）： 就是按照约定的流程下的方法，分为前置通知（before advice）、后置通知（after advice ）、环绕通知 （ around advice ）、 事后返回通知（ afterRetuming advice ）和异常通知 (after Throwing advice），它会根据约定织入流程中，需要弄明白它们在流程中的顺序和运行 的条件。 • 目标对象 （target）：即被代理对象，例如，约定编程中的 HelloServicelmpl 实例就是一个目 标对象，它被代理了。 引入（introduction ）： 是指引入新的类和其方法， 增强现有 Bean 的功能。
织入 （weaving）：它是一个通过动态代理技术，为原有服务对象生成代理对象， 然后将与切 点定义匹配的连接点拦截，并按约定将各类通知织入约定流程的过程。 切面（aspect）：是一个可以定义切点、各类通知和引入的内容， SpringAOP 将通过它的信息 来增强 Bean 的功能或者将对应的方法织入流程。
一 依赖

       <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <!-- 分析客户端信息的工具类-->
        <dependency>
            <groupId>eu.bitwalker</groupId>
            <artifactId>UserAgentUtils</artifactId>
            <version>1.20</version>
        </dependency>
        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>1.8.4</scope>
        </dependency>

二 开发切面

import eu.bitwalker.useragentutils.UserAgent;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;

import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.apache.log4j.Logger;
import javax.servlet.http.HttpServletRequest;
import java.time.LocalDateTime;
import java.util.Arrays;

@Aspect
@Component
public class WebLogAspect {
    private static Logger log =Logger.getLogger(WebLogAspect.class) ;

    /**
     * 进入方法时间戳
     */
    private Long startTime;
    /**
     * 方法结束时间戳(计时)
     */
    private Long endTime;

    public WebLogAspect() {
    }

    /**
     * 定义请求日志切入点，其切入点表达式有多种匹配方式,这里是指定路径
     */
    @Pointcut("execution(public * com.lovely.xwjwan.controller.LogbackController.getMsg(..))")
    public void webLogPointcut() {
    }

    @Before("webLogPointcut()")
    public void doBefore(JoinPoint joinPoint) {
        // 接收到请求，记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        //获取请求头中的User-Agent
        UserAgent userAgent = UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
        //打印请求的内容
        startTime = System.currentTimeMillis();
        log.info("请求开始时间：{}" + LocalDateTime.now());
        log.info("请求Url : {}" + request.getRequestURL().toString());
        log.info("请求方式 : {}" + request.getMethod());
        log.info("请求ip : {}" + request.getRemoteAddr());
        log.info("请求方法 : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        log.info("请求参数 : {}" + Arrays.toString(joinPoint.getArgs()));
        // 系统信息
      /*  log.info("浏览器：{}", userAgent.getBrowser().toString());
        log.info("浏览器版本：{}", userAgent.getBrowserVersion());
        log.info("操作系统: {}", userAgent.getOperatingSystem().toString());*/
    }

    /**
     * 返回通知：
     * 1. 在目标方法正常结束之后执行
     * 1. 在返回通知中补充请求日志信息，如返回时间，方法耗时，返回值，并且保存日志信息
     *
     * @param ret
     * @throws Throwable
     */
    @AfterReturning(returning = "ret", pointcut = "webLogPointcut()")
    public void doAfterReturning(Object ret) throws Throwable {
        endTime = System.currentTimeMillis();
        log.info("请求结束时间：{}" + LocalDateTime.now());
        log.info("请求耗时：{}" + (endTime - startTime));
        // 处理完请求，返回内容
        log.info("请求返回 : {}" + ret);
    }

    /**
     * 异常通知：
     * 1. 在目标方法非正常结束，发生异常或者抛出异常时执行
     * 1. 在异常通知中设置异常信息，并将其保存
     *
     * @param throwable
     */
    @AfterThrowing(value = "webLogPointcut()", throwing = "throwable")
    public void doAfterThrowing(Throwable throwable) {
        // 保存异常日志记录
        log.error("发生异常时间：{}" + LocalDateTime.now());
        log.error("抛出异常：{}" + throwable.getMessage());
    }

}

三 编写测试

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/log")
public class LogbackController {
    /**
     * 测试正常请求
     * @param msg
     * @return
     */
    @GetMapping("/{msg}")
    public String getMsg(@PathVariable String msg) {
        return "request msg : " + msg;
    }

    /**
     * 测试抛异常
     * @return
     */
    @GetMapping("/test")
    public String getException(){
        // 故意造出一个异常
        Integer.parseInt("abc123");
        return "success";
    }
}

四 请求入口
LogbackController，访问控制器

测试结果
INFO [http-nio-8081-exec-3] - 请求开始时间：{}2019-12-19T16:48:33.813
INFO [http-nio-8081-exec-3] - 请求Url : {}http://localhost:8081/log/ceshi
INFO [http-nio-8081-exec-3] - 请求方式 : {}GET
INFO [http-nio-8081-exec-3] - 请求ip : {}0:0:0:0:0:0:0:1
INFO [http-nio-8081-exec-3] - 请求方法 : com.lovely.xwjwan.controller.LogbackController.getMsg
INFO [http-nio-8081-exec-3] - 请求参数 : {}[ceshi]
INFO [http-nio-8081-exec-3] - 请求结束时间：{}2019-12-19T16:48:33.813
INFO [http-nio-8081-exec-3] - 请求耗时：{}0
INFO [http-nio-8081-exec-3] - 请求返回 : {}request msg : ceshi