Environment Switcher

Environment Switcher 是一個(gè)在 Android 的開發(fā)和測(cè)試階段颁虐，用來一鍵切換環(huán)境的工具。

最新版本及使用方法：https://codexiaomai.github.io/2019/07/29/EnvironmentSwitcher
。

項(xiàng)目成就

[圖片上傳失敗...(image-2a48c3-1544534998176)]
[圖片上傳失敗...(image-86fea6-1544534998176)]
[圖片上傳失敗...(image-e37521-1544534998176)]

為什么要做這個(gè)工具

做這個(gè)工具是為了方便開發(fā)和測(cè)試人員在不重新打包的情況下快速切換環(huán)境。

相信大家都遇到過下面的某些場(chǎng)景。

• App 在開發(fā)撑柔、測(cè)試、上線等階段需要頻繁切換環(huán)境您访。
• 同一個(gè)App中的不同模塊铅忿，在同一階段需要配置不同的環(huán)境。
• 某些功能只能在指定環(huán)境下使用灵汪。
• 正在測(cè)試環(huán)境開發(fā)【課程評(píng)價(jià)】模塊檀训，這個(gè)模塊要通過點(diǎn)擊“首頁(yè)->我的課程->課程詳情->課程評(píng)價(jià)”進(jìn)入柑潦，但是這時(shí)測(cè)試環(huán)境的【首頁(yè)】掛了，導(dǎo)致后面的頁(yè)面都無(wú)法進(jìn)入肢扯，于是@Server端的同事修復(fù)妒茬，要一直等他們改好了，才能進(jìn)入目標(biāo)頁(yè)面進(jìn)行調(diào)試蔚晨。
• 由于環(huán)境地址乍钻，在代碼中寫死，導(dǎo)致每次修改環(huán)境之后代碼管理工具都會(huì)提示這行代碼有改動(dòng)铭腕，一旦疏忽就提交了银择，這對(duì)于代碼管理是不嚴(yán)謹(jǐn)?shù)摹?/li>

Environment Switcher 應(yīng)運(yùn)而生

Environment Switcher 就是為了解決以上問題而設(shè)計(jì)的，它具有以下幾個(gè)特點(diǎn)：

• 只需簡(jiǎn)單幾步配置即可使用
• 安全累舷，測(cè)試環(huán)境地址不泄漏
• 一鍵切換環(huán)境浩考，使用方便
• 支持按模塊配置與切換環(huán)境
• 支持環(huán)境切換通知回調(diào)
• 自動(dòng)生成 切換 保存 獲取 環(huán)境的邏輯代碼
• 與項(xiàng)目解偶
• ......

為什么不用 Gradle

看到這里你心里可能會(huì)想，這些功能我用 Gradle 就能搞定了被盈，干嘛這么麻煩析孽？別著急，下面我們來比較一下 Environment Switcher 和 Gradle只怎。

這里就先列舉這么多袜瞬，僅 運(yùn)行時(shí)切換環(huán)境 、打包數(shù)量身堡、切換環(huán)境回調(diào) 這幾個(gè)特點(diǎn)就比 Gradle 方便很多邓尤，而且 Environment Switcher 的接入成本也很低。是不是想試一試了贴谎？

使用方法

1. 添加 Environment Switcher 依賴

   具體依賴方式請(qǐng)查看 https://github.com/CodeXiaoMai/EnvironmentSwitcher

