一种环境变量替换使用的方法、系统、设备和存储介质

技术领域

本领域涉及应用开发领域，更具体地，特别是指一种环境变量替换使用的方法、系统、设备和存储介质。

背景技术

ICM平台(浪潮自主研发设计的云海管理平台)UI(User Interface，用户界面)是使用react进行构建开发，通过Kubernetes部署。服务新功能开发完成过程中会被依次部署到研发环境开发测试，测试环境验收和生产环境使用。

多个不同使用场景决定了变量的使用不能采取值写死的方式，因此希望找到一种动态替换的方式满足需求，希望能够将React应用程序使用Docker(容器)运行，只构建一次，能够在任何地方运行，并且希望在运行时提供重新配置容器的时机，允许在docker-compose(容器组成)文件内进行变量配置。

React应用在开发中，有两种不同的环境变量。一种是在编译时已经确定的环境变量，通过类似config.js的配置文件进行配置；而另一种是在部署时(运行时)才确定的环境变量，比较常见的是根据环境进行区分的一些变量，比如API(Application ProgrammingInterface，应用程序接口)请求地址前缀，根据部署的环境不同而不同。当前端镜像生成后，需要通过外部去注入这个变量。

多数方案将两种环境变量混合在一起，导致很难区分编译时已经确定的环境变量和部署时确定的环境变量，也就无法确定可以注入修改的环境变量。以下面代码为例：

let env＝process.env.NODE_ENV

let baseUrl＝”

if(env＝＝＝'development'){

baseUrl＝urlDev

}else if(env＝＝＝'production'){

baseUrl＝urlProd

}

可以非常明显的看出，上述代码中的环境变量需要通过不同的环境来确定编译时已经确定的环境变量和部署时确定的环境变量。

发明内容

有鉴于此，本发明实施例的目的在于提出一种环境变量替换使用的方法、系统、计算机设备及计算机可读存储介质，本发明通过将初始环境变量和注入环境变量合并生成最终环境变量对象，并将最终环境变量对象放入系统根目录下，使得在多个环境的部署过程中，只需要构建一次最终环境变量对象，简化了应用部署安装流程。

基于上述目的，本发明实施例的一方面提供了一种环境变量替换使用的方法，包括如下步骤：判断用户根目录下是否存在环境变量文件；响应于用户根目录下存在环境变量文件，将所述环境变量文件复制到系统根目录下；合并初始环境变量和所述环境变量文件生成最终环境变量对象，并判断React应用当前是本地启动还是生产环境打包；以及响应于React应用当前是本地启动，将所述最终环境变量对象放入所述系统根目录下。

在一些实施方式中，方法还包括：响应于React应用当前是生产环境打包，将所述最终环境变量对象放入所述系统根目录下，并复制所述环境变量文件、初始环境变量和最终环境变量对象到dist目录下。

在一些实施方式中，所述合并初始环境变量和所述环境变量文件生成最终环境变量对象包括：设置初始全局变量，并根据所述初始环境变量和所述环境变量文件的键将所述初始全局变量生成最终的全局变量。

在一些实施方式中，所述根据所述初始环境变量和所述环境变量文件的键将所述初始全局变量生成最终的全局变量包括：读取并比对所述初始环境变量和所述环境变量文件，响应于存在新的环境变量，将所述新的环境变量的值替换所述初始全局变量中键值对中的值。

本发明实施例的另一方面，提供了一种环境变量替换使用的系统，包括：判断模块，配置用于判断用户根目录下是否存在环境变量文件；复制模块，配置用于响应于用户根目录下存在环境变量文件，将所述环境变量文件复制到系统根目录下；合并模块，配置用于合并初始环境变量和所述环境变量文件生成最终环境变量对象，并判断React应用当前是本地启动还是生产环境打包；以及执行模块，配置用于响应于React应用当前是本地启动，将所述最终环境变量对象放入所述系统根目录下。

在一些实施方式中，系统还包括第二执行模块，配置用于：响应于React应用当前是生产环境打包，将所述最终环境变量对象放入所述系统根目录下，并复制所述环境变量文件、初始环境变量和最终环境变量对象到dist目录下。

在一些实施方式中，所述合并模块配置用于：设置初始全局变量，并根据所述初始环境变量和所述环境变量文件的键将所述初始全局变量生成最终的全局变量。

