fragmentargs 源码解析

简介

fragmentargs可以用来处理Fragment属性的保存(Fragment.setArguments(Bundle bundle))和自动赋值(Fragment.getArguments())逻辑,以在编译时自动生成源代码的方式来减少一些重复代码的编写,可以查看这篇博文了解一下

流程图

简单的流程图


无标题绘图.jpg

编译时注解

由于运行时注解用到了反射技术,在性能方面会有影响,而编译时注解是在编译期生成源代码的方式,性能会好一些

如何Debug

在Android Studio中想在工程编译时进行Debug会比较麻烦一些,要做一些配置,具体的可以查看这篇博文,下面简要介绍下(小坑还挺多)
1、配置~/.gradle/gradle.properties

org.gradle.daemon=true
org.gradle.jvmargs=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005

然后启动gradle daemon(mac平台)

./gradlew --daemon

2、在AS中配置remote debugger,其实是新建一个Run/Debug Configuration(remote类型)。我们每次创建一个Android Project的时候AS都会默认创建一个Run/Debug Configuration(Android Application类型),名字叫做app,这个大家都挺眼熟的:)
Run/Debug Configuration信息基本上不用做任何更改,只要确保端口号跟上一个步骤的一致就行

0A350BEB-24B8-429F-AEA5-949D255F9F08.png

3、在自定义的annotation processor设置断点,启动remote debugger,在命令行中运行./gradlew clean assembleDebug

763A27C5-8F67-4B72-9977-DE680630ECBA.png

fragmentargs annotation processor分析

fragmentargs库中的annotation processor主要生成两种类型的java源代码,首先会生成被注解过的Frament的FragmentBuilder.java文件(会有多个),然后会生成FragmentArgsInjector.java文件(仅一个)

MyFragmentBuilder.java

package com.tubb.argknife;

import android.os.Bundle;
public final class MyFragmentBuilder {
  private final Bundle mArguments = new Bundle();

  public MyFragmentBuilder(int dis) {
    mArguments.putInt("dis", dis);
  }
  public static MainActivity.MyFragment newMyFragment(int dis) {
    return new MyFragmentBuilder(dis).build();
  }
  public static final void injectArguments(MainActivity.MyFragment fragment) {
    Bundle args = fragment.getArguments();
    if (args == null) {
      throw new IllegalStateException("No arguments set");
    }
    if (!args.containsKey("dis")) {
      throw new IllegalStateException("required argument dis is not set");
    }
    fragment.dis = args.getInt("dis");
  }
  public MainActivity.MyFragment build() {
    com.tubb.argknife.MainActivity.MyFragment fragment = new com.tubb.argknife.MainActivity.MyFragment();
    fragment.setArguments(mArguments);
    return fragment;
  }
  public <F extends MainActivity.MyFragment> F build(F fragment) {
    fragment.setArguments(mArguments);
    return fragment;
  }
}

AutoFragmentArgInjector.java

package com.hannesdorfmann.fragmentargs;

import android.os.Bundle;
public final class AutoFragmentArgInjector
    implements com.tubb.argknife.annotation.FragmentArgsInjector {

  public void inject(Object target) {

    Class<?> targetClass = target.getClass();
    String targetName = targetClass.getSimpleName();

    if ( com.tubb.argknife.OuterFragment.class.getSimpleName().equals(targetName) ) {
      com.tubb.argknife.OuterFragmentBuilder.injectArguments( ( com.tubb.argknife.OuterFragment ) target);
      return;
    }

    if ( com.tubb.argknife.MainActivity.MyFragment.class.getSimpleName().equals(targetName) ) {
      com.tubb.argknife.MyFragmentBuilder.injectArguments( ( com.tubb.argknife.MainActivity.MyFragment ) target);
      return;
    }
  }
}

fragmentargs使用squareup的javawriter来生成java源文件的,只需要配置下就行

compile 'com.squareup:javawriter:2.2.1'

但我自己在实践的过程中遇到一个很奇怪的问题,明明javawriter代码已经导入了,但就是引用不了,后来参考作者的做法把JavaWriter类拷贝到本地repackage了一下,问题解决

