ClassPlaceholder外掛：動態修改jar包class檔案

南山伐木發表於2018-09-06
JAR

背景：

在開發，一些在jar包或底層庫封裝的一些常量引數有時需要根據環境的切換而改變，如在jar中的使用的baseUrl，一般都是通過向外暴露一個set()方法，由外部注入。但若在底層庫在多個模組引用，又不能避免其他模組對引數的修改時，特別是在大專案若一些管理混亂的專案中，就會出現多個地方set不同的值，不能保證引數set()入口的唯一性。這時便可以考慮不向外暴露set()方法。並將原引數定義為 private static final ，這樣外面就不能隨便修改該引數值。但我們如何去動態修改該引數呢？

google了一圈，沒有找到合適的工具。索性自己寫一個gradle的外掛，利用class檔案編輯利器ASM和Android提供的Transform動態修改jar包中的class檔案。即可實現上述動態修改私有的靜態常量。另外還提供了對Java原始碼的字串替換方法。

github地址：ClassPlaceholder

外掛建立參考這篇：

使用：

  1. 引入外掛
buildscript {
    repositories {
       maven { url 'https://plugins.gradle.org/m2/' }
    }
    dependencies {
       classpath 'gradle.plugin.me.xp.gradle:placeholder:1.0.1'
    }
}
複製程式碼
  1. 在要替換的類中使用佔位符預埋好要替換要常量，如：
public static final String TEST_PUBLIC = "${public}";
private static final String TEST_PRIVATE = "${private}";
複製程式碼

3.在主專案的build.gradle檔案中新增placeholder外掛，定義在替換的值及檔名，如：

 apply plugin: 'me.xp.gradle.placeholder.PlaceholderPlugin'

    placeholders {
        addholder {
            //is modify source java file
            isModifyJava = true
            //modify file name
            classFile = "me/xp/gradle/classplaceholder/AppConfig.java"
            //replace name and value
            values = ['public' : 'AppConfigPubic',
                      'private': 'AppConfigPrivate',
                      'field'  : 'AppConfigField']
        }
        addholder {
            isModifyJava = false
            classFile = "me/xp/gradle/jarlibrary/JarConfig.class"
            values = ['config': 'JarConfigPubic']
        }
    }
複製程式碼
  1. 新增後，若修改替換值，需要先執行clean命令，再build即可在jar包展開的class檔案中看到替換後的值。

相關文章