Merge pull request #14429 from abpframework/Proxy-Contracts

Generate DTOs in the client-side for static c# proxy generation.
abpframework · Nov 1, 2022 · 2bae1cc · 2bae1cc
2 parents ff43bdc + 4b62d77
commit 2bae1cc
Show file tree

Hide file tree

Showing 8 changed files with 444 additions and 165 deletions.
diff --git a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/CliUrls.cs b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/CliUrls.cs
@@ -1,4 +1,5 @@
 using System;
+using Volo.Abp.Http.Modeling;
 
 namespace Volo.Abp.Cli;
 
@@ -26,9 +27,9 @@ public static string GetNuGetPackageInfoUrl(string apiKey, string packageId)
         return $"{NuGetRootPath}{apiKey}/v3/package/{packageId}/index.json";
     }
 
-    public static string GetApiDefinitionUrl(string url)
+    public static string GetApiDefinitionUrl(string url, ApplicationApiDescriptionModelRequestDto model = null)
     {
         url = url.EnsureEndsWith('/');
-        return $"{url}api/abp/api-definition";
+        return $"{url}api/abp/api-definition{(model != null ? model.IncludeTypes ? "?includeTypes=true" : string.Empty : string.Empty)}";
     }
 }
diff --git a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/Commands/ProxyCommandBase.cs b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/Commands/ProxyCommandBase.cs
@@ -68,8 +68,10 @@ private GenerateProxyArgs BuildArgs(CommandLineArgs commandLineArgs)
         var source = commandLineArgs.Options.GetOrNull(Options.Source.Short, Options.Source.Long);
         var workDirectory = commandLineArgs.Options.GetOrNull(Options.WorkDirectory.Short, Options.WorkDirectory.Long) ?? Directory.GetCurrentDirectory();
         var folder = commandLineArgs.Options.GetOrNull(Options.Folder.Long);
+        var withoutContracts = commandLineArgs.Options.ContainsKey(Options.WithoutContracts.Short) ||
+                               commandLineArgs.Options.ContainsKey(Options.WithoutContracts.Long);
 
-        return new GenerateProxyArgs(CommandName, workDirectory, module, url, output, target, apiName, source, folder, commandLineArgs.Options);
+        return new GenerateProxyArgs(CommandName, workDirectory, module, url, output, target, apiName, source, folder, withoutContracts, commandLineArgs.Options);
     }
 
     public virtual string GetUsageInfo()
@@ -162,5 +164,11 @@ public static class WorkDirectory
             public const string Short = "wd";
             public const string Long = "working-directory";
         }
+
+        public static class WithoutContracts
+        {
+            public const string Short = "c";
+            public const string Long = "without-contracts";
+        }
     }
 }
diff --git a/.../src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ServiceProxying/CSharp/CSharpServiceProxyGenerator.cs b/.../src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ServiceProxying/CSharp/CSharpServiceProxyGenerator.cs
diff --git a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ServiceProxying/GenerateProxyArgs.cs b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ServiceProxying/GenerateProxyArgs.cs
@@ -25,6 +25,8 @@ public class GenerateProxyArgs
 
     public string Folder { get; }
 
+    public bool WithoutContracts { get; }
+
     [NotNull]
     public Dictionary<string, string> ExtraProperties { get; set; }
 
@@ -38,6 +40,7 @@ public GenerateProxyArgs(
         string apiName,
         string source,
         string folder,
+        bool withoutContracts,
         Dictionary<string, string> extraProperties = null)
     {
         CommandName = Check.NotNullOrWhiteSpace(commandName, nameof(commandName));
@@ -49,6 +52,7 @@ public GenerateProxyArgs(
         ApiName = apiName;
         Source = source;
         Folder = folder;
+        WithoutContracts = withoutContracts;
         ExtraProperties = extraProperties ?? new Dictionary<string, string>();
     }
 }
