.NET Core Api获取所有Action以及注释内容

有个项目需要获取项目内所有Action，并在凌晨定时任务跑完所有接口检查是否有接口报错，写了如下方法：

1.         /// <summary>
2.         /// 获取Action注释
3.         /// </summary>
4.         /// <param name="root"></param>
5.         /// <param name="method">方法</param>
6.         /// <param name="xmlPath">项目xml路径</param>
7.         /// <returns></returns>
8.         static string? GetMethodSummary(XmlElement root, MethodInfo method, string xmlPath)
9.         {
10.             // 查找方法的注释节点
11.             string memberName = GetMethodSignature(method);
12.             XmlNode? memberNode = root.SelectSingleNode($"//member[@name='{memberName}']");
14.             // 获取方法的 <summary> 注释
15.             XmlNode? summaryNode = memberNode?.SelectSingleNode("summary");
16.             string? summary = summaryNode?.InnerText.Trim();
18.             return summary;
19.         }

复制代码

1.         /// <summary>
2.         /// 获取控制器注释
3.         /// </summary>
4.         /// <param name="root"></param>
5.         /// <param name="controllerType">控制器</param>
6.         /// <param name="xmlPath">项目xlm路径</param>
7.         /// <returns></returns>
8.         static string? GetMemberSummary(XmlElement root, Type controllerType, string xmlPath)
9.         {
10.             // 查找方法的注释节点
11.             string memberName = $"T:{controllerType.FullName}";
12.             XmlNode? memberNode = root.SelectSingleNode($"//member[@name='{memberName}']");
14.             // 获取方法的 <summary> 注释
15.             XmlNode? summaryNode = memberNode?.SelectSingleNode("summary");
16.             string? summary = summaryNode?.InnerText.Trim();
18.             return summary;
19.         }

复制代码

1.         /// <summary>
2.         /// 获取方法签名
3.         /// </summary>
4.         /// <param name="methodInfo"></param>
5.         /// <returns></returns>
6.         static string GetMethodSignature(MethodInfo methodInfo)
7.         {
8.             StringBuilder signatureBuilder = new StringBuilder();
9.             signatureBuilder.Append($"M:{methodInfo.DeclaringType!.FullName}.{methodInfo.Name}");
11.             ParameterInfo[] parameters = methodInfo.GetParameters();
12.             if (parameters.Length > 0)
13.             {
14.                 signatureBuilder.Append("(");
15.                 for (int i = 0; i < parameters.Length; i++)
16.                 {
17.                     ParameterInfo parameter = parameters[i];
19.                     // 判断是否为泛型类型
20.                     if (parameter.ParameterType.IsGenericType)
21.                     {
22.                         Type genericTypeDefinition = parameter.ParameterType.GetGenericTypeDefinition();
23.                         Type[] genericArguments = parameter.ParameterType.GetGenericArguments();
25.                         string typeName = $"{genericTypeDefinition.FullName!.Remove(genericTypeDefinition.FullName.IndexOf('`'))}{{";
26.                         for (int j = 0; j < genericArguments.Length; j++)
27.                         {
28.                             typeName += $"{genericArguments[j].FullName},";
29.                         }
30.                         typeName = typeName.TrimEnd(',') + "}";
32.                         signatureBuilder.Append(typeName);
33.                     }
34.                     else
35.                     {
36.                         signatureBuilder.Append(parameter.ParameterType.FullName);
37.                     }
39.                     if (i < parameters.Length - 1)
40.                     {
41.                         signatureBuilder.Append(",");
42.                     }
43.                 }
44.                 signatureBuilder.Append(")");
45.             }
47.             return signatureBuilder.ToString();
48.         }

复制代码

实体类：

