Java 自定义注解及使用场景

Java自定义注解一般使用场景为:自定义注解+拦截器或者AOP,使用自定义注解来自己设计框架,使得代码看起来非常优雅。
本文将先从自定义注解的基础概念说起,然后开始实战,写小段代码实现自定义注解+拦截器,自定义注解+AOP。

一. 什么是注解(Annotation)

Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。

Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同,Java 标注可以通过反射获取标注内容。在编译器生成类文件时,标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容,在运行时可以获取到标注内容 。 当然它也支持自定义 Java 标注。

二. 注解体系图

在这里插入图片描述
内置的注解:Java 定义了一套注解,共有 7 个,3 个在 java.lang 中,剩下 4 个在 java.lang.annotation 中。

作用在代码的注解是

@Override - 检查该方法是否是重写方法。如果发现其父类,
或者是引用的接口中并没有该方法时,会报编译错误。
@Deprecated - 标记过时方法。如果使用该方法,会报编译警告。
@SuppressWarnings - 指示编译器去忽略注解中声明的警告。

作用在其他注解上的注解(称为 元注解)是:

@Retention - 标识这个注解怎么保存,是只在代码中,还是编入class文件中,
或者是在运行时可以通过反射访问。
    取值在java.lang.annotation.RetentionPolicy中,取值为:
    SOURCE:在源文件中有效,编译过程中会被忽略
    CLASS:随源文件一起编译在class文件中,运行时忽略
    RUNTIME:在运行时有效
    只有定义为RetentionPolicy.RUNTIME时,我们才能通过注解反射获取到注解。
    
@Documented - 标记这些注解是否包含在用户文档中。

@Target - 描述了注解修饰的对象范围,取值在java.lang.annotation.ElementType定义,
常用的包括:
     METHOD:用于描述方法
     PACKAGE:用于描述包
     PARAMETER:用于描述方法变量
     TYPE:用于描述类、接口或enum类型


@Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

三. 如何拿到我们定义的注解

注解处理类:既然上面定义了注解,那得有办法拿到我们定义的注解啊。java.lang.reflect.AnnotationElement接口则提供了该功能。注解的处理是通过java反射来处理的。如下,反射相关的类Class, Method, Field都实现了AnnotationElement接口。

反射处理AnnotationElement接口方法
因此,只要我们通过反射拿到Class, Method, Field类,就能够通过getAnnotation(Class)拿到我们想要的注解并取值。

四. 示例-反射获取注解

先定义一个注解:

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyField {
   
    String description();
    int length();
}

通过反射获取注解:

import java.lang.reflect.Field;

public class Main {
   
    //使用我们的自定义注解
    @MyField(description = "用户名", length = 12)
    private String username;

    public void testMyField(){
   
        // 获取类模板
        Class c = Main.class;
        // 获取所有字段
        for(Field f : c.getDeclaredFields()){
   
            // 判断这个字段是否有MyField注解
            if(f.isAnnotationPresent(MyField.class)){
   
                MyField annotation = f.getAnn
  • 2
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
Java中的自定义注解是一种在代码中声明的特殊标记,用于在运行时对代码进行处理。通过定义注解,我们可以在代码中添加一些额外的元数据或标记信息,以实现对代码的自定义处理。使用自定义注解可以简化代码的编写和维护,提高代码的可读性和可维护性。 自定义注解使用场景有很多,以下是一些常见的使用场景: 1. 代码检查和规范:通过定义注解并在代码中添加注解,可以对代码进行静态检查,以确保代码符合规范和标准。例如,可以定义一个@NonNull注解用于标记不允许为null的参数或返回值,通过编译器插件或静态检查工具进行检查,从而避免了空指针异常。 2. 代码生成:通过定义注解和处理器,可以自动生成一些重复性的代码,提高开发效率。例如,可以定义一个@Entity注解用于标记实体类,通过注解处理器自动生成数据库表的建表语句或实体类的序列化/反序列化方法。 3. 运行时的动态处理:通过定义注解,并在运行时使用反射机制获取注解信息,可以实现一些动态处理的功能。例如,可以定义一个@Cacheable注解用于标记需要缓存的方法,然后使用反射在方法执行前判断是否有缓存数据,如果有则直接返回缓存结果,提高系统性能。 4. 测试框架:通过定义注解和处理器,可以实现自定义的测试框架。例如,可以定义一个@Test注解用于标记测试方法,然后使用注解处理器在测试运行时自动执行标记的测试方法。 总之,自定义注解Java语言中一种强大的元数据扩展机制,可以在代码中实现各种功能的自定义处理。通过合理设计和使用自定义注解,可以提高代码的可读性、可维护性和可扩展性。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值