SpringBoot切面AOP

spring切面，在方法的执行前后切入代码，切入事物service层，或做一些日志操作。

AOP切面主要是切方法，我们一般搞一些日志分析和事务操作，要用到切面，类似拦截器；

@Aspect注解是切面注解类

@Pointcut切点定义

@Before是方法执行前调用

@After是方法执行后调用

@AfterReturning方法执行返回值调用

Service层本身就可以切入事务，所以我们这类搞个常用的 切controller层方法

每个执行controller层的方法 都记录下请求Url，访问者IP 执行类方法参数等信息；

@Pointcut定义切点，对controller任意类的任意方法进行切入，第一个*任意返回值 *.*任意类的任意方法

@Before("log()") 执行前调用 log()加入切点，通过切点joinPoint获得信息

@AfterReturning 方法的返回值  returning="result"指定返回参数和下面匹配

切面，切入点是这个controller 。注解@Pointcut 定义切入点，就是作用在哪个业务方法。execution(public * * com.java.controller.*.*(..))  是一个表达式，匹配业务方法的路径。第一个*表示方法的返回数据可以是任意类型。最后两个*表示所有类的所有方法。

import javax.servlet.http.HttpServletRequest;

import org.apache.log4j.Logger;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;


@Aspect
@Component
public class RequestAspect {

	private Logger logger=Logger.getLogger(RequestAspect.class);
	
	@Pointcut("execution(public * com.java.controller.*.*(..))")
	public void log(){
	}
	
	@Before("log()")
	public void doBefore(JoinPoint joinPoint){
		logger.info("方法执行前...");
		ServletRequestAttributes sra=(ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
		HttpServletRequest request=sra.getRequest();
		logger.info("url:"+request.getRequestURI());
		logger.info("ip:"+request.getRemoteHost());
		logger.info("method:"+request.getMethod());
		logger.info("class_method:"+joinPoint.getSignature().getDeclaringTypeName()+"."+joinPoint.getSignature().getName());
		logger.info("args:"+joinPoint.getArgs());
		Student student=(Student) joinPoint.getArgs()[0];
		System.out.println(student);
	}
	
	@After("log()")
	public void doAfter(JoinPoint joinPoint){
		logger.info("方法执行后...");
	}
	
	@AfterReturning(returning="result",pointcut="log()")
	public void doAfterReturning(Object result){
		logger.info("方法返回值："+result);
	}
}

controller

import javax.annotation.Resource;
import javax.validation.Valid;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.entity.Student;
import com.service.StudentService;

@RestController
@RequestMapping("/student")
public class StudentController {

	@Resource
	private StudentService studentService;
	
	@RequestMapping("/add")
	public String add(@Valid Student student,BindingResult bindingResult){
		if(bindingResult.hasErrors()){
			return bindingResult.getFieldError().getDefaultMessage();
		}else{
			studentService.add(student);
			return "添加成功";
		}
	}
}

RequestContextHolder获取request信息的所有属性，在执行前获取当前人的url，ip和调用的方法

joinPoint.getSignature() 看调用的是哪个类和构造，获取类名和方法

joinPoint.getArgs()获取参数

@Aspect
@Component
public class LogAspect {
    @Pointcut("execution(public * com.cmic.attendance.web.*.*(..))")
    public void webPointCut(){}
 
    @Before("webPointCut()")
    public void deBefore(JoinPoint joinPoint) throws Throwable {
        // 接收到请求，记录请求内容
        System.out.println("【注解：Before】------------------切面  before");
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // 记录下请求内容
        System.out.println("【注解：Before】浏览器输入的网址=URL : " + request.getRequestURL().toString());
        System.out.println("【注解：Before】HTTP_METHOD : " + request.getMethod());
        System.out.println("【注解：Before】IP : " + request.getRemoteAddr());
        System.out.println("【注解：Before】执行的业务方法名=CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        System.out.println("【注解：Before】业务方法获得的参数=ARGS : " + Arrays.toString(joinPoint.getArgs()));
 
    }
 
    @AfterReturning(returning = "ret", pointcut = "webPointCut()")
    public void doAfterReturning(Object ret) throws Throwable {
        // 处理完请求，返回内容
        System.out.println("【注解：AfterReturning】这个会在切面最后的最后打印，方法的返回值 : " + ret);
    }
 
    //后置异常通知
    @AfterThrowing("webPointCut()")
    public void throwss(JoinPoint jp){
        System.out.println("【注解：AfterThrowing】方法异常时执行.....");
    }
 
    //后置最终通知,final增强，不管是抛出异常或者正常退出都会执行
    @After("webPointCut()")
    public void after(JoinPoint jp){
        System.out.println("【注解：After】方法最后执行.....");
    }
 
    //环绕通知,环绕增强，相当于MethodInterceptor
    @Around("webPointCut()")
    public Object arround(ProceedingJoinPoint pjp) {
        System.out.println("【注解：Around . 环绕前】方法环绕start.....");
        try {
            Object o =  pjp.proceed();//如果不执行这句，会不执行切面的Before方法及controller的业务方法
            System.out.println("【注解：Around. 环绕后】方法环绕proceed，结果是 :" + o);
            return o;
        } catch (Throwable e) {
            e.printStackTrace();
            return null;
        }
    }
}

@RestController
public class MyWebController {
 
    @RequestMapping("/first")
    public Object first(String name,Integer age) {
        System.out.println("方法执行中ing........");
        return "first controller";
    }
 
    @RequestMapping("/doError")
    public Object error() {
        return 1 / 0;
    }
}

访问 first方法 ，不抛异常时，执行结果如图：

可以看出各注解及业务方法的执行顺序。如果删掉@Around 的语句 pjp.proceed(); 会不执行切面的Before方法及controller的业务方法