百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程网 > 正文

「asp.net core 系列」简化开发的代码生成工具

yuyutoo 2024-10-26 16:11 6 浏览 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用来确保一次请求一个工作流程,简单的代码生成类让我们能让我们忽略那些繁重的创建同类代码的工作。

相关推荐

深度解读Spring框架的核心原理

深度解读Spring框架的核心原理在Java开发的世界里,提到Spring框架,就像提起一位久经沙场的老将,它几乎成了企业级应用开发的代名词。那么,这个被无数开发者膜拜的框架究竟有何独特之处?今天,我...

「Spring认证」Spring 框架概述

Spring是最流行的企业Java应用程序开发框架。全球数以百万计的开发人员使用SpringFramework来创建高性能、易于测试和可重用的代码。Spring框架是一个开源的Java...

学习Spring框架 这一篇就够了

1.spring概述1.1Spring是什么(理解)...

Spring框架双核解析:IOC与AOP的本质与实战

#Spring核心#IOC容器#AOP编程#Java框架设计...

Spring Boot与传统Spring框架的对比:探索Java开发的新境界

SpringBoot与传统Spring框架的对比:探索Java开发的新境界在Java生态系统中,Spring框架无疑是一个里程碑式的存在。从最初的简单依赖注入容器,到如今覆盖企业级开发方方面面的庞大...

Spring MVC框架源码深度剖析:从入门到精通

SpringMVC框架源码深度剖析:从入门到精通SpringMVC框架简介SpringMVC作为Spring框架的一部分,为构建Web应用程序提供了强大且灵活的支持。它遵循MVC(Model-V...

Spring框架入门

一.spring是什么?Spring是分层...

程序员必知必会技能之Spring框架基础——面向切面编程!

面向切面编程AOP(AspectOrientedProgramming)与OOP(ObjectOrientedProgramming,面向对象编程)相辅相成。AOP提供了与OOP不同的抽象软件结...

Spring Security安全框架深度解读:为你的应用穿上“钢铁铠甲”

SpringSecurity安全框架深度解读:为你的应用穿上“钢铁铠甲”在现代网络世界里,保护我们的应用程序免受各种威胁攻击至关重要。而在这个过程中,SpringSecurity框架无疑是我们最可...

Spring框架的设计哲学与实现:打造轻量级的企业级Java应用

Spring框架的设计哲学与实现:打造轻量级的企业级Java应用Spring框架自2003年诞生以来,已成为企业级Java应用开发的代名词。它不仅仅是一个框架,更是一种设计理念和哲学的体现。本文将带你...

Spring框架深度解析:从核心原理到底层实现的全方位避坑指南

一、Spring框架核心概念解析1.控制反转(IoC)与依赖注入(DI)Spring的核心思想是通过IoC容器管理对象的生命周期和依赖关系。传统开发中,对象通过new主动创建依赖对象,导致高耦合;而S...

Java框架 —— Spring简介

简介一般来说,Spring指的是SpringFramework,它提供了很多功能,例如:控制反转(IOC)、依赖注入...

Spring 框架概述,模块划分

Spring框架以控制反转(InversionofControl,IoC)和面向切面编程(Aspect-OrientedProgramming,AOP)为核心,旨在简化企业级应用开发,使开发者...

spring框架怎么实现依赖注入?

依赖注入的作用就是在使用Spring框架创建对象时,动态的将其所依赖的对象注入到Bean组件中,其实现方式通常有两种,一种是属性setter方法注入,另一种是构造方法注入。具体介绍如下:●属性set...

Spring框架详解

  Spring是一种开放源码框架,旨在解决企业应用程序开发的复杂性。一个主要优点就是它的分层体系结构,层次结构让你可以选择要用的组件,同时也为J2EE应用程序开发提供了集成框架。  Spring特征...

取消回复欢迎 发表评论: