【注解】annotationProcessor自动生成代码

2024-09-03 14:58
文章标签 代码 生成 自动 注解 annotationprocessor

本文主要是介绍【注解】annotationProcessor自动生成代码，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

使用annotationProcessor根据注解自动生成代码。本文先不讲原理，只讲实现过程。尝试了一下在模块化中使用注解自动生成代码，但是会报错：Attribute value must be constant。这是因为在library模块中使用该注解（即使用BindView绑定id）
image.png
而library构建时产生的R文件在壳模块app中，如下图所示：
image.png
所以在library中使用注解绑定id，该id就不是常量类型，因此会报错，目前不知道该如何解决，希望有大佬指点一二。

1 创建项目

  • 项目结构
    项目结构

annotation：注解类的java-library
app：主工程
compiler：主要用于根据注解类来生成对应代码的java-library

  • 创建annotation的java-library

image.png

BindView.java

package com.example.annotation;import androidx.annotation.IdRes;import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Target(ElementType.FIELD)
@Retention(RetentionPolicy.SOURCE)
public @interface BindView {@IdRes int value();
}

OnClick.java

package com.example.annotation;import androidx.annotation.IdRes;import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;/*** Created by yds* on 2020/3/6.*/
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.METHOD)
public @interface OnClick {@IdRes int value();
}

Keep.java

package com.example.annotation;import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;/*** Created by yds* on 2020/3/6.*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface Keep {
}

BindingSuffix.java

package com.example.annotation;
/*** Created by yds* on 2020/3/6.*/
public class BindingSuffix {public static final String GENERATED_CLASS_SUFFIX = "$Binding";private BindingSuffix() {}
}

build.gradle

apply plugin: 'java-library'dependencies {implementation fileTree(dir: 'libs', include: ['*.jar'])implementation 'androidx.annotation:annotation:1.1.0'}sourceCompatibility = "1.8"
targetCompatibility = "1.8"
  • 创建compiler库
    compiler也是java-library类型的module

MyProcessor.java

