自动注入AutoInject:一个通用的代码注入(自动注册)基础库

韩瑶
• 阅读 2616

在组件化的过程中,业务被划分到各自独立的模块,可能会面临以下几点问题:

  1. 各业务模块生成的一些索引类需要注册至对应的组件中,比如EventBus索引类的注册,Router索引类的注册。另外,如果各业务模块对外提供的api接口的话,也需要注册api接口。
  2. 需要为散落在各个模块中的一些组件提供初始化的时机,有些组件需要在主线程中初始化,有些组件为不阻塞主线程需要在非主线程中初始化。

通常的处理方式是在主模块硬编码来完成这些事情。那如何不通过在主模块硬编码来完成这些事情?

解决思路

首先,我将问题分解为以下几个小问题:

问题1:

  • 各业务模块如何对外提供对象?

    业务模块各自新建一个类A,实现定义好的接口IAutoArrow<T>,通过在接口get方法中返回对象。

  • 组件怎么获取对象,并进行注册等相关操作?

    为组件新建一个类B,实现定义好的接口IAutoBow<T>,通过在接口shoot方法中获取入参对象T,并进行注册等相关操作。

  • 在什么时候/位置做这件事情?

    预先定义一个空方法并在适当时机调用这个空方法。在打包apk时,通过Gradle Transform + ASM,找到类A、类B以及空方法,在空方法内注入一下格式的代码:

    A a = new A()
    B b = new B()
    b.shoot(a.get())
    

问题2:

  • 如何为各业务模块提供初始化时机?

    业务模块各自新建一个类A,实现定义好的接口IAutoBowArrow,通过在接口shoot方法中做初始化事情。

  • 在什么时候/位置做这件事情?

    预先定义一个空方法并在适当时机调用这个空方法。在打包apk时,通过Gradle Transform + ASM,找到类A和空方法,在空方法内注入一下格式的代码:

    A a = new A()
    a.shoot()
    

设计模型

自动注入AutoInject:一个通用的代码注入(自动注册)基础库

利用弓把对应型号的箭射向耙子。

箭:对应一种型号

弓:适配对应型号的箭,射向唯一的耙子。

耙子:名称唯一

Usage

在根项目的build.gradle中添加插件依赖:

buildscript {
    ... 
    dependencies {
        ...
        classpath 'com.eastwood.tools.plugins:auto-inject:1.0.0'
    }
    
}

继续在模块build.gradle中添加注解库依赖:

dependencies {
    ...
    implementation 'com.eastwood.common:auto-inject:1.0.0'
     
}

@AutoArrow

新建一个类,并实现IAutoArrow接口,在get方法中返回对象。例如:

@AutoArrow(model = "eventBusIndex")
public class ModuleBAutoArrow implements IAutoArrow<SubscriberInfoIndex> {
 
    @Override
    public SubscriberInfoIndex get() {
        return new ModuleBEventBusIndex();
    }
 
}

@AutoBow

新建一个类,并实现IAutoBow接口,在shoot方法中获取对象并执行相关动作。例如:

@AutoBow(target = "addIndex2EventBus", model = "eventBusIndex", context = true)
public class EventBusAutoBow implements IAutoBow<SubscriberInfoIndex> {
 
    private App app;
 
    EventBusAutoBow(Application application) {
        app = (App) application;
    }
 
    @Override
    public void shoot(SubscriberInfoIndex index) {
        app.eventBusBuilder.addIndex(index);
    }
 
}

@AutoTarget

预先定义一个空方法并调用,在方法上标记@AutoTarget,例如:

public class App extends Application {
 
    public EventBusBuilder eventBusBuilder;
 
    @Override
    public void onCreate() {
        super.onCreate();
 
        eventBusBuilder = EventBus.builder();
        // add config to eventBusBuilder
        addIndex2EventBus();
        eventBusBuilder.build();

    }
 
    @AutoTarget
    void addIndex2EventBus() {}

}