diff --git a/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ServiceProxying/ServiceProxyGeneratorBase.cs b/framework/src/Volo.Abp.Cli.Core/Volo/Abp/Cli/ServiceProxying/ServiceProxyGeneratorBase.cs
@@ -27,13 +27,13 @@ protected ServiceProxyGeneratorBase(CliHttpClientFactory cliHttpClientFactory, I
 
     public abstract Task GenerateProxyAsync(GenerateProxyArgs args);
 
-    protected virtual async Task<ApplicationApiDescriptionModel> GetApplicationApiDescriptionModelAsync(GenerateProxyArgs args)
+    protected virtual async Task<ApplicationApiDescriptionModel> GetApplicationApiDescriptionModelAsync(GenerateProxyArgs args, ApplicationApiDescriptionModelRequestDto requestDto = null)
     {
         Check.NotNull(args.Url, nameof(args.Url));
 
         var client = CliHttpClientFactory.CreateClient();
 
-        var apiDefinitionResult = await client.GetStringAsync(CliUrls.GetApiDefinitionUrl(args.Url));
+        var apiDefinitionResult = await client.GetStringAsync(CliUrls.GetApiDefinitionUrl(args.Url, requestDto));
         var apiDefinition = JsonSerializer.Deserialize<ApplicationApiDescriptionModel>(apiDefinitionResult);
 
         var moduleDefinition = apiDefinition.Modules.FirstOrDefault(x => string.Equals(x.Key, args.Module, StringComparison.CurrentCultureIgnoreCase)).Value;
@@ -43,6 +43,7 @@ protected virtual async Task<ApplicationApiDescriptionModel> GetApplicationApiDe
         }
 
         var apiDescriptionModel = ApplicationApiDescriptionModel.Create();
+        apiDescriptionModel.Types = apiDefinition.Types;
         apiDescriptionModel.AddModule(moduleDefinition);
 
         return apiDescriptionModel;

diff --git a/framework/src/Volo.Abp.Http/Volo/Abp/Http/Modeling/ControllerApiDescriptionModel.cs b/framework/src/Volo.Abp.Http/Volo/Abp/Http/Modeling/ControllerApiDescriptionModel.cs
@@ -14,6 +14,8 @@ public class ControllerApiDescriptionModel
 
     public bool IsRemoteService { get; set; }
 
+    public bool IntegrationService { get; set; }
+
     public string ApiVersion { get; set; }
 
     public string Type { get; set; }
@@ -34,6 +36,7 @@ public static ControllerApiDescriptionModel Create(string controllerName, string
             ControllerName = controllerName,
             ControllerGroupName = groupName,
             IsRemoteService = isRemoteService,
+            IntegrationService = IntegrationServiceAttribute.IsDefinedOrInherited(type),
             ApiVersion = apiVersion,
             Type = type.FullName,
             Actions = new Dictionary<string, ActionApiDescriptionModel>(),

diff --git a/framework/src/Volo.Abp.Http/Volo/Abp/Http/Modeling/ControllerInterfaceApiDescriptionModel.cs b/framework/src/Volo.Abp.Http/Volo/Abp/Http/Modeling/ControllerInterfaceApiDescriptionModel.cs
@@ -1,4 +1,7 @@
 using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
 
 namespace Volo.Abp.Http.Modeling;
 
@@ -7,16 +10,45 @@ public class ControllerInterfaceApiDescriptionModel
 {
     public string Type { get; set; }
 
+    public string Name { get; set; }
+
+    public InterfaceMethodApiDescriptionModel[] Methods { get; set; }
+
     public ControllerInterfaceApiDescriptionModel()
     {
 
     }
 
     public static ControllerInterfaceApiDescriptionModel Create(Type type)
     {
-        return new ControllerInterfaceApiDescriptionModel
+        var model = new ControllerInterfaceApiDescriptionModel
         {
-            Type = type.FullName
+            Type = type.FullName,
+            Name = type.Name
         };
+
+        var methods = new List<InterfaceMethodApiDescriptionModel>();
+
+        var methodInfos = new List<MethodInfo>();
+        foreach (var methodInfo in type.GetMethods())
+        {
+            methodInfos.Add(methodInfo);
+            methods.Add(InterfaceMethodApiDescriptionModel.Create(methodInfo));
+        }
+
+        foreach (var @interface in type.GetInterfaces())
+        {
+            foreach (var method in @interface.GetMethods())
+            {
+                if (!methodInfos.Contains(method))
+                {
+                    methods.Add(InterfaceMethodApiDescriptionModel.Create(method));
+                }
+                methodInfos.Add(method);
+            }
+        }
+
+        model.Methods = methods.ToArray();
+        return model;
     }
 }
diff --git a/framework/src/Volo.Abp.Http/Volo/Abp/Http/Modeling/InterfaceMethodApiDescriptionModel.cs b/framework/src/Volo.Abp.Http/Volo/Abp/Http/Modeling/InterfaceMethodApiDescriptionModel.cs
@@ -0,0 +1,40 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+using JetBrains.Annotations;
+
+namespace Volo.Abp.Http.Modeling;
+
+[Serializable]
+public class InterfaceMethodApiDescriptionModel
+{
+    public string Name { get; set; }
+
+    public IList<MethodParameterApiDescriptionModel> ParametersOnMethod { get; set; }
+
+    public ReturnValueApiDescriptionModel ReturnValue { get; set; }
+
+    public InterfaceMethodApiDescriptionModel()
+    {
+
+    }
+
+    public static InterfaceMethodApiDescriptionModel Create([NotNull] MethodInfo method)
+    {
+        return new InterfaceMethodApiDescriptionModel
+        {
+            Name = method.Name,
+            ReturnValue = ReturnValueApiDescriptionModel.Create(method.ReturnType),
+            ParametersOnMethod = method
+                .GetParameters()
+                .Select(MethodParameterApiDescriptionModel.Create)
+                .ToList(),
+        };
+    }
+
+    public override string ToString()
+    {
+        return $"[InterfaceMethodApiDescriptionModel {Name}]";
+    }
+}