Merge pull request #16617 from abpframework/RemoveAndReplaceControllers

Support to remove and replace controllers.

framework/src/Volo.Abp.AspNetCore.Mvc/Volo/Abp/AspNetCore/Mvc/AbpAspNetCoreMvcOptions.cs

@@ -12,6 +12,8 @@ public class AbpAspNetCoreMvcOptions
 
     public HashSet<Type> IgnoredControllersOnModelExclusion { get; }
 
+    public HashSet<Type> ControllersToRemove { get; }
+
     public bool AutoModelValidation { get; set; }
 
     public bool EnableRazorRuntimeCompilationOnDevelopment { get; set; }
@@ -22,6 +24,7 @@ public class AbpAspNetCoreMvcOptions
     {
         ConventionalControllers = new AbpConventionalControllerOptions();
         IgnoredControllersOnModelExclusion = new HashSet<Type>();
+        ControllersToRemove = new HashSet<Type>();
         AutoModelValidation = true;
         EnableRazorRuntimeCompilationOnDevelopment = true;
         ChangeControllerModelApiExplorerGroupName = true;

framework/src/Volo.Abp.AspNetCore.Mvc/Volo/Abp/AspNetCore/Mvc/Conventions/AbpServiceConvention.cs

@@ -11,6 +11,7 @@ using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.Extensions.Options;
 using Volo.Abp.Application.Services;
+using Volo.Abp.AspNetCore.Controllers;
 using Volo.Abp.DependencyInjection;
 using Volo.Abp.GlobalFeatures;
 using Volo.Abp.Http;
@@ -80,6 +81,36 @@ public class AbpServiceConvention : IAbpServiceConvention, ITransientDependency
     {
         var controllerModelsToRemove = new List<ControllerModel>();
 
+        if (Options.ControllersToRemove.Any())
+        {
+            var removeControllerModels = GetControllers(application)
+                .Where(cm => Options.ControllersToRemove.Contains(cm.ControllerType))
+                .ToArray();
+
+            if (removeControllerModels.Any())
+            {
+                controllerModelsToRemove.AddRange(removeControllerModels);
+                Logger.LogInformation($"Removing the controller{(removeControllerModels.Length > 1 ? "s" : "")} {removeControllerModels.Select(c => c.ControllerType.AssemblyQualifiedName).JoinAsString(", ")} from the application model");
+            }
+        }
+
+        foreach (var controllerModel in GetControllers(application))
+        {
+            var replaceControllersAttr = ReflectionHelper.GetSingleAttributeOrDefault<ReplaceControllersAttribute>(controllerModel.ControllerType);
+            if (replaceControllersAttr != default)
+            {
+                var replaceControllerModels = GetControllers(application)
+                    .Where(cm => replaceControllersAttr.ControllerTypes.Contains(cm.ControllerType))
+                    .ToArray();
+
+                if (replaceControllerModels.Any())
+                {
+                    controllerModelsToRemove.AddRange(replaceControllerModels);
+                    Logger.LogInformation($"Removing the controller{(replaceControllerModels.Length > 1 ? "s" : "")} {replaceControllersAttr.ControllerTypes.Select(c => c.AssemblyQualifiedName).JoinAsString(", ")} from the application model since {(replaceControllerModels.Length > 1 ? "they are" : "it is")} replaced by the controller: {controllerModel.ControllerType.AssemblyQualifiedName}");
+                }
+            }
+        }
+
         foreach (var controllerModel in GetControllers(application))
         {
             if (!controllerModel.ControllerType.IsDefined(typeof(ExposeServicesAttribute), false))
@@ -99,8 +130,11 @@ public class AbpServiceConvention : IAbpServiceConvention, ITransientDependency
                     .Where(cm => exposeServicesAttr.ServiceTypes.Contains(cm.ControllerType))
                     .ToArray();
 
-                controllerModelsToRemove.AddRange(exposedControllerModels);
+                if (exposedControllerModels.Any())
-                Logger.LogInformation($"Removing the controller{(exposedControllerModels.Length > 1 ? "s" : "")} {exposeServicesAttr.ServiceTypes.Select(c => c.AssemblyQualifiedName).JoinAsString(", ")} from the application model since {(exposedControllerModels.Length > 1 ? "they are" : "it is")} replaced by the controller: {controllerModel.ControllerType.AssemblyQualifiedName}");
+                {
+                    controllerModelsToRemove.AddRange(exposedControllerModels);
+                    Logger.LogInformation($"Removing the controller{(exposedControllerModels.Length > 1 ? "s" : "")} {exposeServicesAttr.ServiceTypes.Select(c => c.AssemblyQualifiedName).JoinAsString(", ")} from the application model since {(exposedControllerModels.Length > 1 ? "they are" : "it is")} replaced by the controller: {controllerModel.ControllerType.AssemblyQualifiedName}");
+                }
                 continue;
             }
 

framework/src/Volo.Abp.AspNetCore/Volo/Abp/AspNetCore/Controllers/ReplaceControllersAttribute.cs

@@ -0,0 +1,14 @@
+using System;
+
+namespace Volo.Abp.AspNetCore.Controllers;
+
+[AttributeUsage(AttributeTargets.Class)]
+public class ReplaceControllersAttribute : Attribute
+{
+    public Type[] ControllerTypes { get; }
+
+    public ReplaceControllersAttribute(params Type[] controllerTypes)
+    {
+        ControllerTypes = controllerTypes ?? Type.EmptyTypes;
+    }
+}

framework/test/Volo.Abp.AspNetCore.Mvc.Tests/Volo/Abp/AspNetCore/Mvc/Controllers/ReplaceBuiltInController.cs

@@ -0,0 +1,50 @@
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using Volo.Abp.AspNetCore.Controllers;
+using Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations;
+
+namespace Volo.Abp.AspNetCore.Mvc.Controllers;
+
+[Area("abp")]
+[RemoteService(Name = "abp")]
+[ReplaceControllers(typeof(AbpApplicationConfigurationController), typeof(AbpApplicationLocalizationController))]
+public class ReplaceBuiltInController : AbpController
+{
+    [HttpGet("api/abp/application-configuration")]
+    public virtual Task<MyApplicationConfigurationDto> GetAsync(MyApplicationConfigurationRequestOptions options)
+    {
+        return Task.FromResult(new MyApplicationConfigurationDto()
+        {
+            Random = options.Random
+        });
+    }
+
+    [HttpGet("api/abp/application-localization")]
+    public virtual Task<MyApplicationLocalizationDto> GetAsync(MyApplicationLocalizationRequestDto input)
+    {
+        return Task.FromResult(new MyApplicationLocalizationDto()
+        {
+            Random = input.Random
+        });
+    }
+}
+
+public class MyApplicationConfigurationRequestOptions : ApplicationConfigurationRequestOptions
+{
+    public string Random { get; set; }
+}
+
+public class MyApplicationConfigurationDto : ApplicationConfigurationDto
+{
+    public string Random { get; set; }
+}
+
+public class MyApplicationLocalizationRequestDto : ApplicationLocalizationRequestDto
+{
+    public string Random { get; set; }
+}
+
+public class MyApplicationLocalizationDto : ApplicationLocalizationDto
+{
+    public string Random { get; set; }
+}

framework/test/Volo.Abp.AspNetCore.Mvc.Tests/Volo/Abp/AspNetCore/Mvc/Controllers/ReplaceBuiltInController_Tests.cs

@@ -0,0 +1,32 @@
+using System;
+using System.Net;
+using System.Threading.Tasks;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using Shouldly;
+using Volo.Abp.AspNetCore.Mvc.Localization;
+using Xunit;
+
+namespace Volo.Abp.AspNetCore.Mvc.Controllers;
+
+public class ReplaceBuiltInController_Tests : AspNetCoreMvcTestBase
+{
+    protected override void ConfigureServices(HostBuilderContext context, IServiceCollection services)
+    {
+        services.Configure<AbpAspNetCoreMvcOptions>(options =>
+        {
+            options.ControllersToRemove.Add(typeof(AbpLanguagesController));
+        });
+    }
+
+    [Fact]
+    public async Task Test()
+    {
+        var random = Guid.NewGuid().ToString("N");
+
+        (await GetResponseAsObjectAsync<MyApplicationConfigurationDto>("api/abp/application-configuration?random=" + random)).Random.ShouldBe(random);
+        (await GetResponseAsObjectAsync<MyApplicationLocalizationDto>("api/abp/application-localization?CultureName=en&random=" + random)).Random.ShouldBe(random);
+
+        (await GetResponseAsync("Abp/Languages/Switch", HttpStatusCode.NotFound)).StatusCode.ShouldBe(HttpStatusCode.NotFound);
+    }
+}