从零开始，搭建博客系统MVC5+EF6搭建框架（3），添加Nlog日志、缓存机制（MemoryCache、RedisCache）、创建控制器父类BaseController

一、回顾系统进度以及本章概要

     目前博客系统已经数据库创建、以及依赖注入Autofac集成，接下来就是日志和缓存集成，这里日志用的是Nlog,其实还有其他的日志框架如log4，这些博客园都有很多介绍，这里就不说了，缓存机制用的是微软自带的MemoryCache和比较流行Redis，这里我也只是了解使用，没有做更升入的研究，以后好好学一下Redis，然后就是实现一个BaseController父类用来重写JsonResult方法为的是返回时间格式问题，默认json返回的时间格式是Date（84923838332223）转为常见的yyyy-MM-dd HH:mm:ss格式。

二、缓存机制实现

1、在公共程序集中创建连个文件加一个Cache用来存放缓存类，一个是Log是用来创建Nlog类，这里都使用接口来实现，以便可以以后可以多个实现。

2、首先创建一个ICacheManager接口类。

namespace Wchl.WMBlog.Common.Cache
{
    public interface ICacheManager
    {
       /// <summary>
       /// 获取
       /// </summary>
       /// <typeparam name="TEntity"></typeparam>
       /// <param name="key"></param>
       /// <returns></returns>
        TEntity Get<TEntity>(string key);
        //设置
        void Set(string key, object value, TimeSpan cacheTime);
        //判断是否存在
        bool Contains(string key);
        //移除
        void Remove(string key);
        //清除
        void Clear();

    }
}

3、在实现微软缓存机制的时候需要引用System.Runtime.Caching.dll,创建一个MemoryCacheManager 类

namespace Wchl.WMBlog.Common.Cache
{
     public  class MemoryCacheManager : ICacheManager
    {
        public void Clear()
        {

            foreach (var item in MemoryCache.Default)
            {
                this.Remove(item.Key);
            }
        }

        public bool Contains(string key)
        {
            return MemoryCache.Default.Contains(key);
        }

        public TEntity Get<TEntity>(string key)
        {
            return (TEntity)MemoryCache.Default.Get(key);
        }

        public void Remove(string key)
        {
            MemoryCache.Default.Remove(key);
        }

        public void Set(string key, object value, TimeSpan cacheTime)
        {
            MemoryCache.Default.Add(key, value, new CacheItemPolicy { SlidingExpiration = cacheTime });
        }
    }
}

4、实现RedisCacheManager类，这里我们使用的免费的Redis客服端是StackExchange.Redis.可以在nuget中下载到。

RedisCacheManager类

namespace Wchl.WMBlog.Common.Cache
{
    public class RedisCacheManager : ICacheManager
    {
        private readonly string redisConnenctionString;

        public volatile ConnectionMultiplexer redisConnection;

        private readonly object redisConnectionLock = new object();

        public RedisCacheManager()
        {
            //链接redis服务语句
            string redisConfiguration = ConfigurationManager.ConnectionStrings["redisCache"].ToString();

            if (string.IsNullOrWhiteSpace(redisConfiguration))
            {
                throw new ArgumentException("redis config is empty", nameof(redisConfiguration));
            }
            this.redisConnenctionString = redisConfiguration;
            this.redisConnection = GetRedisConnection();
        }

        private ConnectionMultiplexer GetRedisConnection()
        {
            if (this.redisConnection != null && this.redisConnection.IsConnected)
            {
                return this.redisConnection;
            }
            lock (redisConnectionLock)
            {
                if (this.redisConnection != null)
                {
                    //释放redis连接
                    this.redisConnection.Dispose();
                }
                this.redisConnection = ConnectionMultiplexer.Connect(redisConnenctionString);
            }
            return this.redisConnection;
        }

        public void Clear()
        {
            foreach (var endPoint in this.GetRedisConnection().GetEndPoints())
            {
                var server = this.GetRedisConnection().GetServer(endPoint);
                foreach (var key in server.Keys())
                {
                    redisConnection.GetDatabase().KeyDelete(key);
                }
            }
        }

