C#简单配置类及数据绑定

简介

本文实现一个简单的配置类,原理比较简单,适用于一些小型项目。主要实现以下功能:

  • 保存配置到json文件
  • 从文件或实例加载配置类的属性值
  • 数据绑定到界面控件

一般情况下,项目都会提供配置的设置界面,很少手动更改配置文件,所以选择以json文件保存配置数据。

配置基类

为了方便管理,项目中的配置一般是按用途划分到不同的配置类中,保存时也是保存到多个配置文件。所以,我们需要实现一个配置基类,然后再派生出不同用途的配置类。
配置基类需要引用Json.NET,继承数据绑定基类BindableBase(参考WPF之数据绑定基类),实现从其它实例加载数据的功能(参考C# 两个具有相同属性的类赋值),基类代码如下:

using Newtonsoft.Json;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;

namespace TestConfigDll
{
    /// <summary>
    /// 配置基类,实现配置类的加载、保存功能
    /// </summary>
    /// <typeparam name="T"></typeparam>
    public class ConfigBase<T> : BindableBase where T : class
    {
        /// <summary>
        /// 文件保存路径
        /// </summary>
        private string filePath = "";

        /// <summary>
        /// 设置文件保存路径
        /// </summary>
        /// <param name="filePath"></param>
        public virtual void SetPath(string filePath)
        {
            this.filePath = filePath;
        }

        /// <summary>
        /// 保存到本地文件
        /// </summary>
        public virtual void Save()
        {
            string dirStr = Path.GetDirectoryName(filePath);
            if (!Directory.Exists(dirStr))
            {
                Directory.CreateDirectory(dirStr);
            }
            string jsonStr = JsonConvert.SerializeObject(this);
            File.WriteAllText(filePath, jsonStr);
        }

        /// <summary>
        /// 从本地文件加载
        /// </summary>
        public virtual void Load()
        {
            if (File.Exists(filePath))
            {
                var config = JsonConvert.DeserializeObject<T>(File.ReadAllText(filePath));
                foreach (PropertyInfo pro in typeof(T).GetProperties())
                {
                    pro.SetValue(this, pro.GetValue(config));
                }
            }
        }

        /// <summary>
        /// 从其它实例加载
        /// </summary>
        /// <param name="config"></param>
        public virtual void Load(T config)
        {
            foreach (PropertyInfo pro in typeof(T).GetProperties())
            {
                pro.SetValue(this, pro.GetValue(config));
            }
        }

        /// <summary>
        /// 从其它实例加载,仅加载指定的属性
        /// </summary>
        /// <param name="config"></param>
        /// <param name="proName"></param>
        public virtual void Load(T config, IEnumerable<string> proName = null)
        {
            foreach (PropertyInfo pro in typeof(T).GetProperties())
            {
                if (proName == null || proName.Contains(pro.Name))
                {
                    pro.SetValue(this, pro.GetValue(config));
                }
            }
        }
    }
}

派生配置类

配置类的属性定义不能使用缩写形式,不用单例模式时可删除“配置单例”的代码,配置类代码如下:

class TestConfig :ConfigBase<TestConfig>
{
    #region 配置单例
    /// <summary>
    /// 唯一实例
    /// </summary>
    public static TestConfig Instance { get; private set; } = new TestConfig();
            
    /// <summary>
    /// 静态构造函数
    /// </summary>
    static TestConfig()
    {
        Instance.SetPath("Config\\" + nameof(TestConfig) + ".json");
        Instance.Load();
    }
    #endregion

    #region 属性定义
    private string configStr = "";        
    public string ConfigStr 
    {
        get 
        { 
            return this.configStr;
        }
        set 
        {
            SetProperty(ref this.configStr, value);
        }
    }

    private int configInt =0;        
    public int ConfigInt
    {
        get
        {
            return this.configInt;
        }
        set
        {
            if (value > 100) 
            {
                SetProperty(ref this.configInt, value);
            }
        }
    }

    private bool configBool = false;        
    public bool ConfigBool
    {
        get
        {
            return this.configBool;
        }
        set
        {
            SetProperty(ref this.configBool, value);
        }
    }
    #endregion
}

数据绑定

一般数据绑定会定义一个Model类、ViewModel类,本文为了演示方便使用配置类同时承担两者的角色。

Winform中的数据绑定

先设计一个简单的界面,如下所示:


配置数据的加载、保存不用对每个控件进行操作,后台代码如下:

public partial class Form1 : Form
{
    private TestConfig testConfig = new TestConfig();
    private List<string> proName = new List<string>();

    public Form1()
    {
        InitializeComponent();

        string textProName = nameof(textBox1.Text);
        textBox1.DataBindings.Add(textProName, testConfig, nameof(testConfig.ConfigStr));
        textBox2.DataBindings.Add(textProName, testConfig, nameof(testConfig.ConfigInt));
        string checkedProName= nameof(checkBox1.Checked);
        checkBox1.DataBindings.Add(checkedProName, testConfig, nameof(testConfig.ConfigBool));

        proName.Add(textBox1.DataBindings[0].BindingMemberInfo.BindingField);
        proName.Add(textBox2.DataBindings[0].BindingMemberInfo.BindingField);
        proName.Add(checkBox1.DataBindings[0].BindingMemberInfo.BindingField);

    }

    private void button1_Click(object sender, EventArgs e)
    {
        testConfig.Load(TestConfig.Instance, proName);
    }

    private void button2_Click(object sender, EventArgs e)
    {
        TestConfig.Instance.Load(testConfig, proName);
        TestConfig.Instance.Save();
    }
}

如上所示,testConfig作为中转,可以根据需求加载、保存配置类的部分或全部属性。如果对Winform下的数据绑感兴趣,可以参考Winform 普通控件的双向绑定

WPF下的数据绑定

先设计一个简单的界面,如下所示:

<Window x:Class="WpfApp1.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:WpfApp1"
        mc:Ignorable="d"
        Title="MainWindow" Height="208" Width="306.667">
    <Grid>
        <Label Content="ConfigStr:" HorizontalAlignment="Left" Margin="18,16,0,0" VerticalAlignment="Top"/>
        <TextBox HorizontalAlignment="Left" Height="23" Margin="113,20,0,0" TextWrapping="Wrap" VerticalAlignment="Top" Width="156" Text="{Binding Path=ConfigStr ,Mode=TwoWay}"/>
        <Label Content="ConfigInt:" HorizontalAlignment="Left" Margin="18,44,0,0" VerticalAlignment="Top"/>
        <TextBox HorizontalAlignment="Left" Height="23" Margin="113,48,0,0" TextWrapping="Wrap" VerticalAlignment="Top" Width="156" Text="{Binding Path=ConfigInt ,Mode=TwoWay}"/>
        <Label Content="ConfigBool:" HorizontalAlignment="Left" Margin="18,74,0,0" VerticalAlignment="Top"/>
        <CheckBox Content="" HorizontalAlignment="Left" Margin="118,84,0,0" VerticalAlignment="Top" IsChecked="{Binding Path=ConfigBool ,Mode=TwoWay}"/>
        <Button Content="加载" HorizontalAlignment="Left" Margin="24,129,0,0" VerticalAlignment="Top" Width="75" Click="Button_Click"/>
        <Button Content="保存" HorizontalAlignment="Left" Margin="194,129,0,0" VerticalAlignment="Top" Width="75" Click="Button_Click_1"/>

    </Grid>
</Window>

相对于Winform,WPF控件绑定的操作由XAML实现,后台代码如下:

/// <summary>
/// MainWindow.xaml 的交互逻辑
/// </summary>
public partial class MainWindow : Window
{
    private TestConfig testConfig = new TestConfig();

    public MainWindow()
    {
        InitializeComponent();
        this.DataContext = testConfig;
    }

    private void Button_Click(object sender, RoutedEventArgs e)
    {
        testConfig.Load(TestConfig.Instance);
    }

    private void Button_Click_1(object sender, RoutedEventArgs e)
    {
        TestConfig.Instance.Load(testConfig);
        TestConfig.Instance.Save();
    }
}

上面的代码比较粗糙,没有记录已经绑定的属性,实际使用时可以进一步优化。

附件

原文地址:https://www.cnblogs.com/timefiles/p/CSharpConfigBase.html

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


项目中经常遇到CSV文件的读写需求,其中的难点主要是CSV文件的解析。本文会介绍CsvHelper、TextFieldParser、正则表达式三种解析CSV文件的方法,顺带也会介绍一下CSV文件的写方法。 CSV文件标准 在介绍CSV文件的读写方法前,我们需要了解一下CSV文件的格式。 文件示例 一
简介 本文的初衷是希望帮助那些有其它平台视觉算法开发经验的人能快速转入Halcon平台下,通过文中的示例开发者能快速了解一个Halcon项目开发的基本步骤,让开发者能把精力完全集中到算法的开发上面。 首先,你需要安装Halcon,HALCON 18.11.0.1的安装包会放在文章末尾。安装包分开发和
这篇文章主要简单记录一下C#项目的dll文件管理方法,以便后期使用。 设置dll路径 参考C#开发奇技淫巧三:把dll放在不同的目录让你的程序更整洁中间的 方法一:配置App.config文件的privatePath : &lt;runtime&gt; &lt;assemblyBinding xml
在C#中的使用JSON序列化及反序列化时,推荐使用Json.NET——NET的流行高性能JSON框架,当然也可以使用.NET自带的 System.Text.Json(.NET5)、DataContractJsonSerializer、JavaScriptSerializer(不推荐)。
事件总线是对发布-订阅模式的一种实现,是一种集中式事件处理机制,允许不同的组件之间进行彼此通信而又不需要相互依赖,达到一种解耦的目的。&#xA;EventBus维护一个事件的字典,发布者、订阅者在事件总线中获取事件实例并执行发布、订阅操作,事件实例负责维护、执行事件处理程序。
通用翻译API的HTTPS 地址为https://fanyi-api.baidu.com/api/trans/vip/translate,使用方法参考通用翻译API接入文档 。&#xA;请求方式可使用 GET 或 POST 方式(Content-Type 请指定为:application/x-www-for
词云”由美国西北大学新闻学副教授、新媒体专业主任里奇·戈登(Rich Gordon)于2006年最先使用,是通过形成“关键词云层”或“关键词渲染”,对文本中出现频率较高的“关键词”的视觉上的突出。词云图过滤掉大量的文本信息,使浏览者只要一眼扫过文本就可以领略文本的主旨。&#xA;网上大部分文章介绍的是使用P
微软在.NET中对串口通讯进行了封装,我们可以在.net2.0及以上版本开发时直接使用SerialPort类对串口进行读写操作。&#xA;为操作方便,本文对SerialPort类做了一些封装,暂时取名为**SerialPortClient**。
简介 管道为进程间通信提供了平台, 管道分为两种类型:匿名管道、命名管道,具体内容参考.NET 中的管道操作。简单来说,匿名管道只能用于本机的父子进程或线程之间,命名管道可用于远程主机或本地的任意两个进程,本文主要介绍命名管道的用法。 匿名管道在本地计算机上提供进程间通信。 与命名管道相比,虽然匿名
目录自定义日志类NLog版本的日志类Serilog版本的日志类 上个月换工作,新项目又要重新搭建基础框架,把日志实现部分单独记录下来方便以后参考。 自定义日志类 代码大部分使用ChatGPT生成,人工进行了测试和优化,主要特点: 线程安全,日志异步写入文件不影响业务逻辑 支持过期文件自动清理,也可自
[TOC] # 原理简介 本文参考[C#/WPF/WinForm/程序实现软件开机自动启动的两种常用方法](https://blog.csdn.net/weixin_42288432/article/details/120059296),将里面中的第一种方法做了封装成**AutoStart**类,使
简介 FTP是FileTransferProtocol(文件传输协议)的英文简称,而中文简称为“文传协议”。用于Internet上的控制文件的双向传输。同时,它也是一个应用程序(Application)。基于不同的操作系统有不同的FTP应用程序,而所有这些应用程序都遵守同一种协议以传输文件。 FTP
使用特性,可以有效地将元数据或声明性信息与代码(程序集、类型、方法、属性等)相关联。 将特性与程序实体相关联后,可以在运行时使用反射这项技术查询特性。&#xA;在 C# 中,通过用方括号 ([]) 将特性名称括起来,并置于应用该特性的实体的声明上方以指定特性。
# 简介 主流的识别库主要有ZXing.NET和ZBar,OpenCV 4.0后加入了QR码检测和解码功能。本文使用的是ZBar,同等条件下ZBar识别率更高,图片和部分代码参考[在C#中使用ZBar识别条形码](https://www.cnblogs.com/w2206/p/7755656.htm
C#中Description特性主要用于枚举和属性,方法比较简单,记录一下以便后期使用。 扩展类DescriptionExtension代码如下: using System; using System.ComponentModel; using System.Reflection; /// &lt;
本文实现一个简单的配置类,原理比较简单,适用于一些小型项目。主要实现以下功能:保存配置到json文件、从文件或实例加载配置类的属性值、数据绑定到界面控件。&#xA;一般情况下,项目都会提供配置的设置界面,很少手动更改配置文件,所以选择以json文件保存配置数据。
前几天用SerialPort类写一个串口的测试程序,关闭串口的时候会让界面卡死。网上大多数方法都是定义2个bool类型的标记Listening和Closing,关闭串口和接受数据前先判断一下。我的方法是DataReceived事件处理程序用this.BeginInvoke()更新界面,不等待UI线程
约束告知编译器类型参数必须具备的功能。 在没有任何约束的情况下,类型参数可以是任何类型。 编译器只能假定 System.Object 的成员,它是任何 .NET 类型的最终基类。 如果客户端代码使用不满足约束的类型,编译器将发出错误。 通过使用 where 上下文关键字指定约束。&#xA;最常用的泛型约束为
protobuf-net是用于.NET代码的基于契约的序列化程序,它以Google设计的“protocol buffers”序列化格式写入数据,适用于大多数编写标准类型并可以使用属性的.NET语言。&#xA;protobuf-net可通过NuGet安装程序包,也可直接访问github下载源码:https:/
工作中经常遇到需要实现TCP客户端或服务端的时候,如果每次都自己写会很麻烦且无聊,使用SuperSocket库又太大了。这时候就可以使用SimpleTCP了,当然仅限于C#语言。&#xA;SimpleTCP是一个简单且非常有用的 .NET 库,用于处理启动和使用 TCP 套接字(客户端和服务器)的重复性任务