在一些实施方式中，所述合并模块配置用于：读取并比对所述初始环境变量和所述环境变量文件，响应于存在新的环境变量，将所述新的环境变量的值替换所述初始全局变量中键值对中的值。

本发明实施例的又一方面，还提供了一种计算机设备，包括：至少一个处理器；以及存储器，所述存储器存储有可在所述处理器上运行的计算机指令，所述指令由所述处理器执行时实现如上方法的步骤。

本发明实施例的再一方面，还提供了一种计算机可读存储介质，计算机可读存储介质存储有被处理器执行时实现如上方法步骤的计算机程序。

本发明具有以下有益技术效果：通过将初始环境变量和注入环境变量合并生成最终环境变量对象，并将最终环境变量对象放入系统根目录下，使得在多个环境的部署过程中，只需要构建一次最终环境变量对象，简化了应用部署安装流程。

附图说明

为了更清楚地说明本发明实施例中的技术方案，下面将对实施例中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的实施例。

图1为本发明提供的环境变量替换使用的方法的实施例的示意图；

图2为本发明提供的环境变量替换使用的系统的实施例的示意图；

图3为本发明提供的环境变量替换使用的计算机设备的实施例的硬件结构示意图；

图4为本发明提供的环境变量替换使用的计算机存储介质的实施例的示意图。

具体实施方式

为使本发明的目的、技术方案和优点更加清楚明白，以下结合具体实施例，并参照附图，对本发明实施例进一步详细说明。

需要说明的是，本发明实施例中所有使用“第一”和“第二”的表述均是为了区分两个相同名称非相同的实体或者非相同的参量，可见“第一”“第二”仅为了表述的方便，不应理解为对本发明实施例的限定，后续实施例对此不再一一说明。

本发明实施例的第一个方面，提出了一种环境变量替换使用的方法的实施例。图1示出的是本发明提供的环境变量替换使用的方法的实施例的示意图。如图1所示，本发明实施例可以包括如下步骤：

S1、判断用户根目录下是否存在环境变量文件；

S2、响应于用户根目录下存在环境变量文件，将所述环境变量文件复制到系统根目录下；

S3、合并初始环境变量和所述环境变量文件生成最终环境变量对象，并判断React应用当前是本地启动还是生产环境打包；以及

S4、响应于React应用当前是本地启动，将所述最终环境变量对象放入所述系统根目录下。

React是用于构建用户界面的JavaScript库。React主要用于构建用户界面，可以在React里传递多种类型的参数，如声明代码，帮助渲染出用户界面，也可以是静态的HTML(Hypertext Markup Language，超文本标记语言)DOM元素，还可以传递动态变量或者可交互的应用组件。Kubernetes简称K8s，是一个开源的、用于管理云平台中多个主机上的容器化的应用。Kubernetes的目标是让部署容器化的应用简单并且高效。

本发明实施例提出了在使用react进行应用开发时对环境变量进行替换使用的方案，该方案可以在运行时配置，所以不需要针对每个环境都进行构建。本发明实施例使用shell脚本的方式，直接生成js文件，通过window.env＝{}来注入一个全局的变量，使用时只要通过window._env_yourVarName来获取即可。

本发明实施例中具体可包括如下几个文件：

.default.env：该文件一般是一些初始环境变量的默认值，目前包括一些原有的环境变量，达到平滑升级的效果；

.env：用户使用的环境变量文件，用户可以在该文件中以键＝值的形式声明环境变量；

\env-config.js：通过运行shell脚本后生成的最终环境变量对象；

env.sh：合并脚本，进行用户环境变量和注入环境变量的合并。

判断React应用当前是本地启动还是生产环境打包，响应于React应用当前是本地启动，判断用户根目录下是否存在环境变量文件。当为本地启动(start，development)时，在用户根目录下进行查找是否有环境变量文件.env。

响应于用户根目录下存在环境变量文件，将所述环境变量文件复制到系统根目录下。如果用户根目录下有环境变量文件.env，将环境变量文件复制到系统根目录@inspur/boot下，与合并脚本env.sh同级。

合并初始环境变量和所述环境变量文件生成最终环境变量对象，并将所述最终环境变量对象放入所述系统根目录下。采用合并脚本env.sh合并初始环境变量和所述环境变量文件生成最终环境变量对象。根据合并脚本中的逻辑，合并.default.env和.env的环境变量，也即是合并初始环境变量和用户环境变量以生成最终环境变量对象env-config.js。将env-config.js放入到同级目录下，由于该目录被设置为contentBase(基本目录)，所以启动的代码中能够加载到该目录。

