Gradle之使用BuildConfig自定义常量

有时候，我们定义的常量往往版本有关，有两个最大的用途就是http的base地址，和log打印的控制器。Eclipse时代，我们都是在某个类里面定义一个开关，在发版本debug，或者release的时候手动修改。然而，忙起来的时候，往往容易忘记。发错版本，等流到测试那里，被打回来，浪费了整个项目的时间。

现在Android studio时代就不一样了，有了gradle，我们可以使用BuildConfig自定义常量，让debug和release区别开来。

在正常项目开发中，我们经常会用到网络访问来连接我们自己的服务器，在开发中与正式环境中往往用到不同的接口地址，正常情况下，我们会在代码中自定义一个String常量来存储HTTP头地址，在开发阶段使用测试地址，上线打包时更换为正式地址。而用Android Studio开发项目时，我们可以用更优雅的方式来解决这个问题，即在BuildConfig中来自定义这个接口地址。
BuildConfig是android studio在打包时自动生成的一个java类，在项目工程的build/generated/source/buildConfig目录下，打开这个目录可以发现会有多个不同的目录来存放BuildConfig.java类，一般会有androidTest、debug、release等多个目录，这些目录中的BuildConfig类中有相同的常量字段，但这里常量字段的值是完全可以自定义的，这样我们就可以通过定义一些常量使其在debug以及release中生成不同的字段，这里我们来定义一个HTTP_BASE字段来使其在debug中使用测试地址而在release中使用正式地址。
在build.gradle中的buildTypes下，我们可以为release以及debug定义我们所需要的常量：

buildTypes {          release {              minifyEnabled true              signingConfig signingConfigs.release              proguardFiles getDefaultProguardFile('proguard-project.txt'), 'proguard-rules.pro'              buildConfigField("String", "HTTP_BASE", '"https://www.baidu.com/api/release/"')          }          debug {              signingConfig signingConfigs.debug              proguardFiles getDefaultProguardFile('proguard-project.txt'), 'proguard-rules.pro'              buildConfigField("String", "HTTP_BASE", '"https://www.baidu.com/api/debug"')          }  }  

如上所示，我们可以使用buildConfigField()方法来自定义一些 常量，进入该方法源码

/**  * Adds a new field to the generated BuildConfig class.  *  * <p>The field is generated as: <code><type> <name> = <value>;</code>  *  * <p>This means each of these must have valid Java content. If the type is a String, then the  * value should include quotes.  *  * @param type the type of the field  * @param name the name of the field  * @param value the value of the field  */  public void buildConfigField(          @NonNull String type,          @NonNull String name,          @NonNull String value) {      ClassField alreadyPresent = getBuildConfigFields().get(name);      if (alreadyPresent != null) {          logger.info("BuildType({}): buildConfigField '{}' value is being replaced: {} -> {}",                  getName(), name, alreadyPresent.getValue(), value);      }      addBuildConfigField(AndroidBuilder.createClassField(type, name, value));  }  

该方法需要传入三个参数，第一个参数为要定义的常量的类型，第二个参数为该常量的命名，第三个参数为该常量的值，明白了这个方法使用方法后，我们就可以在buildTypes中的release和debug下来自定义某些场景下所需要的值，需要注意的是，当我们定义这些值时，release和debug下这些值的type、name必须相同，这是毋庸置疑的，value就是我们想要在release和debug下所需要的不同的值。当添加好这些值后，rebuild一下项目，然后在BuildConfig类中，这些我们刚刚定义的值就会显示出来，这些值就可以在整个module中使用了。