Asp.net 面向接口可扩展框架之数据处理模块及EntityFramework扩展和Dapper扩展(含干货)

接口数据处理模块是什么意思呢？实际上很简单,就是使用面向接口的思想和方式来做数据处理。

还提到EntityFramework和Dapper,EntityFramework和Dapper是.net环境下推崇最高的两种ORM工具。

1、EntityFramework是出自微软根正苗红的.net下的ORM工具,直接在Vs工具和Mvc框架中集成了,默认生成的项目就是使用EntityFramework的;微软也一直都在维护更新升级,最新版本都到EF7了。也迁移到了最新的.net Core平台了。

2、Dapper也是个厉害的角色。号称.net下"无敌",速度最快

但是他们两个开发方式完全不一样,个人认为EntityFramework是基于领域模型的,Dapper是基于sql的

注:我以前没用Dapper做过项目。之前一直讨厌Dapper,对赤裸裸的sql有很大成见,原因一程序员去直接写sql搞不好就会导致sql注入风险,原因二我认为程序员应该花精力琢磨逻辑如何写,而不是和DBA比写sql的功底

注:EntityFramework我也用的少,我主导的项目都是用我自己开发的ORM工具,维护别人的项目经常碰到EntityFramework生成复杂到不可理喻的sql,而且EntityFramework几乎不能在一个项目中分库分表读写分离操作(这个问题已经解决，后面会讲到)

现在要做的就是让ORM工具(含EntityFramework和Dapper)以面向接口的方式工作,"屏蔽"掉一些个性化的差异

一、面向接口数据处理模块

面向接口数据处理模块很简单,就是一堆数据处理的接口,像数据仓储接口。有了它们几乎所有数据仓储都不用再定义新接口了,主要的核心接口全部公布如下:

    /// <summary>

    /// 实体泛型主键接口

    /// </summary>

    /// <typeparam name="TPrimaryKey"></typeparam>

    public interface IEntity<TPrimaryKey> : IEntity

    {

        /// <summary>

        /// 主键

        /// </summary>

        TPrimaryKey Id { get; set; }

    }

    /// <summary>

    /// 实体接口

    /// </summary>

    public interface IEntity

    {

        /// <summary>

        /// 主键

        /// </summary>

        object ObjId { get; }

    }

1、IEntity

注:主键是泛型(TPrimaryKey),意味着支持任意类型的主键,而不是简单粗暴的只支持int或者guid,当然也就支持复合主键了

    /// <summary>

    /// 泛型添加

    /// </summary>

    /// <typeparam name="TEntity"></typeparam>

    public interface IEntityAdd<in TEntity>

    {

        /// <summary>

        /// 添加

        /// </summary>

        /// <param name="obj"></param>

        /// <returns></returns>

        object Add(TEntity obj);

    }

2、IEntityAdd

    /// <summary>

    /// 泛型删除

    /// </summary>

    /// <typeparam name="TEntity"></typeparam>

    public interface IEntityDel<in TEntity>

    {

        /// <summary>

        /// 删除

        /// </summary>

        /// <param name="obj"></param>

        /// <returns></returns>

        bool Del(TEntity obj);

    }

}

3、IEntityDel

    /// <summary>

    /// 按主键删除

    /// </summary>

    /// <typeparam name="TPrimaryKey"></typeparam>

    public interface IEntityKeyDel<TPrimaryKey>

    {

        /// <summary>

        /// 按主键删除

        /// </summary>

        /// <param name="key"></param>

        /// <returns></returns>

        bool Del(TPrimaryKey key);

    }

4、IEntityKeyDel

    /// <summary>

    /// 泛型修改

    /// </summary>

    /// <typeparam name="TEntity"></typeparam>

    public interface IEntityUpdate<in TEntity>

    {

        /// <summary>

        /// 修改

        /// </summary>

        /// <param name="obj"></param>

        /// <returns></returns>

        bool Update(TEntity obj);

    }

5、IEntityUpdate

    /// <summary>

    /// 泛型获取列表数据

    /// </summary>

    /// <typeparam name="TEntity"></typeparam>

    public interface IEntityList<TEntity>

    {

        /// <summary>

        /// 获取所有数据

        /// </summary>

        /// <returns></returns>

        IEnumerable<TEntity> ListAll();

    }

6、IEntityList

    /// <summary>

    /// 获取数据条数

    /// </summary>

    public interface ICount

    {

        /// <summary>

        /// 获取数据条数

        /// </summary>

        /// <returns></returns>

        int Count();

    }

7、ICount

    /// <summary>

    /// 泛型查看

    /// </summary>

    /// <typeparam name="TEntity"></typeparam>

    public interface IEntityView<TEntity>

    {

        /// <summary>

        /// 查看

        /// </summary>

        /// <param name="obj"></param>

        /// <returns></returns>

        TEntity View(TEntity obj);

    }

8、IEntityView

    /// <summary>

    /// 泛型查主键看

    /// </summary>

    /// <typeparam name="TEntity"></typeparam>

    /// <typeparam name="TPrimaryKey"></typeparam>

    public interface IEntityKeyView<TEntity, TPrimaryKey>

        where TEntity : IEntity<TPrimaryKey>

    {

        /// <summary>

        /// 按主键获取

        /// </summary>

        /// <param name="key"></param>

        /// <returns></returns>

        TEntity View(TPrimaryKey key);

    }

