Android APT 实现控件注入框架SqInject-六虎

作者

大家好，我叫小鑫，也能够叫我蜡笔小鑫；

自己17年结业于中山大学，于2018年7月参加37手游安卓团队，曾经上任于久邦数码担任安卓开发工程师；

现在是37手游安卓团队的海外负责人，负责相关业务开发；一起兼顾一些基础建设相关工作。

布景

在游戏发行中，常常需求切包，假如直接运用R.id.xxx，在回编译时，因为resources.arsc会从头编译，R类中的id值和resources.arsc中的对应联系会反常，导致程序反常。咱们有两种解决方法。

一种是在切包过程中纠正R类的值，完成计划详细介绍能够检查

游戏发行切包资源索引冲突解决计划,链接如下：

/post/693605…

另一种解决计划则是运用getIdentifier获取资源ID，抛弃运用R类，这种方法中，编码较为麻烦，并且getIdentifier中需求写的是字符串，容易写错，并且编译过程中是发现不了的。根据这种情况，咱们开发了根据getIdentifier的控件注入结构

一、APT技能简介

1、APT定义

APT(Annotation Processing Tool)即注解处理器，是一种处理注解的工具，确切的说它是javac的一个工具，它用来在编译时扫描和处理注解。注解处理器以Java代码作为输入，生成.java文件作为输出

2、注解定义

1、注解是一种能被添加到java代码中的元数据，类、方法、变量、参数和包都能够用注解润饰。

2、注解对于它所润饰的代码没有直接的影响

3、APT原理简介

Annotation processing是在编译阶段履行的，它的原理便是读入Java源代码，解析注解，然后生成新的Java代码。新生成的Java代码最后被编译成Java字节码，注解解析器（Annotation Processor）不能改变读入的Java 类，比如不能参加或删去Java方法

二、APT实战运用

1、SqInject结构来源

在手游发行中，常常需求切包，将游戏接完SDK1的包，通过反编译，替换smali文件及其他资源文件的方法，替换为途径SDK2的途径包。在这个反编译回编译的过程中，资源索引ID（即R类和resources.arsc中的ID映射联系）会发生冲突导致程序反常，即不做特别处理的话，途径SDK及发行SDK是不能直接运用R类的，要运用getIdentifier获取资源ID

要求在程序中运用getIdentifier，在开发过程中是比较麻烦的事情。在这样的条件下，咱们也无法运用如butterknife这样的结构。因此，咱们模仿butterknife开发了一套根据getIdentifier的控件注入结构SqInject。下面介绍SqInject的完成，先来看下简单运用哈

public class MainActivity extends AppCompatActivity {
    //绑定ID
    @BindView(SqR.id.tv)
    TextView hello;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        SqInject.bind(this);
        Log.e("SqInject", hello.getText().toString());
    }
    //绑定点击事件
    @OnClick(SqR.id.tv)
    public void click(View view) {
        Intent intent = new Intent(MainActivity.this, TestActivity.class);
        startActivity(intent);
    }
}

2、SqInject的完成原理

2.1、注解处理器模块完成

上文说到APT常用于生成代码，在SqInject中APT注解处理环节中，流程如下图所示：

在编译过程中扫描注解，生成Java代码，然后再次编译

在SqInject代码中，完成如下：

@AutoService(Processor.class)
@SupportedSourceVersion(SourceVersion.RELEASE_7)
public class SqInjectProcessor extends AbstractProcessor {
    ...
    //中心方法
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        //控件类注解解析,ResChecker检查资源id合法性，合规律生成"类名+$ViewBinder类,否则编译失败
        BindViewBuilder bindViewBuilder = new BindViewBuilder(roundEnvironment, mResChecker, mElementUtils, mTypeUtils, mFiler, mMessager);
        bindViewBuilder.build();
        //id类注解解析，ResChecker检查资源id合法性，合规律生成"类名+$IdBinder类",否则编译失败
        BindIdsBuilder bindIdsBuilder = new BindIdsBuilder(roundEnvironment, mResChecker, mElementUtils, mTypeUtils, mFiler, mMessager);
        bindIdsBuilder.build();
        return false;
    }
}

在生成控件注入相关代码之前，结构中会先检测资源id的合法性，本结构中在运用注解时，传入的是字符串。可资源名称是有可能不存在对应资源的，结构会做相应的检测

2.2、资源检测

Android编译资源过程中，会生成R类，也便是说只要在R类中存在的，用getIdentifier才能够获取到，那么咱们能够用R类来检测传入的参数是否合理，代码如下：

