百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT知识 > 正文

Java APT_java APT 生成代码

liuian 2025-10-02 03:21 9 浏览

Java APT(Annotation Processing Tool)是一种在 Java 编译阶段处理注解的工具。APT 会在编译阶段扫描源代码中的注解,并根据这些注解生成代码、资源文件或其他输出,从而实现代码自动生成、配置生成、校验逻辑等功能。

一、APT 是什么?

APT 全称是 Annotation Processing Tool,它是 Java 编译器的一部分,用于在编译阶段处理注解(Annotations)。APT 允许开发者编写自定义的注解处理器(Annotation Processor),并在编译期间根据注解生成额外的代码或资源。

1.1 注解处理的生命周期

APT 的工作发生在编译阶段,具体是在 javac 编译 .java 文件为 .class 文件之前。在这个阶段,注解处理器可以:

  • 扫描和处理源码中的注解;
  • 生成新的 Java 源文件(.java)或资源文件;
  • 修改已有的代码(不推荐,通常通过生成代码来替代)。

二、APT 的核心组件

2.1 注解(Annotation)

Java 注解是一种元数据形式,可以添加到类、方法、字段等元素上。例如:

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

2.2 注解处理器(Annotation Processor)

需要编写一个类实现 javax.annotation.processing.Processor 接口,或者继承 AbstractProcessor 类。

@SupportedAnnotationTypes("com.example.MyAnnotation")
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public class MyAnnotationProcessor extends AbstractProcessor {
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (TypeElement annotation : annotations) {
            Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(annotation);
            for (Element element : elements) {
                // 处理被注解的类、方法等
                System.out.println("Found annotated element: " + element);
                // 生成代码
                generateCode(element);
            }
        }
        return true;
    }

    private void generateCode(Element element) {
        // 使用 JavaPoet 或手动拼接生成 Java 源文件
    }
}


2.3 注册处理器

可以在 resources/META-INF/services/javax.annotation.processing.Processor 文件中注册你的处理器:

com.example.MyAnnotationProcessor

三、APT 的使用场景

APT 常用于以下场景:

框架

用途

Dagger / Hilt

依赖注入框架,通过注解生成依赖注入代码

Butter Knife / ViewBinding

视图绑定,通过注解绑定 View

Lombok

通过注解简化 Java 代码,如自动生成 getter/setter

Room

数据库框架,通过注解生成数据库访问代码

AutoService / AutoValue

自动生成代码,简化开发

四、APT 的优缺点

优点:

  • 提升开发效率:自动生成重复代码;
  • 减少运行时开销:处理在编译期完成,不影响运行时性能;
  • 编译期检查:可以在编译时进行类型安全检查;
  • 与 IDE 集成良好

缺点:

  • 学习曲线陡峭:需要理解注解、处理器、代码生成等机制;
  • 调试困难:APT 错误信息可能不直观;
  • 生成代码维护困难:如果生成代码结构复杂,调试和维护成本高;
  • 影响编译速度:注解处理器复杂或过多会拖慢编译速度。

五、APT 工具推荐

工具

说明

JavaPoet

Square 提供的 Java 代码生成库,简化代码生成过程

AutoService

Google 提供的工具,帮助自动生成 META-INF/services/ 文件

KAPT

Kotlin 的 APT 支持(用于 Kotlin 与 Java APT 兼容)

KSP(Kotlin Symbol Processing)

Kotlin 官方提供的 APT 替代方案,比 KAPT 更快

六、简单示例:用 JavaPoet 生成代码

private void generateCode(Element element) {
    TypeSpec generatedClass = TypeSpec.classBuilder("GeneratedClass")
            .addMethod(MethodSpec.methodBuilder("sayHello")
                    .addStatement("System.out.println($S)", "Hello from " + element.getSimpleName())
                    .build())
            .build();

    JavaFile javaFile = JavaFile.builder("com.example", generatedClass).build();

    try {
        javaFile.writeTo(processingEnv.getFiler());
    } catch (IOException e) {
        e.printStackTrace();
    }
}

编译后会生成:

package org.example.apt;

public class GeneratedClass {
    public void sayHello() {
        System.out.println("Hello from MyClass");
    }
}

七、总结

APT 是 Java 编译期处理注解的强大工具,广泛用于现代 Java/Kotlin 框架中。通过 APT,你可以:

  • 自动生成代码;
  • 提高开发效率;
  • 实现编译期安全检查;
  • 构建插件化、模块化的架构。

