4. abp中的asp.net core模塊剖析

来源:https://www.cnblogs.com/zhiyong-ITNote/archive/2019/12/07/12002766.html

相關模塊 1. AbpAspNetCoreModule 2. AbpAspNetCoreMvcModule 3. AbpAspNetCoreMvcContractsModule abp通過這三個模塊載入並配置了 asp.net core。,最主要的就是AbpAspNetCoreMvcModule模塊 ...


相關模塊
  1. AbpAspNetCoreModule
  2. AbpAspNetCoreMvcModule
  3. AbpAspNetCoreMvcContractsModule

abp通過這三個模塊載入並配置了 asp.net core。,最主要的就是AbpAspNetCoreMvcModule模塊類,abp如何基於aspnet core構建自己的控制器和AppServices,就是在這個類中。

  • AbpAspNetCoreMvcModule
    將AbpAspNetCoreMvcConventionalRegister類添加到ConventionalRegistrarList列表中,該類主要是用來註入依賴及獲取服務生命周期的。

      public override void PreConfigureServices(ServiceConfigurationContext context)
      {
          context.Services.AddConventionalRegistrar(new AbpAspNetCoreMvcConventionalRegistrar());
      }

    接下來就是重點,在ConfigureServices方法中配置視圖和控制器,當然是基於 asp.net core mvc。首先配置Razor:

      context.Services.Insert(0,
          ServiceDescriptor.Singleton<IConfigureOptions<RazorViewEngineOptions>>(
              new ConfigureOptions<RazorViewEngineOptions>(options =>
                  {
                      options.FileProviders.Add(
                          new RazorViewEngineVirtualFileProvider(
                              context.Services.GetSingletonInstance<IObjectAccessor<IServiceProvider>>()
                          )
                      );
                  }
              )
          )
      );
    

    配置Api描述符:

      Configure<ApiDescriptionModelOptions>(options =>
      {
          options.IgnoredInterfaces.AddIfNotContains(typeof(IAsyncActionFilter));
          options.IgnoredInterfaces.AddIfNotContains(typeof(IFilterMetadata));
          options.IgnoredInterfaces.AddIfNotContains(typeof(IActionFilter));
      });

    可以看到 aspnetcore mvc中的過濾器介面,我們將其添加到了Api描述模型選項類中。下麵就是註入MVC:

      var mvcCoreBuilder = context.Services.AddMvcCore();
      var mvcBuilder = context.Services.AddMvc()
          .AddDataAnnotationsLocalization(options =>
          {
              options.DataAnnotationLocalizerProvider = (type, factory) =>
              {
                  var resourceType = abpMvcDataAnnotationsLocalizationOptions.AssemblyResources.GetOrDefault(type.Assembly);
                  return factory.Create(resourceType ?? type);
              };
          })
          .AddViewLocalization();

    使用DI創建控制器,使用的是aspnet core預設的控制器激活器ServiceBasedControllerActivator類:

      //Use DI to create controllers
      context.Services.Replace(ServiceDescriptor.Transient<IControllerActivator, ServiceBasedControllerActivator>());

    abp提供了一個基於約定的控制器特性提供器類,這個類是基於 aspnetcore mvc的ControllerFeatureProvider構建自己的控制器,並檢索判斷控制器。

      //Add feature providers
      var partManager = context.Services.GetSingletonInstance<ApplicationPartManager>();
      var application = context.Services.GetSingletonInstance<IAbpApplication>();
    
      partManager.FeatureProviders.Add(new AbpConventionalControllerFeatureProvider(application));

    該類源碼:

      public class AbpConventionalControllerFeatureProvider : ControllerFeatureProvider
      {
          private readonly IAbpApplication _application;
    
          public AbpConventionalControllerFeatureProvider(IAbpApplication application)
          {
              _application = application;
          }
    
          protected override bool IsController(TypeInfo typeInfo)
          {
              //TODO: Move this to a lazy loaded field for efficiency.
              if (_application.ServiceProvider == null)
              {
                  return false;
              }
    
              var configuration = _application.ServiceProvider
                  .GetRequiredService<IOptions<AbpAspNetCoreMvcOptions>>().Value
                  .ConventionalControllers
                  .ConventionalControllerSettings
                  .GetSettingOrNull(typeInfo.AsType());
    
              return configuration != null;
          }
      }

    由上,abp會基於aspnetcore mvc配置abp的mvc模塊,特別是Controller的創建。從代碼裡面可以看出獲取到AbpAspNetCoreMvcOptions的服務再去檢索規約的控制器。由此返回是否是控制器。AbpAspNetCoreMvcOptions類是Abp對aspnet core mvc的一個封裝,源碼如下:

      public class AbpAspNetCoreMvcOptions
      {
          public ConventionalControllerOptions ConventionalControllers { get; }
    
          public AbpAspNetCoreMvcOptions()
          {
              ConventionalControllers = new ConventionalControllerOptions();
          }
      }
    
      //規約控制器集合
      public class ConventionalControllerOptions
      {
          public ConventionalControllerSettingList ConventionalControllerSettings { get; }
    
          public List<Type> FormBodyBindingIgnoredTypes { get; }
    
          public ConventionalControllerOptions()
          {
              ConventionalControllerSettings = new ConventionalControllerSettingList();
    
              FormBodyBindingIgnoredTypes = new List<Type>
              {
                  typeof(IFormFile)
              };
          }
    
          public ConventionalControllerOptions Create(Assembly assembly, [CanBeNull] Action<ConventionalControllerSetting> optionsAction = null)
          {
              var setting = new ConventionalControllerSetting(assembly, ModuleApiDescriptionModel.DefaultRootPath); // DefaultRootPath = app,abp路由就是以這個app開頭的。
              optionsAction?.Invoke(setting);
              setting.Initialize();
              ConventionalControllerSettings.Add(setting);
              return this;
          }
      }

    AbpAspNetCoreMvcOptions實際上是通過ConventionalControllerOptions來完成規約的配置,來實現自定義的路由以及動態API。

  • AspNetCoreDescriptionModelProvider

    abp是如何aspnet core創建自己的API的呢?有這麼一個類AspNetCoreDescriptionModelProvider,這個類就是提供了aspnet core的描述模型,源碼如下:

      public class AspNetCoreApiDescriptionModelProvider : IApiDescriptionModelProvider, ITransientDependency
      {
          public ILogger<AspNetCoreApiDescriptionModelProvider> Logger { get; set; }
    
          private readonly IApiDescriptionGroupCollectionProvider _descriptionProvider;
          private readonly AbpAspNetCoreMvcOptions _options;
          private readonly ApiDescriptionModelOptions _modelOptions;
    
          public AspNetCoreApiDescriptionModelProvider(
              IApiDescriptionGroupCollectionProvider descriptionProvider,
              IOptions<AbpAspNetCoreMvcOptions> options,
              IOptions<ApiDescriptionModelOptions> modelOptions)
          {
              _descriptionProvider = descriptionProvider;
              _options = options.Value;
              _modelOptions = modelOptions.Value;
    
              Logger = NullLogger<AspNetCoreApiDescriptionModelProvider>.Instance;
          }
    
          public ApplicationApiDescriptionModel CreateApiModel()
          {
              //TODO: Can cache the model?
    
              var model = ApplicationApiDescriptionModel.Create();
    
              foreach (var descriptionGroupItem in _descriptionProvider.ApiDescriptionGroups.Items)
              {
                  foreach (var apiDescription in descriptionGroupItem.Items)
                  {
                      if (!apiDescription.ActionDescriptor.IsControllerAction())
                      {
                          continue;
                      }
    
                      AddApiDescriptionToModel(apiDescription, model);
                  }
              }
    
              return model;
          }
    
          private void AddApiDescriptionToModel(ApiDescription apiDescription, ApplicationApiDescriptionModel model)
          {
              var controllerType = apiDescription.ActionDescriptor.AsControllerActionDescriptor().ControllerTypeInfo.AsType();
              var setting = FindSetting(controllerType);
    
              var moduleModel = model.GetOrAddModule(GetRootPath(controllerType, setting));
    
              var controllerModel = moduleModel.GetOrAddController(controllerType.FullName, CalculateControllerName(controllerType, setting), controllerType, _modelOptions.IgnoredInterfaces);
    
              var method = apiDescription.ActionDescriptor.GetMethodInfo();
    
              var uniqueMethodName = GetUniqueActionName(method);
              if (controllerModel.Actions.ContainsKey(uniqueMethodName))
              {
                  Logger.LogWarning($"Controller '{controllerModel.ControllerName}' contains more than one action with name '{uniqueMethodName}' for module '{moduleModel.RootPath}'. Ignored: " + method);
                  return;
              }
    
              Logger.LogDebug($"ActionApiDescriptionModel.Create: {controllerModel.ControllerName}.{uniqueMethodName}");
              var actionModel = controllerModel.AddAction(uniqueMethodName, ActionApiDescriptionModel.Create(
                  uniqueMethodName,
                  method,
                  apiDescription.RelativePath,
                  apiDescription.HttpMethod,
                  GetSupportedVersions(controllerType, method, setting)
              ));
    
              AddParameterDescriptionsToModel(actionModel, method, apiDescription);
          }
    
          private static string CalculateControllerName(Type controllerType, ConventionalControllerSetting setting)
          {
              var controllerName = controllerType.Name.RemovePostFix("Controller").RemovePostFix(ApplicationService.CommonPostfixes);
    
              if (setting?.UrlControllerNameNormalizer != null)
              {
                  controllerName = setting.UrlControllerNameNormalizer(new UrlControllerNameNormalizerContext(setting.RootPath, controllerName));
              }
    
              return controllerName;
          }
      }

    這個類為我們提供了從Action到Controller的描述,構建了abp自己的api。它的調用有兩個地方,一個是AbpApiDefinitionController,一個是ProxyScriptManager,前者是定義Abp的api控制器定義的地方,後者則是生成代理腳本的地方,abp的示例項目BookStore中會調用介面Abp/ServiceProxyScript生成一個js文件,這個js文件裡面就是api的url地址,前端通過訪問這個api地址來訪問appservice等後端方法。源碼如下:

      [Area("Abp")]
      [Route("Abp/ServiceProxyScript")]
      [DisableAuditing]
      public class AbpServiceProxyScriptController : AbpController
      {
          private readonly IProxyScriptManager _proxyScriptManager;
    
          public AbpServiceProxyScriptController(IProxyScriptManager proxyScriptManager)
          {
              _proxyScriptManager = proxyScriptManager;
          }
    
          [HttpGet]
          [Produces("text/javascript", "text/plain")]
          public string GetAll(ServiceProxyGenerationModel model)
          {
              model.Normalize();
              return _proxyScriptManager.GetScript(model.CreateOptions());
          }
      }
  • AbpHttpModule模塊
    Abp創建jquery代理腳本生成器,主要用來生產api提供給前端訪問

      public override void ConfigureServices(ServiceConfigurationContext context)
      {
          Configure<AbpApiProxyScriptingOptions>(options =>
          {
              options.Generators[JQueryProxyScriptGenerator.Name] = typeof(JQueryProxyScriptGenerator);
          });
      }

