前端应用中沙盒与生产环境的动态切换与API管理教程

// environment.js

// 定义环境类型常量
const ENVS = {
  LOCAL: "local",
  SANDBOX: "sandbox",
  PROD: "prod",
};

// 定义不同环境的详细配置
const Environments = {
  Sandbox: {
    name: "Sandbox",
    env: ENVS.SANDBOX,
    apiHost: "http://156.21.190.78", // 沙盒环境API主机
    apiBase: "/api/v1", // API基础路径
  },
  Prod: {
    name: "Production",
    env: ENVS.PROD,
    apiHost: "http://156.23.190.78", // 生产环境API主机
    apiBase: "/api/v1",
  },
  // 可以根据需要添加更多环境，例如 Local
  // Local: {
  //   name: "Local",
  //   env: ENVS.LOCAL,
  //   apiHost: "http://localhost:8000",
  //   apiBase: "/api/v1",
  // },
};

// 存储当前激活的环境
const Environment = {
  current: Environments.Prod, // 默认设置为生产环境
};

// 定义主机名匹配规则，用于自动检测环境
const ENV_MATCHERS = {
  [ENVS.LOCAL]: ["localhost", "127.0.0.1"],
  [ENVS.SANDBOX]: ["sandbox"], // 例如，如果URL包含"sandbox"子域名
};

/**
 * 判断当前主机URL是否匹配特定环境
 * @param {string} hostUrl - 当前应用的主机URL
 * @param {string} environment - 要匹配的环境类型 (ENVS.LOCAL, ENVS.SANDBOX等)
 * @returns {boolean} - 是否匹配
 */
const isEnv = (hostUrl, environment) => {
  const matchers = ENV_MATCHERS[environment];
  if (!matchers) {
    console.warn(`Critical: No matchers defined for environment: ${environment}`);
    return false; // 或者抛出错误
  }
  return matchers.some((match) => hostUrl.includes(match));
};

/**
 * 根据主机URL初始化当前环境
 * @param {string} host - 主机URL字符串
 * @returns {string} - 初始化后的环境类型
 */
const initEnv = (host) => {
  // 优先匹配本地开发环境
  if (isEnv(host, ENVS.LOCAL)) {
    // Environment.current = Environments.Local; // 如果有Local环境，则取消注释
    return ENVS.LOCAL;
  }
  // 其次匹配沙盒环境
  if (isEnv(host, ENVS.SANDBOX)) {
    Environment.current = Environments.Sandbox;
    return ENVS.SANDBOX;
  }
  // 默认设置为生产环境
  Environment.current = Environments.Prod;
  return ENVS.PROD;
};

/**
 * 重新加载环境配置
 * @param {string} [envType=''] - 可选参数，指定要切换到的环境类型，如 "sandbox" 或 "Production"
 */
const reloadEnvironmentConfig = (envType = '') => {
  if (envType) {
    // 如果指定了环境类型，则直接切换
    const targetEnv = Object.values(Environments).find(e => e.name.toLowerCase() === envType.toLowerCase() || e.env === envType.toLowerCase());
    if (targetEnv) {
      Environment.current = targetEnv;
      return targetEnv.env;
    } else {
      console.warn(`Environment type "${envType}" not found. Falling back to host detection.`);
    }
  }
  // 如果未指定或指定的环境不存在，则根据当前浏览器host自动检测
  return initEnv(window.location.host);
};

// 应用启动时自动加载一次环境配置
reloadEnvironmentConfig();

export { Environment, reloadEnvironmentConfig, ENVS, Environments };

// App.jsx 或您的仪表盘组件

import React, { useState, useEffect } from "react";
import { Switch, Text, Flex, Button } from "@chakra-ui/react";
import { Environment, reloadEnvironmentConfig, Environments } from "./environment"; // 导入环境管理模块

function App() {
  // 使用 useState 跟踪当前环境的名称，用于UI显示
  const [currentEnvName, setCurrentEnvName] = useState(Environment.current.name);

  // 根据当前环境名称判断 Switch 的状态
  const isSandboxMode = currentEnvName === Environments.Sandbox.name;

  // 切换模式的函数
  const switchMode = () => {
    // 根据当前模式决定切换到哪个环境
    const targetEnv = isSandboxMode ? Environments.Prod.name : Environments.Sandbox.name;

    // 调用 reloadEnvironmentConfig 切换全局环境
    reloadEnvironmentConfig(targetEnv);

    // 更新 UI 状态
    setCurrentEnvName(Environment.current.name);
  };

  return (
    <Flex align="center" justify="center" p={4}>
      <Text fontSize={15} mr={2}>
        {currentEnvName === Environments.Sandbox.name ? "Sandbox" : "Production"}
      </Text>
      <Switch
        isChecked={isSandboxMode} // 控制 Switch 的选中状态
        onChange={switchMode}    // 绑定切换事件
        colorScheme="teal"       // Chakra UI 颜色方案
      />
      <Text ml={4}>当前环境: {currentEnvName}</Text>
      {/* 可以在这里展示根据环境加载的数据 */}
      <Button ml={4} onClick={() => console.log("重新加载数据，当前环境API:", Environment.current.apiHost + Environment.current.apiBase)}>
        重新加载数据
      </Button>
    </Flex>
  );
}

export default App;

// api.js

import axios from "axios";
import { Environment } from "./environment"; // 导入环境管理模块

export class Api {
  /**
   * 获取当前环境的API基础URL
   * @returns {string} - 完整的API基础URL
   */
  static getBaseUrl() {
    const { apiHost, apiBase } = Environment.current;
    if (!apiHost || !apiBase) {
      console.error("当前环境API配置不完整:", Environment.current);
      throw new Error("API配置错误：缺少apiHost或apiBase");
    }
    return apiHost + apiBase;
  }

  /**
   * 发起GET请求
   * @param {string} urlPath - API路径，例如 "/customer/paginate-customer"
   * @param {object} config - Axios请求配置
   * @returns {Promise} - Axios响应Promise
   */
  static get(urlPath, config) {
    const fullUrl = Api.getBaseUrl() + urlPath;
    return axios.get(fullUrl, config);
  }

  // 可以根据需要添加其他HTTP方法，如 post, put, delete 等
  static post(urlPath, data, config) {
    const fullUrl = Api.getBaseUrl() + urlPath;
    return axios.post(fullUrl, data, config);
  }

  // ... 其他方法
}

// customerService.js 或您的API服务文件

import { Api } from "./api"; // 导入抽象API类

const getAllCustomers = async (rows, page, token) => {
  const config = {
    headers: {
      Authorization: `Bearer ${token}`,
    },
  };
  // 使用 Api.get() 发起请求，它会自动使用当前激活的环境API
  const response = await Api.get(
    `/customer/paginate-customer?page=${page}&rows=${rows}`,
    config
  );
  return response.data;
};

// 导出函数供其他组件使用
export { getAllCustomers };