注解处理器apt在java中的实现(代码片段)

我想月薪过万 我想月薪过万     2022-12-30     617

关键词:

概念理解

APT:英文全名(Annotation Processor Tool),即:注解处理器。它是 javac 的一个工具,这是Sun为了帮助注解的处理过程而提供的工具,apt被设计为操作Java源文件,而不是编译后的类。

作用阶段示意图如下:

具体作用

  1.  在编译期能够获取注解与注解声明的类包括类中的所有成员信息,一般用于生成额外的辅助类。
  2. 语法检查

实战代码

第一步:定义注解

package com.wustyq.demo01;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * ClassName: tb_person <br/>
 * Description: <br/>
 * date: 2021/9/5 17:32<br/>
 *
 * @author yiqi<br />
 * @since JDK 1.8
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface tb_person 
    String name();
    String id();
    int age();

第二步:定义使用注解的测试类

package com.wustyq.demo01;

/**
 * ClassName: Person <br/>
 * Description: <br/>
 * date: 2021/9/5 17:36<br/>
 *
 * @author yiqi<br />
 * @since JDK 1.8
 */
@tb_person(name="person",id="123456",age=16)
public class Person 


第三步:定义注解处理器

package com.wustyq.demo01;

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic;
import java.util.Set;

/**
 * ClassName: myAnnotationHandler <br/>
 * Description: <br/>
 * date: 2021/9/5 17:46<br/>
 *
 * @author yiqi<br />
 * @since JDK 1.8
 */
public class myAnnotationHandler extends AbstractProcessor 
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) 
        System.out.println("=========");
        processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE,"********");
        return false;
    

第四步:运行

运行一定要分为两步:

所以我们先将注解类和注解处理器类进行编译

javac com\\wustyq\\demo01\\myAnnotationHandler.java com\\wustyq\\demo01\\tb_person.java

接下来进行编译我们的测试类,此时在编译时需要加上processor参数,用来指定相关的注解处理类。

javac -processor com.wustyq.demo01.myAnnotationHandler com\\wustyq\\demo01\\Person.java

可能出现的报错情况:

 两个原因:

  1. 所使用类的完整类名确实有问题
  2. 当前文件夹位置必须在 所使用类完整类名的同级目录,例如这里与 com 同级

 这是因为你在写注解处理器的时候没有指定 版本 和 处理哪一类的注解,解决方法如下:

@SupportedSourceVersion(SourceVersion.RELEASE_8)
@SupportedAnnotationTypes("com.wustyq.demo01.tb_person")

记住,把这些东西都加进去之后类要重新编译,不然你改了和没改一样

运行效果展示

 

 

框架手写系列---apt注解处理器方式实现butterknife框架(代码片段)

一、ButterKnifeButterKnife作为常用框架之一,主要用于简化代码,减少重复代码。这里主要注重原理与核心,将分步骤手写它的核心代码。ButterKnife最常用的是去除代码中的findViewById,以注解的方式代替原有的代码... 查看详情

java中的apt的工作过程(代码片段)

...作过程APT即AnnotatinoProcessingTool,他的作用是处理代码中的注解,用来生成代码,换句话说,这是用代码生成代码的工具,减少boilerplate代码.我们通过一个简单的例子来简单APT的工作过程,因为本文demo不设计ide及gradle等,请注意包名及import... 查看详情

aop之注解处理器apt在android中的finderview实际详解(代码片段)

一前言     android中现今流行的各大框架,比如ButterFly、eventBus、OrmLite、Retrofit等都使用注解,注解是什么呢?注解就是元数据,可以理解为属性、方法、类等的一个说明,具体详解可百度,也可移步我... 查看详情

注解处理器(apt)是什么?(代码片段)

...解,这篇咱们科普一下注解的其中一种用途——注解处理器(APT),文章会手把手的帮助大家学会APT的使用,并使用简单的例子来进行练习。一、定义注解处理器(AnnotationProcessingTool,简称APT)ÿ... 查看详情

04注解处理器(apt)是什么?——《android打怪升级之旅》(代码片段)

