2024年Android 如何编写基于编译时注解的项目，零基础学习android编程

最新推荐文章于 2025-11-13 15:01:28 发布

原创最新推荐文章于 2025-11-13 15:01:28 发布 · 827 阅读

26 ·

CC 4.0 BY-SA版权

文章标签：

#android #学习

程序员专栏收录该内容

440 篇文章

订阅专栏

最后

感觉现在好多人都在说什么安卓快凉了，工作越来越难找了。又是说什么程序员中年危机啥的，为啥我这年近30的老农根本没有这种感觉，反倒觉得那些贩卖焦虑的都是瞎j8扯谈。当然，职业危机意识确实是要有的，但根本没到那种草木皆兵的地步好吗？

Android凉了都是弱者的借口和说辞。虽然 Android 没有前几年火热了，已经过去了会四大组件就能找到高薪职位的时代了。这只能说明 Android 中级以下的岗位饱和了，现在高级工程师还是比较缺少的，很多高级职位给的薪资真的特别高（钱多也不一定能找到合适的），所以努力让自己成为高级工程师才是最重要的。

所以，最后这里放上我耗时两个月，将自己8年Android开发的知识笔记整理成的Android开发者必知必会系统学习资料笔记，上述知识点在笔记中都有详细的解读，里面还包含了腾讯、字节跳动、阿里、百度2019-2021面试真题解析，并且把每个技术点整理成了视频和PDF（知识脉络 + 诸多细节）。

以上全套学习笔记面试宝典，吃透一半保你可以吊打面试官，只有自己真正强大了，有核心竞争力，你才有拒绝offer的权力，所以，奋斗吧！骚年们！千里之行，始于足下。种下一颗树最好的时间是十年前，其次，就是现在。

最后，赠与大家一句诗，共勉！

不驰于空想，不骛于虚声。不忘初心，方得始终。

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化学习资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

（2）process的实现

process中的实现，相比较会比较复杂一点，一般你可以认为两个大步骤：

收集信息
生成代理类（本文把编译时生成的类叫代理类）

什么叫收集信息呢？就是根据你的注解声明，拿到对应的Element，然后获取到我们所需要的信息，这个信息肯定是为了后面生成JavaFileObject所准备的。

例如本例，我们会针对每一个类生成一个代理类，例如MainActivity我们会生成一个MainActivity$$ViewInjector。那么如果多个类中声明了注解，就对应了多个类，这里就需要：

一个类对象，代表具体某个类的代理类生成的全部信息，本例中为ProxyInfo
一个集合，存放上述类对象（到时候遍历生成代理类），本例中为Map<String, ProxyInfo>，key为类的全路径。

这里的描述有点模糊没关系，一会结合代码就好理解了。

a.收集信息

private Map<String, ProxyInfo> mProxyMap = new HashMap<String, ProxyInfo>();

@Override

public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv){

mProxyMap.clear();

Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(BindView.class);

//一、收集信息

for (Element element : elements){

//检查element类型

if (!checkAnnotationUseValid(element)){

return false;

}

//field type

VariableElement variableElement = (VariableElement) element;

//class type

TypeElement typeElement = (TypeElement) variableElement.getEnclosingElement();//TypeElement

String qualifiedName = typeElement.getQualifiedName().toString();

ProxyInfo proxyInfo = mProxyMap.get(qualifiedName);

if (proxyInfo == null){

proxyInfo = new ProxyInfo(mElementUtils, typeElement);

mProxyMap.put(qualifiedName, proxyInfo);

}

BindView annotation = variableElement.getAnnotation(BindView.class);

int id = annotation.value();

proxyInfo.mInjectElements.put(id, variableElement);

}

return true;

}

首先我们调用一下mProxyMap.clear();，因为process可能会多次调用，避免生成重复的代理类，避免生成类的类名已存在异常。

然后，通过roundEnv.getElementsAnnotatedWith拿到我们通过@BindView注解的元素，这里返回值，按照我们的预期应该是VariableElement集合，因为我们用于成员变量上。

接下来for循环我们的元素，首先检查类型是否是VariableElement.

然后拿到对应的类信息TypeElement，继而生成ProxyInfo对象，这里通过一个mProxyMap进行检查，key为qualifiedName即类的全路径，如果没有生成才会去生成一个新的，ProxyInfo与类是一一对应的。

接下来，会将与该类对应的且被@BindView声明的VariableElement加入到ProxyInfo中去，key为我们声明时填写的id，即View的id。

这样就完成了信息的收集，收集完成信息后，应该就可以去生成代理类了。

b.生成代理类

@Override

public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv){

//…省略收集信息的代码，以及try,catch相关

for(String key : mProxyMap.keySet()){

ProxyInfo proxyInfo = mProxyMap.get(key);

JavaFileObject sourceFile = mFileUtils.createSourceFile(

proxyInfo.getProxyClassFullName(), proxyInfo.getTypeElement());

Writer writer = sourceFile.openWriter();

writer.write(proxyInfo.generateJavaCode());

writer.flush();

writer.close();

}

return true;

}

可以看到生成代理类的代码非常的简短，主要就是遍历我们的mProxyMap，然后取得每一个ProxyInfo，最后通过mFileUtils.createSourceFile来创建文件对象，类名为proxyInfo.getProxyClassFullName()，写入的内容为proxyInfo.generateJavaCode().

看来生成Java代码的方法都在ProxyInfo里面。

c.生成Java代码

这里我们主要关注其生成Java代码的方式。

下面主要看生成Java代码的方法：

#ProxyInfo

//key为id，value为对应的成员变量

public Map<Integer, VariableElement> mInjectElements = new HashMap<Integer, VariableElement>();

