ClassIndex 使用指南

ClassIndex 使用指南

classindexIndex classes, do not scan them!项目地址:https://gitcode.com/gh_mirrors/cl/classindex

项目介绍

ClassIndex 是一个高效且标准兼容的 Java 类索引库，允许开发者以查询方式获取到指定注解标注的类、接口实现类、特定类的子类等信息。它通过在编译时生成索引来避免运行时的类路径扫描性能瓶颈，支持增量编译、Java 模块系统、ServiceLoader 以及 JAXB 索引。此项目采用 Apache-2.0 许可证发布，适用于那些需要在编译时期或运行时期获取类信息而不想依赖复杂的类路径扫描逻辑的场景。

项目快速启动

添加依赖

对于 Maven 用户，在 pom.xml 中加入以下依赖：

<dependency>
    <groupId>org.attreo.classindex</groupId>
    <artifactId>classindex</artifactId>
    <version>3.4</version>
</dependency>

若使用 Gradle，则在 build.gradle 文件添加：

implementation 'org.attreo.classindex:classindex:3.4'
annotationProcessor 'org.attreo.classindex:classindex:3.4'

示例代码

为了让您快速体验 ClassIndex 的功能，下面展示了如何找出所有被 @Entity 注解标记的类：

import org.attreo.classindex.ClassIndex;
import org.attreo.classindex.Indexed;

@Entity
public class SampleEntity {}

// 在其他类中检索使用@Entity注解的类
public class App {
    public static void main(String[] args) {
        Iterable<Class<?>> entities = ClassIndex.getAnnotated(Entity.class);
        for (Class<?> entity : entities) {
            System.out.println("Found entity: " + entity.getName());
        }
    }
}

记得将 @Entity 注解添加 @Indexed，以便于编译时创建索引：

import org.attreo.classindex.Indexed;

@Indexed
public @interface Entity {}

应用案例和最佳实践

• 元编程：在编译期收集标注了特定注解的类，进行自动配置或注册。
• 框架开发：框架可以使用 ClassIndex 自动发现并注册组件，如数据库实体、Spring 的 bean 或 RESTful 资源。
• 服务加载：结合 ServiceLoader，提供更高效的基于类型的服务查找机制。

最佳实践

• 对自定义注解添加 @Indexed，确保它们会被索引。
• 在大型项目中，利用 ClassIndex 支持的增量编译特性，提高构建速度。
• 注意在创建阴影jar时配置 ClassIndexTransformer，以防索引丢失。

典型生态项目

虽然 ClassIndex 本身是一个独立的工具库，但它广泛适用于任何需要在编译期间或运行期间动态地根据类型信息（比如注解）来操作类的应用场景。在微服务架构、框架开发、或者是任何需要元数据处理的Java项目中，都可以找到它的身影。尤其适合那些希望减少运行时开销、提升应用程序初始化效率的高级开发实践。

由于 ClassIndex的设计哲学是简洁与高效，它常作为基础工具集成在各种定制化框架或者内部库中，直接与项目紧密集成而非作为一个独立的“生态项目”存在。因此，推荐的做法是将其融入您的技术栈，利用其能力优化您的应用架构设计。

classindexIndex classes, do not scan them!项目地址:https://gitcode.com/gh_mirrors/cl/classindex