您的分享是我們最大的動力!

更多相關文章
  • 前言本文的文字及圖片來源於網路,僅供學習、交流使用,不具有任何商業用途,版權歸原作者所有,如有問題請及時聯繫我們以作處理。作者:bihl 直接上代碼,哈哈!! from urllib import request import os from user_agents import ua_list i ...
  • 前言 這兩三年項目中一直在使用比較流行的spring cloud框架,也算有一定積累,打算有時間就整理一些乾貨與大家分享。 本次分享zuul網關集成jwt身份驗證 業務背景 項目開發少不了身份認證,jwt作為當下比較流行的身份認證方式之一主要的特點是無狀態,把信息放在客戶端,伺服器端不需要保存ses ...
  • 多任務非同步協程asyncio asyncio的使用 多任務協程 aiohttp的使用 非同步協程爬蟲案例 基於aiohttp的多任務協程的爬蟲 ...
  • 本筆記摘抄自:https://www.cnblogs.com/zhili/archive/2012/07/23/Event_Constructor.html,記錄一下學習過程以備後續查用。 前面講的線程同步主要是用戶模式的(CLR Via C# 一書中是這麼定義的,書中說到線程同步分兩種:一、用戶模 ...
  • 本文介紹了C#中的屬性,以及C#6和C#7中與屬性相關的新特性。 ...
  • 《.Net 最佳實踐》 [作者] (美) Stephen Ritchie[譯者] (中) 黃燈橋 黃浩宇 李永[出版] 機械工業出版社[版次] 2014年01月 第1版[印次] 2018年01月 第1次 印刷[定價] 69.00元 (P001) 開發人員應該對任何稱之為“最佳實踐”的實踐保持一種懷疑 ...
  • 目前遇到的問題: 1.路徑區分大小寫及路徑用“/”,而不是常用的"\\"。 windows下路徑為:"xxxx\\yyyy",Linux路徑下為:"xxxx/yyyy" 使用 Path.Combine("xxxx","yyyy") 進行合併即可。 2.有時候就需要在 docker 容器里訪問宿主機提 ...
  • 安裝 參考文檔:https://docs.docker.com/install/linux/docker-ce/centos/#install-using-the-repository 前提條件 Docker 要求 CentOS 系統的內核版本高於 3.10,在終端輸入以下命令: uname -r ...
