Remote Config VS Code 插件教程

# Remote Config VS Code 插件教程

使用 VS Code 并安装此插件，你可以管理存储在 BytePower Remote Config 上的配置文件，功能包括新增、修改、查看文件详情、对比版本差异等。

# 下载 VS Code 并安装插件

# 下载安装 VS Code

VS Code 下载地址 (opens new window)，详细的安装教程请参照官方文档。

# 下载安装插件

插件下载地址（最新版本：0.3.5）

如图所示，打开 VS Code，点击左侧菜单栏 Extensions 图标，然后点击菜单中的 Install from VSIX，选择本地的插件文件即可安装成功。

install_extension

# 更新插件

目前此插件不支持自动更新，所以在新版本的插件发布之后，我们会把最新的插件安装包发给你，你需要做的是卸载，然后安装新的插件。

如图所示，首先点击左侧菜单栏 Extensions 图标，会自动显示已经安装的插件，找到 BytePower Remote Config Assistant，点击设置图标，然后点击 Uninstall。

uninstall

# 插件的初始化配置

在本地创建一个用来存放所有配置文件的空文件夹，并使用 VS Code 打开。
使用 VS Code 在这个空文件夹内再创建一个新的文件夹，命名为 .config，然后选中此文件夹，创建一个新的文件，命名为 .config.json。
在 .config.json 文件中，写入 BytePower Remote Config 相关的配置，请向 BytePower 组的同事申请。内容格式如下：

{
    "environments": [
        {
            "environment_name": "Test", // 配置根环境名称，必须唯一。一般用于区分测试和开发环境，本地会同步生成同名文件夹
            "domain": "console.bytepowerapp.cn", // 配置当前环境的 api 地址的一级域名
            "operator": "someone@ihandysoft.com", // 配置当前环境的操作用户，必须为有效 BP 用户，为空的话仅能执行查询操作，无法上传配置文件
            "applications": [
                {
                    "application_name": "test-app", // 配置 App 名称，必须唯一。用于树形菜单显示，本地会同步生成同名文件夹
                    "application_id": "APP3HGLRQILDI", // 配置 App ID，必须唯一。用于 api 接口访问
                    "ignore_collections": [
                        "prometheus_group" // 配置需要忽略的 collection，用于在树形菜单下隐藏某些不需要显示的项，可选
                    ]
                },
                {
                    "application_name": "prometheus",
                    "application_id": "APPDDT5JEIE"
                }
            ]
        },
        // 可配置多个环境，用名字区分
        ...
    ]
}

完成上述步骤之后，点击插件的图标，完成初始化。如果有报错，请联系 BytePower 组的同事。
此时插件的目录结构如下图所示：
1. 目录的第一级为环境名称，例如图中的 test 和 production。
2. 目录的第二级为 App 的名称，例如图中的 Walk 和 RunFast。
3. 目录的第三级为每个 App 下的配置文件的名称，代表了一类配置文件，例如图中的 walk_configs。
4. 目录的第四级为每个配置文件的 config_id，括号内为本地文件的名称，点击配置文件，在右侧可以看到配置文件的内容。

init_finish

# 管理配置文件

# 下载配置文件

下载配置文件是最常用到的功能，此插件提供了三种不同的下载方式。

下载所有环境、所有 App 的全部配置文件。
下载指定环境下指定 App 的全部配置文件。
下载单个配置文件。

# 下载所有环境、所有 App 的全部配置文件

按钮如下图所示，点击此按钮，插件会同步所有的线上最新配置到本地。

download_config

# 下载指定环境下指定 App 的全部配置文件

按钮如下图所示，点击此按钮，插件会同步指定 App 下的所有线上配置到本地。

download_config

# 下载单个配置文件

选中你想要下载的配置文件，右键点击，然后点击菜单中的 Download from BytePower CMS，如下图所示，插件会把此配置的线上版本到本地。

download_single_config

# 新增配置文件

首先切换到系统文件目录，选中你要增加的配置文件对应的文件夹，创建一个新文件，文件命名的格式推荐使用 <config_id> + .json。例如如果你要增加一个 config_id 为 20 的配置，那么推荐命名为 20.json

new_config_file

编辑完配置文件之后，选中此文件右键点击，出现菜单，然后点击 Upload to BytePower CMS

upload_to_cms

此时在 VS Code 的上方出现输入框，依照输入框内的提示，依次输入此配置文件的 config_id/tag/description，每次填写之后，点击回车完成输入，然后此配置文件会被上传到 BytePower Remote Config。

upload_to_cms_2

注意

同一 App 下同一类配置的多个配置文件，不可以使用相同的 config_id。
新增配置文件填写配置信息时，config_id 为必填项。

# 修改配置文件

修改配置文件分为 3 步

在修改之前，首先需要把 BytePower Remote Config 上最新版本的配置文件下载到本地。
选中要修改的配置文件，进行修改，修改完成后记得按 cmd(ctrl) + s 保存。
在插件的目录中，右键点击修改完成的配置文件，然后点击菜单选项中的 Upload to BytePower CMS，此时在 VS Code 上方出现输入框，可以填写此次更新的记录（选填），填写完按回车上传。

upload_config