.Net 配置的簡陋解決方案

来源:https://www.cnblogs.com/zhouandke/archive/2018/03/30/8676278.html
-Advertisement-
Play Games

公司是做CS產品的, 最近分配給我一個活, 要求: 1. 公司程式啟動時, 檢測是否有配置文件, 沒有的話則按預設值創建一個 2. 配置文件要加密, 不能讓客戶隨便看到裡面的參數 3. 配置文件要有配套的GUI配置工具, 因為現場實施人員嫌XML配置麻煩 如果只有一個產品需要這個功能, 把每個配置項 ...


    公司是做CS產品的, 最近分配給我一個活, 要求:
    1. 公司程式啟動時, 檢測是否有配置文件, 沒有的話則按預設值創建一個
    2. 配置文件要加密, 不能讓客戶隨便看到裡面的參數
    3. 配置文件要有配套的GUI配置工具, 因為現場實施人員嫌XML配置麻煩

    如果只有一個產品需要這個功能, 把每個配置項的讀寫功能硬編碼寫到工具里就完事了, 但公司有好幾個產品都需要這個, 不得不寫一個通用的工具類

    這個工作還解決了兩個問題:
    a. 以前設置項都配置在 app.config 里, 每次升級都會覆蓋原來的設置, 所以現場人員都必須先將 app.config複製出來.
    b. app.config 里新增了配置項, 現場實施人員必須仔細對比, 將新增項人工放入原來的app.config

    現在的做法是, 配置文件ConfigSetting.xml並不在安裝包中, 所以卸載升級都不會影響它; 程式第一次啟動時, 會按預設值生成一個ConfigSetting.xml; 以後程式啟動的時候, 假如有新增的配置項, 則將其加入ConfigSetting.xml

    我把涉及的兩個類都放在了一個文件, 這樣引入一個文件即可

    using System;
    using System.Collections.Generic;
    using System.Xml.Linq;
    using System.Security.Cryptography;
    using System.IO;
    /// <summary>
    /// 設置項的幫助類
    /// </summary>
    public class ConfigSettingTool
    {
        /// <summary>
        /// 保存讀取時, 是否加密解密; 設為false, 可以方便調試
        /// 其實也只能防小白, 隨便反編譯一下就啥都漏出來了
        /// </summary>
        private static bool isEncrypt = false;

        /// <summary>
        /// 預設的配置文件名
        /// </summary>
        public static readonly string DefaultXmlFileName = "ConfigSetting.xml";

        /// <summary>
        /// 獲取XDocument, 解密失敗、XML結構不合理, 都會根據模板重新生成一個
        /// </summary>
        /// <param name="xmlFileName"></param>
        /// <param name="msg"></param>
        /// <returns>確保返回如下格式
        /// <?xml version="1.0" encoding="utf-8" standalone="yes"?>
        /// <Setting>
        ///   <SingleSetting></SingleSetting>
        /// </Setting>
        /// </returns>
        public static XDocument GetXDocument(string xmlFileName, out string msg)
        {
            msg = null;
            if (!System.IO.File.Exists(xmlFileName))
            {
                msg = "配置文件不存在, 創建預設配置文件";
                return new XDocument(new XDeclaration("1.0", "utf-8", "yes"), new XElement("Setting", new XElement("SingleSetting")));
            }
            try
            {
                var textContent = System.IO.File.ReadAllText(xmlFileName);
                textContent = isEncrypt ? Decrypt(textContent) : textContent;
                var xdoc = XDocument.Parse(textContent);
                if (xdoc.Root.Name != "Setting")
                {
                    throw new Exception("根節點不是 Setting");
                }
                if (xdoc.Root.Element("SingleSetting") == null)
                {
                    throw new Exception("沒有 SingleSetting 節點");
                }
                return xdoc;
            }
            catch
            {
                msg = "配置文件不是標準格式, 刪除後, 創建預設配置文件";
                return new XDocument(new XDeclaration("1.0", "utf-8", "yes"), new XElement("Setting", new XElement("SingleSetting")));
            }
        }


        /// <summary>
        /// 將xml信息讀出到settingArray, 如果缺少某項設定則增加到xdoc
        /// </summary>
        /// <param name="xdoc"></param>
        /// <param name="settingList">通常就是GlobalSetting.DefaultGlobalSettingArray</param>
        public static void ReadValueToSettingArray(XDocument xdoc, List<ConfigureItemModel> settingArray)
        {
            var singleSettingElement = xdoc.Root.Element("SingleSetting");
            foreach (var configureItem in settingArray)
            {
                configureItem.ErrorMsg = null;
                var element = singleSettingElement.Element(configureItem.Name);
                if (element == null)
                {
                    element = new XElement(configureItem.Name, configureItem.DefaultValue, new XAttribute("Caption", configureItem.Caption), new XAttribute("Description", configureItem.Description), new XAttribute("DefaultValue", configureItem.DefaultValue), new XAttribute("CanBeEmpty", configureItem.CanBeEmpty));
                    singleSettingElement.Add(element);
                }
                configureItem.Value = string.IsNullOrWhiteSpace(element.Value) ? "" : element.Value.Trim();
            }
        }


        /// <summary>
        /// 將xml信息讀出到settingArray
        /// </summary>
        /// <param name="xdoc"></param>
        /// <param name="settingList">通常就是GlobalSetting.DefaultGlobalSettingArray</param>
        public static void ReadConfig(XDocument xdoc, out List<ConfigureItemModel> settingList)
        {
            settingList = new List<ConfigureItemModel>();

            var singleSettingElement = xdoc.Root.Element("SingleSetting");
            foreach (var element in singleSettingElement.Elements())
            {
                var captionAttribute = element.Attribute("Caption");
                var caption = captionAttribute != null ? captionAttribute.Value : "";

                var name = element.Name.ToString();
                var value = element.Value.ToString();

                var descriptionAttribute = element.Attribute("Description");
                var description = descriptionAttribute != null ? descriptionAttribute.Value : "";

                var defaultValueAttribute = element.Attribute("DefaultValue");
                var defaultValue = defaultValueAttribute != null ? defaultValueAttribute.Value : "";

                var canBeEmpty = false;
                try
                {
                    canBeEmpty = bool.Parse(element.Attribute("CanBeEmpty").Value);
                }
                catch { }

                var errorMsgAttribute = element.Attribute("ErrorMsg");
                var errorMsg = errorMsgAttribute != null ? errorMsgAttribute.Value : "";


                var configureItem = new ConfigureItemModel(caption, name, defaultValue, description, canBeEmpty) { Value = value, ErrorMsg = errorMsg };
                settingList.Add(configureItem);
            }
        }


        /// <summary>
        /// 嘗試解析設置內容 到 目標class
        /// </summary>
        /// <param name="settingList">通常就是GlobalSetting.DefaultGlobalSettingArray, 配置項設置不合理時, 會將錯誤信息保存到ErrorMsg</param>
        /// <param name="targetSettingClass">通常就是GlobalSetting</param>
        /// <returns>成功, true; 失敗: false</returns>
        public static bool TryParseConfig(List<ConfigureItemModel> settingArray, Type targetSettingClass)
        {
            bool isAllSuccess = true;
            foreach (var configureItem in settingArray)
            {
                configureItem.ErrorMsg = null;
                configureItem.Value = string.IsNullOrWhiteSpace(configureItem.Value) ? "" : configureItem.Value.Trim();
                if (configureItem.Value == "" && configureItem.CanBeEmpty == false)
                {
                    configureItem.ErrorMsg += "該項值不能為空, 請手動填寫該值;";
                    isAllSuccess = false;
                    continue;
                }

                var property = targetSettingClass.GetProperty(configureItem.Name);
                //如果 targetSettingClass 沒有對應的靜態屬性, 則跳過
                if (property == null)
                {
                    continue;
                }
                object value = null;
                try
                {
                    value = Convert.ChangeType(configureItem.Value, property.PropertyType);
                    property.SetValue(null, value, null);
                }
                catch
                {
                    configureItem.ErrorMsg += configureItem.Value + "不能轉換為" + property.PropertyType.Name + ", 請重新填寫該值;";
                    isAllSuccess = false;
                    continue;
                }
            }
            return isAllSuccess;
        }


        /// <summary>
        /// 寫入
        /// </summary>
        /// <param name="xmlFileName"></param>
        /// <param name="settingList">通常就是GlobalSetting.DefaultGlobalSettingArray</param>
        /// <returns>成功, null</returns>
        public static bool TrySaveToXML(string xmlFileName, List<ConfigureItemModel> settingArray, out string msg)
        {
            msg = null;
            var xdoc = GetXDocument(xmlFileName, out  msg);//原文件讀出錯誤, 忽略即可, 因為settingArray會自動填充
            var singleSettingElement = xdoc.Root.Element("SingleSetting");

            foreach (var configureItem in settingArray)
            {
                var element = singleSettingElement.Element(configureItem.Name);
                if (element == null)
                {
                    element = new XElement(configureItem.Name, configureItem.Value);
                    singleSettingElement.Add(element);
                }
                else
                {
                    element.Value = configureItem.Value ?? "";
                }
                element.RemoveAttributes();
                element.Add(new XAttribute("Caption", configureItem.Caption));
                element.Add(new XAttribute("Description", configureItem.Description));
                element.Add(new XAttribute("DefaultValue", configureItem.DefaultValue));
                element.Add(new XAttribute("CanBeEmpty", configureItem.CanBeEmpty));
                if (!string.IsNullOrWhiteSpace(configureItem.ErrorMsg))
                {
                    element.Add(new XAttribute("ErrorMsg", configureItem.ErrorMsg));
                }
            }


            var textContent = xdoc.ToString();
            textContent = isEncrypt ? Encrypt(textContent) : textContent;
            try
            {
                System.IO.File.WriteAllText(xmlFileName, textContent);
                return true;
            }
            catch (Exception ex)
            {
                msg= "保存失敗:" + ex.Message;
                return false;
            }
        }

        #region 加密解密部分
        private static byte[] DESKey = new byte[] { 11, 69, 93, 102, 172, 41, 18, 12 };
        private static byte[] DESIV = new byte[] { 75, 77, 46, 197, 78, 157, 23, 36 };

        /// <summary>
        /// 加密
        /// </summary>
        private static string Encrypt(string source)
        {
            string reValue = "";
            DESCryptoServiceProvider objDes = new DESCryptoServiceProvider();
            MemoryStream objMemoryStream = new MemoryStream();
            CryptoStream objCrytoStream = new CryptoStream(objMemoryStream, objDes.CreateEncryptor(DESKey, DESIV), CryptoStreamMode.Write);
            StreamWriter objStreamWriter = new StreamWriter(objCrytoStream);
            objStreamWriter.Write(source);
            objStreamWriter.Flush();
            objCrytoStream.FlushFinalBlock();
            objMemoryStream.Flush();
            reValue = Convert.ToBase64String(objMemoryStream.GetBuffer(), 0, (int)objMemoryStream.Length);
            return reValue;
        }

        /// <summary>
        /// 解密
        /// </summary>
        private static string Decrypt(string source)
        {
            string reValue = "";
            DESCryptoServiceProvider objDES = new DESCryptoServiceProvider();
            byte[] Input = Convert.FromBase64String(source);
            MemoryStream objMemoryStream = new MemoryStream(Input);
            CryptoStream objCryptoStream = new CryptoStream(objMemoryStream, objDES.CreateDecryptor(DESKey, DESIV), CryptoStreamMode.Read);
            StreamReader objStreamReader = new StreamReader(objCryptoStream);
            reValue = objStreamReader.ReadToEnd();
            return reValue;
        }
        #endregion
    }

    /// <summary>
    /// 單個設置項
    /// </summary>
    /// <remarks>由於XML中不能保存null, 所以所有屬性都不會被設置為null</remarks>
    public class ConfigureItemModel
    {
        /// <summary>
        /// 單個設置項
        /// </summary>
        /// <param name="captionParam">顯示名稱</param>
        /// <param name="nameParam">參數名稱</param>
        /// <param name="defaultValueParam">預設值</param>
        /// <param name="descriptionParam">描述, 該項不設定時候, 顯示預設值</param>
        /// <param name="canBeEmptyParam">能否為空字元串</param>
        public ConfigureItemModel(string captionParam, string nameParam, string defaultValueParam, string descriptionParam = "", bool canBeEmptyParam = false)
        {
            Caption = captionParam;
            Name = nameParam;
            Description = descriptionParam;
            DefaultValue = defaultValueParam;
            CanBeEmpty = canBeEmptyParam;
        }



        private string caption = "";
        /// <summary>
        /// 顯示名稱
        /// </summary>
        public string Caption
        {
            get { return caption; }
            set { caption = string.IsNullOrWhiteSpace(value) ? "" : value; }
        }



        private string name = "";
        /// <summary>
        /// 參數名稱
        /// </summary>
        public string Name
        {
            get { return name; }
            set { name = string.IsNullOrWhiteSpace(value) ? "" : value; ; }
        }


        private string description = "";
        /// <summary>
        /// 說明, 如果該值沒有賦值, 則顯示DefaultValue
        /// </summary>
        public string Description
        {
            get { return string.IsNullOrWhiteSpace(description) ? defaultValue : description; }
            set { description = string.IsNullOrWhiteSpace(value) ? "" : value; }
        }


        private string defaultValue = "";
        /// <summary>
        /// 預設值
        /// </summary>
        public string DefaultValue
        {
            get { return defaultValue; }
            set { defaultValue = string.IsNullOrWhiteSpace(value) ? "" : value; }
        }


        /// <summary>
        /// 能否為空字元串
        /// </summary>
        public bool CanBeEmpty { get; set; }

        /// <summary>
        /// 能否為空字元串 的字元串形式
        /// </summary>
        public string CanBeEmptyString { get { return CanBeEmpty ? "是" : "否"; } }


        private string innerValue = "";
        /// <summary>
        /// 值
        /// </summary>
        public string Value
        {
            get { return innerValue; }
            set { innerValue = string.IsNullOrWhiteSpace(value) ? "" : value; ; }
        }


        private string errorMsg = "";
        /// <summary>
        /// 錯誤信息
        /// </summary>
        public string ErrorMsg
        {
            get { return errorMsg; }
            set { errorMsg = string.IsNullOrWhiteSpace(value) ? "" : value; ; }
        }

    }