1. ublic class Themeinterface
2. {
3.     /// <summary>
4.     /// 方法
5.     /// </summary>
6.     [Description("方法")]
7.     [StringLength(50)]
8.     [Column("Action")]
9.     public string Action { get; set; }
11.     /// <summary>
12.     /// 方法特性
13.     /// </summary>
14.     [Description("方法特性")]
15.     [Column("ActionAttributes")]
16.     public string? ActionAttributes { get; set; }
18.     /// <summary>
19.     /// 方法名称
20.     /// </summary>
21.     [Description("方法名称")]
22.     [Column("ActionName")]
23.     public string? ActionName { get; set; }
25.     /// <summary>
26.     /// 方法参数
27.     /// </summary>
28.     [Description("方法参数")]
29.     [Column("ActionParams")]
30.     public string? ActionParams { get; set; }
32.     /// <summary>
33.     /// 控制器
34.     /// </summary>
35.     [Description("控制器")]
36.     [StringLength(255)]
37.     [Column("Controller")]
38.     public string Controller { get; set; }
40.     /// <summary>
41.     /// 控制器名称
42.     /// </summary>
43.     [Description("控制器名称")]
44.     [Column("ControllerName")]
45.     public string? ControllerName { get; set; }
47.     [Key]
48.     [Column("Id")]
49.     public int Id { get; set; }
51.     /// <summary>
52.     /// 调用时间
53.     /// </summary>
54.     [Description("调用时间")]
55.     [Column("InvokeTime")]
56.     public int? InvokeTime { get; set; }
57.     /// <summary>
58.     /// 执行状态
59.     /// </summary>
60.     public string Status { get; set; }
61.     /// <summary>
62.     ///
63.     /// </summary>
64.     public int StatusCode { get; set; }
65.     /// <summary>
66.     /// 请求方法
67.     /// </summary>
68.     public string? Method { get; set; }
69.     /// <summary>
70.     ///
71.     /// </summary>
72.     public string? IP { get; set; }
73.     /// <summary>
74.     /// 异常
75.     /// </summary>
76.     public string? Exception { get; set; }
77.     /// <summary>
78.     /// 请求路径
79.     /// </summary>
80.     public string? Path { get; set; }
81.     /// <summary>
82.     /// 请求参数
83.     /// </summary>
84.     public string? QueryString { get; set; }
85.     /// <summary>
86.     ///
87.     /// </summary>
88.     public DateTime? CreateTime { get; set; }
89.     /// <summary>
90.     ///
91.     /// </summary>
92.     public DateTime? UpdateTime { get; set; }
93. }

复制代码

使用：

1.         /// <summary>
2.         /// 获取所有接口
3.         /// </summary>
4.         /// <returns></returns>
5.         public static List<Themeinterface> GetAllInterface()
6.         {
7.             // 获取方法的 XML 文档路径
8.             string xmlPath = Assembly.GetExecutingAssembly().Location.Replace("dll", "xml");
9.             XmlDocument xmlDoc = new XmlDocument();
10.             xmlDoc.Load(xmlPath);
11.             XmlElement root = xmlDoc.DocumentElement!;
13.             var childControllers = Assembly.GetExecutingAssembly()
14.             .GetTypes()
15.             .Where(t => t.IsSubclassOf(typeof(BaseController)) && t != typeof(BaseController) && !t.IsDefined(typeof(IgnoreInterfaceAttribute)))
16.             .ToList();
18.             List<Themeinterface> themeinterfaces = new();
19.             foreach (var controllerType in childControllers)
20.             {
21.                 var actions = controllerType.GetMethods(BindingFlags.Public | BindingFlags.Instance)
22.                     .Where(m => (typeof(IActionResult).IsAssignableFrom(m.ReturnType) || typeof(Task<IActionResult>).IsAssignableFrom(m.ReturnType))
23.                     && m.DeclaringType == controllerType && !m.IsDefined(typeof(IgnoreInterfaceAttribute)))
24.                     .Select(m => new
25.                     {
26.                         ActionName = m.Name,
27.                         Parameters = m.GetParameters()
28.                             .Select(p => new
29.                             {
30.                                 Name = p.Name,
31.                                 Type = p.ParameterType.FullName,
32.                                 Attributes = p.GetCustomAttributes().Select(attr => attr.GetType().Name).ToList()
33.                             })
34.                             .ToList(),
35.                         ActionSummary = GetMethodSummary(root, m, xmlPath),
36.                         Method = m.GetCustomAttributes(typeof(HttpPostAttribute), false).Cast<HttpPostAttribute>().FirstOrDefault() == null ? "GET" : "POST"
37.                     })
38.                     .ToList();
40.                 foreach (var action in actions)
41.                 {
43.                     Dictionary<string, object> actionAttributes = new();
44.                     foreach (var parameter in action.Parameters)
45.                     {
46.                         var key = $"{parameter.Type} {parameter.Name}";
47.                         if (parameter.Attributes.Any())
48.                         {
49.                             actionAttributes.Add(key, string.Join(", ", parameter.Attributes));
50.                         }
51.                     }
52.                     themeinterfaces.Add(new Themeinterface
53.                     {
54.                         Action = action.ActionName,
55.                         ActionName = action.ActionSummary,
56.                         ActionAttributes = JsonConvert.SerializeObject(actionAttributes.Select(p => p.Value)),
57.                         //ActionParams = string.Join(", ", action.Parameters.Select(p => p.Name)),
58.                         Controller = controllerType.FullName!,
59.                         ControllerName = GetMemberSummary(root, controllerType, xmlPath),
60.                         Method = action.Method
61.                     });
62.                 }
63.             }
64.             return themeinterfaces;
65.         }

复制代码

 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！