Skip to content

kelinZhou/EnvironmentPlugin

BranchesTags

Repository files navigation

EnvironmentPlugin

一款用来配置环境的插件，可以在开发时可以切换不同环境的情况，而在打生产包后又不会导致非生产环境泄漏。

简介

在gradle中配置开发时的所有环境，你只需要很少的代码就能实现环境动态切换的功能。而在打生产包时你只需要在gradle中修改release的值为true就能将非生产环境剔除(不会将非生产环境打包到Apk中)，从而保证非生产环境不会泄漏。在gradle中配置完成后只需要clean一下就会在BuildConfig的目录中生成一个EnvConfig的类，你只需要通过EnvConfig.getEnv()方法就能获取到所有你在gradle中配置的值，而此时你不需要关心自己当前处于哪个环境。切换环境时你只需要调用EnvConfig.setEnv(Type type)方法切换当前环境即可。

体验

点击下载或扫码下载DemoApk

DemoApk

下载

第一步：添加 gradlew plugins 仓库到你项目根目录的 gradle 文件中。
buildscript {
  repositories {
    maven { url "https://plugins.gradle.org/m2/" }
  }
  dependencies {
    classpath "gradle.plugin.com.kelin.environment:environment:${last version here}"
  }
}
第二步：在module中引入插件。
apply plugin: "com.kelin.environment"

更新记录

[1.6.2] - 2024-11-6

Removed

  • 移除releaseConfig发布环境配置，改用configs配置。
  • 移除devConfig开发环境配置，改用configs配置。

Added

  • 新增envPackage配置，用于配置EnvConfig的包名，用于适配多包名的情况，避免不同包名下使用EnvConfig需要导不同包的尴尬情况。
environment{
    online true
    
    envPackage "com.example.demo" //为EnvConfig固定包名。
    
    //…… 省略N行代码 
}
  • 新增enabledConfig用于启用某个Flavor的配置，当只有一个Flavors时可以省略，需配合configs使用。
  • 新增configs配置，用于取代releaseConfig和devConfig，在configs中可以新增理论上不限制个数的不同的Flavors配置。
environment{
    online true
    
    envPackage "com.example.demo" //为EnvConfig固定包名。

    enabledConfig "CN" //本次编译启用Flavor为CN的配置。
    
    configs{
        //配置项的命名的规则为Flavor+Type,Flavor遵循Java命名规范即可，Type只可以是Release(发布)和Dev(开发)。
        //以下面的cnRelease为例，其中cn就是Flavor而Release这表示这里一个发布环境下的配置，也就是`online`为`true`时的配置。
        cnRelease { //声明一个Flavor为CN的发布环境配置，这里的配置内容与原来的releaseConfig一致。
            appIcon "@mipmap/ic_android"
            appName "EnvPlugin"
            versionName "1.0.0"
            applicationId packageName
            variable 'APK_BUILD_TYPE', "release"
        }

        cnDev { //声明一个Flavor为CN的开发环境配置，这里的配置内容与原来的devConfig一致。
            appIcon "@mipmap/ic_launcher"
            appName "@string/app_name_test"
            versionName "1.0.0.alpha1"
            applicationId "${packageName}.test"
            variable 'APK_BUILD_TYPE', "test"
            variable 'TEST_BASE_VARIABLE', "base_devConfig"
        }
    }
    
    //…… 省略N行代码 
}

1.6.0

将applicationId、appIcon、appRoundIcon、appName这些字段改为非必要。

1.5.9

修复在Gradle6.7.1已以后的版本中使用时会报错：sourceOutputDir方法丢失的问题。

1.5.5

environment 增加manifestPlaceholders成员，由于插件有些时候生成manifestPlaceholders不起作用，该成员方便从gradle中配置，以下方式只有在manifestPlaceholders失效时才使用，默认不需要使用。 **方式一：**可以在App的build.gradle中的android中增加如下代码。

