1.背景

接手的專案近期需要上線，于是復習了一下專案簽名檔案配置流程，這里做個系統性總結，

2.最終目標

根據需求為debug包與release包配置簽名檔案，快速滿足中小型專案的需要，

3.創建簽名檔案

要將簽名檔案配置到專案中，首先需要創建一個簽名檔案，android studio為我們提供了圖形化創建方式，這里簡單贅述一下：

導航欄build下選擇 generate signed bundle/apk，如下圖：

國內的就選擇apk，點擊next：

點擊 create new，創建一個新的簽名檔案：

接下來需要填入一些資訊，下面的截圖簡單解釋了一下，其中，certificate下的六個填空題，做一個就可以了，這里建議應填盡填：

填完之后，點擊OK，進行創建，完事兒~ 等等？咋還報錯了嘞？瞅瞅說的啥，，，

哦~ 他讓咱們用命令列遷移到行業標準格式，那來吧：復制一下警告彈窗里的那條命令（keytool -importkeystore......pkcs12），打開terminal終端，粘貼進去，點回車，走你~ 按照提示，輸入源秘鑰庫口令，就是剛剛設定的密碼，再回車，走你~ OK，到這里，簽名檔案就創建完成了，

4.生成release與debug簽名檔案的配置資訊

我們需要在app的build.gradle下生成測驗包與正式包的配置腳本，來分別配置debug包與release包的不同屬性，比如測驗包與正式包都使用自己的簽名檔案、正式包開混淆但測驗包不開等等，方便我們進行開發與上線， android studio也為我們提供了圖形化操作界面，下面一起來走一遍：

導航欄 file -> project structure，進到專案結構界面

專案結構界面依次選擇: modules -> app -> signing configs，如下圖：

點擊“+”新增一個配置資訊，輸入release，代表這是用于正式包的簽名檔案資訊，點擊OK：

輸入相關資訊后，點擊 apply，release包的簽名檔案就生成完畢了，同理，生成debug包的簽名檔案配置資訊，用于日常開發與除錯，這里建議與release包使用相同的簽名檔案，避免相同包名的debug版本與release版本，由于簽名不同而重復卸載與安裝（插個題外話：必須要讓debug包與release包使用不同簽名檔案的小伙伴，可以采用給測驗包追加包名的方式，避免正式包與測驗包的包名沖突，這里先挖個坑【坑1】，下文來填上）， release簽名檔案配置如圖：

debug簽名檔案配置如圖：

點擊OK之后，等待專案配置完成，然后打開專案app目錄下的build.gradle檔案，我們可以看到，release包的簽名資訊與debug包的簽名資訊都已經生成，如圖：

但是目前為止，我們僅僅是生成了自己的兩種簽名檔案資訊，卻還沒配置到測驗包與正式包里，那么怎么在編譯測驗包或者正式包的時候，讓他們各自使用自己的簽名檔案資訊呢？先別捉急，咱喝口茶緩一緩先，

5.將簽名檔案資訊配置給對應的包

喝著茶咱也別閑著，來看一看app目錄下build.gradle里面的buildType的資訊：

這個bulidType里，記錄著專案的release包、debug包等各種包的配置，咱們可以看到，創建專案的時候，系統為咱們顯式自動生成了release包的配置，但是只配置了兩個值，這里簡單解釋一下：

• minifyEnabled：是否開啟混淆（debug模式默認為true，release模式默認false）
• proguardFiles：混淆檔案（僅在minifyEnabled為true時生效） OK，接下來咱們先配置release包的簽名檔案，依舊是打開專案結構界面，但是選擇 build variants，如圖：

咱們看到，系統已經生成了一個release，這個就是正式包的組態檔，咱們這次只需要設定一下簽名檔案就OK了，別的設定可以自行了解，在signing config下選擇設定的signingConfigs.release選項，點擊apply來應用設定， 編譯完成后，回到app目錄下的build.gradle，查看buildTypes，如圖：

到這里，release包的簽名檔案便配置完成了， 接下來配置debug包的簽名檔案，依舊是打開專案結構界面創建變數界面（file-> project structure -> build variants ），選擇app包：

點擊“+”號，輸入debug，點擊OK后，debug包的各項默認配置便顯示出來了，

咱們可以根據需要來更改這些配置，比如，Debuggable（應用是否可除錯，底下解釋【埋坑2】）默認值是true，這時候咱們可以顯式的指定出來，就給它默認值改為手動設定的true，當然，這里不改也是沒問題的，Debuggable如下圖：

【坑2】解釋：debuggable，顧名思義，就是是否可調式，指的是應用在運行程序中，能否通過編譯器進行除錯，最直接的表現就是系統日志輸出，默認情況下，release包下處于關閉模式，debug包處于開啟模式，開發程序中，必要情況下可以更改該值來除錯debug包或者release包，

配置debug包簽名檔案操作與配置release包的簽名檔案基本一樣，找到 signing config，選擇簽名檔案，然后點擊apply來應用配置，最后OK，如下圖：

同步完成后，可以看到編譯器已經為我們自動產生了debug包的配置資訊，并應用了咱們自定義的簽名檔案：

