使用反射管理参数配置

标签：反射 string AppConfig 配置参数 AppConfigManager property config public

在C#中，反射是一种强大的机制，它允许我们在运行时检查和操作类型的成员，包括属性和字段。利用反射，我们可以实现参数的灵活配置和管理。本篇博客将详细介绍如何使用反射来管理参数配置，并提供一个帮助类的代码示例。

创建参数配置类

首先，我们需要创建一个参数配置类，该类将包含我们希望配置的属性。以一个简单的应用为例，我们创建一个名为AppConfig的类，该类具有以下属性：

public class AppConfig
{
    public string ServerAddress { get; set; }
    public int Port { get; set; }
    public string Username { get; set; }
    public string Password { get; set; }
}

在这个示例中，我们希望配置服务器地址、端口号、用户名和密码。

使用反射读取和设置参数配置

接下来，我们将展示如何使用反射来读取和设置参数配置。我们需要定义一个帮助类，该类将提供读取和设置参数值的方法。

public static class AppConfigManager
{
    // 使用反射设置参数值
    public static void SetConfigValue<T>(object obj, string propertyName, T value)
    {
        PropertyInfo property = obj.GetType().GetProperty(propertyName);
        if (property != null && property.CanWrite)
        {
            property.SetValue(obj, value);
        }
    }

    // 使用反射获取参数值
    public static T GetConfigValue<T>(object obj, string propertyName)
    {
        PropertyInfo property = obj.GetType().GetProperty(propertyName);
        if (property != null && property.CanRead)
        {
            return (T)property.GetValue(obj);
        }
        return default(T);
    }
}

在上述代码中，我们定义了一个AppConfigManager类，它包含了SetConfigValue和GetConfigValue方法。这些方法使用反射来设置和获取参数值。

使用示例

现在，我们可以使用AppConfigManager类来读取和设置参数配置。以下是一个简单的示例：

public class Program
{
    public static void Main(string[] args)
    {
        // 创建参数配置对象
        AppConfig config = new AppConfig();

        // 动态设置参数
        AppConfigManager.SetConfigValue(config, "ServerAddress", "127.0.0.1");
        AppConfigManager.SetConfigValue(config, "Port", 8080);
        AppConfigManager.SetConfigValue(config, "Username", "admin");
        AppConfigManager.SetConfigValue(config, "Password", "password");

        // 动态获取参数
        string serverAddress = AppConfigManager.GetConfigValue<string>(config, "ServerAddress");
        int port = AppConfigManager.GetConfigValue<int>(config, "Port");
        string username = AppConfigManager.GetConfigValue<string>(config, "Username");
        string password = AppConfigManager.GetConfigValue<string>(config, "Password");

        // 输出参数值
        Console.WriteLine("Server Address: " + serverAddress);
        Console.WriteLine("Port: " + port);
        Console.WriteLine("Username: " + username);
        Console.WriteLine("Password: " + password);
    }
}

在上述示例中，我们创建了一个AppConfig对象，并使用AppConfigManager类来设置参数值。然后，我们再次使用AppConfigManager类来获取参数值，并将其输出到控制台。

结论

使用反射可以方便地管理参数配置，使得参数的读取和设置变得灵活和可扩展。我们通过使用AppConfigManager类来演示了如何利用反射来读取和设置参数值。希望本篇博客能够帮助你更好地理解和应用反射机制。

参考资料

Microsoft Docs: System.Reflection Namespace

完整代码

using System;
using System.Reflection;

public class AppConfig
{
    public string ServerAddress { get; set; }
    public int Port { get; set; }
    public string Username { get; set; }
    public string Password { get; set; }
}

public static class AppConfigManager
{
    public static void SetConfigValue<T>(object obj, string propertyName, T value)
    {
        PropertyInfo property = obj.GetType().GetProperty(propertyName);
        if (property != null && property.CanWrite)
        {
            property.SetValue(obj, value);
        }
    }

    public static T GetConfigValue<T>(object obj, string propertyName)
    {
        PropertyInfo property = obj.GetType().GetProperty(propertyName);
        if (property != null && property.CanRead)
        {
            return (T)property.GetValue(obj);
        }
        return default(T);
    }
}