具体代码的生成过程挺繁琐和抽象的,首先会去得到注解的类(Fragment)和注解的属性(Fragment中的属性)的Element信息,然后根据这些Elements来动态生成类和类中的方法和属性,具体的源码大家可以看下我剥离出来的代码

fragmentargs的调用过程

fragmentargs通过annotation processor在工程编译完成后生成很多的FragmentBuilder.java源文件和一个AutoFragmentArgInjector。java源文件,当然最终也会编译成相应的class文件
fragmentargs的使用非常简单README,那它内部是如何工作的呢
通过FragmentArgs.inject(this)的调用,会进入到FragmentArgs类中的injectFromBundle(Object target)方法

package com.hannesdorfmann.fragmentargs;

/**
 * The root class to inject arguments to a fragment
 *
 * @author Hannes Dorfmann
 */
public class FragmentArgs {

  public static final String AUTO_MAPPING_CLASS_NAME = "AutoFragmentArgInjector";
  public static final String AUTO_MAPPING_PACKAGE = "com.hannesdorfmann.fragmentargs";
  public static final String AUTO_MAPPING_QUALIFIED_CLASS =
      AUTO_MAPPING_PACKAGE + "." + AUTO_MAPPING_CLASS_NAME;

  private static FragmentArgsInjector autoMappingInjector;

  public static void inject(Object fragment) {
    injectFromBundle(fragment);
  }

  static void injectFromBundle(Object target) {

    if (autoMappingInjector == null) {
      // Load the automapping class
      try {
        Class<?> c = Class.forName(AUTO_MAPPING_QUALIFIED_CLASS);
        autoMappingInjector = (FragmentArgsInjector) c.newInstance();
      } catch (Exception e) {
        // Since 2.0.0 we don't throw an exception because of android library support.
        // Instead we print this exception as warning message

        /*
        Exception wrapped = new Exception("Could not load the generated automapping class. "
            + "However, that may be ok, if you use FragmentArgs in library projects", e);
        wrapped.printStackTrace();
        */
      }
    }

    if (autoMappingInjector != null) {
      autoMappingInjector.inject(target);
    }
  }
}

通过源码我们可以发现,会去反射(注意是static,性能上基本上不会有影响)实例化一个实现了FragmentArgsInjector接口的类的实例,其实就是我们之前介绍的AutoFragmentArgInjector,然后调用AutoFragmentArgInjectorAutoFragmentArgInjector.inject(target)方法,我们可以来看看这个方法中具体做了些啥

  public void inject(Object target) {

    Class<?> targetClass = target.getClass();
    String targetName = targetClass.getSimpleName();

    if ( com.tubb.argknife.OuterFragment.class.getSimpleName().equals(targetName) ) {
      com.tubb.argknife.OuterFragmentBuilder.injectArguments( ( com.tubb.argknife.OuterFragment ) target);
      return;
    }

    if ( com.tubb.argknife.MainActivity.MyFragment.class.getSimpleName().equals(targetName) ) {
      com.tubb.argknife.MyFragmentBuilder.injectArguments( ( com.tubb.argknife.MainActivity.MyFragment ) target);
      return;
    }
  }

看到这些代码是不是突然明悟了:) 在这个方法中把FragmentBuilder和我们自己的Fragment联系起来了,其实就是通过Fragment.getArguments()来为我们的属性赋值,也就是Auto Inject

    public static final void injectArguments(MyFragment fragment) {
        Bundle args = fragment.getArguments();
        if(args == null) {
            throw new IllegalStateException("No arguments set");
        } else if(!args.containsKey("dis")) {
            throw new IllegalStateException("required argument dis is not set");
        } else {
            fragment.dis = args.getInt("dis");
        }
    }

Note

在自己使用fragmentargs的过程中遇到一个比较坑的东西,发现当Fragment为内部类时不能正常工作,自己测试用的代码尝试修复了这个问题,也给作者提了一个issuse,估计作者下个版本会进行修复的

还有一点,ArgKnife并不能用在工作项目中,只是测试代码😄

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

推荐阅读更多精彩内容