Spring 创建一个自定义注解

简介: 平时在用springBoot的使用,常常会用到@Service,@Compent等等注解,简化了我们的开发流程,提升了开发效率.那如何自己来写一个注解呢?下面就来介绍一下。

网络异常,图片无法展示
|


前言


平时在用springBoot的使用,常常会用到@Service@Compent等等注解,简化了我们的开发流程,提升了开发效率.那如何自己来写一个注解呢?下面就来介绍一下。

写一个注解

创建一个注解主要分两部分,一部分是创建注解类,一部分是创建一个切面类

创建注解类

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnn {
    String value() default "d";
}

创建注解类的关键字就是@interface,这个注解类设置了一个value变量,默认值为d;

在注解类上面还有@Target@Retention注解,下面来说说创建注解类时需要用到的几个注解:

@Target

用来标记这个注解可以用于哪些地方,与ElementType枚举类搭配使用,那这个枚举类里面有什么内容呢?

public enum ElementType {
    /** 类,接口(包括注释类型)或枚举声明*/
    TYPE,
    /** 字段声明(包括枚举常量)*/
    FIELD,
    /** 方法声明*/
    METHOD,
    /** 形式参数(形参-调用方法时传入的参数)声明 */
    PARAMETER,
    /** 构造函数声明 */
    CONSTRUCTOR,
    /** 局部变量声明 */
    LOCAL_VARIABLE,
    /** 注释类型声明 */
    ANNOTATION_TYPE,
    /** 包声明 */
    PACKAGE,
    /**
     * 类型参数声明
     * java8新特性:
     * @since 1.8
     */
    TYPE_PARAMETER,
    /**
     * 任何类型声明 
     * java8新特性:
     * @since 1.8
     */
    TYPE_USE
}

@Retention

该注解表示自定义注解的生命周期

public enum RetentionPolicy {
    /**
     * 注释将被编译器丢弃。
     */
    SOURCE,
    /**
     * 注释由编译器记录在类文件中
     * 但不必在运行时由VM保留。 这是默认值
     */
    CLASS,
    /**
     *注释由编译器记录在类文件中,并且
     *在运行时由VM保留,因此可以以反射方式读取它们。
     */
    RUNTIME
}

写一个切面类

因为用到了切面,所以我们要先导入Spring AOP这个依赖包。

<!--SpringBoot项目导入AOP-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

创建切面类

@Aspect
@Component
public class MyAnnAop {
    private Logger logger= LoggerFactory.getLogger(MyAnnAop.class);
    @Pointcut("@annotation(com.example.demo.annotation.MyAnn)")
    public void ann(){
    }
    @Before("ann()")
    public void before(JoinPoint joinPoint){
        logger.info("打印:开始前");
    }
    @AfterReturning(value = "ann()",returning = "res")
    public Object dochange(JoinPoint joinPoint,Object res){
        logger.info("AfterReturning通知开始-获取数据:{}",res);
        //获取数据
        Map<String,String> map= (Map<String, String>) res;
        //添加新值
        map.put("s1","我是在AOP中添加的新值");
        return map;
    }
}

Spring AOP说明

具体可以查阅Spring AOP相关资料

注解 说明
@Before 前置通知,在连接点方法前调用
@Around 环绕通知,它将覆盖原有方法,但是允许你通过反射调用原有方法
@After 后置通知,在连接点方法后调用
@AfterReturning 返回通知,在连接点方法执行并正常返回后调用,要求连接点方法在执行过程中没有发生异常
@AfterThrowing 异常通知,当连接点方法异常时调用

使用自定义的注解

这里使用普通的SpringBoot来使用注解,创建一个Service,在里面使用注解,然后才控制层调用

