infomas-asl 技术文档

1. 安装指南

1.1 Maven 配置

要使用 infomas-asl 项目，首先需要在你的 Maven 项目中添加依赖。在 pom.xml 文件中添加以下内容：

<dependency>
   <groupId>eu.infomas</groupId>
   <artifactId>annotation-detector</artifactId>
   <version>3.0.6</version>
</dependency>

1.2 手动安装

如果你不使用 Maven，可以直接下载 annotation-detector-3.0.6.jar 文件，并将其添加到项目的类路径中。

2. 项目的使用说明

2.1 基本使用

infomas-asl 项目的主要功能是扫描类路径中的注解类、方法或实例变量。以下是基本的使用示例：

2.1.1 扫描类路径中的注解

// 扫描类路径中的所有 .class 文件，报告所有带有 org.junit.Test 注解的方法
final MethodReporter reporter = new MethodReporter() {

    @SuppressWarnings("unchecked")
    @Override
    public Class<? extends Annotation>[] annotations() {
        return new Class[]{Test.class};
    }

    @Override
    public void reportMethodAnnotation(Class<? extends Annotation> annotation,
        String className, String methodName) {
        // 处理注解信息
    }
    
};
final AnnotationDetector cf = new AnnotationDetector(reporter);
cf.detect();

2.2 高级使用

2.2.1 使用 Java 8 语法

// 获取所有带有 @RuntimeVisibleTestAnnotation 注解的类列表
List<Class<?>> types = AnnotationDetector.scanClassPath()
    .forAnnotations(RuntimeVisibleTestAnnotation.class)
    .collect(AnnotationDetector::getType);

    assertEquals(1, types.size());
    assertSame(NewApiTest.class, types.get(0));

// 获取所有带有 @RuntimeVisibleTestAnnotation 注解的方法列表，排除 "eu.infomas" 包及其子包中以 "Test.class" 结尾的文件
List<Method> methods = AnnotationDetector.scanClassPath("eu.infomas") // 或者使用 scanFiles(File... files)
    .forAnnotations(RuntimeVisibleTestAnnotation.class) // 一个或多个注解
    .on(ElementType.METHOD) // 可选，默认 ElementType.TYPE。一个或多个元素类型
    .filter((File dir, String name) -> !name.endsWith("Test.class")) // 可选，默认所有 *.class 文件
    .collect(AnnotationDetector::getMethod);

    assertEquals(1, methods.size());
    assertEquals(void.class, methods.get(0).getReturnType());

3. 项目API使用文档

3.1 AnnotationDetector 类

AnnotationDetector 类是 infomas-asl 项目的核心类，用于扫描类路径中的注解。

3.1.1 方法

• detect(): 开始扫描类路径中的注解。
• scanClassPath(): 扫描整个类路径。
• scanFiles(File... files): 扫描指定的文件。
• forAnnotations(Class<? extends Annotation>... annotations): 指定要查找的注解。
• on(ElementType... elementTypes): 指定要查找的元素类型（如类、方法、字段等）。
• filter(BiPredicate<File, String> filter): 过滤文件名。
• collect(Function<AnnotationDetector, T> collector): 收集扫描结果。

3.2 MethodReporter 接口

MethodReporter 接口用于报告带有特定注解的方法。

3.2.1 方法

• annotations(): 返回要查找的注解数组。
• reportMethodAnnotation(Class<? extends Annotation> annotation, String className, String methodName): 处理找到的注解信息。

4. 项目安装方式

4.1 Maven 安装

通过 Maven 安装是最简单的方式，只需在 pom.xml 中添加依赖即可。

4.2 手动安装

如果不使用 Maven，可以直接下载 annotation-detector-3.0.6.jar 文件，并将其添加到项目的类路径中。

---

通过以上文档，你应该能够顺利安装和使用 infomas-asl 项目，并了解其 API 的使用方法。