package com.example.compiler;import com.example.annotation.BindView;
import com.example.annotation.Keep;
import com.example.annotation.OnClick;
import com.google.auto.service.AutoService;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.TypeSpec;import java.io.IOException;
import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.Filer;
import javax.annotation.processing.Messager;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.VariableElement;
import javax.lang.model.util.ElementFilter;
import javax.lang.model.util.Elements;
import javax.tools.Diagnostic;@AutoService(Processor.class)
public class MyProcessor extends AbstractProcessor {private Filer filer;private Messager messager;private Elements elementUtils;//每个存在注解的类整理出来，key:package_classname value:被注解的类型元素private Map<String, List<Element>> annotationClassMap = new HashMap<>();@Overridepublic synchronized void init(ProcessingEnvironment processingEnv) {super.init(processingEnv);filer = processingEnv.getFiler();messager = processingEnv.getMessager();elementUtils = processingEnv.getElementUtils();}@Overridepublic boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {if (!roundEnv.processingOver()) {buildAnnotatedElement(roundEnv, BindView.class);buildAnnotatedElement(roundEnv, OnClick.class);}else {for (Map.Entry<String, List<Element>> entry : annotationClassMap.entrySet()) {String packageName = entry.getKey().split("_")[0];String typeName = entry.getKey().split("_")[1];ClassName className = ClassName.get(packageName, typeName);ClassName generatedClassName = ClassName.get(packageName, NameStore.getGeneratedClassName(typeName));/*创建要生成的类，如下所示@Keeppublic class MainActivity$Binding {}*/TypeSpec.Builder classBuilder = TypeSpec.classBuilder(generatedClassName).addModifiers(Modifier.PUBLIC).addAnnotation(Keep.class);/*添加构造函数*   public MainActivity$Binding(MainActivity activity) {bindViews(activity);bindOnClicks(activity);}*/classBuilder.addMethod(MethodSpec.constructorBuilder().addModifiers(Modifier.PUBLIC).addParameter(className, NameStore.Variable.ANDROID_ACTIVITY).addStatement("$N($N)",NameStore.Method.BIND_VIEWS,NameStore.Variable.ANDROID_ACTIVITY).addStatement("$N($N)",NameStore.Method.BIND_ON_CLICKS,NameStore.Variable.ANDROID_ACTIVITY).build());/*创建方法bindViews(MainActivity activity)* private void bindViews(MainActivity activity) {}*/MethodSpec.Builder bindViewsMethodBuilder = MethodSpec.methodBuilder(NameStore.Method.BIND_VIEWS).addModifiers(Modifier.PRIVATE).returns(void.class).addParameter(className, NameStore.Variable.ANDROID_ACTIVITY);/*增加方法体* activity.tvHello = (TextView)activity.findViewById(2131165326);* */for (VariableElement variableElement : ElementFilter.fieldsIn(entry.getValue())) {BindView bindView = variableElement.getAnnotation(BindView.class);if (bindView != null) {bindViewsMethodBuilder.addStatement("$N.$N = ($T)$N.findViewById($L)",NameStore.Variable.ANDROID_ACTIVITY,variableElement.getSimpleName(),variableElement,NameStore.Variable.ANDROID_ACTIVITY,bindView.value());}}//将构建出来的方法添加到类里面classBuilder.addMethod(bindViewsMethodBuilder.build());/*以下构建如下代码*   private void bindOnClicks(final MainActivity activity) {activity.findViewById(2131165218).setOnClickListener(new View.OnClickListener() {public void onClick(View view) {activity.onHelloBtnClick(view);}});}*/ClassName androidOnClickListenerClassName = ClassName.get(NameStore.Package.ANDROID_VIEW,NameStore.Class.ANDROID_VIEW,NameStore.Class.ANDROID_VIEW_ON_CLICK_LISTENER);ClassName androidViewClassName = ClassName.get(NameStore.Package.ANDROID_VIEW,NameStore.Class.ANDROID_VIEW);MethodSpec.Builder bindOnClicksMethodBuilder = MethodSpec.methodBuilder(NameStore.Method.BIND_ON_CLICKS).addModifiers(Modifier.PRIVATE).returns(void.class).addParameter(className, NameStore.Variable.ANDROID_ACTIVITY, Modifier.FINAL);for (ExecutableElement executableElement : ElementFilter.methodsIn(entry.getValue())) {OnClick onClick = executableElement.getAnnotation(OnClick.class);if (onClick != null) {TypeSpec onClickListenerClass = TypeSpec.anonymousClassBuilder("").addSuperinterface(androidOnClickListenerClassName).addMethod(MethodSpec.methodBuilder(NameStore.Method.ANDROID_VIEW_ON_CLICK).addModifiers(Modifier.PUBLIC).addParameter(androidViewClassName, NameStore.Variable.ANDROID_VIEW).addStatement("$N.$N($N)",NameStore.Variable.ANDROID_ACTIVITY,executableElement.getSimpleName(),NameStore.Variable.ANDROID_VIEW).returns(void.class).build()).build();bindOnClicksMethodBuilder.addStatement("$N.findViewById($L).setOnClickListener($L)",NameStore.Variable.ANDROID_ACTIVITY,onClick.value(),onClickListenerClass);}}classBuilder.addMethod(bindOnClicksMethodBuilder.build());//将类写入文件中try {JavaFile.builder(packageName,classBuilder.build()).build().writeTo(filer);} catch (IOException e) {messager.printMessage(Diagnostic.Kind.ERROR, e.toString());}}}return true;}@Overridepublic Set<String> getSupportedAnnotationTypes() {return new TreeSet<>(Arrays.asList(BindView.class.getCanonicalName(),OnClick.class.getCanonicalName(),Keep.class.getCanonicalName()));}@Overridepublic SourceVersion getSupportedSourceVersion() {return SourceVersion.latestSupported();}private void buildAnnotatedElement(RoundEnvironment roundEnv, Class<? extends Annotation> clazz) {for (Element element : roundEnv.getElementsAnnotatedWith(clazz)) {String className = getFullClassName(element);List<Element> cacheElements = annotationClassMap.get(className);if (cacheElements == null) {cacheElements = new ArrayList<>();annotationClassMap.put(className, cacheElements);}cacheElements.add(element);}}private String getFullClassName(Element element) {TypeElement typeElement = (TypeElement) element.getEnclosingElement();String packageName = elementUtils.getPackageOf(typeElement).getQualifiedName().toString();return packageName + "_" + typeElement.getSimpleName().toString();}
}

这里的类上面一定要加上@AutoService(Processor.class)，如果不加上，你必须在main目录下面创建一个resources/META-INF/services/javax.annotation.processing.Processor，并在该文件里加入你所编写的Processor类，如下图所示：
image.png
否则，将不会自动生成类。

NameStore.java