android{
    //...省略部分代码
    
    applicationVariants.configureEach { variants ->
        variants.mergedFlavor.manifestPlaceholders = environment.manifestPlaceholders
    }
}

**方式二：**可以在App的build.gradle中的android中增加如下代码。

android{
    //...省略部分代码
    
    productFlavors.configureEach { flavor ->
        flavor.manifestPlaceholders = environment.manifestPlaceholders
    }
}

**方式三：**可以在App的build.gradle中的android中的defaultConfig中增加如下代码。

android{
    //...省略部分代码
    
    defaultConfig{
        //...省略部分代码
        
        manifestPlaceholders.putAll(environment.manifestPlaceholders)
    }
}

1.5.1

environment 增加constants()方法用于声明常量,声明的常量可以直接通过EnvConfig.XXX的方式调用，constants()的用法与variables()的用法一致。

1.4.1

优化environment的variables()方法的逻辑，无论任何地方使用variables()方法都将会生成环境变量，如果不同地方有相同的生命则config中的覆盖environment中的，env环境中的覆盖config中的。而placeholder的配置再任意地方配置均会生效。

1.4.0

变更方法 releaseConfig和devConfig中使用variable()方法添加编译期的临时变量。

1.3.0

对environment.getVariable(key)方法和environment.variables字段进行优化，不仅可以取出devConfig和releaseConfig中的配置，还能取出各个Env中的配置。

1.2.0.2

完善日志输出，在控制台中打印出所有的manifestPlaceHolder的字段，方便排查问题。

1.2.0.1

* 修复在极端情况下会出现环境配置实例化时传值不正确的Bug。
* 环境配置变量支持指定类型，目前支持String、int、boolean这三种类型。

1.1.9 为了增加易用性，在EnvConfig中增加IS_DEBUG字段(等价于!EnvConfig.IS_RELEASE)。

1.1.8 Gradle4.0适配，Gradle没有升级到4.0的同学请继续使用1.1.8之前的版本。

1.修复在gradle4.0及以上版本中编辑报错(变更了buildConfigPackageName的返回值类型)的问题 2.去除了在BuildConfig中自动新增IS_DEBUG字段的功能(可以使用EnvConfig.IS_RELEASE字段代替)。

1.1.7 优化配置

  1. environment Task 中的用来配置是否是打生产包的release更名为online。
  2. environment Task 中的用来配置初始环境的initEnvironment的配置方式由字符串类型改为枚举类型，具体有以下四种：
release  //对应releaseEnv Task (生产环境)
dev      //对应devEnv Task (开发环境)
test     //对应testEnv Task (测试环境)
demo     //对应demoEnv Task (预发布环境)
  1. environment增加getVariable(key: String)方法，用于更加方便的获取devConfig和releaseConfig两个Task中配置的variables。

1.1.6 美化编译日志的打印输出，使其容易阅读和复制。

1.1.5

将devConfig和releaseConfig两个task中，默认的versionCode编码规则(省略versionCode配置时)改为yyMMddHH格式(年份后两位+月份+日期+小时)，例如:2020年5月20号 5:20分打包的话默认versionCode为20052005。如不希望使用这个规则，则可以手动指定(不省略versionCode的配置)。

1.1.3

增加为devConfig和releaseConfig配置环境变量的功能，以解决生产和除生产之外的环境变量配置，且该环境变量只在编译器可以使用(也就是只能在gradle中使用)，运行时(代码中)无法使用.

1.1.2及以下

省略 ……

效果图

效果图

使用

在App gradle中添加如下配置。

