Spring AOP中@Aspect拦截介绍(二)

本章介绍的@Aspect拦截用的注解方式,对于想要实现多数据源切换,在指定类或方法上只需加上一个注解便可以实现入参出参日志打印的小伙伴,要认真看那一大堆有关Spring AOP支持的AspectJ切入点指示符的注释了。
使用 @Pointcut("@within(com.example.springboot.common.aspectj.LogAspect)") 就是在你想打日志的类上加上自定义注解@LogAspect;
使用 @Pointcut("@annotation(com.example.springboot.common.aspectj.LogAspect)") 就是在你想打日志的方法上加上自定义注解@LogAspect;
其他的指示符大家自行探索其中的奥秘吧,有需要改进的联系我哦!

1.第一步创建自定义注解

@LogAspect

package com.example.springboot.common.aspectj;

import java.lang.annotation.*;

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface LogAspect {
}

2.第二步在service层创建两个测试用的实现类,注意只在父类上加上了自定义注解@LogAspect,为什么继承Father的Child不加这个注解,这是为了同时测试这个注解是否具有被继承的效果。

Father.java

package com.example.springboot.service;

import com.example.springboot.common.aspectj.LogAspect;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

@LogAspect
@Slf4j
@Service
public class Father {

    public String eat(String food){
        String f = food+"太好吃了吧!";
        log.info("执行方法...");
        return f;
    }
}

Child.java

package com.example.springboot.service;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

@Slf4j
@Service
public class Child extends Father {

    public String drink(String drink){
        String d = drink+"太好喝了吧!";
        log.info("执行方法...");
        return d;
    }
}

3.第三部在controller层创建测试类,注意不要与上一章(Spring AOP中@Aspect拦截介绍(一))测试的controller在同一个包下,因为这样会重复拦截,好奇心强的小伙伴可以试试

TestController.java

package com.example.springboot.cheng.controller;

import com.example.springboot.service.Child;
import com.example.springboot.service.Father;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/tc")
public class TestController {
    @Autowired
    private Father father;

    @Autowired
    private Child child;

    /**
     * 测试父类内方法是否打印日志
     * @param name
     * @return
     */
    @GetMapping("/a01")
    public String testa01(String name){
        return father.eat(name);
    }

    /**
     * 测试没有注解的子类内的方法是否打印日志
     * @param name
     * @return
     */
    @GetMapping("/a02")
    public String testa02(String name){
        return child.drink(name);
    }
}

4.最后一步,就是修改第一章(Spring AOP中@Aspect拦截介绍(一))中的拦截器了,就加了了切点拦截和一些注释,建议替换掉

注意:
@within:这个最后实现的效果是吧自定义注解加到类上,本章便是用的这个注解
@annotation这个最后实现的效果是吧自定义注解加到方法上

TestAspect.java

package com.example.springboot.common.aspectj;

import com.example.springboot.cheng.domain.User;
import com.example.springboot.common.core.domain.AjaxResult;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
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;

/**
 * @description 使用该切面拦截时,有两种方式,选择其中一种注掉另一种即可,建议使用第二种,因为可以拦截后修改传入参数:1.@Before+@After 2.@Around
 * Spring AOP支持的AspectJ切入点指示符:
 *   execution:用于匹配方法执行的连接点;
 *   within:用于匹配指定类型内的方法执行;
 *   this:用于匹配当前AOP代理对象类型的执行方法;注意是AOP代理对象的类型匹配,这样就可能包括引入接口也类型匹配;
 *   target:用于匹配当前目标对象类型的执行方法;注意是目标对象的类型匹配,这样就不包括引入接口也类型匹配;
 *   args:用于匹配当前执行的方法传入的参数为指定类型的执行方法;
 *   @within:用于匹配所以持有指定注解类型内的方法;
 *   @target:用于匹配当前目标对象类型的执行方法,其中目标对象持有指定的注解;
 *   @args:用于匹配当前执行的方法传入的参数持有指定注解的执行;
 *   @annotation:用于匹配当前执行方法持有指定注解的方法
 *   bean:Spring AOP扩展的,AspectJ没有对于指示符,用于匹配特定名称的Bean对象的执行方法;例如:bean(*Service) 匹配所有以Service命名(id或name)结尾的Bean
 *   reference pointcut:表示引用其他命名切入点,只有@ApectJ风格支持,Schema风格不支持。
 */