/**
     * 检测资源id在R文件中是否存在
     * @param name
     * @param type
     * @return
     */
    public boolean isIdValid(String name, String type) {
        String RClassName = mPackageNeme + ".R." + type;
        TypeElement RClassType = mElementUtils.getTypeElement(RClassName);
        if (RClassType == null) {
            mMessager.printMessage(Diagnostic.Kind.ERROR, RClassName + "不存在，请检查是否包名有误，或者类型错误");
        } else {
            //遍历属性
            for (Element element : RClassType.getEnclosedElements()) {
                String fieldName = element.getSimpleName().toString();
                if (name.equals(fieldName)) {
                    return true;
                }
            }
        }
        return false;
    }

2.3、解析注解，生成代码

以解析BindView为例，代码如下：

/**
     * 解析BindView注解
     * @return
     */
    private Map<TypeElement, List<VariableElement>> parseBindView(){
        Set<Element> elements = (Set<Element>) mRoundEnvironment.getElementsAnnotatedWith(BindView.class);
        if (!Utils.isEmpty(elements)) {
            Map<TypeElement, List<VariableElement>> map = new HashMap<>();
            for (Element element : elements) {
                if (element instanceof VariableElement) {
                    //获取该属性所在类
                    TypeElement targetElement = (TypeElement) element.getEnclosingElement();
                    mTargetSet.add(targetElement);
                    if (map.get(targetElement) == null) {
                        List<VariableElement> targetStringLists = new ArrayList<>();
                        targetStringLists.add((VariableElement) element);
                        map.put(targetElement, targetStringLists);
                    } else {
                        map.get(targetElement).add((VariableElement) element);
                    }
                }
            }
            return map;
        }
        return null;
    }

解析完BindView注解后，运用javapoet生成代码,篇幅有限，下面仅列出获取参数和生成代码的一小部分

if (mBindViewIdTargetMap != null && mBindViewIdTargetMap.get(targetElement) != null) {
                List<VariableElement> viewElements = mBindViewIdTargetMap.get(targetElement);
                //方法体
                for (VariableElement viewElement : viewElements) {
                    //获取属性名
                    String fieldName = viewElement.getSimpleName().toString();
                    //获取类型
                    TypeMirror typeMirror = viewElement.asType();
                    TypeElement fieldClassElement = (TypeElement) mTypeUtils.asElement(typeMirror);
                    mMessager.printMessage(Diagnostic.Kind.NOTE, "注解的字段类型为: " + fieldClassElement.getQualifiedName().toString());
                    TypeElement fieldType = mElementUtils.getTypeElement(fieldClassElement.getQualifiedName());
                    ClassName fieldClassName = ClassName.get(fieldType);
                    //获取@BindView注解的值,即名称
                    String name = viewElement.getAnnotation(BindView.class).value();
                    //检测名称是否合法
                    if(!mResChecker.isIdValid(name, "id")){
                        mMessager.printMessage(Diagnostic.Kind.ERROR, "R文件中不存在id为" + name + "的值");
                    }
                    methodBuilder.addStatement("target.$N = $T.findRequiredViewAsType(source, $S, $S, $T.class)", fieldName, JptConstants.UTILS, name, "field " + fieldName,fieldClassName);
                }
            }

小小总结一下，在注解处理器中，最重要的两个环节，一个是解析注解，获取参数，然后是利用javapoet结构生成代码

下面看下生成的代码

public class MainActivity$ViewBinder implements ViewBinder<MainActivity> {
  @Override
  public void bindView(final MainActivity target, final View source) {
    //这儿便是上面的代码生成的
    target.hello = ViewUtils.findRequiredViewAsType(source, "tv", "field hello", TextView.class);
    IdUtils.findViewByName("tv", source).setOnClickListener(new DebouncingOnClickListener() {
      public void doClick(View v) {
        target.click(v);
      }
    } );
  }
}

到这儿，就介绍完了运用APT生成代码了哈。本文中说到的结构SqInject是咱们日常工作中会运用到的SqInject结构，该结构以开源，地址是： github.com/37sy/SqInje… 有爱好的欢迎star哈

一起，在结构中，还有另一个很重要的环节，R类对应的SqR类，SqR类中记录的是项目中的资源对应的字符串名称，该模块是通过自定义gradle插件完成的，有爱好可检查 /post/687784…

结束语

过程中有问题或者需求沟通的同学，能够扫描二维码加好友，然后进群进行问题和技能的沟通等；

Android APT 实现控件注入框架SqInject

作者

布景

一、APT技能简介

1、APT定义

2、注解定义

3、APT原理简介

二、APT实战运用

1、SqInject结构来源

2、SqInject的完成原理

2.1、注解处理器模块完成

2.2、资源检测

2.3、解析注解，生成代码

结束语

相关文章

Go1.21 那些事：泛型库、for 语义变更、统一 log/slog、WASI 等新特性，你知道多少？

BabaSSL：支持半同态加密算法 EC-ElGamal

一文教会你mock（Mockito和PowerMock双剑合璧）

为什么有人说 vite 快，有人却说 vite 慢？

作者信息