Android Studio gradle 技巧一 重要信息脱敏

开个头

众所周知，android的签名文件(.jks 或者 .keystore)很重要。一般我们配置签名文件的写法是直接在app build.gradle文件里进行明文配置。不是很优雅。
还有我们对接第三方的时候，会申请一些appkey或者appSecret，一般也是会直接出现在代码里，不是很安全。

不优雅的配置签名信息
app build.gradle
android{
	...
	 signingConfigs {
        debug {
            storeFile file("xxx.jks") //签名文件路径
            storePassword "xxx"//仓库密码
            keyAlias "xxx"//别名
            keyPassword "xxx" //签名密码
        }
        release {
            storeFile file("xxx.jks") //签名文件路径
            storePassword "xxx"//仓库密码
            keyAlias "xxx" //别名
            keyPassword "xxx" //签名密码
        }
    }
	...
}

不优雅地设置第三方key
在某java文件中明文

    // APP_ID 替换为你的应用从官方网站申请到的合法appID
    private static final String APP_ID = "xxxxxx";

    // IWXAPI 是第三方app和微信通信的openApi接口
    private static IWXAPI api;

    //向微信注册 appId
    public static void registToWX() {
        // 通过WXAPIFactory工厂，获取IWXAPI的实例
        api = WXAPIFactory.createWXAPI(MyApp.getApplication(), APP_ID, false);
        // 将应用的appId注册到微信
        api.registerApp(APP_ID);
    }

或者在manifest.xml中明文

<!-- 高德地图START -->
<meta-data
    android:name="com.amap.api.v2.apikey"
    android:value="xxxxxxx" />
<!-- 高德地图END -->

解决方法

优雅地设置签名信息

1.创建keystore.properties

在项目根目录下，创建keystore.properties文件。文件里配置签名文件信息。
默认你已经在项目根目录下，创建了一个签名文件

# about keystore
storeFile=xxx.jks
storePassword=xxx
keyAlias=xxx
keyPassword=xxx

2.在build.gradle文件里引用.properties文件

在 app build.gradle文件里引用刚创建好的keystore.properties文件。

...
// Create a variable called keystorePropertiesFile, and initialize it to your
// keystore.properties file, in the rootProject folder.
def keystorePropertiesFile = rootProject.file("keystore.properties")

// Initialize a new Properties() object called keystoreProperties.
def keystoreProperties = new Properties()

// Load your keystore.properties file into the keystoreProperties object.
keystoreProperties.load(new FileInputStream(keystorePropertiesFile))
android{
	...
}
...

3.优雅地设置

...
android{
	...
	//开发中为了方便测试，debug的签名文件和release的签名文件，用的是一套。。。
	signingConfigs {
        release {
            storeFile file(keystoreProperties['storeFile'])
            storePassword keystoreProperties['storePassword']
            keyAlias keystoreProperties['keyAlias']
            keyPassword keystoreProperties['keyPassword']
        }
        debug {
            storeFile file(keystoreProperties['storeFile'])
            storePassword keystoreProperties['storePassword']
            keyAlias keystoreProperties['keyAlias']
            keyPassword keystoreProperties['keyPassword']
        }
    }
}
...

经过以上步骤，我们的签名文件已经脱敏。可以大胆的把项目上传到远程仓库（把签名文件 加入 .ignore）

优雅地设置第三方key

有了上面的基础，我们已经可以实现在build.gradle里面实现进行信息脱敏，所以，现在我们只要能实现在java文件和manifest文件中拿到build.gradle文件中的变量值，这样就可以实现将java文件和manifest文件中的第三方信息脱敏。

在Java文件和manifest文件中共享参数

BuildConfig

简单介绍下BuildConfig这个类，下面的代码块是BuildConfig默认的一些值。
1.这个类是编译时gradle帮我们自动生成的一个类（方便维护，或者说不需要我们维护）
2.这个类里面的值都是静态常量 （方便调用）
3.这个类会根据Build类型（debug/release）来给常量赋值 （这个功能比较厉害，下面单独说）

/**
 * Automatically generated file. DO NOT MODIFY
 */
package com.example.xxxx;

public final class BuildConfig {
  public static final boolean DEBUG = Boolean.parseBoolean("true");
  public static final String APPLICATION_ID = "com.example.xxx";
  public static final String BUILD_TYPE = "debug";
  public static final String FLAVOR = "";
  public static final int VERSION_CODE = 1;
  public static final String VERSION_NAME = "1.0";
}

1在keystore.properties里面定义参数

在这个文件中#表示注释。
在这个文件里面字符串不要用双引号""包裹。

