鸿蒙多环境配置(一)

鸿蒙多环境配置

在实际开发过程中，你是否遇到了如下一些问题。项目分多套环境，如开发环境，生产环境，甚至还有灰度环境，不同的环境请求的服务器地址不一样，不同环境依赖的库也不一样，使用的三库key也不一样。测试会问开发环境的包和生产环境的包可以同时安装在手机上吗，我怎么区分哪个是生产环境的包，开发环境能否加个入口等等。

是否可以使用debug和release来区分不同的环境

大多数情况下，我们可能只需要区分开发环境和生产环境，那么有人会问，只有2套环境，是否可以用debug代表开发环境，release来代表生产环境呢？在代码编译阶段，会生成一个BuildProfile文件，在代码中使用BuildProfile.DEBUG就能区分了。

这种方式在部分场景下也许可行，但有存在一些问题，比如后面在上线前增加灰度环境怎么处理，遇到问题要在生产环境调试怎么办？所以我们并不推荐使用此方式来区分不同的环境，鸿蒙提供了Product和Target概念来很好的处理多环境配置需要。

认识Product和Target

我们将需要编译打包的应用定义为一个Product，当想打多个不同应用时，就可以定义多个不同的Product，执行打包时，也需要选择相应的Product。

每一个Module都可以设定自己的源码目录，资源目录，运行的设备，分发规则等等，我们将这些行为定义成一个Target，不同的Target可以有不同的行为。每一个Target都需要配置应用到哪些Product中，这样就建立了Product与Target的关联关系。

下图是选择Product和Target的方式。

配置多环境产物

如何在手机上同时安装开发包和生产包

要想同时安装开发包和生产包，需要有2个bundleName，我们可以定义2个Product，在Product中设置不同的bundleName，示例如下

{
  "app": {
    "signingConfigs": [],
    "products": [
      {
        "name": "default",//开发环境
        "bundleName": "com.aloe.moment.dev"
      },
      {
        "name": "prod",//生产环境
        "bundleName": "com.aloe.moment"
      }
    ]
  }
}

如何区分开发包和生产包

手机桌面上同时安装了开发包和生产包，该如何区分哪个是生产包呢，是否能对APP设置不同的名称和icon呢？答案是可以的，我们可以在不同的target中设置针对每一个ability设置不同的名称和icon，示例如下

{ 
   "apiType": 'stageMode', 
   "buildOption": { 
   }, 
   "targets": [ 
     { 
       "name": "default", 
       "source": {
        "abilities": [
          {
            "name": "EntryAbility",
            "icon":"$media:layered_image",
            "label":"$string:EntryAbility_label",
            "launchType": "singleton"
          }
        ]
      }
     }, 
     { 
       "name": "prod", 
       "source": {
        "abilities": [
          {
            "name": "EntryAbility",
            "icon":"$media:layered_image",
            "label":"$string:EntryAbility_label",
            "launchType": "multiton"
          }
        ]
      }
     }
   ] 
 }

其实Target还可以定制不同的资源目录，如何我们想针对不同的Product设置不同的名称和icon，完全可以定制不同的资源目录，然后将名称和icon放在不同的资源目录中。示例如下

{
  "apiType": "stageMode",
  "targets": [
    {
      "name": "default",
      "resource": {
        "directories": [
          "./src/default/resources",
          "./src/main/resources"
        ]
      }
    },
    {
      "name": "prod",
      "resource": {
        "directories": [
          "./src/prod/resources",
          "./src/main/resources"
        ]
      }
    }
  ]
}

不同的环境设置不同的参数

在开发过程中，我们经常会根据不同的环境来设置不同的参数，比如debug和release环境，所使用的参数有所不同，或者开发环境与生产环境使用的第三方key有所不同，这些场景都可以通过编译期间生成的BuildProfile来实现，避免直接在代码中判断不同的环境来设置不同的值 。下面以不随环境变化的COMMON_TYPE参数，区分debug和release环境的BUILD_TYPE参数,区分开发环境和生产环境的KEY参数来举例说明

{
  "apiType": "stageMode",
  "buildOption": {
    "arkOptions": {
      "buildProfileFields": {
        "COMMON_TYPE": "common_type"
      }
    }
  },
  "buildOptionSet": [
    {
      "name": "release",
      "arkOptions": {
        "buildProfileFields": {
          "BUILD_TYPE": "build_release"
        }
      }
    },
    {
      "name": "debug",
      "arkOptions": {
        "buildProfileFields": {
          "BUILD_TYPE": "build_debug"
        }
      }
    }
  ],
  "targets": [
    {
      "name": "default",
      "config": {
        "buildOption": {
          "arkOptions": {
            "buildProfileFields": {
              "KEY": "default_key"
            }
          }
        }
      }
    },
    {
      "name": "prod"
      "config": {
        "buildOption": {
          "arkOptions": {
            "buildProfileFields": {
              "KEY": "prod_key"
            }
          }
        }
      }
    }
  ]
}

这样配置后，编译时会自动根据不同的环境来生成不同的参数，在代码中就可以直接使用，不用额外判断环境了。

不同的环境如何区分不同的业务逻辑

现在有这样一个需求，生产环境正常显示APP的版本名称和版本号，开发环境为了区分当前提测包是否为最新包，需要额外显示一个打包时间或最新代码提交时间，这种需求除了在代码中判断环境，还能如何处理呢？测试要求在开发包中额外增加一个配置入口，方便他们直接修改相关配置，可以不判断环境，统一处理吗？

针对上面的问题，我们可以在Target中设置不同的源码目录，然后根据各自的环境，实现不同的业务逻辑。我们先在Target中配置不同的源码目录，示例如下

{
  "apiType": "stageMode",
  "targets": [
    {
      "name": "default",
      "source": {
        "sourceRoots": ["./src/default"]
      }
    },
    {
      "name": "prod",
      "source": {
        "sourceRoots": ["./src/prod"]
      }
    }
  ]
}

然后在各自的源码目录中实现相关逻辑，我们以实现一个AppUtil.getName获取名称和testConfig添加测试配置入口为例，相关代码如下

//开发环境的实现
export namespace AppUtil{
  export function getName():string{
    return 'develop'
  }
}
@Builder
export function testConfig(){
  Button('测试入口')
}

//生产环境的实现
export namespace AppUtil{
  export function getName():string{
    return 'produce'
  }
}
@Builder
export function testConfig(){}

在页面中使用方式如下

import { AppUtil,testConfig } from 'entry/ets/utils/AppUtil';

@Entry
@Component
struct Index {

  build() {
    Column() {
      Text(AppUtil.getName())
      testConfig()
    }
    .height('100%')
    .width('100%')
  }
}

最终运行到手机上的效果是开发环境界面显示develop并在下方显示了一个测试入口的按钮，而在生产环境仅显示了produce，没有显示测试入口的按钮。