//服务层
@Service
public class TestService {
    @MyAnn
    public Map test(){
        Map<String,String>  map=new HashMap<>();
        map.put("t1","我是在Service设置的值");
        return map;
    }
}
//控制层
@RestController
public class Test2 {
    private Logger logger= LoggerFactory.getLogger(Test2.class);
    @Autowired
    private TestService testService;
    @GetMapping("/test")
    public String test(String id){
        Map<String,String> s=testService.test();
        logger.info("控制层输出:{}",s.get("s1"));
        return "sccess";
    }
}

输出

com.example.demo.aop.MyAnnAop : AfterReturning通知开始-获取数据:{t1=我是在Service设置的值}
com.example.demo.web.Test2    : 控制层输出:我是在AOP中添加的新值

注意事项

上面那样使用注解是没问题的,但是如果是下面这样使用,AOP就会失效

@RestController
public class Test2 {
    private Logger logger= LoggerFactory.getLogger(Test2.class);
    @Autowired
    private TestService testService;
    @GetMapping("/test")
    public String test(String id){
        Map<String,String> s=this.test2();
        logger.info("控制层输出:{}",s.get("s1"));
        return "sccess";
    }
    @MyAnn
    public Map test2(){
        Map<String,String>  map=new HashMap<>();
        map.put("t1","我是在控制层设置的值");
        return map;
    }
}

输出

com.example.demo.web.Test2       : 控制层输出:null

这是应为内部方法调用,调用的是具体方法,并没有调用使用AOP后生成的代理方法

目录
相关文章
|
2月前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
56 0
|
6天前
|
Java Spring
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
124 73
|
1天前
|
Java Spring 容器
【SpringFramework】Spring IoC-基于注解的实现
本文主要记录基于Spring注解实现IoC容器和DI相关知识。
33 21
|
7天前
|
XML Java 数据格式
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
本文介绍了在使用Spring框架时,如何通过创建`applicationContext.xml`配置文件来管理对象。首先,在resources目录下新建XML配置文件,并通过IDEA自动生成部分配置。为完善配置,特别是添加AOP支持,可以通过IDEA的Live Templates功能自定义XML模板。具体步骤包括:连续按两次Shift搜索Live Templates,配置模板内容,输入特定前缀(如spring)并按Tab键即可快速生成完整的Spring配置文件。这样可以大大提高开发效率,减少重复工作。
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
|
8天前
|
设计模式 XML Java
【23种设计模式·全精解析 | 自定义Spring框架篇】Spring核心源码分析+自定义Spring的IOC功能,依赖注入功能
本文详细介绍了Spring框架的核心功能,并通过手写自定义Spring框架的方式,深入理解了Spring的IOC(控制反转)和DI(依赖注入)功能,并且学会实际运用设计模式到真实开发中。
【23种设计模式·全精解析 | 自定义Spring框架篇】Spring核心源码分析+自定义Spring的IOC功能,依赖注入功能
|
6天前
|
存储 Java Spring
【Spring】获取Bean对象需要哪些注解
@Conntroller,@Service,@Repository,@Component,@Configuration,关于Bean对象的五个常用注解
|
6天前
|
Java Spring
【Spring配置】idea编码格式导致注解汉字无法保存
问题一:对于同一个项目,我们在使用idea的过程中,使用汉字注解完后,再打开该项目,汉字变成乱码问题二:本来a项目中,汉字注解调试好了,没有乱码了,但是创建出来的新的项目,写的注解又成乱码了。
|
14天前
|
NoSQL Java Redis
Spring Boot 自动配置机制:从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解,根据类路径中的依赖和条件注解自动配置所需的 Bean,大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例,帮助开发者更好地理解和利用这一强大特性。
63 14
|
2月前
|
前端开发 Java Spring
Spring MVC核心:深入理解@RequestMapping注解
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的核心,它将HTTP请求映射到控制器的处理方法上。本文将深入探讨`@RequestMapping`注解的各个方面,包括其注解的使用方法、如何与Spring MVC的其他组件协同工作,以及在实际开发中的应用案例。
45 4
|
2月前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
74 4
SpringBoot必须掌握的常用注解!