Blade - 基本使用

  之前学习很多的框架,我个人觉得学习框架的目的主要两点:

  1. 理解框架的原理,在实际开发中,才会得心应手,游刃有余。
  2. 学习框架的设计思想和技术亮点。我觉得这才是学习框架的最终目的,只有学到了东西,才算是对自己有提升。

  今天,我写这篇文章主要是为了介绍我的第一个框架--BladeBlade其实不是非常厉害的框架,就是基于APT技术开发的依赖注入框架,简称DI框架。

1. 概述

  其实,熟悉Java开发的同学应该都知道,Google有一个非常著名的依赖注入框架--Dagger,那我为什么还要自己开发一个依赖注入的框架呢?俗话说,重复造轮子是对轮子最大的不尊重。
  当然我也不是吃饱了撑的没事干(其实仔细想一想,还是有那么一点),这里面是有一定的原因。最近,楼主做自己的毕业设计,想在自己的毕业设计中加上依赖注入的框架,使得写的代码更加简洁。介于这个原因,我去学习了Google爸爸的Dagger框架。在学习过程中,我发现Dagger的一个设计,就是它提供对象都是通过方法来实现的,这个与我的想法有点相悖(有可能还有其他方式可以实现,但是我不知道)。由于这个原因,我就狠下心,打算自己来写一个,自己想要什么都可以自己来实现,然后入坑了。。。
  在这框架开发过程中,我借鉴了Dagger的部分思想。其实,我们可以从框架命名可以看出来,Dagger的中文意思是匕首,而Blade是剑的意思,看上去也是非常相似,以表示我对Dagger的尊重。
  接下来,我将简单介绍一下Blade(其实就是将github的ReadMe拷贝过来)。

2. gradle 导入方式

(1). 项目的build.gradle

allprojects {
    repositories {
        // ······
        maven { url 'https://jitpack.io' }
    }
}

(2). app的build.gradle

dependencies {
    // ······
    implementation 'com.github.BeauteousJade.blade:inject:latest version'
    annotationProcessor 'com.github.BeauteousJade.blade:processor:latest version'
}

3. 基本结构

  在整个DI框架,有两个注解,分别是Inject, Provides,先来解释这三个注解所表示的意思。

注解 含义 使用范围
Inject 如果一个变量需要注入,那么该变量会被标记Inject,表示注入的目标 比如上面的B类对象,必须标记Inject。该注解默认带一个String参数(可以不填), 表示以此String字符串为id从注入源取得注入对象;不填表示默认以该对象的ClassName为id。因此,在同一个Module下,不能同时有两个相同类型的变量的Inject注解不填id。
Provides 如果一个变量需要被注入,该变量会标记Provides注解。需要被注入的变量必须放在一个Context(Object类型,也就是任意类型)里面;反之,如果一个类里面有一个变量标记了Provides注解,表示该类可以作为一个Context Provides默认带一个String参数,表示注入的id,跟Inject的参数相对应。

  如果使用注解成功的标记我们想要被注入和注入的变量,我们可以在通过调用Bladeinject(Object target, Object source)方法进行注入操作的最后一步,也只有经过这一步,想要注入的变量才会成功赋值。如下是Blade的代码:

public class Blade {

    public static void inject(Object target, Object source) {
        inject(target, source, null);
    }

    private static void inject(Object target, Map<String, ?> extraMap) {
        inject(target, new EmptyProviderImpl(), extraMap);
    }

    public static void inject(Object target, Object source, Map<String, ?> extraMap) {
        try {
            Object targetObject = Class.forName(target.getClass().getName() + "_Inject").newInstance();
            Provider sourceObject = (Provider) Class.forName(source.getClass().getName() + "ProviderImpl")
                    .getConstructor(source.getClass(), Map.class)
                    .newInstance(source, extraMap);
            targetObject.getClass()
                    .getMethod("inject", target.getClass(), Provider.class)
                    .invoke(targetObject, target, sourceObject);
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InstantiationException e) {
            e.printStackTrace();
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        }
    }
}

  这也是本框架唯一通过反射方式来实现的地方。

  在编译器时期,APT会扫面每个被Module标记的类,然后对应着会生成一个Java类,上面代码的作用就是调用生成的Java类的inject方法进行赋值。下面是一个Demo代码:

public class MainActivity_Inject {
  public void inject(MainActivity target, Provider source) {
    target.strings = (java.lang.String[])(source.find("strings"));
    target.demoDemoString = (java.lang.String)(source.find("demoDemoString"));
    target.pby = (java.lang.String)(source.find("pby"));
    target.string1 = (java.lang.String)(source.find("demo3String"));
    target.strings1 = (java.lang.String[])(source.find("java.lang.String[]"));
    target.code = (int)(source.find("int"));
  }
}

4. 基本使用

  首先我们有一个类的有一些变量注入,比如MainActivity

public class MainActivity extends AppCompatActivity {

    @Inject
    String string;
    @Inject
    int a;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        Blade.inject(this, new Context());
    }
    // ······
}

  这里需要注意的是:

  1. 注入的变量需要标记Inject

  然后我们定义一个Context对象:

public class MainActivity extends AppCompatActivity {

    // ······
    public static class Context {
        @Provides
        String string = "string";
        @Provides
        int a = 1;
    }
}

  这里需要注意的是:

  1. 作为数据源的变量需要标记Provides

  最后在调用Bladeinject方法。

        Blade.inject(this, new Context());

  整个注入过程就完成了。

5. github地址

   github:blade

6. 参考框架

  1. dagger
  2. butterKnife
  3. AptPreferences
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,657评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,889评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,057评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,509评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,562评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,443评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,251评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,129评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,561评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,779评论 3 335
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,902评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,621评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,220评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,838评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,971评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,025评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,843评论 2 354

推荐阅读更多精彩内容