ASP.NET MVC5網站開發之網站設定（九）_實用技巧

網站配置一般用來儲存網站的一些設定，寫在設定檔中比寫在資料庫中要合適一下，因為設定檔本身帶有緩衝，隨網站啟動讀入緩衝中，速度更快，而儲存在資料庫中要單獨為一條記錄建立一個表，結構不夠清晰，而且讀寫也沒有設定檔容易實現。這次要做的是網站的基本資料，資料儲存在SiteConfig.config。

在14年的時候寫過一篇部落格《.Net MVC 網站中設定檔的讀寫》 ，在那篇部落格中把思路和方法都已經寫清楚了，這次的實現思路和上次一樣，只是那次自己實現了KeyValueElement類和KeyValueElementCollection類，其實這兩個類在System.Configuration命名空間中都已經實現，直接使用就行。 

一、網站配置類（SiteConfig）

1、在Nninesky.Core項目建立檔案夾Config

2、在Config檔案夾添加類SiteConfig。

using System.ComponentModel.DataAnnotations;using System.Configuration;namespace Ninesky.Core.Config{ /// <summary> /// 網站配置類 /// </summary> public class SiteConfig : ConfigurationSection { private static ConfigurationProperty _property = new ConfigurationProperty(string.Empty, typeof(KeyValueConfigurationCollection), null, ConfigurationPropertyOptions.IsDefaultCollection); [ConfigurationProperty("", Options = ConfigurationPropertyOptions.IsDefaultCollection)] private KeyValueConfigurationCollection keyValues { get { return (KeyValueConfigurationCollection)base[_property]; } set { base[_property] = value; } } /// <summary> ///網站名稱 /// </summary> [Required(ErrorMessage = "*")] [StringLength(50, ErrorMessage = "最多{1}個字元")] [Display(Name = "網站名稱")] public string SiteName { get { return keyValues["SiteName"] == null? string.Empty: keyValues["SiteName"].Value; } set { keyValues["SiteName"].Value = value; } } /// <summary> ///網站標題 /// </summary> [Required(ErrorMessage = "*")] [StringLength(50, ErrorMessage = "最多{1}個字元")] [Display(Name = "網站標題")] public string SiteTitle { get { return keyValues["SiteTitle"] == null? string.Empty: keyValues["SiteTitle"].Value; } set { keyValues["SiteTitle"].Value = value; } } /// <summary> ///網站地址 /// </summary> [DataType(DataType.Url)] [Required(ErrorMessage = "*")] [StringLength(500, ErrorMessage = "最多{1}個字元")] [Display(Name = "網站地址")] public string SiteUrl { get { return keyValues["SiteUrl"] == null ? "http://" : keyValues["SiteUrl"].Value; } set { keyValues["SiteUrl"].Value = value; } } /// <summary> ///Meta關鍵詞 /// </summary> [DataType(DataType.MultilineText)] [StringLength(500, ErrorMessage = "最多{1}個字元")] [Display(Name = "Meta關鍵詞")] public string MetaKeywords { get { return keyValues["MetaKeywords"] == null ? string.Empty: keyValues["MetaKeywords"].Value; } set { keyValues["MetaKeywords"].Value = value; } } /// <summary> ///Meta描述 /// </summary> [DataType(DataType.MultilineText)] [StringLength(1000, ErrorMessage = "最多{1}個字元")] [Display(Name = "Meta描述")] public string MetaDescription { get { return keyValues["MetaDescription"] == null ? string.Empty : keyValues["MetaDescription"].Value; } set { keyValues["MetaDescription"].Value = value; } } /// <summary> ///著作權資訊 /// </summary> [DataType(DataType.MultilineText)] [StringLength(1000, ErrorMessage = "最多{1}個字元")] [Display(Name = "著作權資訊")] public string Copyright { get { return keyValues["Copyright"] == null ? "Ninesky 著作權" : keyValues["Copyright"].Value; } set { keyValues["Copyright"].Value = value; } } }}

Siteconfig類繼承自ConfigurationSection，繼承自這個類是才能讀寫配置節。

在類中聲明一個配置元素的子項目 private static ConfigurationProperty _property，子項目的配置實體類型是KeyValueConfigurationCollection（鍵/值集合）。

複製代碼 代碼如下:

private static ConfigurationProperty _property = new ConfigurationProperty(string.Empty, typeof(KeyValueConfigurationCollection), null, ConfigurationPropertyOptions.IsDefaultCollection);

然後徐再在類中聲明一個屬性private KeyValueConfigurationCollection keyValues。利用keyValues擷取、設定配置節鍵/值集合。

 [ConfigurationProperty("", Options = ConfigurationPropertyOptions.IsDefaultCollection)] private KeyValueConfigurationCollection keyValues { get { return (KeyValueConfigurationCollection)base[_property]; } set { base[_property] = value; } } 

然後就可以使用keyValues[“name”]擷取設定具體配置了。 

/// <summary> ///網站名稱 /// </summary> [Required(ErrorMessage = "*")] [StringLength(50, ErrorMessage = "最多{1}個字元")] [Display(Name = "網站名稱")] public string SiteName { get { return keyValues["SiteName"] == null? string.Empty: keyValues["SiteName"].Value; } set { keyValues["SiteName"].Value = value; } }

 

看起來是不是跟其他模型類差不多，知識Get；Set；有所不同。

二、設定設定檔的類型和路徑 

開啟Nniesky.web項目的 web.config檔案，找到configSections，然後添加SiteConfig配置節 

紅框部分為添加類型，說明了配置節的名稱和類型，注意紅線部分，restartOnExternalChanges設為"false"，如果不設定，設定檔修改後會重啟網站。 

在設定檔的結尾</configuration>添加設定檔的路徑 

圖中紅框部分為新增內容，指明SiteConfig的位置檔案在網站目錄Config檔案夾下名為SiteConfig.config的檔案。 

然後在項目中添加Config檔案夾，然後添加名為SiteConfig.config的設定檔。

<?xml version="1.0" encoding="utf-8"?><SiteConfig> <add key="SiteName" value="Ninesky" /> <add key="SiteTitle" value="1133" /> <add key="SiteUrl" value="http://mzwhj.cnblogs.com" /> <add key="MetaKeywords" value="關鍵詞，" /> <add key="MetaDescription" value="描述" /> <add key="Copyright" value="Ninesky 著作權<a>11</a>" /></SiteConfig>

設定檔中的鍵名與SiteConfig的屬性名稱對應。 

三、控制器和視圖
1、設定檔的讀取

在Ninesky.Web/Areas/Control/Controllers【右鍵】->添加->控制器，輸入控制器名ConfigController。 

在控制其中添加方法SiteConfig方法 

/// <summary> /// 網站設定 /// </summary> /// <returns></returns> public ActionResult SiteConfig() { SiteConfig _siteConfig = System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration("~").GetSection("SiteConfig") as Ninesky.Core.Config.SiteConfig; return View(_siteConfig); }

代碼很簡單，利用WebConfigurationManager的GetSection方法就將配置資訊讀出來了。 

右鍵添加視圖，將個屬性顯示出來。 

@model Ninesky.Core.Config.SiteConfig@{ ViewBag.Title = "網站設定";}@section SideNav{@Html.Partial("SideNavPartialView")}<ol class="breadcrumb"> <li><span class="glyphicon glyphicon-home"></span> @Html.ActionLink("首頁", "Index", "Home")</li> <li>@Html.ActionLink("系統設定", "Index")</li> <li class="active">網站設定</li></ol>@using (Html.BeginForm()){ @Html.AntiForgeryToken()  <div class="form-horizontal"> @Html.ValidationSummary(true, "", new { @class = "text-danger" }) <div class="form-group"> @Html.LabelFor(model => model.SiteName, htmlAttributes: new { @class = "control-label col-md-2" }) <div class="col-md-10"> @Html.EditorFor(model => model.SiteName, new { htmlAttributes = new { @class = "form-control" } }) @Html.ValidationMessageFor(model => model.SiteName, "", new { @class = "text-danger" }) </div> </div> <div class="form-group"> @Html.LabelFor(model => model.SiteTitle, htmlAttributes: new { @class = "control-label col-md-2" }) <div class="col-md-10"> @Html.EditorFor(model => model.SiteTitle, new { htmlAttributes = new { @class = "form-control" } }) @Html.ValidationMessageFor(model => model.SiteTitle, "", new { @class = "text-danger" }) </div> </div> <div class="form-group"> @Html.LabelFor(model => model.SiteUrl, htmlAttributes: new { @class = "control-label col-md-2" }) <div class="col-md-10"> @Html.EditorFor(model => model.SiteUrl, new { htmlAttributes = new { @class = "form-control" } }) @Html.ValidationMessageFor(model => model.SiteUrl, "", new { @class = "text-danger" }) </div> </div> <div class="form-group"> @Html.LabelFor(model => model.MetaKeywords, htmlAttributes: new { @class = "control-label col-md-2" }) <div class="col-md-10"> @Html.EditorFor(model => model.MetaKeywords, new { htmlAttributes = new { @class = "form-control" } }) @Html.ValidationMessageFor(model => model.MetaKeywords, "", new { @class = "text-danger" }) </div> </div> <div class="form-group"> @Html.LabelFor(model => model.MetaDescription, htmlAttributes: new { @class = "control-label col-md-2" }) <div class="col-md-10"> @Html.EditorFor(model => model.MetaDescription, new { htmlAttributes = new { @class = "form-control" } }) @Html.ValidationMessageFor(model => model.MetaDescription, "", new { @class = "text-danger" }) </div> </div> <div class="form-group"> @Html.LabelFor(model => model.Copyright, htmlAttributes: new { @class = "control-label col-md-2" }) <div class="col-md-10"> @Html.EditorFor(model => model.Copyright, new { htmlAttributes = new { @class = "form-control" } }) @Html.ValidationMessageFor(model => model.Copyright, "", new { @class = "text-danger" }) </div> </div> <div class="form-group"> <div class="col-md-offset-2 col-md-10"> <input type="submit" value="儲存" class="btn btn-default" /> </div> </div> </div>}

2、設定檔的儲存。 

在控制器中再添加一個[HttpPost]類型的SiteConfig方法。 

[ValidateInput(false)] [ValidateAntiForgeryToken] [HttpPost] public ActionResult SiteConfig(FormCollection form) { SiteConfig _siteConfig = System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration("~").GetSection("SiteConfig") as Ninesky.Core.Config.SiteConfig; if (TryUpdateModel<SiteConfig>(_siteConfig)) { _siteConfig.CurrentConfiguration.Save(); return View("Prompt", new Prompt() { Title = "修改成功", Message = "成功修改了網站設定", Buttons = new List<string> { "<a href='"+Url.Action("SiteConfig") +"' class='btn btn-default'>返回</a>" } }); } else return View(_siteConfig); } }

代碼也非常簡單，與讀取設定檔相同，使用WebConfigurationManager的GetSection方法將配置資訊讀入_siteConfig中，然後用TryUpdateModel<SiteConfig>(_siteConfig)綁定視圖提交過來的資訊。 

如果綁定成功，利用_siteConfig.CurrentConfiguration.Save()方法儲存配置資訊（這個方法繼承自ConfigurationSection，不用自己實現）。 

效果如下圖

=================================================
 代碼下載：http://git.oschina.net/ninesky/Ninesky 
下載方法：http://www.cnblogs.com/mzwhj/p/5729848.html

以上就是本文的全部內容，希望對大家的學習有所協助，也希望大家多多支援雲棲社區。