2. 編寫 EnvironmentConfig 文件

   這個(gè)類是 Environment Switcher 依賴的核心代碼汞扎，所有獲取、修改環(huán)境的邏輯代碼都會(huì)依賴這個(gè)類中被 @Module 和 @Environment 兩個(gè)注解標(biāo)記的類和屬性自動(dòng)生成擅这。

   /**
    * 環(huán)境配置類</br>
    *
    *  建議不要引用該類中的任何子類和成員變量?澈魄，一但引用了非正式環(huán)境的屬性，打包時(shí)混淆工具就不會(huì)移除該類仲翎，導(dǎo)致測(cè)試地址泄漏痹扇。</br>
    * 而 Environment Switcher 在編譯 Release 版本時(shí)，會(huì)自動(dòng)隱藏測(cè)試環(huán)境地址谭确。</br></br>
    *
    * 建議將該類中所有被 {@link Module} 和 {@link Environment} 修飾的類或成員變量用 private 修飾帘营，</br>
    * Environment Switcher 會(huì)在編譯期間自動(dòng)生成相應(yīng)的 Module_XX 和 Environment_XX 靜態(tài)常量票渠。</br>
    * 例如：通過 EnvironmentSwitcher.MODULE_APP 就可以獲取到 App 模塊下相應(yīng)的所有環(huán)境</br>
    */
   public class EnvironmentConfig {
   
       /**
        * 整個(gè) App 的環(huán)境
        */
       @Module
       private class App {
           @Environment(url = "https://gank.io/api/", isRelease = true, alias = "正式")
           private String online;
       }
   
       /**
        * 特殊模塊 Music 的環(huán)境
        */
       @Module(alias = "音樂")
       private class Music {
           @Environment(url = "https://www.codexiaomai.top/api/", isRelease = true, alias = "正式")
           private String online;
   
           @Environment(url = "http://test.codexiaomai.top/api/", alias = "測(cè)試")
           private String test;
       }
   
       /**
        * 特殊模塊 News 的環(huán)境
        */
       @Module(alias = "新聞")
       private class News {
           @Environment(url = "http://news/release/", isRelease = true, alias = "正式")
           private String release;
   
           @Environment(url = "http://news/test/", alias = "測(cè)試")
           private String test;
   
           @Environment(url = "http://news/test1/")
           private String test1;
   
           @Environment(url = "http://news/sandbox/", alias = "沙箱")
           private String sandbox;
       }
   }
   

   • @Module
     被它修飾的類或接口表示一個(gè)模塊逐哈，編譯時(shí)會(huì)自動(dòng)生成相應(yīng)模塊的 getXXEnvironment() 和 setXXEnvironment() 方法。一個(gè)被 @Module 修飾的類中问顷，可以有 n (n>0) 個(gè)被 @Environment 修飾的屬性昂秃，表示該模塊中有 n 種環(huán)境禀梳。

     例如：上面的代碼中，有三個(gè)類被 @Module 修飾肠骆，意味著有三個(gè)模塊算途，其中 App 模塊中，只有一個(gè)屬性被 @Environment 修飾蚀腿，表示該模塊只有一種環(huán)境嘴瓤；而 Music 和 News 模塊分別有 2 種和 4 種環(huán)境。

     此外 @Module 還有一個(gè)可選屬性 alias 莉钙，用來指定該模塊的別名廓脆。該值默認(rèn)為空字符串。這個(gè)屬性的主要目的是在切換環(huán)境 UI 頁(yè)面顯示中文名稱磁玉。例如：Music 和 News 模塊在切換環(huán)境頁(yè)面中就會(huì)分別顯示 “音樂” 和 “新聞”停忿。

     注：如果你的項(xiàng)目中所有模塊共用同一個(gè) Host 地址，那么只需配置一個(gè) Module 就可以了蚊伞。

   • @Environment
     被它修飾的屬性表示一個(gè)環(huán)境席赂，必須指定 url 的值，此外還有兩個(gè)可選屬性：isRelease 和 alias时迫。

     • isRelease 是一個(gè) boolean 型的屬性颅停，默認(rèn)為 false，當(dāng)值為 true 時(shí)别垮，它就是所在 Module 的默認(rèn)環(huán)境便监，以及 App 正式發(fā)布時(shí)的環(huán)境。一個(gè) Module 中必須有且只有一個(gè) Environment 的 isRelease 的值為 true碳想，否則編譯會(huì)失敗烧董。
     • alias 和 @Module 中的 alias 相似，用于在切換環(huán)境的UI頁(yè)面展示該環(huán)境的名字胧奔，該值默認(rèn)為空字符串逊移，如果給它指定非空字符串，則環(huán)境的名字就被指定為 alias 的值龙填。

     例如：Music 模塊中有兩種環(huán)境分別是 online（正式）和 test （測(cè)試）胳泉，因?yàn)?online 的 isRelease = true，所以它就是默認(rèn)環(huán)境和App 正式發(fā)布時(shí)的環(huán)境岩遗。

     再次強(qiáng)調(diào)：一個(gè) Module 中必須有且只有一個(gè) Environment 的 isRelease 的值為 true扇商，否則編譯會(huì)失敗。

