java反射获取有注解的类

原创

mob64ca12d8c182 2024-01-05 06:24:25 ©著作权

文章标签 Java java List 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12d8c182的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java反射获取有注解的类

在Java中，反射是一种强大的工具，可以在运行时获取类的信息并操作类的成员。它允许我们动态地加载和使用类，而无需在编译时知道类的名称。本文将介绍如何使用反射来获取具有特定注解的类。

什么是注解

注解是Java语言的一种特性，它可以用来在代码中添加元数据。注解本身没有任何实际的功能，但可以在运行时被其他程序使用。Java提供了一些内置的注解，如@Override，@Deprecated等，同时我们也可以自定义注解。

定义一个注解

首先，让我们定义一个简单的注解@MyAnnotation，该注解用于标记特定的类：

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyAnnotation {
}

在上面的代码中，我们使用@Retention(RetentionPolicy.RUNTIME)指定了注解的保留策略为运行时，这样我们就可以在运行时获取到该注解。@Target(ElementType.TYPE)表示该注解只能应用在类上。

使用反射获取有注解的类

接下来，我们将使用反射来获取具有@MyAnnotation注解的类。首先，我们需要编写一个工具方法getAnnotatedClasses，该方法接收一个包名作为参数，并返回该包下所有带有@MyAnnotation注解的类的列表。

import java.util.ArrayList;
import java.util.List;

public class ReflectionUtils {

    public static List<Class<?>> getAnnotatedClasses(String packageName) throws Exception {
        List<Class<?>> annotatedClasses = new ArrayList<>();
        List<Class<?>> classes = ClassUtils.getClasses(packageName);
        
        for (Class<?> clazz : classes) {
            if (clazz.isAnnotationPresent(MyAnnotation.class)) {
                annotatedClasses.add(clazz);
            }
        }
        
        return annotatedClasses;
    }
}

在上面的代码中，我们使用了一个ClassUtils工具类的getClasses方法，该方法用于获取指定包名下的所有类。你可以根据自己的需要实现该方法。

接下来，让我们来看一个例子。假设我们有一个包名为com.example，其中有两个类MyClass1和MyClass2，我们想获取所有带有@MyAnnotation注解的类：

package com.example;

@MyAnnotation
public class MyClass1 {
    // ...
}

public class MyClass2 {
    // ...
}

我们可以使用以下代码来获取带有@MyAnnotation注解的类：

import java.util.List;

public class Main {

    public static void main(String[] args) throws Exception {
        List<Class<?>> annotatedClasses = ReflectionUtils.getAnnotatedClasses("com.example");
        
        for (Class<?> clazz : annotatedClasses) {
            System.out.println(clazz.getName());
        }
    }
}

上面的代码将打印出com.example.MyClass1，因为MyClass1带有@MyAnnotation注解。