到這里，簽名檔案的基本配置流程已經講完了，但是這樣的配置是會產生簽名檔案資訊的安全問題的， 在談安全問題之前，咱們先填一填前面埋的【坑1】：關于在debug包追加包名的事兒，有興趣的小伙伴來了解一下，沒興趣的可以跳下一小節了， 前面提到，為了避免測驗包與正式包安裝沖突，咱們可以使用兩種方式，一種是上面的使用同一個簽名檔案，另一種是給測驗包追加包名，讓他們包名不同，從而避免包名沖突，android studio同樣為我們提供了圖形化追加包名的方式，甚至剛剛我們還見到過，

[ 黑人問號臉.jpg ]

不信你看截圖：

沒錯，就是在這里追加包名，比如我的demo的默認包名是com.dylan.signaturetest，我想讓測驗包的包名是com.dylan.signaturetest.debug，那么我只需要在這個application id suffix里添加“.debug”即可，如圖：

依次點擊apply與OK后，等待同步完成，查看build.gradle的配置如下：

可以看到，applicationIdSuffix屬性已經被添加成功，這時候我們分別運行正式包與測驗包，運行方式如圖：

運行結果如圖：

可以看到，兩個包可以同時存在，查看包名，如圖：

正如我們期望的那樣，正式包與測驗包同時存在了， OK，上面埋的坑填完了，底下講一講上文提到的，簽名檔案資訊安全問題，

6.將簽名檔案資訊移動到專案本地組態檔

前面我們發現，簽名檔案的檔案名、密碼等極其敏感的資訊，都是放在專案app包下的build.gradle里的，會隨著專案的發包，一起發到各大應用市場，這樣安裝包被不懷好意的玩家們進行反編譯后，輕而易舉的就可以獲取到我們的簽名檔案資訊，除此之外，檔案路徑寫在gradle里，在多端協作開發同一個專案的時候，大家的簽名檔案放置的位置五花八門，也會引起這里gradle檔案的簽名檔案路徑被多人頻繁修改的問題， 為了避免這種情況，往往我們會將簽名檔案的配置資訊單獨在本地組態檔local.properties里，該檔案在新建專案的時候，android studio會幫我們創建好，位于專案根目錄下，在進行Git版本控制時，默認不會被添加到Git提交到遠程倉庫，在別人第一次拉取遠程倉庫代碼時，只需要創建自己的local.properties檔案即可，檔案截圖如下：

可以看到，我們的android SDK路徑就是在這里配置的，底下我們來撰寫代碼，來實作從local.properties檔案里讀取簽名檔案資訊，

首先，local.properties檔案內指定簽名檔案路徑、密碼、別名、別名密碼等資訊，如圖：

接著在app目錄下的build.gradle檔案的android下撰寫代碼，讀取local.properties檔案，并讀取指定的資訊，如圖：

最后，將讀取到的簽名檔案資訊配置給signingConfigs內debug與release，如圖：

至此，簽名檔案從產生到配置的完整流程，算是已經講完了，

7.總結

本文講解了從零開始配置一個android專案簽名檔案的完整流程，通過閱讀本文，我們可以對簽名檔案配置有一個整體的把握，后續配置簽名檔案也可以一文搞定， 由于筆者能力有限，文章難免出現錯誤，歡迎指正！

附錄：相關原始碼

核心組態檔一共兩點，即專案根目錄下的local.properties與app目錄下的build.gradle檔案的android屬性，分別如下：

local.properties

## This file is automatically generated by Android Studio.
# Do not modify this file -- YOUR CHANGES WILL BE ERASED!
#
# This file should *NOT* be checked into Version Control Systems,
# as it contains information specific to your local configuration.
#
# Location of the SDK. This is only used by Gradle.
# For customization when using a Version Control System, please read the
# header note.
sdk.dir=C\:\\Users\\Dylan\\AppData\\Local\\Android\\Sdk
#
#簽名檔案配置資訊
keyStoreFile=C\:\\Users\\Dylan\\Desktop\\signatureTest.jks
keyStorePassword=123456
keyAlias=key0
keyAliasPassword=123456

復制代碼

使用的時候更換為自己的簽名檔案相關資訊，

app//build.gradle

android {

    // 讀取local.properties檔案
    Properties properties = new Properties()
    InputStream inputStream = project.rootProject.file('local.properties').newDataInputStream()
    properties.load(inputStream)

    // 讀取簽名檔案
    def keyKeyStoreFile = file(properties.getProperty('keyStoreFile'))
    // 讀取簽名檔案別名、密碼等資訊
    def keyKeyStorePassword = properties.getProperty('keyStorePassword')
    def keyKeyAlias = properties.getProperty('keyAlias')
    def keyKeyAliasPassword = properties.getProperty('keyAliasPassword')


    signingConfigs {
        release {
            storeFile keyKeyStoreFile
            storePassword keyKeyStorePassword
            keyAlias keyKeyAlias
            keyPassword keyKeyAliasPassword
        }
        debug {
            storeFile keyKeyStoreFile
            storePassword keyKeyStorePassword
            keyAlias keyKeyAlias
            keyPassword keyKeyAliasPassword
        }
    }
    compileSdkVersion 30
    buildToolsVersion "30.0.3"

    defaultConfig {
        applicationId "com.dylan.signaturetest"
        minSdkVersion 21
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.release
        }
        debug {
            signingConfig signingConfigs.debug
            debuggable true
            applicationIdSuffix '.debug'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = '1.8'
    }
}
復制代碼