関連モジュール
- AbpAspNetCoreModule
- AbpAspNetCoreMvcModule
- AbpAspNetCoreMvcContractsModule
これら三つのモジュールを介して、ABPがロードされ、asp.netコアを構成しています。最も重要なのは、独自のコントローラとAppServicesを構築する方法に基づいてAbpAspNetCoreMvcModuleモジュールクラス、ABP ASPNETコアであり、それはこのクラスです。
AbpAspNetCoreMvcModule
ConventionalRegistrarListリストに追加AbpAspNetCoreMvcConventionalRegisterクラス、クラスは主に注入の依存関係を使用し、サービスのライフサイクルを取得しています。public override void PreConfigureServices(ServiceConfigurationContext context) { context.Services.AddConventionalRegistrar(new AbpAspNetCoreMvcConventionalRegistrar()); }
次のステップは、asp.netコアMVCに基づいて、コースの焦点、およびビュー構成コントローラConfigureServices方法、です。最初のconfigureレイザー:
context.Services.Insert(0, ServiceDescriptor.Singleton<IConfigureOptions<RazorViewEngineOptions>>( new ConfigureOptions<RazorViewEngineOptions>(options => { options.FileProviders.Add( new RazorViewEngineVirtualFileProvider( context.Services.GetSingletonInstance<IObjectAccessor<IServiceProvider>>() ) ); } ) ) );
コンフィギュレーション・ディスクリプタのアピ:
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コアベーターServiceBasedControllerActivatorカテゴリを使用して、コントローラを作成するために使用します。
//Use DI to create controllers context.Services.Replace(ServiceDescriptor.Transient<IControllerActivator, ServiceBasedControllerActivator>());
ABPは、独自のコントローラ、およびコントローラの取り出しの決意を構築MVC ControllerFeatureProvider aspnetcoreに基づいてコントローラ基づく慣例特性プロバイダクラスを提供します。
//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 ABP MVCモジュールのは、特にコントローラの作成において、aspnetcore MVCに基づいて構成されます。これは法令AbpAspNetCoreMvcOptionsサービスコントローラーを取得GO得られたコードから見ることができます。結果はコントローラであるかどうかを返します。AbpAspNetCoreMvcOptionsクラスは、以下のように、ソースコードであるABP ASPNETコア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コアAPI?そのようなAクラスAspNetCoreDescriptionModelProviderがあり、このクラスは次のようにソースコードは、モデルASPNETコアの記述を提供することです。
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; } }
このクラスは、そのAPI ABP建てコントローラへのアクションから説明を提供してくれます。これは、1つは、APIコントローラABPの定義は、後者であるAbpApiDefinitionController一ProxyScriptManager、前者が定義され、二つの場所を呼び出す場合生成されたプロキシスクリプト、サンプルプロジェクト書店ABPは、ABP / ServiceProxyScriptインターフェース呼びますjsがアクセスバックエンド法に遠位のAPI appserviceアドレスにアクセスすることで、ドキュメント、API JS URLアドレスでドキュメントを生成します。ソースとして、次のとおりです。
[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主にフロントエンドのアクセスを提供するために、農産物APIに使用される、jqueryのプロキシスクリプトジェネレータを作成しますpublic override void ConfigureServices(ServiceConfigurationContext context) { Configure<AbpApiProxyScriptingOptions>(options => { options.Generators[JQueryProxyScriptGenerator.Name] = typeof(JQueryProxyScriptGenerator); }); }