...解,这篇咱们科普一下注解的其中一种用途——注解处理器(APT),文章会手把手的帮助大家学会APT的使用。一、定义注解处理器(AnnotationProcessingTool,简称APT),是JDK提供的工具,用于在编译... 查看详情

asm(代码片段)

...?分别解释下这几个名词APT:APT(AnnotationProcessingTool)即注解处理器,是一种处理注解的工具,确切的说它是javac的一个工具,它用来在编译时扫描和处理注解。注解处理器以Java代码(或者编译过的字节码)作为输入,生成.java文件作... 查看详情

anroidapt(代码片段)

 前言APT:AnnotationProcessorTool(注解处理器)什么时注解处理器注解处理器是(AnnotationProcessor)是Javac的一个工具,其作用在编译期间,用来处理加了注解的代码,其会扫描编译其的源码获得加了特定注解的目标代码;注解处... 查看详情

anroidapt(代码片段)

 前言APT:AnnotationProcessorTool(注解处理器)什么时注解处理器注解处理器是(AnnotationProcessor)是Javac的一个工具,其作用在编译期间,用来处理加了注解的代码,其会扫描编译其的源码获得加了特定注解的目标代码;注解处... 查看详情

android编译时注解处理apt(代码片段)

一、注解在使用Java语言开发的过程中,我们会经常看到各种各样的注解,@Override(表示方法的重写),@Deprecated(标记过时的元素方法,类或属性),@LayoutRes(表示的是布局资源),@IdRes(表示的是ID资源),@Drawa... 查看详情

android编译时注解处理apt(代码片段)

一、注解在使用Java语言开发的过程中,我们会经常看到各种各样的注解,@Override(表示方法的重写),@Deprecated(标记过时的元素方法,类或属性),@LayoutRes(表示的是布局资源),@IdRes(表示的是ID资源),@Drawa... 查看详情

注解深入浅出(二apt)

...ool,它是javac的一个工具,中文意思为编译时注解处理器。APT可以用来在编译时扫描和处理注解。通过APT可以获取到注解和被注解对象的相关信息,在拿到这些信息后我们可以根据需求来自动的生成一些代码,省... 查看详情

android编译时注解处理apt(代码片段)

一、注解在使用Java语言开发的过程中,我们会经常看到各种各样的注解,@Override(表示方法的重写),@Deprecated(标记过时的元素方法,类或属性),@LayoutRes(表示的是布局资源),@IdRes(表示的是ID资源),@Drawa... 查看详情

android编译时注解处理apt(代码片段)

一、注解在使用Java语言开发的过程中,我们会经常看到各种各样的注解,@Override(表示方法的重写),@Deprecated(标记过时的元素方法,类或属性),@LayoutRes(表示的是布局资源),@IdRes(表示的是ID资源),@Drawa... 查看详情

框架手写系列---apt方式实现arouter框架(代码片段)

...原理,十分简单:用注解标识各个页面,注解处理器将该注 查看详情

java编程基础:注解(annotationprocessingtool)注解处理器利用注解解读类属性生成xml文件

...生成额外的源文件和其他的文件(文件的具体内容由注解处理器的编写者决定),APT还会编译生成的源代码文件和原来的源文件,将它们一起生成class文件。Hibernate自动生成X 查看详情

javajavajsr269简介(代码片段)

...下游阶段继续处理,直至生成最终的class文件。实现注解处理器的第一步是继承AbstractProcessor类,实现它的process方法,如下面的代码清单8-1所示。SupportedAnnotationTypes 查看详情

java中的全局异常处理(代码片段)

...理全局异常处理SpringBoot的全局异常处理@ControllerAdvice注解全局异常处理ErrorController接口和@ControllerAdvice注解比较:相同点:两者都是Spring项目中的全局异常处理方式不同点:捕获异常位置不同:ErrorController接口捕获全局所有的异... 查看详情

java中的全局异常处理(代码片段)

...理全局异常处理SpringBoot的全局异常处理@ControllerAdvice注解全局异常处理ErrorController接口和@ControllerAdvice注解比较:相同点:两者都是Spring项目中的全局异常处理方式不同点:捕获异常位置不同:ErrorController接口捕获全局所有的异... 查看详情