一周排行
  • 這是一個個人敘述自己建設博客的帖子,既然是第一篇那肯定是不牽扯代碼了,主要講一下大體的東西,微軟最新的web框架應該就數asp.net core 3.1了這是一個長期支持版,而且是跨平臺又開源版本,所以大家可以去GitHub上找源碼,也可以研究源碼是怎麼寫的。 大過年的偏偏出現這個疫情,所以只能窩屋 ...
  • 上一篇帖子講了用了哪些技術,這個帖子就先介紹介紹api項目吧,項目就是一個普通的webapi項目,賬戶系統用的identity ,什麼是identity呢? 其實就是官方封裝好的一系列的可以用來操作資料庫的類,對用戶信息進行增刪改查。主要牽扯的類有如下幾個: UserManager SignInMa ...
  • 1、添加php的yum軟體倉庫 sudo rpm -Uvh https://mirror.webtatic.com/yum/el6/latest.rpm 2、安裝php相關軟體,執行過程中全部選擇yes即可 sudo yum install php71w.x86_64 php71w-cli.x86_ ...
  • 預設情況下,CentOS6 64 bit 已經早已不支持php5.2.x ,但是某些php程式還需要zend optimizer支持,怎麼辦呢?目前大部分的yum repos 都已經不支持直接安裝php5.2了,怎麼在CentOS6.x/6.5/6.4/6.3/6.2/7.x 64位安裝php5.2 ...
  • Dart Bool類型和其他語言類似,比較簡單 其特點有: 1.使用 bool 表示布爾類型 2.布爾值只有 true 和 false 3.布爾類型bool預設值是null bool isTrue = true; bool isFalse = false; bool defaultBool ; pr ...
  • 今天在資料庫中生成數據表,生成遷移文件時報了一堆錯。 最重要的就是TypeError: __init__() missing 1 required positional argument: 'on_delete', 他說我缺少一個必要的參數。 代碼如下: 關聯外鍵 sgrade = models.F ...
  • —— 終端中的編輯器 01. 簡介 在工作中,要對 伺服器 上的文件進行 簡單 的修改,可以使用 遠程登錄到伺服器上,並且使用 進行快速的編輯即可 常見需要修改的文件包括: 源程式 配置文件 ,例如 的配置文件 在沒有圖形界面的環境下,要編輯文件, 是最佳選擇! 每一個要使用 Linux 的程式員, ...
  • 認識 Python 人生苦短,我用 Python —— Life is short, you need Python 01. Python 的起源 Python 的創始人為吉多·範羅蘇姆(Guido van Rossum) 1. 1989 年的聖誕節期間,吉多·範羅蘇姆為了在阿姆斯特丹打發時間,決心 ...
  • 01. 第一個 程式 1.1 Python 源程式的基本概念 1. Python 源程式就是 一個特殊格式的文本文件 ,可以 使用任意文本編輯軟體 做 的開發 2. Python 程式的 文件擴展名 通常都是 1.2 演練步驟 在桌面下,新建 目錄 在 目錄下新建 文件 使用 gedit 編輯 並且 ...
  • PyCharm 的官方網站地址是:https://www.jetbrains.com/pycharm/ 01. 恢復 PyCharm 的初始設置 的 配置信息 是保存在 用戶家目錄下 的 目錄下的, 表示當前使用的 的版本號 如果要恢復 的初始設置,可以按照以下步驟進行: 1. 關閉正在運行的 2. ...
x