9、IEntityKeyView

    /// <summary>

    /// 数据操作仓储接口

    /// </summary>

    /// <typeparam name="TEntity"></typeparam>

    /// <typeparam name="TPrimaryKey"></typeparam>

    public interface IRepository<TEntity, TPrimaryKey> : IEntityAdd<TEntity>, IEntityUpdate<TEntity>, IEntityDel<TEntity>, IEntityKeyDel<TPrimaryKey>

        , IEntityView<TEntity>, IEntityKeyView<TEntity, TPrimaryKey>

        , IEntityList<TEntity>, ICount

        where TEntity : IEntity<TPrimaryKey>

    {

    }

10、IRepository

    /// <summary>

    /// 按条件获取列表

    /// </summary>

    /// <typeparam name="TCondition"></typeparam>

    /// <typeparam name="T"></typeparam>

    public interface IEntityConditionList<T, in TCondition>

    {

        /// <summary>

        /// 按条件获取列表

        /// </summary>

        /// <param name="condition"></param>

        /// <returns></returns>

        IEnumerable<T> List(TCondition condition);

    }

11、IEntityConditionList

    /// <summary>

    /// 按条件获取计数(统计)

    /// </summary>

    /// <typeparam name="TCondition"></typeparam>

    public interface IEntityConditionCount<in TCondition>

    {

        /// <summary>

        /// 按条件获取计数(统计)

        /// </summary>

        /// <param name="condition"></param>

        /// <returns></returns>

        int Count(TCondition condition);

    }

12、IEntityConditionCount

    /// <summary>

    /// 按条件修改接口

    /// </summary>

    /// <typeparam name="TCondition"></typeparam>

    /// <typeparam name="TUpdateContract"></typeparam>

    public interface IEntityConditionUpdate<in TCondition, in TUpdateContract>

    {

        /// <summary>

        /// 按条件修改

        /// </summary>

        /// <param name="condition"></param>

        /// <param name="contract"></param>

        /// <returns></returns>

        bool Update(TCondition condition, TUpdateContract contract);

    }

13、IEntityConditionUpdate

    /// <summary>

    /// 按条件删除接口

    /// </summary>

    /// <typeparam name="TCondition"></typeparam>

    public interface IEntityConditionDel<in TCondition>

    {

        /// <summary>

        /// 按条件删除

        /// </summary>

        /// <param name="condition"></param>

        /// <returns></returns>

        bool Del(TCondition condition);

    }

14、IEntityConditionDel

以上14个大接口涵盖了数据处理中的添、删、改、查各种情况(当然可能不全面还会增加),虽然都是虚的,当绝对是满满的干货(这14个接口是我好几年逐步的总结)。

接口有什么作用,接口就是规则就是标准就是契约

其一、基于接口开发出来的功能模块可高度复用。

其二、依赖接口开发的项目低耦合,可以各自分工同时多线程并行进行

其三、调用接口的模块可以方便的更换部分接口的实现,不会导致大范围的连锁反应,相当于可以给飞行中飞机换引擎

这里要强调的是以上接口不只是操作数据库,数据库只是数据的一种形式,还可以是文件、远程服务、Redis、nosql等。

以上都是"虚"的,来的实际例子使用这些接口

二、首先看一个Dapper(封装后的)开发Mvc例子

1、Model

    /// <summary>

    /// 文章

    /// </summary>

    public class Article : IEntity<int>

    {

        public int Id { get; set; }

        public string Title { get; set; }

        public int BodyId { get; set; }

        public int UserId { get; set; }

        #region IEntity<int>

        object IEntity.ObjId { get { return Id; } }

        #endregion

    }

Article

2、View

@model IEnumerable<CMS.Models.Article>

@{

    ViewBag.Title = "Index";

}

<h2>Index</h2>

<p>

    @Html.ActionLink("Create New", "Create")

</p>

<table>

    <tr>

        <th>

            @Html.DisplayNameFor(model => model.Title)

        </th>

        <th>

            @Html.DisplayNameFor(model => model.BodyId)

        </th>

        <th>

            @Html.DisplayNameFor(model => model.UserId)

        </th>

        <th></th>

    </tr>

@foreach (var item in Model) {

    <tr>

        <td>

            @Html.DisplayFor(modelItem => item.Title)

        </td>

        <td>

            @Html.DisplayFor(modelItem => item.BodyId)

        </td>

        <td>

            @Html.DisplayFor(modelItem => item.UserId)

        </td>

        <td>

            @Html.ActionLink("Edit", "Edit", new { id=item.Id }) |

            @Html.ActionLink("Details", "Details", new { id=item.Id }) |

            @Html.ActionLink("Delete", "Delete", new { id=item.Id })

        </td>

    </tr>

}

</table>

Index.cshtml

注:View是简单了一点,就是Vs默认生成的,只是为了演示功能,大家将就看一下吧

3、Controller

        #region DI配置

        [Dependency("IndexOperater")]

        public IEntityList<CMS.Models.Article> IndexOperater { get; set; }

        [Dependency("DetailOperater")]

        public IEntityKeyView<CMS.Models.Article, int> DetailOperater { get; set; }

        [Dependency("CreateOperater")]

        public IEntityAdd<CMS.Models.Article> CreateOperater { get; set; }

        [Dependency("EditOperater")]

        public IEntityUpdate<CMS.Models.Article> EditOperater { get; set; }

        [Dependency("DeleteOperater")]

        public IEntityKeyDel<int> DeleteOperater { get; set; }

        #endregion

DI配置

        public ActionResult Index()

        {

            var operater = IndexOperater;

            IEnumerable<CMS.Models.Article> list = null;

            if (operater != null)

                list = operater.ListAll();

            return View(list ?? Enumerable.Empty<CMS.Models.Article>());

        }

是不是简单到"不可理喻,一点都看不出Dapper痕迹,要的就是这个效果

注:DI没看懂的请参看另一篇文章“Mvc扩展框架及DI”

4、看一下执行效果