package com.example.compiler;import com.example.annotation.BindingSuffix;/*** Created by yds* on 2020/3/5.*/
public final class NameStore {private NameStore(){}public static String getGeneratedClassName(String clsName){return clsName+ BindingSuffix.GENERATED_CLASS_SUFFIX;}public static class Package{public static final String ANDROID_VIEW = "android.view";}public static class Class {// Androidpublic static final String ANDROID_VIEW = "View";public static final String ANDROID_VIEW_ON_CLICK_LISTENER = "OnClickListener";}public static class Variable{public static final String ANDROID_ACTIVITY = "activity";public static final String ANDROID_VIEW = "view";}public static class Method{public static final String ANDROID_VIEW_ON_CLICK = "onClick";// Binderpublic static final String BIND_VIEWS = "bindViews";public static final String BIND_ON_CLICKS = "bindOnClicks";public static final String BIND = "bind";}
}

build.gradle

apply plugin: 'java-library'dependencies {implementation fileTree(dir: 'libs', include: ['*.jar'])implementation 'com.squareup:javapoet:1.11.1'implementation project(path:':annotation')implementation 'com.google.auto.service:auto-service:1.0-rc5'annotationProcessor 'com.google.auto.service:auto-service:1.0-rc5'
}sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
  • app中类的编写
    Binding.java
package com.example.binder;import android.app.Activity;import com.example.annotation.BindingSuffix;import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;/*** Created by yds* on 2020/3/6.*/
public class Binding {private Binding(){}private static <T extends Activity> void instantiateBinder(T target, String suffix){Class<?> targetClass=target.getClass();String className=targetClass.getName();try {Class<?>bindingClass =targetClass.getClassLoader().loadClass(className+suffix);Constructor<?> classConstructor=bindingClass.getConstructor(targetClass);try {classConstructor.newInstance(target);} catch (IllegalAccessException e) {throw new RuntimeException("Unable to invoke " + classConstructor, e);} catch (InstantiationException e) {throw new RuntimeException("Unable to invoke " + classConstructor, e);} catch (InvocationTargetException e) {Throwable cause = e.getCause();if (cause instanceof RuntimeException) {throw (RuntimeException) cause;}if (cause instanceof Error) {throw (Error) cause;}throw new RuntimeException("Unable to create instance.", cause);}} catch (ClassNotFoundException e) {throw new RuntimeException("Unable to find Class for " + className + suffix, e);} catch (NoSuchMethodException e) {throw new RuntimeException("Unable to find constructor for " + className + suffix, e);}}public static <T extends Activity> void bind(T activity) {instantiateBinder(activity, BindingSuffix.GENERATED_CLASS_SUFFIX);}
}

MainActivity.java

package com.example.annotationdemo6;import androidx.appcompat.app.AppCompatActivity;import android.content.Intent;
import android.os.Bundle;
import android.view.View;
import android.widget.TextView;import com.example.annotation.BindView;
import com.example.annotation.OnClick;
import com.example.binder.Binding;public class MainActivity extends AppCompatActivity {@BindView(R.id.tv)TextView mTextView;@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);Binding.bind(this);mTextView.setText("Hello world");}@OnClick(R.id.btn)void clickByBtn(View v){Intent intent = new Intent();intent.setClass(MainActivity.this,JumpActivity.class);startActivity(intent);}
}

build.gradle