在一些实施方式中，所述合并初始环境变量和所述环境变量文件生成最终环境变量对象包括：设置初始全局变量，并根据所述初始环境变量和所述环境变量文件的键将所述初始全局变量生成最终的全局变量。编写env.sh脚本，该脚本用于环境变量的合并与替换。在项目根目录下(和package.json同级)创建.env文件(如果没有自定义环境变量可以不创建)。以键＝值的形式写入变量，如SERVER＝http://inspur.com.cn；AUTH_URL＝https://api.inspur.com.cn/oauth/login。一般环境变量都是以字符形式注入的，非字符形式可以通过config.js进行处理(如钩子函数等)，或者通过序列化来进行处理(JSON.stringfiy)。

具体的，编写env.sh脚本的步骤可以如下：创建env-config.js文件，创建全局变量window.env，遍历.default.env，如果存在环境变量，则写入键：环境变量值，不存在则写入键：值；遍历.env，处理逻辑同上(这里使用了js对象重复声明一个值，后面的会覆盖前面的特性)。

在一些实施方式中，所述根据所述初始环境变量和所述环境变量文件的键将所述初始全局变量生成最终的全局变量包括：读取并比对所述初始环境变量和所述环境变量文件，响应于存在新的环境变量，将所述新的环境变量的值替换所述初始全局变量中键值对中的值。根据.default.env和.env的键去生成window._env_对象，此时有环境变量则替换为环境变量，无环境变量则使用原来键值对中的值，生成的env-config.js在同级目录下。

在一些实施方式中，方法还包括：响应于React应用当前是生产环境打包，将所述最终环境变量对象放入所述系统根目录下，并复制所述环境变量文件、初始环境变量和最终环境变量对象到dist目录下。

当React应用为生产环境打包(build，product)时，由于启动的代码中不能加载到放入最终环境变量对象的目录，因此需要复制.env、.default.env、env.shell和env-config.js到dist目录下。具体的，在用户根目录下进行查找是否有.env文件，如果有.env文件，复制到@inspur/boot根目录下，与env.sh同级，根据shell中的逻辑，合并.default.env和.env的环境变量生成env-config.js到同级目录下，复制.env、.default.env、env.shell和env-config.js到dist目录下，与index.html同级。

本发明实施例通过将初始环境变量和注入环境变量合并生成最终环境变量对象，并将最终环境变量对象放入系统根目录下，使得在多个环境的部署过程中，只需要构建一次最终环境变量对象，简化了应用部署安装流程。

需要特别指出的是，上述环境变量替换使用的方法的各个实施例中的各个步骤均可以相互交叉、替换、增加、删减，因此，这些合理的排列组合变换之于环境变量替换使用的方法也应当属于本发明的保护范围，并且不应将本发明的保护范围局限在实施例之上。

基于上述目的，本发明实施例的第二个方面，提出了一种环境变量替换使用的系统。如图2所示，系统200包括如下模块：判断模块，配置用于判断用户根目录下是否存在环境变量文件；复制模块，配置用于响应于用户根目录下存在环境变量文件，将所述环境变量文件复制到系统根目录下；合并模块，配置用于合并初始环境变量和所述环境变量文件生成最终环境变量对象，并判断React应用当前是本地启动还是生产环境打包；以及执行模块，配置用于响应于React应用当前是本地启动，将所述最终环境变量对象放入所述系统根目录下。

在一些实施方式中，系统还包括第二执行模块，配置用于：响应于React应用当前是生产环境打包，将所述最终环境变量对象放入所述系统根目录下，并复制所述环境变量文件、初始环境变量和最终环境变量对象到dist目录下。

在一些实施方式中，所述合并模块配置用于：设置初始全局变量，并根据所述初始环境变量和所述环境变量文件的键将所述初始全局变量生成最终的全局变量。

在一些实施方式中，所述合并模块配置用于：读取并比对所述初始环境变量和所述环境变量文件，响应于存在新的环境变量，将所述新的环境变量的值替换所述初始全局变量中键值对中的值。

