【Spring boot篇 1】AOP

 

AOP

Aspect-Oriented Programming， 面向切面编程，基于横向抽取机制将公共的非业务逻辑代码抽取出来封装为切面类

 

AOP的好处

业务逻辑和非业务逻辑分离，便于维护和升级

业务模块更简洁

 

切入点（Pointcut）

AOP通过切入点作用于连接点

 

连接点（Joinpoint）

AOP作用的位置，包括方法执行前、执行后、捕获异常后、正常返回后

 

AspectJ

目前Java社区最完整最主流的AOP框架

可以使用注解挥着XML配置AOP

 

使用AspectJ声明切面

1. @Aspect 将类注解为切面

2. @Order(index) 设置切面的优先级，可省略

3. @Component 将切面类交给Spring IOC容器管理

4. @Pointcut("切入点表达式")  定义可重入切入点

5. @Before 前置通知，作用于方法执行之前

6. @After 后置通知，作用于方法finally域中

7. @AfterReturning 返回通知，作用于方法正常返回之后

8. @AfterThrowing 异常通知，作用于捕获异常之后

9. @Around 环绕通知，围绕方法执行

 

切入点表达式

execution([权限修饰符][返回值类型][简单类名/全限定名][方法名][参数列表])

 

AOP实现日志工具

1. pom.xml中添加依赖启动AOP功能，并在application.properties中配置

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-aop</artifactId>
</dependency>

# AOP配置
spring.aop.auto=true
spring.aop.proxy-target-class=true

2. 安装lombok插件，添加依赖，并在application.properties中配置

<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<optional>true</optional>
</dependency>

#设置某个包下的日志打印级别,默认为info级别
logging.level.com.withmes=trace           
#设置log文件输出地址
logging.path=C://spring

3. 定义日志工具类

package com.example.idbsystem.aop;

import lombok.extern.slf4j.Slf4j;
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.slf4j.Logger;
//import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
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.util.Arrays;

@Aspect
@Order(1)
@Component
@Slf4j
public class LoggerAspect {

//    private final Logger log = LoggerFactory.getLogger(LoggerAspect.class);   //添加Slf4j注解通过lomboc创建Logger对象
    /**
     *  日志类，监控controller层的方法，打印
     *  请求url、ip、参数、方法名、耗时
     */

    /**
     *  定义切入点：监听所有controller层方法
     */
    @Pointcut("execution(* com.example.idbsystem.controller..*.*(..))")
    public void loggerpointcut() {}


    @Around("loggerpointcut()")
    public Object controllerLog(ProceedingJoinPoint pdj) throws Throwable{

        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();

        long startTime = System.currentTimeMillis();//开始时间

        Object[] args = pdj.getArgs();    //获取参数数组
        Object ret = pdj.proceed(args);   //执行原方法并获取返回结果

        long endTime = System.currentTimeMillis();//结束时间

        // 记录下请求内容
        StringBuilder sb = new StringBuilder();
        sb.append("  URL: " + request.getRequestURL().toString());
        sb.append("  IP: " + request.getRemoteAddr());
        sb.append("  Params: " + Arrays.toString(args));
        sb.append("  CLASS_METHOD: " + pdj.getSignature().getDeclaringTypeName() + "." + pdj.getSignature().getName());
        sb.append("  Time: " + (endTime - startTime) + "毫秒");

        log.info(sb.toString());
        return ret;
    }


}

 

AOP实现web项目登陆状态管理，避免在未登陆的情况下，通过指定的URL访问到网站的内页

package com.example.idbsystem.aop;

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


@Aspect   
@Order(2)   
@Component  
public class LoginAspect {

//    @Resource   //import javax.annotation.Resource;
    boolean isLogin=false;

    /**
     *  定义切入点
     *  避免未登陆通过指定的URL请求进入网站的情况
     */

    @Pointcut("execution(* com.example.idbsystem.controller..*.*(..))"+   //扫描controller层所有方法
            "&& !execution(* com.example.idbsystem.controller..*.exit(..))"+  //不扫描访问登陆页或者退出登陆的方法
            "&& !execution(* com.example.idbsystem.controller..*.login(..))"+  //不扫描登陆方法
            "&& !execution(* com.example.idbsystem.controller.ResposeController.*(..))")   //不扫描controller层下指定类的方法
    public void loginedPointcut() {}

    //在一个指定URL请求执行之前要判断当前是否存于登录状态
    @Around("loginedPointcut()")
    public Object loged(ProceedingJoinPoint pdj) throws Throwable {
        Object result;
        if(isLogin) {
            Object[] args = pdj.getArgs();    //获取参数数组
            result= pdj.proceed(args);   //执行原方法并获取返回结果
        }else{
            System.out.println("请先登录");
            result="/login";
        }
        return result;
    }

    /**
     *  是否登录
     */
    @Pointcut("execution(* com.example.idbsystem.controller..*.login(..))"+  //登陆方法
            "|| execution(* com.example.idbsystem.controller..*.exit(..))")  //访问登陆页或者退出登陆的方法
    public void logingPointcut() {}

    //登录和退出的请求执行完后要记得更新登陆的状态
//    @After(pointcut = "logingPointcut()")  //由于登录方法可能没有成功登录仍停留在登录界面，所以不能通过后置通知（After），而需要通过AfterReturning来判断状态
    @AfterReturning(pointcut = "logingPointcut()",returning = "result")
    public void afterreturningloging(JoinPoint joinPoint, Object result){
        String str = (String) result;
        if(str.equals("/home")) isLogin=true;   // 方法返回"/home"表示跳转到主页，即表示登陆
        else isLogin=false;   // 否则未登陆
    }

}