public String generateJavaCode(){

StringBuilder builder = new StringBuilder();

builder.append(“package " + mPackageName).append(”;\n\n");

builder.append(“import com.zhy.ioc.*;\n”);

builder.append("public class “).append(mProxyClassName).append(” implements " + SUFFIX + “<” + mTypeElement.getQualifiedName() + “>”);

builder.append(“\n{\n”);

generateMethod(builder);

builder.append(“\n}\n”);

return builder.toString();

}

private void generateMethod(StringBuilder builder){

builder.append(“public void inject(”+mTypeElement.getQualifiedName()+" host , Object object )");

builder.append(“\n{\n”);

for(int id : mInjectElements.keySet()){

VariableElement variableElement = mInjectElements.get(id);

String name = variableElement.getSimpleName().toString();

String type = variableElement.asType().toString() ;

builder.append(" if(object instanceof android.app.Activity)");

builder.append(“\n{\n”);

builder.append(“host.”+name).append(" = ");

builder.append(“(”+type+“)(((android.app.Activity)object).findViewById(”+id+“));”);

builder.append(“\n}\n”).append(“else”).append(“\n{\n”);

builder.append(“host.”+name).append(" = ");

builder.append(“(”+type+“)(((android.view.View)object).findViewById(”+id+“));”);

builder.append(“\n}\n”);

}

builder.append(“\n}\n”);

}

这里主要就是靠收集到的信息，拼接完成的代理类对象了，看起来会比较头疼，不过我给出一个生成后的代码，对比着看会很多。

package com.zhy.ioc_sample;

import com.zhy.ioc.*;

public class MainActivity$$ViewInjector implements ViewInjector<com.zhy.ioc_sample.MainActivity>{

@Override

public void inject(com.zhy.sample.MainActivity host , Object object ){

if(object instanceof android.app.Activity){

host.mTv = (android.widget.TextView)(((android.app.Activity)object).findViewById(2131492945));

}

else{

host.mTv = (android.widget.TextView)(((android.view.View)object).findViewById(2131492945));

}

这样对着上面代码看会好很多，其实就死根据收集到的成员变量（通过@BindView声明的），然后根据我们具体要实现的需求去生成java代码。

这里注意下，生成的代码实现了一个接口ViewInjector<T>，该接口是为了统一所有的代理类对象的类型，到时候我们需要强转代理类对象为该接口类型，调用其方法；接口是泛型，主要就是传入实际类对象，例如MainActivity，因为我们在生成代理类中的代码，实际上就是实际类.成员变量的方式进行访问，所以，使用编译时注解的成员变量一般都不允许private修饰符修饰（有的允许，但是需要提供getter,setter访问方法）。

这里采用了完全拼接的方式编写Java代码，你也可以使用一些开源库，来通过Java api的方式来生成代码，例如：

javapoet.

A Java API for generating .java source files.

到这里我们就完成了代理类的生成，这里任何的注解处理器的编写方式基本都遵循着收集信息、生成代理类的步骤。

五、API模块的实现

有了代理类之后，我们一般还会提供API供用户去访问，例如本例的访问入口是

//Activity中

Ioc.inject(Activity);

//Fragment中，获取ViewHolder中

Ioc.inject(this, view);

模仿了butterknife，第一个参数为宿主对象，第二个参数为实际调用findViewById的对象；当然在Actiivty中，两个参数就一样了。

API一般如何编写呢？

其实很简单，只要你了解了其原理，这个API就干两件事：

根据传入的host寻找我们生成的代理类：例如MainActivity->MainActity$$ViewInjector。
强转为统一的接口，调用接口提供的方法。

这两件事应该不复杂，第一件事是拼接代理类名，然后反射生成对象，第二件事强转调用。

public class Ioc{

public static void inject(Activity activity){

inject(activity , activity);

}

public static void inject(Object host , Object root){

Class<?> clazz = host.getClass();

String proxyClassFullName = clazz.getName()+“$$ViewInjector”;

//省略try,catch相关代码

Class<?> proxyClazz = Class.forName(proxyClassFullName);

ViewInjector viewInjector = (com.zhy.ioc.ViewInjector) proxyClazz.newInstance();

viewInjector.inject(host,root);

}

public interface ViewInjector{

void inject(T t , Object object);

}

代码很简单，拼接代理类的全路径，然后通过newInstance生成实例，然后强转，调用代理类的inject方法。

这里一般情况会对生成的代理类做一下缓存处理，比如使用Map存储下，没有再生成，这里我们就不去做了。

这样我们就完成了一个编译时注解框架的编写。

六、总结

本文通过具体的实例来描述了如何编写一个基于编译时注解的项目，主要步骤为：项目结构的划分、注解模块的实现、注解处理器的编写以及对外公布的API模块的编写。通过文本的学习应该能够了解基于编译时注解这类框架运行的原理，以及自己如何去编写这样一类框架。

*源码地址: https://github.com/hymanAndroid/ioc-apt-sample

欢迎关注我的微博：

http://weibo.com/u/3165018720

最后

光有这些思路和搞懂单个知识的应用是还远远不够的，在Android开源框架设计思想中的知识点还是比较多的，想要搞懂还得学会整理和规划：我们常见的**Android热修复框架、插件化框架、组件化框架、图片加载框架、网络访问框架、RxJava响应式编程框架、IOC依赖注入框架、最近架构组件Jetpack等等Android第三方开源框架，**这些都是属于Android开源框架设计思想的。如下图所示：

这位阿里P8大佬针对以上知识点，熬夜整理出了一本长达1042页的完整版如何解读开源框架设计思想PDF文档，内容详细，把Android热修复框架、插件化框架、组件化框架、图片加载框架、网络访问框架、RxJava响应式编程框架、IOC依赖注入框架、最近架构组件Jetpack等等Android第三方开源框架这些知识点从源码分析到实战应用都讲的简单明了。