springboot 面向切面编程之使用自定义注解

我们知道使用@Pointcut注解定义切点,它的value属性可以是切点表达式 或者 注解的全限定名;若使用注解的方式,直接在目标切入点方法上加上自定义注解即可纳入AOP的管理

在创建自定义注解时有看到三个注解,分别了解它们的作用

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
定义使用注解的地方

我们先来看看这个枚举类java.lang.annotation.ElementType就是定义注解使用的地方。比如 @Target(ElementType.METHOD) 就是只能用在方法上了。不过可以同时指定多个ElementType的属性来达到既可以用在方法上也可以用在类上的目的: @Target({ElementType.TYPE, ElementType.METHOD})

  • TYPE 申明在类、接口、枚举类上面
  • FIELD 申明在类属性上
  • METHOD 申明在方法上
  • PARAMETER 申明在形式参数上
  • CONSTRUCTOR 申明在构造器上
  • LOCAL_VARIABLE 申明在局部表量上
  • ANNOTATION_TYPE 批注类型
  • PACKAGE 申明在包上
  • TYPE_PARAMETER
  • TYPE_USE

public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,

    /** Field declaration (includes enum constants) */
    FIELD,

    /** Method declaration */
    METHOD,

    /** Formal parameter declaration */
    PARAMETER,

    /** Constructor declaration */
    CONSTRUCTOR,

    /** Local variable declaration */
    LOCAL_VARIABLE,

    /** Annotation type declaration */
    ANNOTATION_TYPE,

    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

再来看看@Documented注解

Documented注解表明这个注释是由 javadoc记录的。 如果一个类型声明被注释了文档化,它的注释成为公共API的一部分。

注解的生命周期

再来看这个枚举类 java.lang.annotation.RetentionPolicy。该类主要功能是定义注解的生命周期

1、RetentionPolicy.SOURCE:注解只保留在源代码,源代码被编译成字节码时注解被干掉。做一些检查性的操作,比如 @Override 和 @SuppressWarnings;还有生成格外的源代码,如lombok中的@Data
2、RetentionPolicy.CLASS:这是默认的生命周期。注解被保留到字节码中,注解在字节码被ClassLoader加载时被干掉。
3、RetentionPolicy.RUNTIME:注解不仅被保存到字节码中,ClassLoader加载之后,仍然存在;如果需要在运行时去动态获取注解信息,那只能用 RUNTIME 注解
4、这3个生命周期分别对应于:源代码 ---> .class文件 ---> jvm中的指令;生命周期长度 SOURCE < CLASS < RUNTIME

package java.lang.annotation;

/**
 * Annotation retention policy.  The constants of this enumerated type
 * describe the various policies for retaining annotations.  They are used
 * in conjunction with the {@link Retention} meta-annotation type to specify
 * how long annotations are to be retained.
 *
 * @author  Joshua Bloch
 * @since 1.5
 */
public enum RetentionPolicy {
    /**
     * Annotations are to be discarded by the compiler.
     */
    SOURCE,

    /**
     * Annotations are to be recorded in the class file by the compiler
     * but need not be retained by the VM at run time.  This is the default
     * behavior.
     */
    CLASS,

    /**
     * Annotations are to be recorded in the class file by the compiler and
     * retained by the VM at run time, so they may be read reflectively.
     *
     * @see java.lang.reflect.AnnotatedElement
     */
    RUNTIME
}

编写自定义注解

创建注解类TestAnnotation。里面有一个name参数,默认是no;没错,该注解只能用在方法上,不能用在类、接口;而且是运行时类型的

package com.springboot.study.demo1.aop.annotation;
import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface TestAnnotation {
    String name() default "no";
}

在目标方法上使用注解

分别指定testAop1()和testAop2()方法的注解属性name值为 yes 和 on

package com.springboot.study.demo1.controller;
import com.baomidou.mybatisplus.extension.api.R;
import com.springboot.study.demo1.aop.annotation.TestAnnotation;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 /**
 *@description: UserController
 *@author: yinkai
 *@create: 2020/2/25 9:51
 */
@RestController
@RequestMapping("/aop")
public class AopController {
    @TestAnnotation(name="no")
    @RequestMapping("/testAop1")
    public R testAop1(){

        System.out.println("testAop1");
        return R.ok("ok");
    }


    @TestAnnotation(name="yes")
    @RequestMapping("/testAop2")
    public R testAop2(){
        System.out.println("testAop2");
        return R.ok("ok");
    }
}

创建切面类

  • @Pointcut注解定义切点,使用注解类的全限定名作为参数。表示只要在方法上用了该注解,那么该方法就会被aop管理
  • 在环绕通知方法中获得目标方法上申明的注解属性name,然后进行判断。分别进行不同的业务
package com.springboot.study.demo1.aop;

import com.springboot.study.demo1.aop.annotation.TestAnnotation;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.aspectj.lang.reflect.SourceLocation;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

/**
 * @desc: 定义切面
 * @author: yinkai
 **/
@Aspect
@Component
public class BrokerAspect {

    @Pointcut("@annotation(com.springboot.study.demo1.aop.annotation.TestAnnotation)")
    public void BrokerAspect() {

    }


    /**
     * @description 使用环绕通知
     */
    @Around("BrokerAspect()")
    public Object doAroundFunction(ProceedingJoinPoint point) throws Throwable {

        MethodSignature signature = (MethodSignature) point.getSignature();
        //得到目标方法
        Method method = signature.getMethod();
        //得到方法之上的注解
        TestAnnotation testAnnotation = method.getAnnotation(TestAnnotation.class);
        //注解业务判断
        if ("yes".equals(testAnnotation.name())) {
            System.out.println("name的值为yes对应的业务");
        } else {
            System.out.println("name的值为no对应的业务");
        }
        return point.proceed();
    }
}

最后重启工程,访问http://localhost:8080/test/aop/testAop1http://localhost:8080/test/aop/testAop2

image.png

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

推荐阅读更多精彩内容