一个快速生成R2.java中fields的插件

项目地址:https://github.com/JeasonWong/R2Assistant

介绍

在子 module 中使用 ButterKnife 时,如果想使用 ButterKnife 提供的编译期注解,那么就得使用 ButterKnife 的 gradle 插件所生成的R2.java,比如 @BindView( R2.id.xxx ),关于更多 R.java 与 R2.java 的资料可以看我这篇文章 R.java、R2.java是时候懂了

当我们在子 module 中新增资源 id 时使用 R2.id.xxx 会报红,报红的原因是 R2.java 是依赖 R.java 生成的,必须重新 build project 生成全新的 R2.java,但这样耗时太久了,大点的工程基本需要四五分钟,报红又使强迫症实在看不下去,那么 R2Assistant 就是来解决这个问题的,使用这个插件可以快速生成 R2.java 中还不存在的 fileds,从而提高工作效率。

演示

r2assistant.gif

使用

在主工程的 build.gradle 中添加插件

apply plugin: 'me.wangyuwei.r2assistant'

buildscript {
    repositories {
        maven {
            url 'https://dl.bintray.com/wangyuwei/maven'
        }
    }
    dependencies {
        classpath 'me.wangyuwei:r2assistant-plugin:1.0.0'
    }
}

运行命令

如果你想对所有的子 module 生效,执行 ./gradlew sweepR2

如果你只想对指定的子 module 生效,执行 ./gradlew sweepR2 -PmoduleName=${subModuleName}

原理

原理其实很简单,基本利用正则表达式。

1、写出 @BindView( R2.id.xxx ) 的正则 R2\.id\.([\w]*

2、遍历 /src/main/java 下的所有 java 文件,并找出所有匹配 1 中正则的资源名:

File srcDir = new File(subProject.projectDir.path.toString() + "/src/main/java")
srcDir.eachFileRecurse(FileType.FILES) { File file ->
    if (file.toString().endsWith(".java")) {
        String fileContent = new String(file.bytes)

        Pattern p = Pattern.compile(FIELD_SRC_ID_REGEX)
        Matcher m = p.matcher(fileContent)
        while (m.find()) {
            srcFieldsSet.add(m.group(1))
        }
    }
}

3、写出子 module 对应的R2.java 中 id 的正则 ,如 @IdRes public static final int action_bar = 0x7f0a004f;,对应的正则是:@IdRes[\s]*public static final int ([\w]*) = *[\w]*;

4、找出子 module 对应的R2.java 中 符合 2 中正则的资源名:

File r2File = new File(subProject.buildDir.path.toString() + "/generated/source/r/debug/" + packageName.replaceAll("\\.", "/") + "/R2.java")

String r2Content = new String(r2File.bytes)

Pattern p = Pattern.compile(FIELD_R2_REGEX)
Matcher m = p.matcher(r2Content)
while (m.find()) {
    r2FieldsSet.add(m.group(1))
}

5、找出 /src/main/java 下的新增资源:

srcFieldsSet.each {
    if (!r2FieldsSet.contains(it)) {
        R2Log.log("add filed: ${it}")
        generateFieldsSet.add(it)
    }
}

6、在 R2.java 中生成新的 filed ,新增 filed 的值可以随便撸,反正运行时用不着:


def STR_CLASS_ID = '''public static final class id {'''

int index = r2Content.indexOf(STR_CLASS_ID)
StringBuilder sb = new StringBuilder()
sb.append(r2Content.substring(0, index + STR_CLASS_ID.length()))

generateFieldsSet.each {
    sb.append("\n\t@IdRes\n\tpublic static final int ${it} = 0x7f888888;\n")
}

sb.append(r2Content.substring(index + STR_CLASS_ID.length(), r2Content.length()))

r2File.delete()
r2File.withWriter(StandardCharsets.UTF_8.name()) { writer ->
    writer.write(sb.toString())
}

7、简单吧。

尾语

实现这个功能其实有很多方案,我的这种并不是最好的,我目前想的一个不错的方案是监听 xml 里的变化,如果有新增资源 id ,而这个 id 在 R2.java 中又不存在,那么自动添加这个 field,而不用现在这样执行一个task,感兴趣的同学可以做做。

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

推荐阅读更多精彩内容