分享一個基於Net Core 3.1開發的模塊化的項目

時間 2020-03-10

標籤分享一個基於 core 3.1 開發模塊化項目简体版

原文原文鏈接

先簡單介紹下項目(因爲從新基於模塊化設計了整個項目,因此目前整個項目功能很少)linux

1.Asp.Net Core 3.1.2+MSSQL2019(LINUX版)git

2.中間件涉及Redis、RabbitMQ等github

3.徹底模塊化的設計,支持每一個模塊有獨立的靜態資源文件docker

github開源地址:編程

https://github.com/yupingyong/mangowindows

上一張項目結構圖:mvc

上圖中 Modules目錄下放的項目的模塊app

Mango.WebHost 承載整個項目運行框架

Mango.Framework 封裝整個項目模塊化核心ide

下面我會分享實現模塊化的幾個核心要點,更詳細的我會在後續的博文中陸續發佈.

框架如何去加載所寫的模塊這是最核心的問題之一,好在Asp.Net Core MVC爲模塊化提供了一個部件管理類

Microsoft.AspNetCore.Mvc.ApplicationParts.ApplicationPartManager

它支持從外部DLL程序集加載組件以及組件的管理.不過要從外部組件去獲取哪些是組件咱們須要藉助一個工廠類ApplicationPartFactory,這個類支持從外部程序集獲得對應的控制器信息,核心代碼以下:

 1         /// <summary>
 2         /// 向MVC模塊添加外部應用模塊組件
 3         /// </summary>
 4         /// <param name="mvcBuilder"></param>
 5         /// <param name="assembly"></param>
 6         private static void AddApplicationPart(IMvcBuilder mvcBuilder, Assembly assembly)
 7         {
 8             var partFactory = ApplicationPartFactory.GetApplicationPartFactory(assembly);
 9             foreach (var part in partFactory.GetApplicationParts(assembly))
10             {
11                 mvcBuilder.PartManager.ApplicationParts.Add(part);
12             }
13             
14             var relatedAssemblies = RelatedAssemblyAttribute.GetRelatedAssemblies(assembly, throwOnError: false);
15             foreach (var relatedAssembly in relatedAssemblies)
16             {
17                 partFactory = ApplicationPartFactory.GetApplicationPartFactory(relatedAssembly);
18                 foreach (var part in partFactory.GetApplicationParts(relatedAssembly))
19                 {
20                     mvcBuilder.PartManager.ApplicationParts.Add(part);
21                     mvcBuilder.PartManager.ApplicationParts.Add(new CompiledRazorAssemblyPart(relatedAssembly));
22                 }
23             }
24         }

上面的代碼展現瞭如何加載控制器信息,可是視圖文件在項目生成的時候是單獨的*.Views.dll文件,咱們接下來介紹如何加載視圖文件,一樣仍是用到了ApplicationPartManager類

mvcBuilder.PartManager.ApplicationParts.Add(new CompiledRazorAssemblyPart(module.ViewsAssembly));

new一個CompiledRazorAssemblyPart對象表示添加進去的是視圖編譯文件,完整的核心代碼

 1         /// <summary>
 2         /// 添加MVC組件
 3         /// </summary>
 4         /// <param name="services"></param>
 5         /// <returns></returns>
 6         public static IServiceCollection AddCustomizedMvc(this IServiceCollection services)
 7         {
 8             services.AddSession();
 9 
10             var mvcBuilder = services.AddControllersWithViews(options=> {
11                 //添加訪問受權過濾器
12                 options.Filters.Add(new AuthorizationComponentFilter());
13             })
14                 .AddJsonOptions(options=> {
15                     options.JsonSerializerOptions.Converters.Add(new DateTimeToStringConverter());
16                 });    
17             foreach (var module in GlobalConfiguration.Modules)
18             {
19                 if (module.IsApplicationPart)
20                 {
21                     if (module.Assembly != null)
22                         AddApplicationPart(mvcBuilder, module.Assembly);
23                     if (module.ViewsAssembly != null)
24                         mvcBuilder.PartManager.ApplicationParts.Add(new CompiledRazorAssemblyPart(module.ViewsAssembly));
25                 }
26             }
27             return services;
28         }

那如何去加載程序集呢?這裏我使用了自定義的ModuleAssemblyLoadContext去加載程序集,這個類繼承自AssemblyLoadContext(它支持卸載加載過的程序集,可是部件添加到MVC中時,好像不支持動態卸載會出現異常,多是我還沒研究透吧)

 1 using System;
 2 using System.Collections.Generic;
 3 using System.Linq;
 4 using System.Threading.Tasks;
 5 using System.Reflection;
 6 using System.Runtime.CompilerServices;
 7 using System.Runtime.Loader;
 8 
 9 namespace Mango.Framework.Module