        public bool Contains(string key)
        {
            return redisConnection.GetDatabase().KeyExists(key);
        }

        public TEntity Get<TEntity>(string key)
        {
            var value = redisConnection.GetDatabase().StringGet(key);
            if (value.HasValue)
            {
                return SerializeHelper.Deserialize<TEntity>(value);
            } else
            {
                return default(TEntity);
            }
        }

        public void Remove(string key)
        {
            redisConnection.GetDatabase().KeyDelete(key);
        }

        public void Set(string key, object value, TimeSpan cacheTime)
        {
            if (value != null)
            {
                redisConnection.GetDatabase().StringSet(key, SerializeHelper.Serialize(value), cacheTime);
            }
        }
    }
}

这里在存储数据的时候使用到了序列化和反序列化，用的序列化工具是Newtonsoft.Json，同样也可以在nuget中找到。

SerializeHelper序列化帮助类

namespace Wchl.WMBlog.Common
{
    public class SerializeHelper
    {
        /// <summary>
        /// 序列化
        /// </summary>
        /// <param name="item"></param>
        /// <returns></returns>
        public static byte[] Serialize(object item)
        {
            var jsonString = JsonConvert.SerializeObject(item);

            return Encoding.UTF8.GetBytes(jsonString);
        }
        /// <summary>
        /// 反序列化
        /// </summary>
        /// <typeparam name="TEntity"></typeparam>
        /// <param name="value"></param>
        /// <returns></returns>
        public static TEntity Deserialize<TEntity>(byte[] value)
        {
            if (value == null)
            {
                return default(TEntity);
            }
            var jsonString = Encoding.UTF8.GetString(value);
            return JsonConvert.DeserializeObject<TEntity>(jsonString);
        }
    }
}

三、日志处理：Nlog日志框架

1、首先实现一个日子接口ILogger

namespace Wchl.WMBlog.Common.Log
{
    public interface ILogger
    {
        void Debug(string message);
        void Debug(string message, Exception exception);
        void Error(string message);
        void Error(string message, Exception exception);
        void Fatal(string message);
        void Fatal(string message, Exception exception);
        void Info(string message);
        void Info(string message, Exception exception);
        void Warn(string message);
        void Warn(string message, Exception exception);
    }
}

2.在nuget中添加Nlog框架

nlog.config是日志框架的配置文件。

Nloglogger类

namespace Wchl.WMBlog.Common.Log
{
    public class NLogLogger : ILogger
    {
        private readonly Logger logger = LogManager.GetCurrentClassLogger();
        public void Debug(string message)
        {
            logger.Debug(message);
        }

        public void Debug(string message, Exception exception)
        {
            logger.Debug(exception, message);
        }

        public void Error(string message)
        {
            logger.Error(message);
        }

        public void Error(string message, Exception exception)
        {
            logger.Error(exception, message);
        }

        public void Fatal(string message)
        {
            logger.Fatal(message);
        }

        public void Fatal(string message, Exception exception)
        {
            logger.Fatal(exception, message);
        }

        public void Info(string message)
        {
            logger.Info(message);
        }

        public void Info(string message, Exception exception)
        {
            logger.Info(exception, message);
        }

        public void Warn(string message)
        {
            logger.Warn(message);
        }

        public void Warn(string message, Exception exception)
        {
            logger.Warn(exception, message);
        }
    }
}

3、配置日志文件NLog.config，这里是在webUI层应用这个文件，因为最终日志是在web下运行。

在targets的节点下面配置，这里是以文件的方式保存日子，你也可以使用这个配置一个直接把日子写到数据库中

<target xsi:type ="File"
    name="file"
    header="------------------------------Start------------------------------"
    footer="------------------------------End------------------------------"
    fileName="${basedir}/App_Data/Logs/${shortdate}.log"
    layout="${longdate} - ${level:uppercase=true}:${message} ${callsite:fileName=true} ${exception:format=Type,Message,Method,StackTrace:maxInnerExceptionLevel=5:innerFormat=ShortType,Message,Method,StackTrace}"
    keepFileOpen="false"
    archiveFileName="${basedir}/App_Data/Logs/Backup_${shortdate}.{##}.log"
    archiveNumbering="Sequence"
    archiveEvery="Day"
    maxArchiveFiles="30">

    </target>