public class Program
{
    public static void Main(string[] args)
    {
        AppConfig config = new AppConfig();

        AppConfigManager.SetConfigValue(config, "ServerAddress", "127.0.0.1");
        AppConfigManager.SetConfigValue(config, "Port", 8080);
        AppConfigManager.SetConfigValue(config, "Username", "admin");
        AppConfigManager.SetConfigValue(config, "Password", "password");

        string serverAddress = AppConfigManager.GetConfigValue<string>(config, "ServerAddress");
        int port = AppConfigManager.GetConfigValue<int>(config, "Port");
        string username = AppConfigManager.GetConfigValue<string>(config, "Username");
        string password = AppConfigManager.GetConfigValue<string>(config, "Password");

        Console.WriteLine("Server Address: " + serverAddress);
        Console.WriteLine("Port: " + port);
        Console.WriteLine("Username: " + username);
        Console.WriteLine("Password: " + password);
    }
}

当需要将配置参数存储到配置文件中时，我们可以使用.NET中提供的配置文件功能来实现。在这种情况下，我们需要对代码进行一些修改和扩展。

首先，我们需要引入System.Configuration命名空间，以便使用配置文件相关的类和接口。然后，我们可以将原先的AppConfig类修改为继承自ConfigurationSection类，同时将其属性标记为ConfigurationProperty。

以下是修改后的代码示例：

using System;
using System.Configuration;
using System.Reflection;

public class AppConfig : ConfigurationSection
{
    [ConfigurationProperty("ServerAddress", DefaultValue = "127.0.0.1", IsRequired = true)]
    public string ServerAddress
    {
        get { return (string)this["ServerAddress"]; }
        set { this["ServerAddress"] = value; }
    }

    [ConfigurationProperty("Port", DefaultValue = 8080, IsRequired = true)]
    public int Port
    {
        get { return (int)this["Port"]; }
        set { this["Port"] = value; }
    }

    [ConfigurationProperty("Username", DefaultValue = "admin", IsRequired = true)]
    public string Username
    {
        get { return (string)this["Username"]; }
        set { this["Username"] = value; }
    }

    [ConfigurationProperty("Password", DefaultValue = "password", IsRequired = true)]
    public string Password
    {
        get { return (string)this["Password"]; }
        set { this["Password"] = value; }
    }
}

public static class AppConfigManager
{
    public static void SetConfigValue<T>(object obj, string propertyName, T value)
    {
        PropertyInfo property = obj.GetType().GetProperty(propertyName);
        if (property != null && property.CanWrite)
        {
            property.SetValue(obj, value);
        }
    }

    public static T GetConfigValue<T>(object obj, string propertyName)
    {
        PropertyInfo property = obj.GetType().GetProperty(propertyName);
        if (property != null && property.CanRead)
        {
            return (T)property.GetValue(obj);
        }
        return default(T);
    }

    public static void SaveConfig(AppConfig config)
    {
        Configuration configManager = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
        configManager.Sections.Remove("AppConfig");
        configManager.Sections.Add("AppConfig", config);
        configManager.Save(ConfigurationSaveMode.Modified);
        ConfigurationManager.RefreshSection("AppConfig");
    }

    public static AppConfig LoadConfig()
    {
        Configuration configManager = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
        return (AppConfig)configManager.GetSection("AppConfig");
    }
}

public class Program
{
    public static void Main(string[] args)
    {
        AppConfig config = AppConfigManager.LoadConfig();

        if (config == null)
        {
            config = new AppConfig();
            AppConfigManager.SaveConfig(config);
        }

        Console.WriteLine("Server Address: " + config.ServerAddress);
        Console.WriteLine("Port: " + config.Port);
        Console.WriteLine("Username: " + config.Username);
        Console.WriteLine("Password: " + config.Password);

        Console.WriteLine("Enter new value for Server Address:");
        string newServerAddress = Console.ReadLine();
        AppConfigManager.SetConfigValue(config, "ServerAddress", newServerAddress);
        AppConfigManager.SaveConfig(config);

        Console.WriteLine("Server Address updated.");

        Console.WriteLine("Server Address: " + config.ServerAddress);
    }
}

在上述代码中，我们修改了AppConfig类，使其继承自ConfigurationSection类，并为每个属性添加了ConfigurationProperty属性，以便将其存储到配置文件中。

AppConfigManager类中新增了SaveConfig方法和LoadConfig方法，用于将配置保存到文件和从文件加载配置。

在Main方法中，我们首先尝试加载配置文件，如果配置文件不存在，则创建一个新的配置，并保存到文件中。然后，我们展示了从配置文件中读取参数配置的示例，并演示了如何动态更新配置参数值，并保存到配置文件中。

希望本篇博客能对你有所帮助！如果有任何问题或建议，请随时提出。

标签：反射,string,AppConfig,配置,参数,AppConfigManager,property,config,public
From： https://www.cnblogs.com/jack-jiang0/p/17610637.html