SpringBoot中自定义注解

简介: SpringBoot中自定义注解

注解


1. 元注解


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

image.png

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";
     }
 }
复制代码


运行结果如下


image.png

目录
相关文章
|
24天前
|
Java Spring 容器
如何解决spring EL注解@Value获取值为null的问题
本文探讨了在使用Spring框架时,如何避免`@Value("${xxx.xxx}")`注解导致值为null的问题。通过具体示例分析了几种常见错误场景,包括类未交给Spring管理、字段被`static`或`final`修饰以及通过`new`而非依赖注入创建对象等,提出了相应的解决方案,并强调了理解框架原理的重要性。
87 4
|
8天前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
|
3月前
|
Java 开发者 Spring
【SpringBoot 异步魔法】@Async 注解:揭秘 SpringBoot 中异步方法的终极奥秘!
【8月更文挑战第25天】异步编程对于提升软件应用的性能至关重要,尤其是在高并发环境下。Spring Boot 通过 `@Async` 注解简化了异步方法的实现。本文详细介绍了 `@Async` 的基本用法及配置步骤,并提供了示例代码展示如何在 Spring Boot 项目中创建与管理异步任务,包括自定义线程池、使用 `CompletableFuture` 处理结果及异常情况,帮助开发者更好地理解和运用这一关键特性。
147 1
|
3月前
|
缓存 Java 数据库连接
Spring Boot奇迹时刻:@PostConstruct注解如何成为应用初始化的关键先生?
【8月更文挑战第29天】作为一名Java开发工程师,我一直对Spring Boot的便捷性和灵活性着迷。本文将深入探讨@PostConstruct注解在Spring Boot中的应用场景,展示其在资源加载、数据初始化及第三方库初始化等方面的作用。
77 0
|
21天前
|
XML Java 数据格式
Spring从入门到入土(bean的一些子标签及注解的使用)
本文详细介绍了Spring框架中Bean的创建和使用,包括使用XML配置文件中的标签和注解来创建和管理Bean,以及如何通过构造器、Setter方法和属性注入来配置Bean。
56 9
Spring从入门到入土(bean的一些子标签及注解的使用)
|
13天前
|
架构师 Java 开发者
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
在40岁老架构师尼恩的读者交流群中,近期多位读者成功获得了知名互联网企业的面试机会,如得物、阿里、滴滴等。然而,面对“Spring Boot自动装配机制”等核心面试题,部分读者因准备不足而未能顺利通过。为此,尼恩团队将系统化梳理和总结这一主题,帮助大家全面提升技术水平,让面试官“爱到不能自已”。
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
|
18天前
|
XML Java 数据库
Spring boot的最全注解
Spring boot的最全注解
|
19天前
|
JSON NoSQL Java
springBoot:jwt&redis&文件操作&常见请求错误代码&参数注解 (九)
该文档涵盖JWT(JSON Web Token)的组成、依赖、工具类创建及拦截器配置,并介绍了Redis的依赖配置与文件操作相关功能,包括文件上传、下载、删除及批量删除的方法。同时,文档还列举了常见的HTTP请求错误代码及其含义,并详细解释了@RequestParam与@PathVariable等参数注解的区别与用法。
|
19天前
|
Java API Spring
springBoot:注解&封装类&异常类&登录实现类 (八)
本文介绍了Spring Boot项目中的一些关键代码片段,包括使用`@PathVariable`绑定路径参数、创建封装类Result和异常处理类GlobalException、定义常量接口Constants、自定义异常ServiceException以及实现用户登录功能。通过这些代码,展示了如何构建RESTful API,处理请求参数,统一返回结果格式,以及全局异常处理等核心功能。
|
25天前
|
Java Spring 容器
Springboot3.2.1搞定了类Service和bean注解同名同类型问题修复
这篇文章讨论了在Spring Boot 3.2.1版本中,同名同类型的bean和@Service注解类之间冲突的问题得到了解决,之前版本中同名bean会相互覆盖,但不会在启动时报错,而在配置文件中设置`spring.main.allow-bean-definition-overriding=true`可以解决这个问题。
60 0
Springboot3.2.1搞定了类Service和bean注解同名同类型问题修复