Java实现自定义注解

简介: 笔记

前言


自定义注解也是一道经常会被问道的面试题.通常会问你自己用过自定义注解吗,让你简单描述下原理,相信如果你写过一次,就能简单的回答出一些问题


注解的作用


像平时用到的 SpringBoot、Mybatis 等框架提供了许多的注解,免去了许多配置文件的繁琐工作,大大简便了开发,Java 提供了自定义注解的功能,这里就先展示简单的例子。


注解可以看作是一种特殊的标记,可以用在方法、类、参数和包上,程序在编译或者运行时可以检测到这些标记而进行一些特殊的处理,例如标注在方法上可以实现接口权限的校验。


使用场景:自定义注解+拦截器或者 AOP。


声明方式:通过关键字 @interface 声明为注解,例子如下:

public @interface MyAnnotation{
}

注解的元素类型


主要有@Target,@Retention,@Document,@Inherited 用来修饰注解。


@Target常用属性

表明该注解可以应用的java元素类型。

20.png

@Retention

表明该注解的生命周期。

21.png

@Documented

表明该注解标记的元素可以被Javadoc 或类似的工具文档化。


@Inherited

表明使用了@Inherited注解的注解,所标记的类的子类也会拥有这个注解


代码实现自定义注解


光说没用,接下来我们实际操作一遍,就能简单感受到自定义注解的作用


1 编写自定义注解


package com.example.annotation;
import java.lang.annotation.*;
/**
 * @description: 自定义注解
 * @author: 魏一鹤
 * @createDate: 2022-08-30 23:04
 **/
//该注解可以应用于类、接口(包括注解类型)、枚举
@Target(ElementType.TYPE)
//该注解标记的元素可以被Javadoc 或类似的工具文档化
@Documented
//该注解的生命周期,由JVM 加载,包含在类文件中,在运行时可以被获取到
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    // 给自定义注解创建基本属性
    // 可以使用default作为默认值使用
    String name() default "法外狂徒张三";
    // 这里没用default默认赋值,一会手动复制
    int age() ;
}

2 编写实体


package com.example.entity;
import com.example.annotation.MyAnnotation;
import lombok.Data;
/**
 * @description: 用户实体类
 * @author: 魏一鹤
 * @createDate: 2022-08-30 23:06
 **/
@Data
// 把我们自定义的注解作用到user类上
@MyAnnotation(age = 18)
public class User {
    String name;
    int age;
}

3 编写测试代码


package com.example.test;
import com.example.annotation.MyAnnotation;
import com.example.entity.User;
/**
 * @description: 测试自定义注解
 * @author: 魏一鹤
 * @createDate: 2022-08-30 23:09
 **/
public class AnnotationTest {
    public static void main(String[] args){
        //获取User的Class对象
        Class<?> userClass = User.class;
        //判断Class对象上是否有我们设置的自定义注解
        if (userClass.isAnnotationPresent(MyAnnotation.class)) {
            System.out.println("User上配置了自定义注解");
            //获取SystemConfig注解
            MyAnnotation myAnnotation = userClass.getAnnotation(MyAnnotation.class);
            System.out.println("MyAnnotation.name:" + myAnnotation.name() + "; MyAnnotation.age:" + myAnnotation.age());
        } else {
            System.out.println("User上没有配置自定义注解");
        }
    }
}

4 测试效果


首先我们给User实体加上我们的自定义注解,可以看到,成功的通过注解获取到了属性

23.png

然后我们给User实体去掉自定义注解 再次运行 很明显,是获取不到注解的属性的

24.png

结语


至此 一个简单的自定义注解Demo就完成了

如果我们的注解写的比较好的话,对于性能有较大的影响,可用于软件的架构设计,实现动态加载,对于分解复杂业务有帮助。

相关文章
|
Java
在 Java 中捕获和处理自定义异常的代码示例
本文提供了一个 Java 代码示例,展示了如何捕获和处理自定义异常。通过创建自定义异常类并使用 try-catch 语句,可以更灵活地处理程序中的错误情况。
374 1
|
2月前
|
存储 Java 索引
用Java语言实现一个自定义的ArrayList类
自定义MyArrayList类模拟Java ArrayList核心功能,支持泛型、动态扩容(1.5倍)、增删改查及越界检查,底层用Object数组实现,适合学习动态数组原理。
105 4
|
4月前
|
Java 数据库 C++
Java异常处理机制:try-catch、throws与自定义异常
本文深入解析Java异常处理机制,涵盖异常分类、try-catch-finally使用、throw与throws区别、自定义异常及最佳实践,助你写出更健壮、清晰的代码,提升Java编程能力。
|
12月前
|
XML Java 编译器
Java注解的底层源码剖析与技术认识
Java注解(Annotation)是Java 5引入的一种新特性,它提供了一种在代码中添加元数据(Metadata)的方式。注解本身并不是代码的一部分,它们不会直接影响代码的执行,但可以在编译、类加载和运行时被读取和处理。注解为开发者提供了一种以非侵入性的方式为代码提供额外信息的手段,这些信息可以用于生成文档、编译时检查、运行时处理等。
234 7
|
5月前
|
XML 人工智能 Java
java通过自定义TraceId实现简单的链路追踪
本文介绍了如何在Spring Boot项目中通过SLF4J的MDC实现日志上下文traceId追踪。内容涵盖依赖配置、拦截器实现、网关与服务间调用的traceId传递、多线程环境下的上下文同步,以及logback日志格式配置。适用于小型微服务架构的链路追踪,便于排查复杂调用场景中的问题。
223 0
|
Java
在 Java 中,如何自定义`NumberFormatException`异常
在Java中,自定义`NumberFormatException`异常可以通过继承`IllegalArgumentException`类并重写其构造方法来实现。自定义异常类可以添加额外的错误信息或行为,以便更精确地处理特定的数字格式转换错误。
222 1
|
Java
让星星⭐月亮告诉你,自定义定时器和Java自带原生定时器
定时器是一种可以设置多个具有不同执行时间和间隔的任务的工具。本文介绍了定时器的基本概念、如何自定义实现一个定时器,以及Java原生定时器的使用方法,包括定义定时任务接口、实现任务、定义任务处理线程和使用Java的`Timer`与`TimerTask`类来管理和执行定时任务。
417 3
|
9月前
|
Java 编译器 开发者
注解的艺术:Java编程的高级定制
注解是Java编程中的高级特性,通过内置注解、自定义注解及注解处理器,可以实现代码的高度定制和扩展。通过理解和掌握注解的使用方法,开发者可以提高代码的可读性、可维护性和开发效率。在实际应用中,注解广泛用于框架开发、代码生成和配置管理等方面,展示了其强大的功能和灵活性。
218 25
|
XML Java 编译器
Java学习十六—掌握注解:让编程更简单
Java 注解(Annotation)是一种特殊的语法结构,可以在代码中嵌入元数据。它们不直接影响代码的运行,但可以通过工具和框架提供额外的信息,帮助在编译、部署或运行时进行处理。
279 43
Java学习十六—掌握注解:让编程更简单
|
12月前
|
Java
java实现从HDFS上下载文件及文件夹的功能,以流形式输出,便于用户自定义保存任何路径下
java实现从HDFS上下载文件及文件夹的功能,以流形式输出,便于用户自定义保存任何路径下
379 34