在rules节点下配置 <logger name="*" minlevel="Error" writeTo="file" />表示什么级别的日志对应放在哪个配置里面。

这里日志保存在发布站点App_DataLogs下

4、日志测试

4.1在测试之前首先设置一个全局错误机制文件ExpFilter继承HandleErrorAttribute，放在Webcore下面

这里需要添加System.Web.Mvc.dll程序集。

ExpFilter类：

namespace Wchl.WMBlog.WebCore
{
    public class ExpFilter:HandleErrorAttribute
    {
        public override void OnException(ExceptionContext filterContext)
        {
            Exception exp = filterContext.Exception;

            //获取ex的第一级内部异常
            Exception innerEx = exp.InnerException == null ? exp : exp.InnerException;
            //循环获取内部异常直到获取详细异常信息为止
            while (innerEx.InnerException!=null)
            {
                innerEx = innerEx.InnerException;
            }
            NLogLogger nlog = new NLogLogger();
            if (filterContext.HttpContext.Request.IsAjaxRequest())
            {

                nlog.Error(innerEx.Message);
                JsonConvert.SerializeObject(new { status = 1, msg ="请求发生错误，请联系管理员"});
            }
            else
            {
                nlog.Error("Error",exp);
                ViewResult vireResult = new ViewResult();
                vireResult.ViewName = "/Views/Shared/Error.cshtml";
                filterContext.Result = vireResult;
            }

            //告诉MVC框架异常被处理
            filterContext.ExceptionHandled = true;
            base.OnException(filterContext);
        }
    }
}

4.2这里对两种请求方式做处理一种是Ajax请求，一种是对链接地址做处理，另外还需要在webui下创建一个错误提醒页面。（/Views/Shared/Error.cshtml）

4.3在homecontroller控制器下写错误代码

4.4日志测试结果：这里直接开始执行（不调试）

然后在项目文件下查看web站点下的App_DataLogs查看日子文件

日志信息：错误信息，以及错误是那个文件多少行都有显示。

四、创建BaseController类

这里使用反序列化工具都是Newtonsoft.Json

BaseController类：

namespace Wchl.WMBlog.WebCore
{
    public class BaseController: Controller
    {
        protected override JsonResult Json(object data, string contentType, Encoding contentEncoding, JsonRequestBehavior behavior)
        {
            return new JsonNetResult { Data = data, ContentType = contentType, ContentEncoding = contentEncoding, JsonRequestBehavior = behavior };
        }
    }
}

JsonNetResult类：

namespace Wchl.WMBlog.WebCore
{
    public class JsonNetResult:JsonResult
    {
        public override void ExecuteResult(ControllerContext context)
        {
            if (context==null)
            {
                throw new ArgumentException(nameof(context));
            }

            var response = context.HttpContext.Response;

            response.ContentType = !string.IsNullOrEmpty(ContentType) ? ContentType : "application/json";

            if (ContentEncoding != null)
            {
                response.ContentEncoding = ContentEncoding;
            }

            var jsonSerializerSetting = new JsonSerializerSettings();
            //首字母小写
            jsonSerializerSetting.ContractResolver = new CamelCasePropertyNamesContractResolver();
            //日期格式化
            jsonSerializerSetting.DateFormatString = "yyyy-MM-dd HH:mm:ss";
            var json = JsonConvert.SerializeObject(Data, Formatting.None, jsonSerializerSetting);

            response.Write(json);

        }
    }
}

直接在创建的控制器下集成：

   接下来就是准备实现页面布局，先做个简单的前台查看，后台分布的功能，然后在一步一步的完善，希望大家多多指点，多多支持，谢谢了。

    10月10日补充说明：

  全局错误处理机制需要在FilterConfig中配置，才能起作用。感谢园友1非烟的指正