environment {
    //当打生产包时将该参数改为true，那么所生成的EnvConfig类中就不会包含releaseEnv以外的内容，避免开发、测试等环境泄漏。
    release false

    //配置初始化环境(应用首次安装到设备上的默认环境)，改参数也是用来配置manifestPlaceholders的环境的。
    initEnvironment "test"

    //本次编译启用Flavor为CN的配置，Flavor的名字不区分大小写。
    enabledConfig "CN" 

    configs{
        //配置项的命名的规则为Flavor+Type,Flavor遵循Java命名规范即可，Type只可以是Release(发布)和Dev(开发)。
        //以下面的cnRelease为例，其中cn就是Flavor而Release这表示这里一个发布环境下的配置，也就是`online`为`true`时的配置。
        //一个Flavor有且必须有两个配置：Release和Dev。
        cnRelease { //声明一个Flavor为CN的发布环境配置，这里的配置内容与原来的releaseConfig一致。
            appIcon "@mipmap/ic_android"
            appName "EnvPlugin"
            versionName "1.0.0"
            applicationId packageName
            variable 'APK_BUILD_TYPE', "release"
        }

        cnDev { //声明一个Flavor为CN的开发环境配置，这里的配置内容与原来的devConfig一致。
            appIcon "@mipmap/ic_launcher"
            appName "@string/app_name_test"
            versionName "1.0.0.alpha1"
            applicationId "${packageName}.test"
            variable 'APK_BUILD_TYPE', "test"
            variable 'TEST_BASE_VARIABLE', "base_devConfig"
        }
    }

    releaseEnv {
        alias "生产"

        variable "API_HOST", "192.168.31.24"
        variable "API_PORT", "8443"
        variable "UM_APP_KEY", '7c2ed9f7f1d5e10131d', true
        variable "WX_APP_ID", "wxc23iadfaioaiuu0a"
        variable "WX_APP_SECRET", "ioa9ad9887ad98ay979ad86"
    }

    testEnv {
        alias "测试"

        variable "API_HOST", "192.168.36.18"
        variable "UM_APP_KEY", '7c2ed9f7f1d5eewiai', true
    }

    demoEnv {
        alias "预发"

        variable "API_HOST", "192.168.36.18"
        variable "UM_APP_KEY", '7c2ed9f7f1d5eewiai', true
    }
}

android{
    //...省略N多行代码
}

然后clean一下项目。

Clean项目

然后你就能得到下面这两个类，EnvConfig 和 Environment。

生成的环境配合的类的位置

EnvConfig
public final class EnvConfig {
    public static final String FLAVOR = "CN";

    public static final boolean IS_RELEASE = Boolean.parseBoolean("false");

    public static final boolean IS_DEBUG = Boolean.parseBoolean("true");

    public static final boolean IS_CONSTANT = true;

    public static final boolean IS_CONSTANT_VALUE = false;

    public static final Type INIT_ENV = Type.nameOf("demo");

    private static final Environment RELEASE_ENV = new EnvironmentImpl("base_R", "test", "https://iyx.smart.api.intelliyx.com/", "f4db09cf-80b2-4d3f-bda1-997ab41a3754", "3031266f-54a8-46dd-ba47-2a0d516df29b", "wxf21bd8885522192d", "1110499891", "2e8044fbb66f158fcc19e3ccec16fd06", "", "https://iyx.smart.api.intelliyx.com/api/v1/", "cmyrDyPBYXDudUtZ", "4");

    private static final Environment TEST_ENV = new EnvironmentImpl("base_test", "test", "http://sit.tms.api.yuchuanglian.com/", "d18d04ab-f433-4242-86f3-c40facf71809", "6cf89834-322d-466f-a5ba-df175f8f1a10", "wxf21bd8885522192d", "1110499891", "2e8044fbb66f158fcc19e3ccec16fd06", "180530", "http://sit.tms.api.yuchuanglian.com:8020/api/v1/", "cmyrDyPBYXDudUtZ", "1");

    private static final Environment DEMO_ENV = new EnvironmentImpl("base_demo", "test", "http://uat.tms.api.yuchuanglian.com/", "d18d04ab-f433-4242-86f3-c40facf71809", "6cf89834-322d-466f-a5ba-df175f8f1a10", "wxf21bd8885522192d", "1110499891", "2e8044fbb66f158fcc19e3ccec16fd06", "180530", "http://uat.tms.api.yuchuanglian.com:8020/api/v1/", "cmyrDyPBYXDudUtZ", "2");

