##鸿蒙核心技术##运动开发#

在开发鸿蒙运动项目时，管理不同运行环境（如开发环境、测试环境、生产环境）是一个常见的需求。通过合理地切换运行环境，开发者可以方便地进行调试、测试和部署。本文将介绍如何实现一个项目运行环境切换器，帮助你在鸿蒙开发中高效地管理不同环境的配置。

前言

在现代软件开发中，环境管理是确保应用稳定性和可维护性的关键环节之一。无论是开发、测试还是生产环境，每个环境都可能有不同的配置需求，例如 API 地址、日志级别、功能开关等。通过实现一个运行环境切换器，我们可以轻松地在不同环境之间切换，而无需修改代码，从而提高开发效率和灵活性。
在这里插入图片描述

一、环境切换器的设计

（一）环境配置类型

为了支持不同环境的配置，我们定义了 EnvironmentConfigs 和 CurrentEnvironment 类型。

export type EnvironmentConfigs = Map<string, Map<string, string>>;export interface CurrentEnvironment {name: string;configs: Map<string, string>;
}

核心点解析：

EnvironmentConfigs：一个映射表，键为环境名称（如 production、development），值为该环境的配置映射表。
CurrentEnvironment：表示当前环境的名称和配置。

（二）环境类型枚举

我们通过枚举定义了支持的环境类型。

export enum EnvironmentType {TYPE_PRODUCTION = "production",TYPE_DEVELOP = "develop"
}

核心点解析：

枚举类型：通过枚举定义了两种环境类型：生产环境（production）和开发环境（develop）。可以根据需要扩展更多环境类型。

（三）环境管理类

环境管理类 Environment 是整个环境切换器的核心。它负责存储环境配置、加载保存的环境、切换环境以及通知回调。

export class Environment {private static instance: Environment;private static readonly ENVIRONMENT_STORAGE_KEY = 'current_environment';private currentEnvironment?: CurrentEnvironment;private environments: EnvironmentConfigs = new Map();private preferences: LibPreferencesSync;private environmentChangeCallbacks: Array<(newEnvironment: CurrentEnvironment) => void> = [];private constructor() {this.preferences = new LibPreferencesSync();}public static getInstance(): Environment {if (!Environment.instance) {Environment.instance = new Environment();}return Environment.instance;}public initEnvironments(evn: EnvironmentConfigs) {this.environments = evn;this.loadSavedEnvironment();}private loadSavedEnvironment() {if (!IS_PRODUCTION) {const savedEnvironmentName = this.preferences.getValue(Environment.ENVIRONMENT_STORAGE_KEY) as string;if (savedEnvironmentName && this.environments.has(savedEnvironmentName)) {this.currentEnvironment = {name: savedEnvironmentName,configs: this.environments.get(savedEnvironmentName)!};} else {this.currentEnvironment = {name: EnvironmentType.TYPE_DEVELOP,configs: this.environments.get(EnvironmentType.TYPE_DEVELOP)!};}} else {this.currentEnvironment = {name: EnvironmentType.TYPE_PRODUCTION,configs: this.environments.get(EnvironmentType.TYPE_PRODUCTION)!};}}public switchEnvironment(name: string) {const configs = this.environments.get(name);if (configs) {this.currentEnvironment = { name, configs };this.preferences.saveKeyValue(Environment.ENVIRONMENT_STORAGE_KEY, name);this.environmentChangeCallbacks.forEach(callback => callback(this.currentEnvironment!));}}public getCurrentEnvironment(): CurrentEnvironment {return this.currentEnvironment!;}public getAllEnvironmentNames(): string[] {return Array.from(this.environments.keys());}public registerEnvironmentChangeCallback(callback: (newEnvironment: CurrentEnvironment) => void) {this.environmentChangeCallbacks.push(callback);}public unregisterEnvironmentChangeCallback(callback: (newEnvironment: CurrentEnvironment) => void) {this.environmentChangeCallbacks = this.environmentChangeCallbacks.filter(cb => cb !== callback);}
}

核心点解析：

单例模式：通过 getInstance 方法确保 Environment 的全局唯一性。
环境初始化：通过 initEnvironments 方法初始化环境配置。
加载保存的环境：在 loadSavedEnvironment 方法中，根据存储的环境名称加载对应的环境配置。
环境切换：通过 switchEnvironment 方法切换环境，并通知所有注册的回调函数。
回调机制：支持注册和注销环境切换回调，方便在环境切换时执行相关操作。

二、环境切换器的使用

（一）环境切换对话框

为了方便用户切换环境，我们实现了一个环境切换对话框 EnvironmentDialog。

@CustomDialog
export struct EnvironmentDialog {public controller: CustomDialogController;private themeManager: ThemeManager = ThemeManager.getInstance();private environment: Environment = Environment.getInstance();public onEnvironmentChanged?: () => void;build() {Column() {Text('选择环境').fontSize(20).fontWeight(FontWeight.Bold).fontColor(this.themeManager.getTextPrimaryColor()).margin({ top: 24, bottom: 16 })List() {ForEach(this.environment.getAllEnvironmentNames(), (envname: string) => {ListItem() {Row() {Column() {Text(envname).fontSize(16).fontColor(this.themeManager.getTextPrimaryColor()).margin({ bottom: 4 })}.alignItems(HorizontalAlign.Start).layoutWeight(1)if (this.environment.getCurrentEnvironment().name === envname) {Image($r('app.media.base_icon_select')).width(24).height(24).margin({ left: 8 })}}.width('100%').padding(16).backgroundColor(this.themeManager.getSurfaceColor()).borderRadius(8).onClick(() => {this.environment.switchEnvironment(envname);this.onEnvironmentChanged?.();this.controller.close();})}.margin({ bottom: 8 })}, (envname: string) => envname)}.width('100%').layoutWeight(1)Button('关闭').width('100%').height(48).backgroundColor(this.themeManager.getPrimaryColor()).margin({ top: 16 }).onClick(() => {this.controller.close();})}.width('90%').padding(16).backgroundColor(this.themeManager.getBackgroundColor()).borderRadius(16)}
}

核心点解析：

环境列表：通过 ForEach 遍历所有环境名称，并为每个环境生成一个列表项。
当前环境标识：如果当前环境与列表项环境一致，则显示选中图标。
环境切换：点击列表项时，调用 switchEnvironment 方法切换环境，并关闭对话框。
回调通知：环境切换后，调用 onEnvironmentChanged 回调函数，通知外部环境已切换。

（二）环境切换的回调机制

为了在环境切换时执行相关操作，我们可以通过注册回调函数来实现。

const environment = Environment.getInstance();environment.registerEnvironmentChangeCallback((newEnvironment) => {console.log(`环境已切换到: ${newEnvironment.name}`);// 在这里执行环境切换后的相关操作，例如重新加载配置、刷新界面等
});