「asp.net core 系列」简化开发的代码生成工具
yuyutoo 2024-10-26 16:11 4 浏览 0 评论
0. 前言
在前一篇中我们创建了一个基于EF的数据查询接口实现基类,这一篇我将带领大家讲一下为这EF补充一些功能,并且提供一个解决避免写大量配置类的方案。
1. SaveChanges的外移
在之前介绍EF Core的时候,我们提到过使用EF需要在每次使用之后,调用一次SaveChanges将数据提交给数据库。在实际开发中,我们不能添加一条数据或者做一次修改就调用一次SaveChanges,这完全不现实。因为每次调用SaveChanges是EF向数据库提交变更的时候,所以EF推荐的是每次执行完用户的请求之后统一提交数据给数据库。
这样就会造成一个问题,可能也不是问题:我们需要一个接口来管理EF 的SaveChanges操作。
1.1 创建一个IUnitOfWork接口
通常我们会在Domain项目中添加一个IUnitOfWork接口,这个接口有一个方法就是SaveChanges,代码如下:
namespace Domain.Insfrastructure
{
public interface IUnitOfWork
{
void SaveChanges();
}
}
这个方法的意思表示到执行该方法的时候,一个完整的工作流程执行完成了。也就是说,当执行该方法后,当前请求不会再与数据库发生连接。
1.2 实现IUnitOfWork接口
在 Domain.Implement中添加IUnitOfWork实现类:
using Domain.Insfrastructure;
using Microsoft.EntityFrameworkCore;
?
namespace Domain.Implements.Insfrastructure
{
public class UnitOfWork: IUnitOfWork
{
private DbContext DbContext;
public UnitOfWork(DbContext context)
{
DbContext = context;
}
?
public void SaveChanges()
{
DbContext.SaveChanges();
}
}
}
1.3 调用时机
到现在我们已经创建了一个UnitOfWork的方法,那么问题来了,我们该在什么时候调用呢,或者说如何调用呢?
我的建议是创建一个ActionFilter,针对所有的控制器进行SaveChanges进行处理。当然了,也可以在控制器中持有一个IUnitOfWork的示例,然后在Action结束的时候,执行SaveChanges。不过这样存在一个问题,可能会存在遗漏的方法。所以我推荐这样操作,这里简单演示一下如何创建拦截器:
在Web的根目录下,创建一个Filters目录,这个目录里用来存储一些过滤器,创建我们需要的过滤器:
using Domain.Insfrastructure;
using Microsoft.AspNetCore.Mvc.Filters;
?
namespace Web.Filters
{
public class UnitOfWorkFilterAttribute : ActionFilterAttribute
{
public IUnitOfWork UnitOfWork;
?
public override void OnActionExecuted(ActionExecutedContext context)
{
UnitOfWork.SaveChanges();
}
}
}
使用一个ActionFilter可以很方便的解决一些容易遗漏但又必须执行的代码。这里就先不介绍如何配置Filter的启用和详细介绍了,请允许我卖个关子。当然了,有些小伙伴肯定也能猜到这是一个Attribute类,所以可以按照Attribute给Controller打标记。
2. 创建一个简单的代码生成方法
之前在介绍EF的时候,有个小伙伴跟我说,还要写配置文件啊,太麻烦了。是的,之前我介绍了很多关于写配置文件不使用特性的好处,但不解决这个问题就无法真正体检配置类的好处。
虽然说,EF Core约定优先,但是如果默认约定的话,得在DBContext中声明 DbSet<T> 来声明这个字段,实体类少的话,比较简单。如果多个数据表的话,就会非常麻烦。
所以这时候就要使用工具类, 那么简单的分析一下,这个工具类需要有哪些功能:
- 第一步,找到实体类并解析出实体类的类名
- 第二步,生成配置文件
- 第三步,创建对应的Repository接口和实现类
很简单的三步,但是难点就是找实体类并解析出实体类名。
在Util项目中添加一个Develop目录,并创建Develop类:
namespace Utils.Develop
{
public class Develop
{
}
}
定位当前类所在目录,通过
Directory.GetCurrentDirectory()
这个方法可以获取当前执行的DLL所在目录,当然不同的编译器在执行的时候,会有微妙的不同。所以我们需要以此为根据然后获取项目的根目录,一个简单的方法,查找*.sln 所在目录:
public static string CurrentDirect
{
get
{
var execute = Directory.GetCurrentDirectory();
var parent = Directory.GetParent(execute);
while(parent.GetFiles("*.sln",SearchOption.TopDirectoryOnly).Length == 0)
{
parent = parent.Parent;
if(parent == null)
{
return null;
}
}
return parent.FullName;
}
}
2.1 获取实体类
那么获取到根目录之后,我们下一步就是获取实体类。因为我们的实体类都要求是继承BaseEntity或者命名空间都是位于Data.Models下面。当然这个名称都是根据实际业务场景约束的,这里只是以当前项目举例。那么,我们可以通过以下方法找到我们设置的实体类:
public static Type[] LoadEntities()
{
var assembly = Assembly.Load("Data");
var allTypes = assembly.GetTypes();
var ofNamespace = allTypes.Where(t => t.Namespace == "Data.Models" || t.Namespace.StartsWith("Data.Models."));
var subTypes = allTypes.Where(t => t.BaseType.Name == "BaseEntity`1");
return ofNamespace.Union(subTypes).ToArray();
}
通过 Assembly加载Data的程序集,然后选择出符合我们要求的实体类。
2.2 编写Repository接口
我们先约定Model的Repository接口定义在 Domain/Repository目录下,所以它们的命名空间应该是:
namespace Domain.Repository
{
}
假设目录情况与Data/Models下面的代码结构保持一致,然后生成代码应该如下:
public static void CreateRepositoryInterface(Type type)
{
var targetNamespace = type.Namespace.Replace("Data.Models", "");
if (targetNamespace.StartsWith("."))
{
targetNamespace = targetNamespace.Remove(0);
}
var targetDir = Path.Combine(new[]{CurrentDirect,"Domain", "Repository"}.Concat(
targetNamespace.Split('.')).ToArray());
if (!Directory.Exists(targetDir))
{
Directory.CreateDirectory(targetDir);
}
?
var baseName = type.Name.Replace("Entity","");
?
if (!string.IsNullOrEmpty(targetNamespace))
{
targetNamespace = #34;.{targetNamespace}";
}
var file = #34;using {type.Namespace};\r\n"
+ #34;using Domain.Insfrastructure;\r\n"
+ #34;namespace Domain.Repository{targetNamespace}\r\n"
+ "{\r\n"
+ #34;\tpublic interface I{baseName}ModifyRepository : IModifyRepository<{type.Name}>\r\n" +
"\t{\r\n\t}\r\n"
+ #34;\tpublic interface I{baseName}SearchRepository : ISearchRepository<{type.Name}>\r\n" +
"\t{\r\n\t}\r\n}";
?
File.WriteAllText(Path.Combine(targetDir, #34;{baseName}Repository.cs"), file);
}
?
2.3 编写Repository的实现类
因为我们提供了一个基类,所以我们在生成方法的时候,推荐继承这个类,那么实现方法应该如下:
public static void CreateRepositoryImplement(Type type)
{
var targetNamespace = type.Namespace.Replace("Data.Models", "");
if (targetNamespace.StartsWith("."))
{
targetNamespace = targetNamespace.Remove(0);
}
?
var targetDir = Path.Combine(new[] {CurrentDirect, "Domain.Implements", "Repository"}.Concat(
targetNamespace.Split('.')).ToArray());
if (!Directory.Exists(targetDir))
{
Directory.CreateDirectory(targetDir);
}
var baseName = type.Name.Replace("Entity", "");
if (!string.IsNullOrEmpty(targetNamespace))
{
targetNamespace = #34;.{targetNamespace}";
}
?
var file = #34;using {type.Namespace};" +
#34;\r\nusing Domain.Implements.Insfrastructure;" +
#34;\r\nusing Domain.Repository{targetNamespace};" +
#34;\r\nusing Microsoft.EntityFrameworkCore;" +
#34;namespace Domain.Implements.Repository{targetNamespace}\r\n" +
"{" +
#34;\r\n\tpublic class {baseName}Repository :BaseRepository<{type.Name}> ,I{baseName}ModifyRepository,I{baseName}SearchRepository " +
"\r\n\t{" +
#34;\r\n\t\tpublic {baseName}Repository(DbContext context) : base(context)"+
"\r\n\t\t{"+
"\r\n\t\t}\r\n"+
"\t}\r\n}";
File.WriteAllText(Path.Combine(targetDir, #34;{baseName}Repository.cs"), file);
}
2.4 配置文件的生成
仔细观察一下代码,可以发现整体都是十分简单的。所以这篇就不掩饰如何生成配置文件了,小伙伴们可以自行尝试一下哦。具体实现可以等一下篇哦。
3. 总结
这一篇粗略的介绍了两个用来辅助EF Core实现的方法或类,这在开发中很重要。UnitOfWork用来确保一次请求一个工作流程,简单的代码生成类让我们能让我们忽略那些繁重的创建同类代码的工作。
相关推荐
- 野路子科技!2步教你把手机改造成一个FTP服务器,支持PC互传
-
哈喽,大家好,我是野路子科技,今天来给大家带来一个教程,希望大家喜欢。正如标题所言,就是教大家如何把售价改造成FTP服务器,而这个时候估计有朋友会问了,把手机改造成FTP服务器有什么用呢?现在有Q...
- 不得不看:别样于Server-U的群晖文件存储服务器的搭建与使用
-
我先前的作品中,有着关于Server-U的ftp文件存储服务器的搭建与访问的头条文章和西瓜视频,而且我们通过各种方式也给各位粉丝介绍了如何突破局域网实现真正意义上的公网访问机制技术。关于Server-...
- Qt三种方式实现FTP上传功能_qt引入qftp库
-
FTP协议FTP的中文名称是“文件传输协议”,是FileTransferProtocol三个英文单词的缩写。FTP协议是TCP/IP协议组中的协议之一,其传输效率非常高,在网络上传输大的文件时,经...
- Filezilla文件服务器搭建及客户端的使用
-
FileZilla是一个免费开源的FTP软件,分为客户端版本和服务器版本,具备所有的FTP软件功能。可控性、有条理的界面和管理多站点的简化方式使得Filezilla客户端版成为一个方便高效的FTP客户...
- 美能达柯美/震旦复印机FTP扫描怎么设置?
-
好多网友不知道怎么安装美能达/震旦复印机扫描,用得最多是SMB和FTP扫描,相对于SMB来说,FTP扫描安装步骤更为便捷,不容易出问题,不需要设置文件夹共享,所以小编推荐FTP来扫描以美能达机器为例详...
- CCD(简易FTP服务器软件)_简单ftp服务器软件
-
CCD简易FTP服务器软件是一款很方便的FPT搭建工具,可以将我们的电脑快速变成一个FPT服务器。使用方法非常简单,只要运行软件就会自动生效,下载银行有该资源。该工具是不提供操作界面的,其他用户可以输...
- Ubuntu系统搭建FTP服务器教程_ubuntu架设服务器
-
在Ubuntu系统上搭建FTP服务器是文件传输的一个非常实用方法,适合需要进行大量文件交换的场景。以下是一步步指导,帮助您在Ubuntu上成功搭建FTP服务器。1.安装vsftpd软件...
- 理光FTP扫描设置教程_理光ftp扫描设置方法
-
此教程主要用来解决WIN10系统下不能使用SMB文件夹扫描的问题,由于旧的SMB协议存在安全漏洞,所以微软在新的系统,WIN8/WIN10/SERVER201220162018里使用了新的SMB传...
- 纯小白如何利用wireshark学习网络技术
-
写在前面工欲善其事必先利其器!熟悉掌握一种神器对以后的工作必然是有帮助的,下面我将从简单的描述Wireshark的使用和自己思考去写,若有错误或不足还请批评指正。...
- 京东买13盘位32GB内存NAS:NAS系统安装设置教程
-
本内容来源于@什么值得买APP,观点仅代表作者本人|作者:yasden你没有看错,我在京东自营商城购买硬件,组装了一台13盘位,32GB内存的NAS,硬盘有13个盘位!CPU是AMD的5500!本文...
- python教程之FTP相关操作_python ftps
-
ftplib类库常用相关操作importftplibftp=ftplib.FTP()ftp.set_debuglevel(2)#打开调试级别2,显示详细信息ftp.connect(“I...
- xftp怎么用,xftp怎么用,具体使用方法
-
Xftp是一款界面化的ftp传输工具,用起来方便简单,这里为大家分享下Xftp怎么使用?希望能帮到有需要的朋友。IIS7服务器管理工具可以批量管理、定时上传下载、同步操作、数据备份、到期提醒、自动更新...
- 树莓派文件上传和下载,详细步骤设置FTP服务器
-
在本指南中,详细记录了如何在树莓Pi上设置FTP。设置FTP可以在网络上轻松地将文件传输到Pi上。FTP是文件传输协议的缩写,只是一种通过网络在两个设备之间传输文件的方法。还有一种额外的方法,你可以用...
- win10电脑操作系统,怎么设置FTP?windows10系统设置FTP操作方法
-
打印,打印,扫描的日常操作是每一个办公工作人员的必需专业技能,要应用FTP作用扫描文件到电脑上,最先要必须一台可以接受文件的FTP服务器。许多软件都需要收费标准进行,但人们还可以应用Windows的系...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- mybatis plus (70)
- scheduledtask (71)
- css滚动条 (60)
- java学生成绩管理系统 (59)
- 结构体数组 (69)
- databasemetadata (64)
- javastatic (68)
- jsp实用教程 (53)
- fontawesome (57)
- widget开发 (57)
- vb net教程 (62)
- hibernate 教程 (63)
- case语句 (57)
- svn连接 (74)
- directoryindex (69)
- session timeout (58)
- textbox换行 (67)
- extension_dir (64)
- linearlayout (58)
- vba高级教程 (75)
- iframe用法 (58)
- sqlparameter (59)
- trim函数 (59)
- flex布局 (63)
- contextloaderlistener (56)