apply plugin: 'com.android.application'android {compileSdkVersion 29buildToolsVersion "29.0.0"defaultConfig {applicationId "com.example.annotationdemo6"minSdkVersion 21targetSdkVersion 29versionCode 1versionName "1.0"testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"}buildTypes {release {minifyEnabled falseproguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'}}
}dependencies {implementation fileTree(dir: 'libs', include: ['*.jar'])implementation project(':annotation')annotationProcessor project(':compiler')implementation 'androidx.appcompat:appcompat:1.1.0'implementation 'androidx.constraintlayout:constraintlayout:1.1.3'testImplementation 'junit:junit:4.12'androidTestImplementation 'androidx.test:runner:1.2.0'androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
}

源码：https://github.com/Yedongsheng/AnnotationDemo2

这篇关于【注解】annotationProcessor自动生成代码的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1133286。

相关文章

Redis实现高效内存管理的示例代码

Redis实现高效内存管理的示例代码

《Redis实现高效内存管理的示例代码》Redis内存管理是其核心功能之一,为了高效地利用内存,Redis采用了多种技术和策略,如优化的数据结构、内存分配策略、内存回收、数据压缩等,下面就来详细的介绍... 目录1. 内存分配策略jemalloc 的使用2. 数据压缩和编码ziplist示例代码3. 优化的
阅读更多...
Python 基于http.server模块实现简单http服务的代码举例

Python 基于http.server模块实现简单http服务的代码举例

《Python基于http.server模块实现简单http服务的代码举例》Pythonhttp.server模块通过继承BaseHTTPRequestHandler处理HTTP请求,使用Threa... 目录测试环境代码实现相关介绍模块简介类及相关函数简介参考链接测试环境win11专业版python
阅读更多...
Python从Word文档中提取图片并生成PPT的操作代码

Python从Word文档中提取图片并生成PPT的操作代码

《Python从Word文档中提取图片并生成PPT的操作代码》在日常办公场景中,我们经常需要从Word文档中提取图片,并将这些图片整理到PowerPoint幻灯片中,手动完成这一任务既耗时又容易出错,... 目录引言背景与需求解决方案概述代码解析代码核心逻辑说明总结引言在日常办公场景中，我们经常需要从 W
阅读更多...
使用Spring Cache本地缓存示例代码

使用Spring Cache本地缓存示例代码

《使用SpringCache本地缓存示例代码》缓存是提高应用程序性能的重要手段,通过将频繁访问的数据存储在内存中,可以减少数据库访问次数,从而加速数据读取,：本文主要介绍使用SpringCac... 目录一、Spring Cache简介核心特点：二、基础配置1. 添加依赖2. 启用缓存3. 缓存配置方案方案
阅读更多...
基于Redis自动过期的流处理暂停机制

基于Redis自动过期的流处理暂停机制

《基于Redis自动过期的流处理暂停机制》基于Redis自动过期的流处理暂停机制是一种高效、可靠且易于实现的解决方案,防止延时过大的数据影响实时处理自动恢复处理,以避免积压的数据影响实时性,下面就来详... 目录核心思路代码实现1. 初始化Redis连接和键前缀2. 接收数据时检查暂停状态3. 检测到延时过
阅读更多...
Java利用@SneakyThrows注解提升异常处理效率详解

Java利用@SneakyThrows注解提升异常处理效率详解

《Java利用@SneakyThrows注解提升异常处理效率详解》这篇文章将深度剖析@SneakyThrows的原理,用法,适用场景以及隐藏的陷阱,看看它如何让Java异常处理效率飙升50%,感兴趣的... 目录前言一、检查型异常的“诅咒”：为什么Java开发者讨厌它1.1 检查型异常的痛点1.2 为什么说
阅读更多...
MySQL的配置文件详解及实例代码

MySQL的配置文件详解及实例代码

《MySQL的配置文件详解及实例代码》MySQL的配置文件是服务器运行的重要组成部分,用于设置服务器操作的各种参数,下面：本文主要介绍MySQL配置文件的相关资料,文中通过代码介绍的非常详细,需要... 目录前言一、配置文件结构1.[mysqld]2.[client]3.[mysql]4.[mysqldum
阅读更多...
Python多线程实现大文件快速下载的代码实现

Python多线程实现大文件快速下载的代码实现

《Python多线程实现大文件快速下载的代码实现》在互联网时代,文件下载是日常操作之一,尤其是大文件,然而,网络条件不稳定或带宽有限时,下载速度会变得很慢,本文将介绍如何使用Python实现多线程下载... 目录引言一、多线程下载原理二、python实现多线程下载代码说明：三、实战案例四、注意事项五、总结引
阅读更多...
C#使用Spire.XLS快速生成多表格Excel文件

C#使用Spire.XLS快速生成多表格Excel文件

《C#使用Spire.XLS快速生成多表格Excel文件》在日常开发中,我们经常需要将业务数据导出为结构清晰的Excel文件,本文将手把手教你使用Spire.XLS这个强大的.NET组件,只需几行C#... 目录一、Spire.XLS核心优势清单1.1 性能碾压：从3秒到0.5秒的质变1.2 批量操作的优雅
阅读更多...
IDEA与MyEclipse代码量统计方式

IDEA与MyEclipse代码量统计方式

《IDEA与MyEclipse代码量统计方式》文章介绍在项目中不安装第三方工具统计代码行数的方法,分别说明MyEclipse通过正则搜索（排除空行和注释）及IDEA使用Statistic插件或调整搜索... 目录项目场景MyEclipse代码量统计IDEA代码量统计总结项目场景在项目中，有时候我们需要统计
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2