wip: 🧠 初步的框架

2025-12-19 05:25:47 +08:00 · 2023-08-25 15:33:42 +08:00
parent 57c1ba2002
commit 18b4d7547a
1014 changed files with 122380 additions and 2 deletions
--- a/src/backend/NetAdmin.Infrastructure/Utils/XmlCommentReader.cs
+++ b/src/backend/NetAdmin.Infrastructure/Utils/XmlCommentReader.cs
@@ -0,0 +1,95 @@
+using System.Xml;
+
+namespace NetAdmin.Infrastructure.Utils;
+
+/// <summary>
+///     程序集注释文档读取工具
+/// </summary>
+public sealed class XmlCommentReader : ISingleton
+{
+    private const    string            _XPATH        = "//doc/members/member[@name=\"{0}\"]";
+    private readonly List<XmlDocument> _xmlDocuments = new();
+
+    /// <summary>
+    ///     Initializes a new instance of the <see cref="XmlCommentReader" /> class.
+    /// </summary>
+    public XmlCommentReader(IOptions<SpecificationDocumentSettingsOptions> specificationDocumentSettings)
+    {
+        var xmlComments = specificationDocumentSettings.Value.XmlComments //
+                          ?? App.GetConfig<SpecificationDocumentSettingsOptions>(
+                                    nameof(SpecificationDocumentSettingsOptions).TrimEndOptions())
+                                .XmlComments;
+        foreach (var commentFile in xmlComments.Where(x => x.Contains(nameof(NetAdmin)))) {
+            var xmlDoc = new XmlDocument();
+            try {
+                xmlDoc.Load(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, commentFile));
+                _xmlDocuments.Add(xmlDoc);
+            }
+            catch (FileNotFoundException) {
+                LogHelper.Get<XmlCommentReader>().Warn(Ln.Xml注释文件不存在);
+            }
+        }
+    }
+
+    /// <summary>
+    ///     获取指定类型的注释
+    /// </summary>
+    /// <exception cref="InvalidCastException">InvalidCastException</exception>
+    public string GetComments(MemberInfo memberInfo)
+    {
+        var node = memberInfo switch {
+                       MethodInfo method => GetNodeByMethod(method)
+                     , Type type         => GetNodeByType(type)
+                     , _                 => throw new InvalidCastException()
+                   };
+
+        if (node?.FirstChild?.Name != "inheritdoc") {
+            return node?.FirstChild?.InnerText.Trim();
+        }
+
+        var cref = node.FirstChild.Attributes?["cref"]?.Value;
+        if (cref != null) {
+            return GetComments(App.EffectiveTypes.Single(x => x.FullName == cref[2..]));
+        }
+
+        var methodFromBaseType = memberInfo.DeclaringType?.BaseType?.GetMethod(memberInfo.Name);
+
+        if (methodFromBaseType != null) {
+            return GetComments(methodFromBaseType);
+        }
+
+        var methodFromInterface = memberInfo.DeclaringType?.GetInterfaces()
+                                            .Select(x => x.GetMethod(memberInfo.Name))
+                                            .FirstOrDefault(x => x != null);
+        return methodFromInterface == null ? null : GetComments(methodFromInterface);
+    }
+
+    private XmlNode GetNodeByMethod(MethodInfo method)
+    {
+        static string Replace(ParameterInfo parameterInfo)
+        {
+            return Regex.Replace(parameterInfo.ParameterType.ToString(), @"`\d+", string.Empty)
+                        .Replace("[", "{")
+                        .Replace("]", "}");
+        }
+
+        var nodeName   = $"M:{method.DeclaringType}.{method.Name}";
+        var parameters = method.GetParameters();
+        if (parameters.Length != 0) {
+            nodeName += $"({string.Join(',', parameters.Select(Replace))})";
+        }
+
+        return _xmlDocuments
+               .Select(xmlDoc => xmlDoc.SelectSingleNode(
+                           string.Format(NumberFormatInfo.InvariantInfo, _XPATH, nodeName)))
+               .FirstOrDefault(ret => ret != null);
+    }
+
+    private XmlNode GetNodeByType(Type type)
+    {
+        return _xmlDocuments
+               .Select(xmlDoc => xmlDoc.SelectSingleNode(
+                           string.Format(NumberFormatInfo.InvariantInfo, _XPATH, $"T:{type.FullName}")))
+               .FirstOrDefault(ret => ret != null);
+    }
+}