@AutoBowArrow

新建一个类,并实现IAutoBowArrow接口,在shoot方法中执行相关动作。

@AutoBowArrow(target = "init")
public class InitAutoBowArrow implements IAutoBowArrow {

    @Override
    public void shoot() {
        // ...
    }

}

将被注入的代码样式

打包成apk后,@AutoTarget对应的方法将会被注入具有固定结构的代码,例如:

@AutoTarget
void addIndex2EventBus() {
    ModuleBAutoArrow moduleBAutoArrow = new ModuleBAutoArrow();
    EventBusAutoBow eventBusAutoBow = new EventBusAutoBow(this);
    eventBusAutoBow.shoot(moduleBAutoArrow.get());
}
 
@AutoTarget
void init() {
    InitAutoBowArrow initAutoBowArrow = new InitAutoBowArrow();
    initAutoBowArrow.shoot();
}

结语

本文并没有详细深入解释Gradle Transform + ASM如何查找到类和方法并注入,源码已上传至github,希望大家自行研究。
github地址:https://github.com/EastWoodYang/AutoInject

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
Jacquelyn38 Jacquelyn38
4年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
国庆假期玩不停双重好礼放肆领
自2021年10月1日00:00起至2021年10月7日24:00,新注册并激活(需全部完成账号注册的五个步骤,否则账号状态并未激活)AWS海外区域账户,填写页面下方表单,即可申领价值$200美元的AWS海外区域账户服务抵扣券直充到您的账户,用以抵扣服务消费,助您轻松体验多个云迁移应用场景。同时,您还可获赠AWS精美祥云纪念T恤一件。,仅限7天AW
AWS国庆双重礼,仅限7天
自2021年10月1日00:00起至2021年10月7日24:00,新注册并激活(需全部完成账号注册的五个步骤,否则账号状态并未激活)AWS海外区域账户,填写页面下方表单,即可申领价值$200美元的AWS海外区域账户服务抵扣券直充到您的账户,用以抵扣服务消费,助您轻松体验多个云迁移应用场景。同时,您还可获赠AWS精美祥云纪念T恤一件。,仅限7天$20
AWS国庆双重礼,仅限7天
自2021年10月1日00:00起至2021年10月7日24:00,新注册并激活(需全部完成账号注册的五个步骤,否则账号状态并未激活)AWS海外区域账户,填写页面下方表单,即可申领价值$200美元的AWS海外区域账户服务抵扣券直充到您的账户,用以抵扣服务消费,助您轻松体验多个云迁移应用场景。同时,您还可获赠AWS精美祥云纪念T恤一件。,仅限7天$20
Stella981 Stella981
3年前
Python之time模块的时间戳、时间字符串格式化与转换
Python处理时间和时间戳的内置模块就有time,和datetime两个,本文先说time模块。关于时间戳的几个概念时间戳,根据1970年1月1日00:00:00开始按秒计算的偏移量。时间元组(struct_time),包含9个元素。 time.struct_time(tm_y
Easter79 Easter79
3年前
Twitter的分布式自增ID算法snowflake (Java版)
概述分布式系统中,有一些需要使用全局唯一ID的场景,这种时候为了防止ID冲突可以使用36位的UUID,但是UUID有一些缺点,首先他相对比较长,另外UUID一般是无序的。有些时候我们希望能使用一种简单一些的ID,并且希望ID能够按照时间有序生成。而twitter的snowflake解决了这种需求,最初Twitter把存储系统从MySQL迁移
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
1年前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这
美凌格栋栋酱 美凌格栋栋酱
4个月前
Oracle 分组与拼接字符串同时使用
SELECTT.,ROWNUMIDFROM(SELECTT.EMPLID,T.NAME,T.BU,T.REALDEPART,T.FORMATDATE,SUM(T.S0)S0,MAX(UPDATETIME)CREATETIME,LISTAGG(TOCHAR(