【注解】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。

相关文章

AI一键生成 PPT

AI一键生成 PPT

AI一键生成 PPT 操作步骤 作为一名打工人，是不是经常需要制作各种PPT来分享我的生活和想法。但是，你们知道，有时候灵感来了，时间却不够用了！😩直到我发现了Kimi AI——一个能够自动生成PPT的神奇助手！🌟 什么是Kimi？ 一款月之暗面科技有限公司开发的AI办公工具，帮助用户快速生成高质量的演示文稿。 无论你是职场人士、学生还是教师，Kimi都能够为你的办公文
阅读更多...
活用c4d官方开发文档查询代码

活用c4d官方开发文档查询代码

当你问AI助手比如豆包，如何用python禁止掉xpresso标签时候，它会提示到 这时候要用到两个东西。https://developers.maxon.net/论坛搜索和开发文档 比如这里我就在官方找到正确的id描述 然后我就把参数标签换过来
阅读更多...
pdfmake生成pdf的使用

pdfmake生成pdf的使用

实际项目中有时会有根据填写的表单数据或者其他格式的数据，将数据自动填充到pdf文件中根据固定模板生成pdf文件的需求 文章目录 利用pdfmake生成pdf文件1.下载安装pdfmake第三方包2.封装生成pdf文件的共用配置3.生成pdf文件的文件模板内容4.调用方法生成pdf 利用pdfmake生成pdf文件 1.下载安装pdfmake第三方包 npm i pdfma
阅读更多...
poj 1258 Agri-Net（最小生成树模板代码）

poj 1258 Agri-Net（最小生成树模板代码）

感觉用这题来当模板更适合。 题意就是给你邻接矩阵求最小生成树啦。~ prim代码：效率很高。172k...0ms。 #include<stdio.h>#include<algorithm>using namespace std;const int MaxN = 101;const int INF = 0x3f3f3f3f;int g[MaxN][MaxN];int n
阅读更多...
poj 1287 Networking（prim or kruscal最小生成树）

poj 1287 Networking（prim or kruscal最小生成树）

题意给你点与点间距离，求最小生成树。 注意点是，两点之间可能有不同的路，输入的时候选择最小的，和之前有道最短路WA的题目类似。 prim代码： #include<stdio.h>const int MaxN = 51;const int INF = 0x3f3f3f3f;int g[MaxN][MaxN];int P;int prim(){bool vis[MaxN];
阅读更多...
poj 2349 Arctic Network uva 10369（prim or kruscal最小生成树）

poj 2349 Arctic Network uva 10369（prim or kruscal最小生成树）

题目很麻烦，因为不熟悉最小生成树的算法调试了好久。 感觉网上的题目解释都没说得很清楚，不适合新手。自己写一个。 题意：给你点的坐标，然后两点间可以有两种方式来通信：第一种是卫星通信，第二种是无线电通信。 卫星通信：任何两个有卫星频道的点间都可以直接建立连接，与点间的距离无关； 无线电通信：两个点之间的距离不能超过D，无线电收发器的功率越大，D越大，越昂贵。 计算无线电收发器D
阅读更多...
hdu 1102 uva 10397（最小生成树prim）

hdu 1102 uva 10397（最小生成树prim）

hdu 1102: 题意： 给一个邻接矩阵，给一些村庄间已经修的路，问最小生成树。 解析： 把已经修的路的权值改为0，套个prim（）。 注意prim 最外层循坏为n-1。 代码： #include <iostream>#include <cstdio>#include <cstdlib>#include <algorithm>#include <cstri
阅读更多...
【生成模型系列（初级）】嵌入（Embedding）方程——自然语言处理的数学灵魂【通俗理解】

【生成模型系列（初级）】嵌入（Embedding）方程——自然语言处理的数学灵魂【通俗理解】

【通俗理解】嵌入（Embedding）方程——自然语言处理的数学灵魂 关键词提炼 #嵌入方程 #自然语言处理 #词向量 #机器学习 #神经网络 #向量空间模型 #Siri #Google翻译 #AlexNet 第一节：嵌入方程的类比与核心概念【尽可能通俗】 嵌入方程可以被看作是自然语言处理中的“翻译机”，它将文本中的单词或短语转换成计算机能够理解的数学形式，即向量。 正如翻译机将一种语言
阅读更多...
poj 3723 kruscal，反边取最大生成树。

poj 3723 kruscal，反边取最大生成树。

题意： 需要征募女兵N人，男兵M人。 每征募一个人需要花费10000美元，但是如果已经招募的人中有一些关系亲密的人，那么可以少花一些钱。 给出若干的男女之间的1~9999之间的亲密关系度，征募某个人的费用是10000 - （已经征募的人中和自己的亲密度的最大值）。 要求通过适当的招募顺序使得征募所有人的费用最小。 解析： 先设想无向图，在征募某个人a时，如果使用了a和b之间的关系
阅读更多...
计算机毕业设计 大学志愿填报系统 Java+SpringBoot+Vue 前后端分离 文档报告 代码讲解 安装调试

计算机毕业设计 大学志愿填报系统 Java+SpringBoot+Vue 前后端分离 文档报告 代码讲解 安装调试

🍊作者：计算机编程-吉哥 🍊简介：专业从事JavaWeb程序开发，微信小程序开发，定制化项目、 源码、代码讲解、文档撰写、ppt制作。做自己喜欢的事，生活就是快乐的。 🍊心愿：点赞 👍 收藏 ⭐评论 📝 🍅 文末获取源码联系 👇🏻 精彩专栏推荐订阅 👇🏻 不然下次找不到哟~Java毕业设计项目~热门选题推荐《1000套》 目录 1.技术选型 2.开发工具 3.功能
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2