MVC5 網站開發之九網站設置 - mzwhj－IT工程師數位筆記本

文章出處

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

MVC5網站開發之一總體概述

MVC5 網站開發之二創建項目

MVC5 網站開發之三數據存儲層功能實現

MVC5 網站開發之四業務邏輯層的架構和基本功能

MVC5 網站開發之五展示層架構

MVC5 網站開發之六管理員 1、登錄、驗證和注銷

MVC5 網站開發之六管理員 2、添加、刪除、重置密碼、修改密碼、列表瀏覽

MVC5 網站開發之七用戶功能 1、角色的后臺管理

MVC5 網站開發之七用戶功能 2 用戶添加和瀏覽

MVC5 網站開發之七用戶功能 3用戶資料的修改和刪除

MVC5 網站開發之八欄目功能添加、修改和刪除

在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 版權所有&lt;a&gt;11&lt;/a&gt;" />
</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);
        }
    }