# about keystore
storeFile=xxx.jks
storePassword=xxx
keyAlias=xxx
keyPassword=xxx
##################################################
# about custom value
#------------------高德地图apiKey------------------
aMapApiKey=xxxxxxxxxx
#------------------   微信分享   ------------------
weChatAppId=xxxxxxxx

2在build.gradle里拿到.properties里的值

app build.gradle

// Create a variable called keystorePropertiesFile, and initialize it to your
// keystore.properties file, in the rootProject folder.
def keystorePropertiesFile = rootProject.file("keystore.properties")

// Initialize a new Properties() object called keystoreProperties.
def keystoreProperties = new Properties()

// Load your keystore.properties file into the keystoreProperties object.
keystoreProperties.load(new FileInputStream(keystorePropertiesFile))
android{
	...
	 //获取 高德地图apiKey
     def aMapApiKey = keystoreProperties['aMapApiKey']
     //获取 微信分享appId
     def weChatAppId = keystoreProperties['weChatAppId']
     //给BuildConfig类里面添加自定义参数
     buildConfigField("String", "weChatAppId", "\"${weChatAppId}\"")
     //创建一个可以在manifest中使用的参数
     manifestPlaceholders = [
                aMapApiKey : "${aMapApiKey}",
     ]
     signingConfigs {
     ...
	 }
}

设置完了后，编译一下我们的项目然后进入BuildConfig类里看一下。gradle已经帮我们把值设置进去了。

/**
 * Automatically generated file. DO NOT MODIFY
 */
 //如果你的项目中依赖了多个library注意看这个包路径。找到app对应的BuildConfig。每个library都会生成自己的BuildConfig
package com.example.xxxx;

public final class BuildConfig {
  public static final boolean DEBUG = Boolean.parseBoolean("true");
  public static final String APPLICATION_ID = "com.example.xxx";
  public static final String BUILD_TYPE = "debug";
  public static final String FLAVOR = "";
  public static final int VERSION_CODE = 1;
  public static final String VERSION_NAME = "1.0";
  // Fields from default config.
  public static final String weChatAppId = "xxx";
}

3在.java代码中使用

 	// APP_ID 替换为你的应用从官方网站申请到的合法appID
 	//这里就直接用BuildConfig.weChatAppId 来获取我们设置在.properties文件中微信的AppId
    private static final String APP_ID = BuildConfig.weChatAppId;

    // IWXAPI 是第三方app和微信通信的openApi接口
    private static IWXAPI api;

    //向微信注册 appId
    public static void registToWX() {
        // 通过WXAPIFactory工厂，获取IWXAPI的实例
        api = WXAPIFactory.createWXAPI(MyApp.getApplication(), APP_ID, false);
        // 将应用的appId注册到微信
        api.registerApp(APP_ID);
    }

4在manifest中使用

 <!-- 高德地图 apiKey -->
        <meta-data
            android:name="com.amap.api.v2.apikey"
            android:value="${aMapApiKey}" />

我们看下manifest文件编译前后的对比。比较一目了然。

BuildConfig厉害的功能

我在开发中，测试和上线的时候，经常会改一些配置项。有时候打完包了正式包才发现一些配置忘了修改。我之前是在配置项之前加上TODO，每次打包之前都看下TODO，然后修改对象的配置项，比较的麻烦。如下图。

有了BuildConfig之后，就方便多辣

app build.gradle

...
android{
	...
	buildTypes {
        release {
            buildConfigField("boolean", "IS_DEBUG", "false")
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
        debug {
            buildConfigField("boolean", "IS_DEBUG", "true")
        }
    }
}
...

然后我们直接在代码中根据BuildConfig.IS_DEBUG的值来判断是debug版本还是release版本就好了。
比如，这个bugly，我们开发过程中生成的bug，真的不用上传上去给主管看到。。。

//TODO bugly 配置是否上传崩溃日志
//之前每次测试和发布产品的时候都要手动改这个boolean值，很麻烦。
CrashReport.initCrashReport(getApplicationContext(), appId, false);

//TODO bugly 配置是否上传崩溃日志
//以后测试和发布的时候，再也不用管辣
CrashReport.initCrashReport(getApplicationContext(), appId, !BuildConfig.IS_DEBUG);

下图可以看到debug 和 release 下BuildConfig里面的值得变化。

这个只是作为一个例子来理解BuildConfig的妙用，其实可以看到BuildConfig自带一个BUILD_TYPE来区分编译类型。不需要我们额外自定义参数。
在我们的开发中还会遇到多版本或者多渠道打包（就是多flavors的时候），这时候如果渠道区分版本或者渠道，这时候BuildConfig就派上大用场辣。这个也不是本篇的重点，先轻描淡写。想了解多渠道打包的可以google官方开发者文档介绍

参考资料

google官方开发者文档
还有默默无闻的大佬们

如有错误，欢迎指正！