10 {
11     public class ModuleAssemblyLoadContext : AssemblyLoadContext
12     {
13         public ModuleAssemblyLoadContext() : base(true)
14         {
15         }
16     }
17 }

在使用ModuleAssemblyLoadContext類加載程序集時,先使用FileStream把程序集文件讀取出來(這樣可以避免文件一直被佔用,方便開發中編譯模塊時報文件被佔用的異常),加載文件路徑時須要注意的問題必定要使用/(\在windows server下沒問題,可是若是在linux下部署就會出現問題),代碼以下:

 1         /// <summary>
 2         /// 添加模塊
 3         /// </summary>
 4         /// <param name="services"></param>
 5         /// <param name="contentRootPath"></param>
 6         /// <returns></returns>
 7         public static IServiceCollection AddModules(this IServiceCollection services, string contentRootPath)
 8         {
 9             try
10             {
11                 GlobalConfiguration.Modules = _moduleConfigurationManager.GetModules();
12                 ModuleAssemblyLoadContext context = new ModuleAssemblyLoadContext();
13                 foreach (var module in GlobalConfiguration.Modules)
14                 {
15                     var dllFilePath = Path.Combine(contentRootPath, $@"Modules/{module.Id}/{module.Id}.dll");
16                     var moduleFolder = new DirectoryInfo(dllFilePath);
17                     if (File.Exists(moduleFolder.FullName))
18                     {
19                         using FileStream fs = new FileStream(moduleFolder.FullName, FileMode.Open);
20                         module.Assembly = context.LoadFromStream(fs);
21                         //
22                         RegisterModuleInitializerServices(module, ref services);
23                     }
24                     else
25                     {
26                         _logger.Warn($"{dllFilePath} file is not find!");
27                     }
28                     //處理視圖文件程序集加載
29                     var viewsFilePath = Path.Combine(contentRootPath, $@"Modules/{module.Id}/{module.Id}.Views.dll");
30                     moduleFolder = new DirectoryInfo(viewsFilePath);
31                     if (File.Exists(moduleFolder.FullName))
32                     {
33                         using FileStream viewsFileStream = new FileStream(moduleFolder.FullName, FileMode.Open);
34                         module.ViewsAssembly = context.LoadFromStream(viewsFileStream);
35                     }
36                     else
37                     {
38                         _logger.Warn($"{viewsFilePath} file is not find!");
39                     }
40                 }
41             }
42             catch (Exception ex)
43             {
44                 _logger.Error(ex);
45             }
46             return services;
47         }

上面簡單介紹瞭如何利用MVC自帶的部件管理類去加載外部程序集,這裏須要說明的一點的是每一個模塊咱們採用建立區域的方式去區分模塊,以下圖展現的帳號模塊結構

基於模塊化開發咱們可能碰到一個比較常見的需求就是,若是每一個模塊須要擁有本身獨立的靜態資源文件呢?這種狀況如何去解決呢?

好在MVC框架也提供了一個靜態資源配置方法UseStaticFiles,咱們在Configure方法中啓用靜態資源組件時,能夠自定義設置靜態文件訪問的路徑,設置代碼以下

 1             //設置每一個模塊約定的靜態文件目錄
 2             foreach (var module in GlobalConfiguration.Modules)
 3             {
 4                 if (module.IsApplicationPart)
 5                 {
 6                     var modulePath = $"{env.ContentRootPath}/Modules/{module.Id}/wwwroot";
 7                     if (Directory.Exists(modulePath))
 8                     {
 9                         app.UseStaticFiles(new StaticFileOptions()
10                         {
11                             FileProvider = new PhysicalFileProvider(modulePath),
12                             RequestPath = new PathString($"/{module.Name}")
13                         });
14                     }
15                 }
16             }

上述代碼片斷中咱們可以看到經過new StaticFileOptions()添加配置項, StaticFileOptions中有兩個重要的屬性,只須要配置好這兩個就能知足基本需求了

FileProvider:該屬性表示文件的實際所在目錄(如:{env.ContentRootPath}/Modules/Mango.Module.Account/wwwroot)

RequestPath:該屬性表示文件的請求路徑(如 /account/test.js 這樣訪問到就是 {env.ContentRootPath}/Modules/Mango.Module.Account/wwwroot下的test.js文件)

這篇博文我就暫時只作一個模塊化開發實現的核心代碼展現和說明,更具體的只能在接下來的博文中展現了.

其實我也開發了一個先後分離的,只剩下鑑權,實現的核心和上面所寫的同樣,這裏我就只把開源地址分享出來,我後面仍是會用業餘時間來繼續完成它