本发明实施例通过将初始环境变量和注入环境变量合并生成最终环境变量对象，并将最终环境变量对象放入系统根目录下，使得在多个环境的部署过程中，只需要构建一次最终环境变量对象，简化了应用部署安装流程。

基于上述目的，本发明实施例的第三个方面，提出了一种计算机设备，包括：至少一个处理器；以及存储器，存储器存储有可在处理器上运行的计算机指令，指令由处理器执行以实现如下步骤：S1、判断用户根目录下是否存在环境变量文件；S2、响应于用户根目录下存在环境变量文件，将所述环境变量文件复制到系统根目录下；S3、合并初始环境变量和所述环境变量文件生成最终环境变量对象，并判断React应用当前是本地启动还是生产环境打包；以及S4、响应于React应用当前是本地启动，将所述最终环境变量对象放入所述系统根目录下。

在一些实施方式中，步骤还包括：响应于React应用当前是生产环境打包，将所述最终环境变量对象放入所述系统根目录下，并复制所述环境变量文件、初始环境变量和最终环境变量对象到dist目录下。

在一些实施方式中，所述合并初始环境变量和所述环境变量文件生成最终环境变量对象包括：设置初始全局变量，并根据所述初始环境变量和所述环境变量文件的键将所述初始全局变量生成最终的全局变量。

在一些实施方式中，所述根据所述初始环境变量和所述环境变量文件的键将所述初始全局变量生成最终的全局变量包括：读取并比对所述初始环境变量和所述环境变量文件，响应于存在新的环境变量，将所述新的环境变量的值替换所述初始全局变量中键值对中的值。

本发明实施例通过将初始环境变量和注入环境变量合并生成最终环境变量对象，并将最终环境变量对象放入系统根目录下，使得在多个环境的部署过程中，只需要构建一次最终环境变量对象，简化了应用部署安装流程。

如图3所示，为本发明提供的上述环境变量替换使用的计算机设备的一个实施例的硬件结构示意图。

以如图3所示的装置为例，在该装置中包括一个处理器301以及一个存储器302。

处理器301和存储器302可以通过总线或者其他方式连接，图3中以通过总线连接为例。

存储器302作为一种非易失性计算机可读存储介质，可用于存储非易失性软件程序、非易失性计算机可执行程序以及模块，如本申请实施例中的环境变量替换使用的方法对应的程序指令/模块。处理器301通过运行存储在存储器302中的非易失性软件程序、指令以及模块，从而执行服务器的各种功能应用以及数据处理，即实现上述方法实施例的环境变量替换使用的方法。

环境变量替换使用的方法包括如下步骤：判断用户根目录下是否存在环境变量文件；响应于用户根目录下存在环境变量文件，将所述环境变量文件复制到系统根目录下；合并初始环境变量和所述环境变量文件生成最终环境变量对象，并判断React应用当前是本地启动还是生产环境打包；以及响应于React应用当前是本地启动，将所述最终环境变量对象放入所述系统根目录下。

在一些实施方式中，方法还包括：响应于React应用当前是生产环境打包，将所述最终环境变量对象放入所述系统根目录下，并复制所述环境变量文件、初始环境变量和最终环境变量对象到dist目录下。

在一些实施方式中，所述合并初始环境变量和所述环境变量文件生成最终环境变量对象包括：设置初始全局变量，并根据所述初始环境变量和所述环境变量文件的键将所述初始全局变量生成最终的全局变量。

在一些实施方式中，所述根据所述初始环境变量和所述环境变量文件的键将所述初始全局变量生成最终的全局变量包括：读取并比对所述初始环境变量和所述环境变量文件，响应于存在新的环境变量，将所述新的环境变量的值替换所述初始全局变量中键值对中的值。

本发明实施例通过将初始环境变量和注入环境变量合并生成最终环境变量对象，并将最终环境变量对象放入系统根目录下，使得在多个环境的部署过程中，只需要构建一次最终环境变量对象，简化了应用部署安装流程。

存储器302可以包括存储程序区和存储数据区，其中，存储程序区可存储操作系统、至少一个功能所需要的应用程序；存储数据区可存储根据环境变量替换使用的方法的使用所创建的数据等。此外，存储器302可以包括高速随机存取存储器，还可以包括非易失性存储器，例如至少一个磁盘存储器件、闪存器件、或其他非易失性固态存储器件。在一些实施例中，存储器302可选包括相对于处理器301远程设置的存储器，这些远程存储器可以通过网络连接至本地模块。上述网络的实例包括但不限于互联网、企业内部网、局域网、移动通信网及其组合。

