4. abp의 asp.netcore 모듈 분석

10801 단어
관련 모듈
  • AbpAspNetCoreModule
  • AbpAspNetCoreMvcModule
  • AbpAspNetCoreMvcContractsModule

  • abp는 이 세 모듈을 통해 asp를 불러오고 설정합니다.net core.,가장 중요한 것은 AbpAspNetCoreMvcModule 모듈 클래스이다. abp가 aspnetcore를 바탕으로 자신의 컨트롤러와 AppServices를 구축하는 방법은 바로 이 클래스에 있다.
  • AbpAspNetCoreMvcModule는AbpAspNetCoreMvcConventionalRegister류를 ConventionalRegistrarList 목록에 추가했는데 이 종류는 주로 의존을 주입하고 서비스의 생명 주기를 얻는 데 사용된다.
      public override void PreConfigureServices(ServiceConfigurationContext context)
      {
          context.Services.AddConventionalRegistrar(new AbpAspNetCoreMvcConventionalRegistrar());
      }
    다음은 중점이다. Configure 서비스 방법에서 보기와 컨트롤러를 설정하는 것은 당연히 asp. 기반이다.net core mvc.우선 Razor 설정:
      context.Services.Insert(0,
          ServiceDescriptor.Singleton>(
              new ConfigureOptions(options =>
                  {
                      options.FileProviders.Add(
                          new RazorViewEngineVirtualFileProvider(
                              context.Services.GetSingletonInstance>()
                          )
                      );
                  }
              )
          )
      );
    
    Api 설명자 설정:
      Configure(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의 기본 컨트롤러 활성기 ServiceBasedController Activator 클래스를 사용합니다.
      //Use DI to create controllers
      context.Services.Replace(ServiceDescriptor.Transient());
    abp는 약속된 컨트롤러 특성을 바탕으로 하는 컨트롤러 클래스를 제공합니다. 이 클래스는 aspnetcore mvc를 바탕으로 하는 Controller Feature Provider로 자신의 컨트롤러를 구축하고 판단 컨트롤러를 검색합니다.
      //Add feature providers
      var partManager = context.Services.GetSingletonInstance();
      var application = context.Services.GetSingletonInstance();
    
      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>().Value
                  .ConventionalControllers
                  .ConventionalControllerSettings
                  .GetSettingOrNull(typeInfo.AsType());
    
              return configuration != null;
          }
      }
    에서 abp는 aspnetcore mvc를 바탕으로 abp의 mvc 모듈을 설정합니다. 특히 Controller의 창설입니다.코드에서 알 수 있듯이 Abp Asp Net Core Mvc Options의 서비스를 얻고 규약의 컨트롤러를 검색합니다.컨트롤러인지 아닌지를 되돌려줍니다.AbpAspNetCoreMvcOptions 클래스는 Abp가 aspnetcoremvc에 대한 봉인된 것이다. 원본 코드는 다음과 같다.
      public class AbpAspNetCoreMvcOptions
      {
          public ConventionalControllerOptions ConventionalControllers { get; }
    
          public AbpAspNetCoreMvcOptions()
          {
              ConventionalControllers = new ConventionalControllerOptions();
          }
      }
    
      //       
      public class ConventionalControllerOptions
      {
          public ConventionalControllerSettingList ConventionalControllerSettings { get; }
    
          public List FormBodyBindingIgnoredTypes { get; }
    
          public ConventionalControllerOptions()
          {
              ConventionalControllerSettings = new ConventionalControllerSettingList();
    
              FormBodyBindingIgnoredTypes = new List
              {
                  typeof(IFormFile)
              };
          }
    
          public ConventionalControllerOptions Create(Assembly assembly, [CanBeNull] Action optionsAction = null)
          {
              var setting = new ConventionalControllerSetting(assembly, ModuleApiDescriptionModel.DefaultRootPath); // DefaultRootPath = app,abp       app   。
              optionsAction?.Invoke(setting);
              setting.Initialize();
              ConventionalControllerSettings.Add(setting);
              return this;
          }
      }
    AbpAspNetCoreMvcOptions는 실제적으로Conventional Controller Options를 통해 규정된 설정을 완성하고 사용자 정의 루트와 동적 API를 실현한다.
  • AspNetCoreDescriptionModelProvider abp는 어떻게 aspnetcore가 자신의 API를 만들었습니까?AspNet Core Description Model Provider가 있습니다. 이 클래스는 aspnet core의 설명 모델을 제공합니다. 원본 코드는 다음과 같습니다.
      public class AspNetCoreApiDescriptionModelProvider : IApiDescriptionModelProvider, ITransientDependency
      {
          public ILogger Logger { get; set; }
    
          private readonly IApiDescriptionGroupCollectionProvider _descriptionProvider;
          private readonly AbpAspNetCoreMvcOptions _options;
          private readonly ApiDescriptionModelOptions _modelOptions;
    
          public AspNetCoreApiDescriptionModelProvider(
              IApiDescriptionGroupCollectionProvider descriptionProvider,
              IOptions options,
              IOptions modelOptions)
          {
              _descriptionProvider = descriptionProvider;
              _options = options.Value;
              _modelOptions = modelOptions.Value;
    
              Logger = NullLogger.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를 구축했습니다.그것의 호출은 두 가지가 있는데 하나는 Abp Api Definition Controller이고 하나는 Proxy Script Manager이다. 전자는 Abp의api 컨트롤러를 정의하는 곳이고 후자는 프록시 스크립트를 생성하는 곳이다. abp의 예시 프로젝트 BookStore에서 인터페이스인 Abp/Service Proxy Script를 호출하여 js 파일을 생성한다. 이 js 파일 안에는api의 url 주소가 있다.전단은 이api 주소에 접근해서 app 서비스 등 후단 방법에 접근합니다.소스:
      [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(options =>
          {
              options.Generators[JQueryProxyScriptGenerator.Name] = typeof(JQueryProxyScriptGenerator);
          });
      }
    에 제공
  • 좋은 웹페이지 즐겨찾기