sunpengfei
2025-08-07 b4205c80b0fd6220632fa0ab7df4c75ba844afc4
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
using Furion;
using Furion.DatabaseAccessor;
using Furion.DataEncryption;
using MediatR;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Internal;
using Microsoft.Extensions.Caching.Distributed;
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Threading.Tasks;
using System.Xml;
 
namespace FlexJobApi.Core
{
    /// <summary>
    /// 注释文档工具
    /// </summary>
    public static class XmlDocUtils
    {
        private const string cacheKey = "XmlDoc";
 
        public static XmlDoc XmlDoc { get; set; }
 
        /// <summary>
        /// 生成注释文档
        /// </summary>
        /// <returns></returns>
        public static async Task<XmlDoc> BuildXmlDocAsync()
        {
            var xmlDoc = new XmlDoc();
            foreach (var item in App.Assemblies)
            {
                var path = item.Location.Replace("dll", "xml");
                if (File.Exists(path))
                {
                    var document = new XmlDocument();
                    document.Load(path);
                    var memberNodes = document.SelectNodes("//member");
                    if (memberNodes != null)
                    {
                        foreach (XmlNode memberNode in memberNodes)
                        {
                            var memberName = memberNode.Attributes?["name"]?.Value;
                            if (!string.IsNullOrEmpty(memberName))
                            {
                                var member = new XmlDocMember
                                {
                                    Name = memberName,
                                    Summary = memberNode.SelectSingleNode("summary")?.InnerText?.Trim(),
                                    Returm = memberNode.SelectSingleNode("returns")?.InnerText?.Trim()
                                };
                                var paramNodes = memberNode.SelectNodes("param");
                                if (paramNodes != null)
                                {
                                    foreach (XmlNode paramNode in paramNodes)
                                    {
                                        var paramNodeName = paramNode.Attributes?["name"]?.Value;
                                        if (!string.IsNullOrEmpty(paramNodeName))
                                        {
                                            member.Parameters.Add(new XmlDocMember
                                            {
                                                Name = paramNodeName,
                                                Summary = paramNode.InnerText?.Trim()
                                            });
                                        }
                                    }
                                }
                                xmlDoc.Members.Add(member);
                            }
                        }
                    }
                }
            }
 
            XmlDoc = xmlDoc;
 
            if (xmlDoc.Members.Any())
            {
                var json = JsonConvert.SerializeObject(xmlDoc);
                await App.GetService<IDistributedCache>().SetStringAsync(cacheKey, json);
                return xmlDoc;
            }
            return null;
        }
 
        /// <summary>
        /// 获取注释文档
        /// </summary>
        /// <returns></returns>
        public static async Task<XmlDoc> GetXmlDocAsync()
        {
            if (XmlDoc == null)
            {
                var json = await App.GetService<IDistributedCache>().GetStringAsync(cacheKey);
                if (!string.IsNullOrEmpty(json))
                {
                    XmlDoc = JsonConvert.DeserializeObject<XmlDoc>(json);
                }
                if (XmlDoc == null)
                {
                    XmlDoc = await BuildXmlDocAsync();
                }
            }
            return XmlDoc;
        }
 
        /// <summary>
        /// 获取注释文档成员
        /// </summary>
        /// <param name="memberInfo"></param>
        /// <param name="xmlDoc"></param>
        /// <returns></returns>
        public static async Task<XmlDocMember> GetXmlDocMemberAsync(this MemberInfo memberInfo, XmlDoc xmlDoc = null)
        {
            if (xmlDoc == null)
            {
                xmlDoc = await GetXmlDocAsync();
            }
            if (xmlDoc != null && memberInfo != null)
            {
                var memberName = GetXmlDocMemberName(memberInfo);
                return xmlDoc.Members.FirstOrDefault(it => it.Name == memberName);
            }
            return null;
        }
 
        public static async Task<string> GetSummary(this MemberInfo memberInfo, XmlDoc xmlDoc = null)
        {
            var memberXmlDoc = await memberInfo.GetXmlDocMemberAsync(xmlDoc);
            return memberXmlDoc?.Summary;
        }
 
        private static string GetXmlDocMemberName(MemberInfo memberInfo)
        {
            if (memberInfo != null)
            {
                if (memberInfo is Type type)
                {
                    return $"T:{GetTypeName(type)}";
                }
                else if (memberInfo is MethodInfo methodInfo && methodInfo.DeclaringType != null)
                {
                    var methodName = $"M:{GetTypeName(methodInfo.DeclaringType)}.{methodInfo.Name}";
                    var parameters = methodInfo.GetParameters();
                    if (parameters.Length > 0)
                    {
                        methodName += $"({string.Join(",", parameters.Select(p => GetTypeName(p.ParameterType)))})";
                    }
                    return methodName;
                }
                else if (memberInfo is FieldInfo fieldInfo && fieldInfo.DeclaringType != null)
                {
                    return $"F:{GetTypeName(fieldInfo.DeclaringType)}.{fieldInfo.Name}";
                }
                else if (memberInfo is PropertyInfo propertyInfo && propertyInfo.DeclaringType != null)
                {
                    return $"P:{GetTypeName(propertyInfo.DeclaringType)}.{propertyInfo.Name}";
                }
            }
            return string.Empty;
        }
 
        private static string GetTypeName(Type type)
        {
            if (type.IsGenericType)
            {
                var genericTypeDefinition = type.GetGenericTypeDefinition();
                var genericArguments = type.GetGenericArguments();
                var baseName = genericTypeDefinition.FullName?.Replace('+', '.') ?? "";
                baseName = baseName.Substring(0, baseName.IndexOf('`'));
                return $"{baseName}`{genericArguments.Length}";
            }
            else if (type.IsArray)
            {
                var elementType = type.GetElementType();
                if (elementType != null)
                {
                    return $"{GetTypeName(elementType)}[]";
                }
            }
            else if (type.IsNested && type.DeclaringType != null)
            {
                return $"{GetTypeName(type.DeclaringType)}+{type.Name}";
            }
            return type.FullName?.Replace('+', '.') ?? "";
        }
    }
}