栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

SpringBoot中自定义注解

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

SpringBoot中自定义注解

文章目录
  • 注解
    • 1. 元注解
      • 1.1 @Target
      • 1.2 @Retention
      • 1.3 @Inherited
      • 1.4 @documented
      • 1.5 @interface
    • 2. 实现一个自定义注解

注解 1. 元注解

元注解就是定义注解的注解,是Java提供的用于定义注解的基本注解

注解说明
@Retention是注解类,实现声明类Class,声明类别,声明拓展
@Target放在自定义注解的上边,表明该注解可以使用的范围
@Inherited允许子类继承父类的注解,在子类中可以获取使用父类的注解
@documented表明这个注解是由javadoc记录的
@interface用来自定义注解的类型
1.1 @Target

该注解的作用是告诉java将自定义的注解放在什么地方,比如类、方法、构造器、变量上等

它的值是一个枚举类型,有以下属性值

  • ElementType.CONSTRUCTOR:用于描述构造器
  • ElementType.FIELD:用于描述成员变量、对象、属性
  • ElementType.LOCAL_VARIABLE:用于描述局部变量
  • ElementType.METHOD:用于描述方法
  • ElementType.PACKAGE:用于描述包
  • ElementType.PARAMETER:用于描述参数
  • ElementType.TYPE:用于描述类、接口或enum枚举声明
1.2 @Retention

该注解用于说明自定义注解的生命周期,在注解中有三个生命周期

  • RetentionPolicy.RUNTIME:始终不会丢弃,运行期也保留该注解,可以使用反射机制读取该注解的信息
  • RetentionPolicy.CLASS:类加载时丢弃,默认使用这种方式
  • RetentionPolicy.SOURCE:编译阶段丢弃,自定义注解在编译结束之后就没有意义,所以不会写进字节码,熟悉的

@Override就属于这种

1.3 @Inherited

该注解是一个标记注解,表明被标记的类型是可以被继承的。如果一个使用这个标记的注解被使用了,那么该类的子类也会用到这个注解

1.4 @documented

该注解表示是否将注解信息添加在java文档中

1.5 @interface

该注解用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数,方法名称就是参数名称,返回值类型就是参数的类型

2. 实现一个自定义注解

首先创建一个自定义注解

package com.example.demo;


import org.springframework.stereotype.Component;

import java.lang.annotation.*;

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@documented
@Component
public @interface MyAnnotation {
    String value();
}

然后编写一个业务逻辑,这里就是拦截被自定义注解的方法,然后在控制台打印注解参数

package com.example.demo;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

@Aspect
@Component
public class TestAnnotationAspect {
    @Pointcut("@annotation(com.example.demo.MyAnnotation)")
    public void myAnnotationPointCut(){}

    @Before("myAnnotationPointCut()")
    public void before(JoinPoint joinPoint)throws Throwable{
        MethodSignature sign=(MethodSignature) joinPoint.getSignature();
        Method method=sign.getMethod();
        MyAnnotation annotation=method.getAnnotation(MyAnnotation.class);
        System.out.println("Test Annotation参数:"+annotation.value());
    }
}

最后实现一个Controller,访问页面的时候查看业务逻辑是否被打印

package com.example.demo;

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

@RestController
public class TestAnnotationController {
    @GetMapping("/test")
    @MyAnnotation("测试自定义注解")
    public String test(){
        return "shelgi";
    }
}

运行结果如下

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/445324.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号