一个或者多个环境变量替换使用的方法对应的计算机指令303存储在存储器302中，当被处理器301执行时，执行上述任意方法实施例中的环境变量替换使用的方法。

执行上述环境变量替换使用的方法的计算机设备的任何一个实施例，可以达到与之对应的前述任意方法实施例相同或者相类似的效果。

本发明还提供了一种计算机可读存储介质，计算机可读存储介质存储有被处理器执行时执行如上环境变量替换使用的方法的计算机程序。

环境变量替换使用的方法包括如下步骤：判断用户根目录下是否存在环境变量文件；响应于用户根目录下存在环境变量文件，将所述环境变量文件复制到系统根目录下；合并初始环境变量和所述环境变量文件生成最终环境变量对象，并判断React应用当前是本地启动还是生产环境打包；以及响应于React应用当前是本地启动，将所述最终环境变量对象放入所述系统根目录下。

在一些实施方式中，方法还包括：响应于React应用当前是生产环境打包，将所述最终环境变量对象放入所述系统根目录下，并复制所述环境变量文件、初始环境变量和最终环境变量对象到dist目录下。

在一些实施方式中，所述合并初始环境变量和所述环境变量文件生成最终环境变量对象包括：设置初始全局变量，并根据所述初始环境变量和所述环境变量文件的键将所述初始全局变量生成最终的全局变量。

在一些实施方式中，所述根据所述初始环境变量和所述环境变量文件的键将所述初始全局变量生成最终的全局变量包括：读取并比对所述初始环境变量和所述环境变量文件，响应于存在新的环境变量，将所述新的环境变量的值替换所述初始全局变量中键值对中的值。

本发明实施例通过将初始环境变量和注入环境变量合并生成最终环境变量对象，并将最终环境变量对象放入系统根目录下，使得在多个环境的部署过程中，只需要构建一次最终环境变量对象，简化了应用部署安装流程。

如图4所示，其示出了本发明提供的上述环境变量替换使用的计算机存储介质的一个实施例的示意图。以如图4所示的计算机存储介质为例，计算机可读存储介质401存储有被处理器执行时执行如上方法的计算机程序402。

最后需要说明的是，本领域普通技术人员可以理解实现上述实施例方法中的全部或部分流程，可以通过计算机程序来指令相关硬件来完成，环境变量替换使用的方法的程序可存储于一计算机可读取存储介质中，该程序在执行时，可包括如上述各方法的实施例的流程。其中，程序的存储介质可为磁碟、光盘、只读存储记忆体(ROM)或随机存储记忆体(RAM)等。上述计算机程序的实施例，可以达到与之对应的前述任意方法实施例相同或者相类似的效果。

以上是本发明公开的示例性实施例，但是应当注意，在不背离权利要求限定的本发明实施例公开的范围的前提下，可以进行多种改变和修改。根据这里描述的公开实施例的方法权利要求的功能、步骤和/或动作不需以任何特定顺序执行。此外，尽管本发明实施例公开的元素可以以个体形式描述或要求，但除非明确限制为单数，也可以理解为多个。

应当理解的是，在本文中使用的，除非上下文清楚地支持例外情况，单数形式“一个”旨在也包括复数形式。还应当理解的是，在本文中使用的“和/或”是指包括一个或者一个以上相关联地列出的项目的任意和所有可能组合。

上述本发明实施例公开实施例序号仅仅为了描述，不代表实施例的优劣。

本领域普通技术人员可以理解实现上述实施例的全部或部分步骤可以通过硬件来完成，也可以通过程序来指令相关的硬件完成，程序可以存储于一种计算机可读存储介质中，上述提到的存储介质可以是只读存储器，磁盘或光盘等。

所属领域的普通技术人员应当理解：以上任何实施例的讨论仅为示例性的，并非旨在暗示本发明实施例公开的范围(包括权利要求)被限于这些例子；在本发明实施例的思路下，以上实施例或者不同实施例中的技术特征之间也可以进行组合，并存在如上的本发明实施例的不同方面的许多其它变化，为了简明它们没有在细节中提供。因此，凡在本发明实施例的精神和原则之内，所做的任何省略、修改、等同替换、改进等，均应包含在本发明实施例的保护范围之内。