前言
大家好,我是Rector
又是星期五,很兴奋,很高兴,很high...啦啦啦。。。
Rector在码友网又和大家见面啦!!!上一篇《一步一步创建ASP.NET MVC5程序[Repository+Autofac+Automapper+SqlSugar](五)》,我们完成了:
- AutoMapper是什么简述
- 安装AutoMapper
- AutoMapper的配置
- AutoMapper的应用
通过前面几篇文章的学习,本系列【一步一步创建ASP.NET MVC5程序[Repository+Autofac+Automapper+SqlSugar]】中主要涉及到的技术和组件已基本介绍到位了。接下来的系列文章主要会以知识技术整合,提升,重构等为中心来展开,通过解决项目实战遇到的各种问题来帮助大家有目,有方向性地学习,以达到提升大家的ASP.NENT MVC 5开发技能的效果。
本文知识要点
今天要给大家分享的是本系列[一步一步创建ASP.NET MVC5程序]的 进阶知识:
- 泛型仓储
为什么使用泛型仓储
说到为什么使用泛型仓储,我们不得不回到我们的项目,以项目设计来驱动,说明为什么是泛型仓储,用泛型仓储有哪些好处。
回到项目本身
在v1.5版本中,我们已经实现了仓储层和服务层。其中,仓储层是我们直接访问数据库的层,可以通过仓储层对数据库进行任何有权限的操作,包括增,删,改,查。我们的PostRepository博文仓储实现类已经实现了其接口中的增,删,改,查操作,IPostRepository接口:
using System.Collections.Generic;
using TsBlog.Domain.Entities;
namespace TsBlog.Repositories
{
public interface IPostRepository
{
/// <summary>
/// 根据ID查询单条数据
/// </summary>
/// <param name="id">ID</param>
/// <returns></returns>
Post FindById(int id);
/// <summary>
/// 查询所有数据(无分页,大数量时请慎用)
/// </summary>
/// <returns></returns>
IEnumerable<Post> FindAll();
/// <summary>
/// 写入实体数据
/// </summary>
/// <param name="entity">博文实体类</param>
/// <returns></returns>
int Insert(Post entity);
/// <summary>
/// 更新实体数据
/// </summary>
/// <param name="entity">博文实体类</param>
/// <returns></returns>
bool Update(Post entity);
/// <summary>
/// 根据实体删除一条数据
/// </summary>
/// <param name="entity">博文实体类</param>
/// <returns></returns>
bool Delete(Post entity);
/// <summary>
/// 删除指定ID的数据
/// </summary>
/// <param name="id">主键ID</param>
/// <returns></returns>
bool DeleteById(object id);
/// <summary>
/// 删除指定ID集合的数据(批量删除)
/// </summary>
/// <param name="ids">主键ID集合</param>
/// <returns></returns>
bool DeleteByIds(object[] ids);
}
}
看着这个接口类文件现在想一下,如果我们再在数据库新增一个用户表(User),然后在领域项目【TsBlog.Domain】中对应创建领域实体(User),那么按照本系列以前添加仓储和服务层接口的步骤,我们是不是还需要在仓储中创建一个IUserRepository.cs,如果IUserRepository也包括了增,删,改,查方法,那么我们是不是需要把IPostRepository中的所有接口方法复制到IUserRepository.cs文件中呢?同时,其实现也要同样的复制。
如果我们又添加在数据库新增了多张表,对应的仓储接口和实现是不是又要重复以上的操作呢?ctrl+c , ctrl+v !!! 如果是这样,还不如使用代码生成器来得快。
看到这里,希望有开发经验的开发者们不要笑话。回想一下当初笔者在初入.NET开发的时候也是这么干的,复制,粘贴,代码生成器都用过。随着时间和经验的积累,你也会变得更好,前提是少用或者不用复制,粘贴来实现编码功能,即使是网上找的实现方法,也要自己动手敲一遍。
以上两段话跑题了,我们还是切回正题,上面提到的问题其实是有办法来避免重复工作,减轻我们的工作量的,即使用泛型仓储。
泛型仓储的实现
首先,打开项目【TsBlog.Repositories】,创建接口文件 IRepository.cs,在其中编写通用的查询接口方法:
using System;
using System.Collections.Generic;
using System.Linq.Expressions;
namespace TsBlog.Repositories
{
/// <summary>
/// 仓储通用接口类
/// </summary>
/// <typeparam name="T">泛型实体类</typeparam>
public interface IRepository<T> where T : class, new()
{
/// <summary>
/// 根据主值查询单条数据
/// </summary>
/// <param name="pkValue">主键值</param>
/// <returns>泛型实体</returns>
T FindById(object pkValue);
/// <summary>
/// 查询所有数据(无分页,请慎用)
/// </summary>
/// <returns></returns>
IEnumerable<T> FindAll();
/// <summary>
/// 根据条件查询数据
/// </summary>
/// <param name="predicate">条件表达式树</param>
/// <param name="orderBy">排序</param>
/// <returns>泛型实体集合</returns>
IEnumerable<T> FindListByClause(Expression<Func<T, bool>> predicate, string orderBy);
/// <summary>
/// 根据条件查询数据
/// </summary>
/// <param name="predicate">条件表达式树</param>
/// <returns></returns>
T FindByClause(Expression<Func<T, bool>> predicate);
/// <summary>
/// 写入实体数据
/// </summary>
/// <param name="entity">实体类</param>
/// <returns></returns>
long Insert(T entity);
/// <summary>
/// 更新实体数据
/// </summary>
/// <param name="entity"></param>
/// <returns></returns>
bool Update(T entity);
/// <summary>
/// 删除数据
/// </summary>
/// <param name="entity">实体类</param>
/// <returns></returns>
bool Delete(T entity);
/// <summary>
/// 删除数据
/// </summary>
/// <param name="where">过滤条件</param>
/// <returns></returns>
bool Delete(Expression<Func<T, bool>> @where);
/// <summary>
/// 删除指定ID的数据
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
bool DeleteById(object id);
/// <summary>
/// 删除指定ID集合的数据(批量删除)
/// </summary>
/// <param name="ids"></param>
/// <returns></returns>
bool DeleteByIds(object[] ids);
}
}
创建泛型基类 GenericRepository.cs :
using System;
using System.Collections.Generic;
using System.Linq.Expressions;
namespace TsBlog.Repositories
{
public abstract class GenericRepository<T> : IRepository<T> where T : class, new()
{
#region Implementation of IRepository<T>
/// <summary>
/// 根据主值查询单条数据
/// </summary>
/// <param name="pkValue">主键值</param>
/// <returns>泛型实体</returns>
public T FindById(object pkValue)
{
using (var db = DbFactory.GetSqlSugarClient())
{
var entity = db.Queryable<T>().InSingle(pkValue);
return entity;
}
}
/// <summary>
/// 查询所有数据(无分页,请慎用)
/// </summary>
/// <returns></returns>
public IEnumerable<T> FindAll()
{
using (var db = DbFactory.GetSqlSugarClient())
{
var list = db.Queryable<T>().ToList();
return list;
}
}
/// <summary>
/// 根据条件查询数据
/// </summary>
/// <param name="predicate">条件表达式树</param>
/// <param name="orderBy">排序</param>
/// <returns>泛型实体集合</returns>
public IEnumerable<T> FindListByClause(Expression<Func<T, bool>> predicate, string orderBy)
{
using (var db = DbFactory.GetSqlSugarClient())
{
var entities = db.Queryable<T>().Where(predicate).ToList();
return entities;
}
}
/// <summary>
/// 根据条件查询数据
/// </summary>
/// <param name="predicate">条件表达式树</param>
/// <returns></returns>
public T FindByClause(Expression<Func<T, bool>> predicate)
{
using (var db = DbFactory.GetSqlSugarClient())
{
var entity = db.Queryable<T>().First(predicate);
return entity;
}
}
/// <summary>
/// 写入实体数据
/// </summary>
/// <param name="entity">实体类</param>
/// <returns></returns>
public long Insert(T entity)
{
using (var db = DbFactory.GetSqlSugarClient())
{
//返回插入数据的标识字段值
var i = db.Insertable(entity).ExecuteReturnBigIdentity();
return i;
}
}
/// <summary>
/// 更新实体数据
/// </summary>
/// <param name="entity"></param>
/// <returns></returns>
public bool Update(T entity)
{
using (var db = DbFactory.GetSqlSugarClient())
{
//这种方式会以主键为条件
var i = db.Updateable(entity).ExecuteCommand();
return i > 0;
}
}
/// <summary>
/// 删除数据
/// </summary>
/// <param name="entity">实体类</param>
/// <returns></returns>
public bool Delete(T entity)
{
using (var db = DbFactory.GetSqlSugarClient())
{
var i = db.Deleteable(entity).ExecuteCommand();
return i > 0;
}
}
/// <summary>
/// 删除数据
/// </summary>
/// <param name="where">过滤条件</param>
/// <returns></returns>
public bool Delete(Expression<Func<T, bool>> @where)
{
using (var db = DbFactory.GetSqlSugarClient())
{
var i = db.Deleteable<T>(@where).ExecuteCommand();
return i > 0;
}
}
/// <summary>
/// 删除指定ID的数据
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
public bool DeleteById(object id)
{
using (var db = DbFactory.GetSqlSugarClient())
{
var i = db.Deleteable<T>(id).ExecuteCommand();
return i > 0;
}
}
/// <summary>
/// 删除指定ID集合的数据(批量删除)
/// </summary>
/// <param name="ids"></param>
/// <returns></returns>
public bool DeleteByIds(object[] ids)
{
using (var db = DbFactory.GetSqlSugarClient())
{
var i = db.Deleteable<T>().In(ids).ExecuteCommand();
return i > 0;
}
}
#endregion
}
}
现在,仓储接口和泛型仓储基类已创建好了,接下来我们重构 IPostRepository 和 PostRepository,使他们分别继承自 IRepository 和 GenericRepository。
IPostRepository.cs
using TsBlog.Domain.Entities;
namespace TsBlog.Repositories
{
public interface IPostRepository :IRepository<Post>
{
}
}
PostRepository.cs
using TsBlog.Domain.Entities;
namespace TsBlog.Repositories
{
/// <summary>
/// POST表的数据库操作类
/// </summary>
public class PostRepository : GenericRepository<Post>
{
}
}
IPostRepository 和 PostRepository 是不是一下简洁了很多,但实现的方法还是和重构前是一样的。
怎么样,如果我们再新增用户表的仓储接口和仓储实现是不是非常简单了呢?再也不用为重复的增,删,改,查操作来复制,粘贴了。
配置基于接口的依赖注入
在项目【TsBlog.Repositories】中添加接口类 IDependency.cs :
namespace TsBlog.Repositories
{
/// <summary>
/// 依赖注入的接口约束
/// </summary>
public interface IDependency
{
}
}
在泛型仓储抽象基类 GenericRepository.cs 中添加 IDependency 接口约束 :
public abstract class GenericRepository<T> : IDependency, IRepository<T> where T : class, new()
打开项目【TsBlog.Frontend】中的 Global.asax 重新配置 AutofacRegister 方法,如下:
private void AutofacRegister()
{
var builder = new ContainerBuilder();
//注册MvcApplication程序集中所有的控制器
builder.RegisterControllers(typeof(MvcApplication).Assembly);
//注册仓储层服务
//builder.RegisterType<PostRepository>().As<IPostRepository>();
//注册基于接口约束的实体
var assembly = AppDomain.CurrentDomain.GetAssemblies();
builder.RegisterAssemblyTypes(assembly)
.Where(
t => t.GetInterfaces()
.Any(i => i.IsAssignableFrom(typeof(IDependency)))
)
.AsImplementedInterfaces()
.InstancePerDependency();
//注册服务层服务
builder.RegisterType<PostService>().As<IPostService>();
//注册过滤器
builder.RegisterFilterProvider();
var container = builder.Build();
//设置依赖注入解析器
DependencyResolver.SetResolver(new AutofacDependencyResolver(container));
}
按F5运行,是否报错了?
是的,因为我们刚才修改了泛型仓储中Insert的返回类型,所以,修改 IPostService.cs中的Insert的返回类型为long:
long Insert(Post entity);
修改后的 IPostService.cs:
using System.Collections.Generic;
using TsBlog.Domain.Entities;
namespace TsBlog.Services
{
public interface IPostService
{
/// <summary>
/// 根据ID查询单条数据
/// </summary>
/// <param name="id">ID</param>
/// <returns></returns>
Post FindById(int id);
/// <summary>
/// 查询所有数据(无分页,大数量时请慎用)
/// </summary>
/// <returns></returns>
IEnumerable<Post> FindAll();
/// <summary>
/// 写入实体数据
/// </summary>
/// <param name="entity">博文实体类</param>
/// <returns></returns>
long Insert(Post entity);
/// <summary>
/// 更新实体数据
/// </summary>
/// <param name="entity">博文实体类</param>
/// <returns></returns>
bool Update(Post entity);
/// <summary>
/// 根据实体删除一条数据
/// </summary>
/// <param name="entity">博文实体类</param>
/// <returns></returns>
bool Delete(Post entity);
/// <summary>
/// 删除指定ID的数据
/// </summary>
/// <param name="id">主键ID</param>
/// <returns></returns>
bool DeleteById(object id);
/// <summary>
/// 删除指定ID集合的数据(批量删除)
/// </summary>
/// <param name="ids">主键ID集合</param>
/// <returns></returns>
bool DeleteByIds(object[] ids);
}
}
再修改 PostService.cs中的Insert的返回类型为long:
public long Insert(Post entity)
{
return _postRepository.Insert(entity);
}
修改后的 PostService.cs:
using System.Collections.Generic;
using TsBlog.Domain.Entities;
using TsBlog.Repositories;
namespace TsBlog.Services
{
public class PostService : IPostService
{
private readonly IRepository<Post> _postRepository;
public PostService(IRepository<Post> postRepository)
{
_postRepository = postRepository;
}
public bool Delete(Post entity)
{
return _postRepository.Delete(entity);
}
public bool DeleteById(object id)
{
return _postRepository.DeleteById(id);
}
public bool DeleteByIds(object[] ids)
{
return _postRepository.DeleteByIds(ids);
}
public IEnumerable<Post> FindAll()
{
return _postRepository.FindAll();
}
public Post FindById(int id)
{
return _postRepository.FindById(id);
}
public long Insert(Post entity)
{
return _postRepository.Insert(entity);
}
public bool Update(Post entity)
{
return _postRepository.Update(entity);
}
}
}
请注意:在 PostRepository.cs中还没有继承至 IPostRepository.cs ,所以,在 PostService.cs 的构造函数中我们暂时使用泛型接口 IRepository<T>:
private readonly IRepository<Post> _postRepository; public PostService(IRepository<Post> postRepository)
_postRepository = postRepository;
}
下一篇将解决这个问题
再次按F5运行,打开页面[http://localhost:54739/home/post],熟悉你页面又回来了,哈哈。。。
![create-aspnet-mvc-5-web-application-repository-autofac-automapper-sqlsugar-step-by-step-06][2]
本文的源码托管地址:https://github.com/lampo1024/TsBlog/releases/tag/v1.6
本文学习到此结束,本系列未完待续,我们下期再见……
如果你喜欢Rector的本系列文章,请为我点个大大的赞。
本文来源 [码友网][3] 《[一步一步创建ASP.NET MVC5程序\[Repository+Autofac+Automapper+SqlSugar\](六)][4]》
[1]: http://codedefault.com/p/create-aspnet-mvc-5-web-application-repository-autofac-automapper-sqlsugar-step-by-step-05
[2]: http://statics.codedefault.com/uploads/2017/12/create-aspnet-mvc-5-web-application-repository-autofac-automapper-sqlsugar-step-by-step-05-05.png
[3]: http://codedefault.com