[增加]1. 增加环境变量帮助类

Author: AlianBlank

GameFrameX.Utility/EnvironmentHelper.cs

@@ -0,0 +1,68 @@
+// GameFrameX 组织下的以及组织衍生的项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
+// 
+// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE 文件。
+// 
+// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！
+
+using Microsoft.Extensions.Hosting;
+
+namespace GameFrameX.Utility;
+
+/// <summary>
+/// 环境帮助器
+/// </summary>
+public static class EnvironmentHelper
+{
+    /// <summary>
+    /// 判断是否为开发环境
+    /// 通过检查环境变量 ASPNETCORE_ENVIRONMENT 或 DOTNET_ENVIRONMENT 的值是否为 Development
+    /// </summary>
+    /// <returns>如果是开发环境返回true，否则返回false</returns>
+    public static bool IsDevelopment()
+    {
+        var env = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")
+                  ?? Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT");
+
+        return string.Equals(env, Environments.Development, StringComparison.OrdinalIgnoreCase);
+    }
+
+    /// <summary>
+    /// 判断是否为生产环境
+    /// 通过检查环境变量 ASPNETCORE_ENVIRONMENT 或 DOTNET_ENVIRONMENT 的值是否为 Production
+    /// </summary>
+    /// <returns>如果是生产环境返回true，否则返回false</returns>
+    public static bool IsProduction()
+    {
+        var env = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")
+                  ?? Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT");
+
+        return string.Equals(env, Environments.Production, StringComparison.OrdinalIgnoreCase);
+    }
+
+    /// <summary>
+    /// 判断是否为测试/预发布环境
+    /// 通过检查环境变量 ASPNETCORE_ENVIRONMENT 或 DOTNET_ENVIRONMENT 的值是否为 Staging
+    /// </summary>
+    /// <returns>如果是测试/预发布环境返回true，否则返回false</returns>
+    public static bool IsStaging()
+    {
+        var env = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")
+                  ?? Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT");
+
+        return string.Equals(env, Environments.Staging, StringComparison.OrdinalIgnoreCase);
+    }
+
+    /// <summary>
+    /// 判断是否为任意自定义环境
+    /// 通过检查环境变量 ASPNETCORE_ENVIRONMENT 或 DOTNET_ENVIRONMENT 的值是否与指定环境名称匹配
+    /// </summary>
+    /// <param name="environmentName">要检查的环境名称</param>
+    /// <returns>如果当前环境与指定环境名称匹配返回true，否则返回false</returns>
+    public static bool IsEnvironment(string environmentName)
+    {
+        var env = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")
+                  ?? Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT");
+
+        return string.Equals(env, environmentName, StringComparison.OrdinalIgnoreCase);
+    }
+}