@Aspect
@Component
public class TestAspect {

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

    ThreadLocal<Long> startTime = new ThreadLocal<>();

    /**
     * 第一个*代表返回类型不限
     * 第二个*代表所有类
     * 第三个*代表所有方法
     * (..) 代表参数不限
     * com.example.springboot.controller 测试的controller层
     */
    @Pointcut("execution(public * com.example.springboot.controller.*.*(..))")
    public void pointCut(){};

    /**
     * 注解方式标注指定类或方法来执行拦截
     *
     */
    @Pointcut("@within(com.example.springboot.common.aspectj.LogAspect)")
    public void pointCutAnnotation(){};


    //@Before(value = "pointCut()")
    public void before(JoinPoint joinPoint){
        System.out.println("方法执行前执行......before");
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        logger.info("<=====================================================");
        logger.info("请求来源: =》" + request.getRemoteAddr());
        logger.info("请求URL:" + request.getRequestURL().toString());
        logger.info("请求方式:" + request.getMethod());
        logger.info("响应方法:" + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logger.info("请求参数:" + Arrays.toString(joinPoint.getArgs()));
        logger.info("连接点的方法签名对象:"+joinPoint.getSignature());
        logger.info("连接点所在的目标对象:"+joinPoint.getTarget());
        logger.info("代理对象:"+joinPoint. getThis());
        logger.info("------------------------------------------------------");
        startTime.set(System.currentTimeMillis());
    }

    // 定义需要匹配的切点表达式,同时需要匹配参数
    /**
     * @description 要拦截修改参数的值只有使用这个方法,Around相当于before+after, AspectJ使用 且(&&)、或(||)、非(!)来组合切入点表达式。
     * @param pjp
     * @param arg 类型可以根据pointCut指定切点类下的方法确定,也可以使用统一的Object,也可以不写参数
     * @return
     * @throws Throwable
     */
    @Around("pointCut()&& args(arg)")
    public Object around(ProceedingJoinPoint pjp, Object arg) throws Throwable{
        logger.info("入参:{}",arg);
        logger.info("方法环绕start...around");

        //修改入参
        User user = (User)pjp.getArgs()[0];
        user.setAge(user.getAge()-5);
        Object[] objects = new Object[]{user};

        Object object = pjp.proceed(objects);
        logger.info("方法环绕end...around");
        logger.info("出参:{}",object.toString());
        return object;
    }

    @Around("pointCutAnnotation()&& args(arg)")
    public Object aroundNo(ProceedingJoinPoint pjp, Object arg) throws Throwable{
        logger.info("入参:{}",arg);
        logger.info("方法环绕start...around");

        Object object = pjp.proceed();

        logger.info("方法环绕end...around");
        logger.info("出参:{}",object.toString());
        return object;
    }

    //@After("within(com.example.springboot.controller.*)")
    public void after(){
        System.out.println("方法之后执行...after.");
    }

    /**
     *
     * @param rst 该参数类型需要与测试的Controller层的返回值类型一致,否则不生效,也就是找不到
     *            该测试中的AjaxResult是测试项目中封装好的出参
     */
    //@AfterReturning(pointcut="pointCut()",returning = "rst")
    public void afterRunning(AjaxResult rst){
        if(startTime.get() == null){
            startTime.set(System.currentTimeMillis());
        }
        System.out.println("方法执行完执行...afterRunning");
        logger.info("耗时(毫秒):" +  (System.currentTimeMillis() - startTime.get()));
        logger.info("返回数据:{}", rst);
        logger.info("==========================================>");
    }

    @AfterThrowing("within(com.example.springboot.controller.*)")
    public void afterThrowing(){
        System.out.println("异常出现之后...afterThrowing");
    }

}

5.使用postman测试(要看)

使用postman调用TestController中的两个方法,测试后发现子类继承了父类中的自定义注解@LogAspect。
第二步测试,去掉LogAspect类中的@Inherited注解,重新启动项目测试就会发现子类不再继承父类的自定义注解。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,293评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,604评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,958评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,729评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,719评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,630评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,000评论 3 397
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,665评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,909评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,646评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,726评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,400评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,986评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,959评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,996评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,481评论 2 342

推荐阅读更多精彩内容