一. 前言
从本节开始,将陆续的介绍几种框架搭建组合形式,分析每种搭建形式的优势和弊端,剖析搭建过程中涉及到的一些思想和技巧。
(一). 技术选型
1. DotNet框架:4.6
2. 数据库访问:EF 6.2 (CodeFrist模式)
3. IOC框架:AutoFac 4.8.1 和 AutoFac.MVC5 4.0.2
4. 日志框架:log4net 2.0.8
5. 开发工具:VS2017
(二). 框架目标
1. 一个项目同时连接多个相同种类的数据库,在一个方法中可以同时对多个数据进行操作。
2. 支持多种数据库:SqlServer、MySQL、Oracle,灵活的切换数据库。
3. 抽象成支持多种数据库连接方式:EF、ADO.Net、Dapper。
二. 搭建思路
1. 层次划分
将框架分为:Ypf.Data、Ypf.IService、Ypf.Service、Ypf.DTO、Ypf.Utils、Ypf.AdminWeb 六个基本层(后续还会补充 Ypf.Api层),每层的作用分别为:
①. Ypf.Data:存放连接数据库的相关类,包括EF上下文类、映射的实体类、实体类的FluentApi模式的配置类。
②. Ypf.IService:业务接口层,用来约束接口规范。
③. Ypf.Service:业务层,用来编写整套项目的业务方法,但需要符合Ypf.IService层的接口约束。
④. Ypf.DTO: 存放项目中用到的自定义的实体类。
⑤. Ypf.Utils: 工具类
⑥. Ypf.AdminWeb: 表现层,系统的展示、接受用户的交互,传递数据,业务对接。
PS:后续会补充Ypf.Api层,用于接受移动端、或其他客户端接口数据,进行相应的业务对接处理。
2. Ypf.Data层的剖析
把EF封装到Ypf.Data层,通过Nuget引入EF的程序集,利用FluentAPI的模式先进行配置(实际项目多种模式配合使用),该层的结构如下:
PS:EF的关闭默认策略、EF的DataAnnotations、EF的FluentAPI模式, 在关闭数据库策略的情况下,无论哪种模式都需要显式的 ToTable来映射表名,否则会提示该类找不到。
EF配置详情参考:
第十五节: EF的CodeFirst模式通过DataAnnotations修改默认协定
第十六节: EF的CodeFirst模式通过Fluent API修改默认协定
3. Service层和IService层简单的封装一下
【PS:这个地方是个关键点,需要考虑多种不同的写法,然后进行封装】
①.【Ypf.Service】层只有一个BaseService泛型类封装,【Ypf.IService】层并没有设置IBaseService接口,设置了一个IServiceSupport标识接口(没有任何内容),需要“AutoFac注入”的所有子类IxxxService都要实现IServiceSupport接口。
②.【Ypf.Service】层中有很多自定义的 xxxService,每个xxxService都要实现【Ypf.IService】层的IxxxService层接口,这里的xxxService层划分并不依赖表名划分,自定义根据业务合理起名即可。
③. xxxService类中,利用using() 包裹EF的上下文“db”便于释放,然后把EF上下文传入到泛型的BaseService类的构造函数中,可以调用其封装的方法。
④.利用AutoFac实现在控制器中属性的注入,相应的配置均写在Global文件中。
⑤.控制器中的Action仅仅负责传值和简单的一些判断,核心业务全部都写在Service层中。
4. 利用AutoFac实现Ypf.AdminWeb层与Ypf.Service层解耦
利用AutoFac进行整合,使Ypf.AdminWeb层只需要引入YpfIService层即可,但需要改一下Ypf. Service输出路径使其程序集输出到Ypf.AdminWeb层中。
解析:利用AutoFac把Ypf.Service中的所有类注册给它的全部实现接口(一个类可能实现了多个接口),并且把实现类中的属性也进行注册(实现类中也可能包含属性的注入)。
AutoFac的配置详情参考:
第二节:框架前期准备篇之AutoFac常见用法总结
5. 将Log4net整合到Ypf.Utils层中
解析:主要配置了两种模式,输出到“txt文本文档”和“SQLServer数据库中”。其中“文本文档”又分了两种模式,全部输入到一个文档中 和 不同类型的日志输入到不同文档下,在调用的时候通过传入参数来区分存放在哪个文件夹下。
Log4net的配置详情参考:
第一节:框架前期准备篇之Log4Net日志详解
6. 完善【Ypf.Service】层中BaseService的封装
封装EF常用的增删改查的方法,这里暂时先不扩展EF插件的方法,分享一下代码。
1 using System; 2 using System.Collections.Generic; 3 using System.Data.Entity; 4 using System.Data.SqlClient; 5 using System.Linq; 6 using System.Linq.Expressions; 7 using System.Reflection; 8 using System.Text; 9 using System.Threading.Tasks; 10 using Ypf.Data; 11 12 namespace Ypf.Service.BaseClass 13 { 14 public class BaseService where T : class 15 //public class BaseService 16 { 17 private DbContext db; 18 19 //子类通过构造函数来传入EF上下文 20 public BaseService(DbContext db) 21 { 22 this.db = db; 23 } 24 25 /****************************************下面进行方法的封装***********************************************/ 26 //1. 直接提交数据库 27 28 #region 01-数据源 29 public IQueryable Entities 30 { 31 get 32 { 33 return db.Set(); 34 } 35 } 36 #endregion 37 38 #region 02-新增 39 public int Add(T model) 40 { 41 DbSet dst = db.Set(); 42 dst.Add(model); 43 return db.SaveChanges(); 44 45 } 46 #endregion 47 48 #region 03-删除(适用于先查询后删除 单个) 49 /// 50 /// 删除(适用于先查询后删除的单个实体) 51 /// 52 /// 需要删除的实体 53 /// 54 public int Del(T model) 55 { 56 db.Set().Attach(model); 57 db.Set().Remove(model); 58 return db.SaveChanges(); 59 } 60 #endregion 61 62 #region 04-根据条件删除(支持批量删除) 63 /// 64 /// 根据条件删除(支持批量删除) 65 /// 66 /// 传入Lambda表达式(生成表达式目录树) 67 /// 68 public int DelBy(Expression> delWhere) 69 { 70 List listDels = db.Set().Where(delWhere).ToList(); 71 listDels.ForEach(d => 72 { 73 db.Set().Attach(d); 74 db.Set().Remove(d); 75 }); 76 return db.SaveChanges(); 77 } 78 #endregion 79 80 #region 05-单实体修改 81 /// 82 /// 修改 83 /// 84 /// 修改后的实体 85 /// 86 public int Modify(T model) 87 { 88 db.Entry(model).State = EntityState.Modified; 89 return db.SaveChanges(); 90 } 91 #endregion 92 93 #region 06-批量修改(非lambda) 94 /// 95 /// 批量修改(非lambda) 96 /// 97 /// 要修改实体中 修改后的属性 98 /// 查询实体的条件 99 /// lambda的形式表示要修改的实体属性名100 /// 101 public int ModifyBy(T model, Expression> whereLambda, params string[] proNames)102 {103 List listModifes = db.Set().Where(whereLambda).ToList();104 Type t = typeof(T);105 List proInfos = t.GetProperties(BindingFlags.Instance | BindingFlags.Public).ToList();106 Dictionary dicPros = new Dictionary();107 proInfos.ForEach(p =>108 {109 if (proNames.Contains(p.Name))110 {111 dicPros.Add(p.Name, p);112 }113 });114 foreach (string proName in proNames)115 {116 if (dicPros.ContainsKey(proName))117 {118 PropertyInfo proInfo = dicPros[proName];119 object newValue = proInfo.GetValue(model, null);120 foreach (T m in listModifes)121 {122 proInfo.SetValue(m, newValue, null);123 }124 }125 }126 return db.SaveChanges();127 }128 #endregion129 130 #region 07-根据条件查询131 /// 132 /// 根据条件查询133 /// 134 /// 查询条件(lambda表达式的形式生成表达式目录树)135 /// 136 public List GetListBy(Expression> whereLambda)137 {138 return db.Set().Where(whereLambda).ToList();139 }140 #endregion141 142 #region 08-根据条件排序和查询143 /// 144 /// 根据条件排序和查询145 /// 146 /// 排序字段类型147 /// 查询条件148 /// 排序条件149 /// 升序or降序150 /// 151 public List GetListBy(Expression> whereLambda, Expression> orderLambda, bool isAsc = true)152 {153 List list = null;154 if (isAsc)155 {156 list = db.Set().Where(whereLambda).OrderBy(orderLambda).ToList();157 }158 else159 {160 list = db.Set().Where(whereLambda).OrderByDescending(orderLambda).ToList();161 }162 return list;163 }164 #endregion165 166 #region 09-分页查询167 /// 168 /// 根据条件排序和查询169 /// 170 /// 排序字段类型171 /// 页码172 /// 页容量173 /// 查询条件174 /// 排序条件175 /// 升序or降序176 /// 177 public List GetPageList(int pageIndex, int pageSize, Expression> whereLambda, Expression> orderLambda, bool isAsc = true)178 {179 180 List list = null;181 if (isAsc)182 {183 list = db.Set().Where(whereLambda).OrderBy(orderLambda)184 .Skip((pageIndex - 1) * pageSize).Take(pageSize).ToList();185 }186 else187 {188 list = db.Set().Where(whereLambda).OrderByDescending(orderLambda)189 .Skip((pageIndex - 1) * pageSize).Take(pageSize).ToList();190 }191 return list;192 }193 #endregion194 195 #region 10-分页查询输出总行数196 /// 197 /// 根据条件排序和查询198 /// 199 /// 排序字段类型200 /// 页码201 /// 页容量202 /// 查询条件203 /// 排序条件204 /// 升序or降序205 /// 206 public List GetPageList(int pageIndex, int pageSize, ref int rowCount, Expression> whereLambda, Expression> orderLambda, bool isAsc = true)207 {208 int count = 0;209 List list = null;210 count = db.Set().Where(whereLambda).Count();211 if (isAsc)212 {213 var iQueryList = db.Set().Where(whereLambda).OrderBy(orderLambda)214 .Skip((pageIndex - 1) * pageSize).Take(pageSize);215 216 list = iQueryList.ToList();217 }218 else219 {220 var iQueryList = db.Set().Where(whereLambda).OrderByDescending(orderLambda)221 .Skip((pageIndex - 1) * pageSize).Take(pageSize);222 list = iQueryList.ToList();223 }224 rowCount = count;225 return list;226 }227 #endregion228 229 230 //2. SaveChange剥离出来,处理事务231 232 #region 01-批量处理SaveChange()233 /// 234 /// 事务批量处理235 /// 236 /// 237 public int SaveChange()238 {239 return db.SaveChanges();240 }241 #endregion242 243 #region 02-新增244 /// 245 /// 新增246 /// 247 /// 需要新增的实体248 public void AddNo(T model)249 {250 db.Set().Add(model);251 }252 #endregion253 254 #region 03-删除255 /// 256 /// 删除257 /// 258 /// 需要删除的实体259 public void DelNo(T model)260 {261 db.Entry(model).State = EntityState.Deleted;262 }263 #endregion264 265 #region 04-根据条件删除266 /// 267 /// 条件删除268 /// 269 /// 需要删除的条件270 public void DelByNo(Expression> delWhere)271 {272 List listDels = db.Set().Where(delWhere).ToList();273 listDels.ForEach(d =>274 {275 db.Set().Attach(d);276 db.Set().Remove(d);277 });278 }279 #endregion280 281 #region 05-修改282 /// 283 /// 修改284 /// 285 /// 修改后的实体286 public void ModifyNo(T model)287 {288 db.Entry(model).State = EntityState.Modified;289 }290 #endregion291 292 293 //3. EF调用sql语句294 295 #region 01-执行增加,删除,修改操作(或调用存储过程)296 /// 297 /// 执行增加,删除,修改操作(或调用存储过程)298 /// 299 /// 300 /// 301 /// 302 public int ExecuteSql(string sql, params SqlParameter[] pars)303 {304 return db.Database.ExecuteSqlCommand(sql, pars);305 }306 307 #endregion308 309 #region 02-执行查询操作310 /// 311 /// 执行查询操作312 /// 313 /// 314 /// 315 /// 316 /// 317 public List ExecuteQuery(string sql, params SqlParameter[] pars)318 {319 return db.Database.SqlQuery(sql, pars).ToList();320 }321 #endregion322 323 324 325 }326 }
三. 剖析核心
1. 如何实现同时操作多个相同类型的不同结构的数据库。
首先【Ypf.Data】层中新建一个存放的实体的文件夹,如“EntityTest”,用来引入另外一个数据库的存放实体和DbContext上下文,然后在【Ypf.Service】层中,双Using,往BaseService类中传入不同db上下文即可实现访问不同的数据库,如果要对多个数据库开启事务,手动开启msdtc服务,然后使用Transactions包裹,进行事务一体操作。
详细的使用步骤见:实战测试。
2. 体会【Ypf.IService】层 和 引入IOC框架的作用
【PS:依赖倒置原则的核心就是:面向接口编程】
(1). 接口层的作用:
a. 便于开发人员分工开发,写业务的单独去写业务,对接的单独去对接,而且事先把接口协议定好,那么对接的人员就不需要等业务人员全部写完代码,就可以对接了,无非最后再测试而已。
b. 降低修改代码造成的成本代价,使以接口为基础搭建起来的框架更加稳健。
举例1: 三层架构 数据库访问层、业务逻辑层、UI调用层。 (非此套框架的模式,后面考虑这么改进)
①. 数据库访问层中有一个 MySqlHelp类,提供链接MySQL数据增删改查的方法。
②. 业务逻辑层有一个登录业务 CheckLogin(MySqlHelp mysql,string userName,string pwd)。
③. UI调用层要调用CheckLogin方法,这时候实例化一个MySqlHelp对象,传到CheckLogin方法中即可。
有一个天,要求支持oracle数据库,所以数据库访问层中增加了一个oracleHelper类,UI调用层按照常规实例化了一个oracleHelper对象,传到CheckLogin方法中,发现我的天!!!!CheckLogin竟然不支持oracleHelper对象,同时发现类似的所有业务层的方法都不支持oracleHelper类,这个时候悲剧就发生了,如果全部改业务层的方法,基本上完蛋。
所以根本的解决方案:依赖倒置原则,即面向接口编程。
①. 数据库访问层声明一个接口IHelper,里面有增删改查方法,MySqlHelp和oracleHelper都实现IHelper接口。
②. 业务逻辑层有一个登录业务改为依赖接口IHelper, CheckLogin(IHelper iHelper,string userName,string pwd)。
③. UI调用层要调用CheckLogin方法,想连哪个数据,就实例化哪个 eg IHelper iHelper=new MySqlHelp(); 或者 IHelper iHelper=new oracleHelper(),此处考虑和IOC框架结合,连代码都不用改,直接改配置文件就行了,就可以切换实例,然后调用CheckLogin即可。
举例2: 类A,类B,类C。
类A中的方法需要传入类B的实例,通常在类A中实例化一下类B,但如果想让类A依赖类C,你会发现改动非常大,类A中的方法原先是类B的参数全部需要改。
所以解决方案:类B和类C都实现接口I,类A中方法的参数由原先的类B改为接口I,这样类A想依赖谁,只需要 I i=new B() 或者 I i=new C(),所有的方法都不用改,也可以再升级一下,这里不直接实例化,利用IOC框架或者手写反射,只需要改一下配置文件,就能控制 到底是 new B 还是 new C 。
(2). 引入IOC框架的作用:
解决的问题1:现有的框架模式(Service层using引入EF上下文,传入到BaseService类中),如何实现快速切换数据库?
a.首先在【Ypf.Data】层引入MySQL数据库所需要的程序集,配置文件也改成连接MySQL的。(此处需要详细测试)
b. 新建一个【Ypf.Service2】层,同样实现对应业务,只不过是连接不同类型的数据库(比如它连接的是MySql数据库),生成路径也输出到【Ypf.AdminWeb】层中,最后只需要改一下AutoFac读取的配置文件“DllName”改为“Ypf.Services2”即可,就可以实现切换数据。
总结:该模式虽然能实现“相同业务、相同表”的不同类型的数据库切换(比如SQLServer→MySQL),但是需要重新写一个整层【Ypf.Service2】,虽然基本上是复制,但是有一定工作量的。但是另外通过手写IOC也可以实现(反射+简单工厂+配置文件),看不到IOC框架的优势所在。
IOC强大之处在于框架本身为我们封装好了很多便于开发的方法,拿AutoFac来说吧,能灵活的控制创建对象的(每次请求都创建、单例、一个Http请求内单例)
四. 实战测试
这里准备两个数据库,分别是:YpfFrame_DB 和 YpfFrameTest_DB
①:YpfFrame_DB中,用到了表:T_SysUser 和 T_SysLoginLog,表结构如下
②. YpfFrameTest_DB 表中用到了T_SchoolInfor,表结构如下
开始测试
1. 测试增删改查,包括基本的事务一体。
在【Ypf.IService】层中新建ITestService接口,在【Ypf.Service】层中新建TestService类,实现ITestService接口, 定义TestBasicCRUD方法,进行测试,代码如下。
1 /// 2 /// 1.测试基本的增删改查,事务一体 3 /// 4 /// 5 public int TestBasicCRUD() 6 { 7 using (DbContext db = new MyDBContext1()) 8 { 9 BaseService T_SysUserService = new BaseService(db);10 BaseService T_SysLoginLogService = new BaseService(db);11 //1.增加操作12 T_SysUser t_SysUser = new T_SysUser()13 {14 id = Guid.NewGuid().ToString("N"),15 userAccount = "123456