    private static Context context;

    private static Type curEnvType;

    EnvConfig() {
        throw new RuntimeException("EnvConfig can't be constructed");
    }

    public static void init(Application app) {
        context = app.getApplicationContext();
        curEnvType = Type.nameOf(PreferenceManager.getDefaultSharedPreferences(context).getString("current_environment_type_string_name", INIT_ENV.name()));
    }

    public static boolean setEnvType(Type type) {
        if (type != curEnvType) {
            curEnvType = type;
            if (context != null) {
                PreferenceManager.getDefaultSharedPreferences(context).edit().putString("current_environment_type_string_name", type.name()).apply();
            }
            return true;
        } else {
            return false;
        }
    }

    public static Type getEnvType() {
        return curEnvType;
    }

    public static Environment getEnv() {
        switch (curEnvType) {
            case RELEASE:
                return RELEASE_ENV;
            case TEST:
                return TEST_ENV;
            case DEMO:
                return DEMO_ENV;
            default:
                throw new RuntimeException("the type:" + curEnvType.toString() + " is unkonwn !");
        }
    }

    public enum Type {
        RELEASE("生产"),

        TEST("测试"),

        DEMO("预发");

        public final String alias;

        Type(String alias) {
            this.alias = alias;
        }

        private static Type nameOf(String typeName) {
            if (typeName != null) {
                for (Type value : values()) {
                    if (value.name().toLowerCase().equals(typeName.toLowerCase())) {
                        return value;
                    }
                }
            }
            return RELEASE;
        }
    }

    private static final class EnvironmentImpl extends Environment {
        EnvironmentImpl(String var0, String var1, String var2, String var3, String var4, String var5,
                        String var6, String var7, String var8, String var9, String var10, String var11) {
            super(var0, var1, var2, var3, var4, var5, var6, var7, var8, var9, var10, var11);
        }
    }
}
Environment
public abstract class Environment {
    public final String TEST_BASE_VARIABLE;

    public final String APK_BUILD_TYPE;

    public final String API_BASE_URL;

    public final String BANK_SDK_APP_SECRET;

    public final String BANK_SDK_APP_ID;

    public final String WE_CHAT_APP_ID;

    public final String QQ_APP_ID;

    public final String WE_CHAT_APP_SECRET;

    public final String API_VERSION;

    public final String LOCATE_URL;

    public final String QQ_APP_KEY;

    public final String HR_SDK_ENV;

    protected Environment(String var0, String var1, String var2, String var3, String var4,
                          String var5, String var6, String var7, String var8, String var9, String var10, String var11) {
        TEST_BASE_VARIABLE = var0;
        APK_BUILD_TYPE = var1;
        API_BASE_URL = var2;
        BANK_SDK_APP_SECRET = var3;
        BANK_SDK_APP_ID = var4;
        WE_CHAT_APP_ID = var5;
        QQ_APP_ID = var6;
        WE_CHAT_APP_SECRET = var7;
        API_VERSION = var8;
        LOCATE_URL = var9;
        QQ_APP_KEY = var10;
        HR_SDK_ENV = var11;
    }
}

初始化。

在你的Application的onCreate方法中进行初始化。

public class MyApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        EnvConfig.init(this);
    }
}

获取当前环境。

Environment env = EnvConfig.getEnv();
String apiHost = env.API_HOST;
String apiPort = env.API_PORT;
String isRelease = EnvConfig.IS_RELEASE;

TODO("未完待续……")

License

Copyright 2016 [email protected]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

一款可以配置不同Api环境的插件

Resources

Readme
Activity

Stars

7 stars

Watchers

3 watching

Forks

1 fork
Report repository

Releases

1 tags

Packages

No packages published

Languages