View Code

 

   產品里建一個 GlobalSetting 類, 裡面的配置項都必須是  static 屬性, 然後加入 public static List<ConfigureItemModel> DefaultGlobalSettingArray 保存預設設置

    /// <summary>
    /// 全局設定
    /// </summary>
    /// <remarks>所有屬性都必須是 static , 即 類屬性</remarks>
    public class GlobalSetting
    {
        public static List<ConfigureItemModel> DefaultGlobalSettingArray = new List<ConfigureItemModel>()
        {
            new ConfigureItemModel("資料庫的主機地址","ConnectionStringHost", "127.0.0.1"),
        };

        /// <summary>
        /// 資料庫的主機地址
        /// </summary>
        public static string ConnectionStringHost { get; set; }
    }
View Code

 

  具體的示例請參考 ConfigSettingToolTest, 第一次運行時會報錯: 升級地址 不能為空, 使用  配置文件編輯工具2.exe 為其賦值後, 就可以正常啟動了

 

ConfigSettingToolTest              ConfigEditer

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Python 全棧開發：python迭代器，生成器
    迭代器 一、什麼是迭代器 二、為何要有迭代器，什麼是可迭代對象，什麼是迭代器對象 三、迭代器對象的使用 四、for迴圈 五、迭代器的優缺點 優點：1.提供一種統一的，不依賴於索引的迭代方式 2.懶性計算，每次只有一條數據，節省記憶體 缺點：1.無法獲取長度（只有在迭代完畢才能知道有多少值） 2.一次性 ...
  • 迪傑斯特拉演算法（Dijkstra）
    本文非原創~~ 指定一個點（源點）到其餘各個頂點的最短路徑，也叫做“單源最短路徑”。例如求下圖中的1號頂點到2、3、4、5、6號頂點的最短路徑。 與Floyd-Warshall演算法一樣這裡仍然使用二維數組e來存儲頂點之間邊的關係，初始值如下。 我們還需要用一個一維數組dis來存儲1號頂點到其餘各個頂 ...
  • aardio修改IDE里代碼的字體
    import ide; ide.setConfig("editor_font_name","fixedsys"); ...
  • C#面向服務WebService從入門到精通
    《C#面向服務WebService從入門到精通》包含以下兩個部分： 一、《C#遠程調用技術WebService修煉手冊【基礎篇】》本次分享課您將學習到以下乾貨知識點：1)、WebService技術調用原理圖。2)、C# WebService常用的幾種調用方式。3)、C# WebService調試小技 ...
  • C#使用反射獲取對象變化的情況
    記錄日誌時, 經常需要描述對象的狀態發生了怎樣的變化, 以前處理的非常簡單粗暴: a. 重寫class的ToString()方法, 將重要的屬性都輸出來 b. 記錄日誌時: 誰誰誰 由 變更前實例.ToString() 變成 變更後實例.ToString() 但輸出的日誌總是太長了, 翻看日誌時想找 ...
  • RabbitMQ 發佈訂閱持久化及持久化方式
    RabbitMQ是一種重要的消息隊列中間件，在生產環境中，穩定是第一考慮。RabbitMQ廠家也深知開發者的聲音，穩定、可靠是第一考慮，為了消息傳輸的可靠性傳輸，RabbitMQ提供了多種途徑的消息持久化保證：Exchange持久化、Queue持久化及Message的持久化等。以保證RabbitMQ ...
  • c# yield關鍵字原理詳解
    c yield關鍵字的用法 1.yield實現的功能 yield return： 先看下麵的代碼，通過yield return實現了類似用foreach遍曆數組的功能，說明yield return也是用來實現迭代器的功能的。 <! more yield break: 再看下麵的代碼，只輸出了1，2， ...
  • Asp.net中GridView使用詳解(轉載)
    l GridView無代碼分頁排序 l GridView選中，編輯，取消，刪除 l GridView正反雙向排序 l GridView和下拉菜單DropDownList結合 l GridView和CheckBox結合 l 滑鼠移到GridView某一行時改變該行的背景色方法一 l 滑鼠移到GridV ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類