虽然学习成本较高,但掌握后可以极大提升开发效率和系统设计能力。

相关推荐

教你把多个视频合并成一个视频的方法

一.情况介绍当你有一个m3u8文件和一个目录,目录中有连续的视频片段,这些片段可以连成一段完整的视频。m3u8文件打开后像这样:m3u8文件,可以理解为播放列表,里面是播放视频片段的顺序。视频片段像这...

零代码编程:用kimichat合并一个文件夹下的多个文件

一个文件夹里面有很多个srt字幕文件,如何借助kimichat来自动批量合并呢?在kimichat对话框中输入提示词:你是一个Python编程专家,完成如下的编程任务:这个文件夹:D:\downloa...

Java APT_java APT 生成代码

JavaAPT(AnnotationProcessingTool)是一种在Java编译阶段处理注解的工具。APT会在编译阶段扫描源代码中的注解,并根据这些注解生成代码、资源文件或其他输出,...

Unit Runtime:一键运行 AI 生成的代码,或许将成为你的复制 + 粘贴神器

在我们构建了UnitMesh架构之后,以及对应的demo之后,便着手于实现UnitMesh架构。于是,我们就继续开始UnitRuntime,以用于直接运行AI生成的代码。PS:...

挣脱臃肿的枷锁:为什么说Vert.x是Java开发者手中的一柄利剑?

如果你是一名Java开发者,那么你的职业生涯几乎无法避开Spring。它如同一位德高望重的老国王,统治着企业级应用开发的大片疆土。SpringBoot的约定大于配置、SpringCloud的微服务...

五年后,谷歌还在全力以赴发展 Kotlin

作者|FredericLardinois译者|Sambodhi策划|Tina自2017年谷歌I/O全球开发者大会上,谷歌首次宣布将Kotlin(JetBrains开发的Ja...

kotlin和java开发哪个好,优缺点对比

Kotlin和Java都是常见的编程语言,它们有各自的优缺点。Kotlin的优点:简洁:Kotlin程序相对于Java程序更简洁,可以减少代码量。安全:Kotlin在类型系统和空值安全...

移动端架构模式全景解析:从MVC到MVVM,如何选择最佳设计方案?

掌握不同架构模式的精髓,是构建可维护、可测试且高效移动应用的关键。在移动应用开发中,选择合适的软件架构模式对项目的可维护性、可测试性和团队协作效率至关重要。随着应用复杂度的增加,一个良好的架构能够帮助...

颜值非常高的XShell替代工具Termora,不一样的使用体验!

Termora是一款面向开发者和运维人员的跨平台SSH终端与文件管理工具,支持Windows、macOS及Linux系统,通过一体化界面简化远程服务器管理流程。其核心定位是解决多平台环境下远程连接、文...

预处理的底层原理和预处理编译运行异常的解决方案

若文章对您有帮助,欢迎关注程序员小迷。助您在编程路上越走越好![Mac-10.7.1LionIntel-based]Q:预处理到底干了什么事情?A:预处理,顾名思义,预先做的处理。源代码中...

为“架构”再建个模:如何用代码描述软件架构?

在架构治理平台ArchGuard中,为了实现对架构的治理,我们需要代码+模型描述所要处理的内容和数据。所以,在ArchGuard中,我们有了代码的模型、依赖的模型、变更的模型等,剩下的两个...

深度解析:Google Gemma 3n —— 移动优先的轻量多模态大模型

2025年6月,Google正式发布了Gemma3n,这是一款能够在2GB内存环境下运行的轻量级多模态大模型。它延续了Gemma家族的开源基因,同时在架构设计上大幅优化,目标是让...

比分网开发技术栈与功能详解_比分网有哪些

一、核心功能模块一个基本的比分网通常包含以下模块:首页/总览实时比分看板:滚动展示所有正在进行的比赛,包含比分、比赛时间、红黄牌等关键信息。热门赛事/焦点战:突出显示重要的、关注度高的比赛。赛事导航...

设计模式之-生成器_一键生成设计

一、【概念定义】——“分步构建复杂对象,隐藏创建细节”生成器模式(BuilderPattern):一种“分步构建型”创建型设计模式,它将一个复杂对象的构建与其表示分离,使得同样的构建过程可以创建...

构建第一个 Kotlin Android 应用_kotlin简介

第一步:安装AndroidStudio(推荐IDE)AndroidStudio是官方推荐的Android开发集成开发环境(IDE),内置对Kotlin的完整支持。1.下载And...