3. 點(diǎn)擊菜單欄中的 “Build” -> “Rebuild Project”宿礁，等待編譯完成案铺。

   到這里整個(gè)配置就算完成了，接下來就可以在項(xiàng)目中愉快的獲取相應(yīng)模塊的環(huán)境地址了梆靖。

添加入口

手動(dòng)切換環(huán)境當(dāng)然要有一個(gè)頁(yè)面控汉，這個(gè)頁(yè)面 Environment Switcher 已經(jīng)自動(dòng)集成了笔诵，只需要添加一個(gè)入口跳轉(zhuǎn)即可（這個(gè)入口只在 Debug 測(cè)試等內(nèi)部版顯示）。

例如：在“我的”頁(yè)面中姑子。

```
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
    ...
    if (!BuildConfig.DEBUG) {
        // only show in debug
        findViewById(R.id.bt_switch_environment).setVisibility(View.GONE);
        return;
    }
    
    findViewById(R.id.bt_switch_environment).setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View view) {
            // entrance of switch environment
            EnvironmentSwitchActivity.launch(getContext());
        }
    });
}
```

你可以使用 Environment Switcher 已經(jīng)提供的 EnvironmentSwitchActivity.launch(getContext()) 方法啟動(dòng)乎婿；當(dāng)然你也可以通過 startActivity(new Intent(getContext(), EnvironmentSwitchActivity.class)) 啟動(dòng)，看個(gè)人喜好了街佑。

獲取相應(yīng)模塊的環(huán)境地址：

EnvironmentSwitcher.getAppEnvironment(getApplication(), BuildConfig.DEBUG);
EnvironmentSwitcher.getMusicEnvironment(getApplication(), BuildConfig.DEBUG);
EnvironmentSwitcher.getNewsEnvironment(getApplication(), BuildConfig.DEBUG);

這里需要注意的是獲取相應(yīng)模塊的地址需要兩個(gè)參數(shù)谢翎，第一個(gè)就是一個(gè) Context 不用解釋，因?yàn)?Environment Switcher 是用 SharedPreferences 進(jìn)行存儲(chǔ)數(shù)據(jù)的沐旨。第二個(gè)參數(shù)是一個(gè) boolean 型的值岳服，如果為 true 表示當(dāng)前為 Debug 或測(cè)試等內(nèi)部使用版本，此時(shí)獲取到的地址是我們手動(dòng)切換保存的地址希俩；而如果為 false 表示當(dāng)前為要發(fā)布給用戶使用的版本吊宋，此時(shí)獲取到的地址為我們?cè)?@Environment 中指定 isRelease = true 的地址，手動(dòng)切換的環(huán)境地址不再生效颜武。

更多使用介紹可參考 Demo 璃搜。

如果你覺得這個(gè)工具對(duì)你有用，隨手給個(gè) Start鳞上，讓我知道它是對(duì)你有幫助的这吻，我會(huì)繼續(xù)更新和維護(hù)它。

Demo 中有 Environment Switcher 結(jié)合 Retrofit 使用的詳細(xì)實(shí)現(xiàn)過程篙议。

Environment Switcher

原理解析

如果你想知道 Environment Switcher 的原理唾糯，可以查看《Environment Switcher 原理解析》。