.NET Core Api獲取所有Action以及註釋內容

来源:https://www.cnblogs.com/runningprogrammer/archive/2023/08/28/controller-action-summary.html
-Advertisement-
Play Games

有個項目需要獲取項目內所有Action,併在凌晨定時任務跑完所有介面檢查是否有介面報錯,寫瞭如下方法: /// <summary> /// 獲取Action註釋 /// </summary> /// <param name="root"></param> /// <param name="metho ...


有個項目需要獲取項目內所有Action,併在凌晨定時任務跑完所有介面檢查是否有介面報錯,寫瞭如下方法:

        /// <summary>
        /// 獲取Action註釋
        /// </summary>
        /// <param name="root"></param>
        /// <param name="method">方法</param>
        /// <param name="xmlPath">項目xml路徑</param>
        /// <returns></returns>
        static string? GetMethodSummary(XmlElement root, MethodInfo method, string xmlPath)
        {
            // 查找方法的註釋節點
            string memberName = GetMethodSignature(method);
            XmlNode? memberNode = root.SelectSingleNode($"//member[@name='{memberName}']");

            // 獲取方法的 <summary> 註釋
            XmlNode? summaryNode = memberNode?.SelectSingleNode("summary");
            string? summary = summaryNode?.InnerText.Trim();

            return summary;
        }
        /// <summary>
        /// 獲取控制器註釋
        /// </summary>
        /// <param name="root"></param>
        /// <param name="controllerType">控制器</param>
        /// <param name="xmlPath">項目xlm路徑</param>
        /// <returns></returns>
        static string? GetMemberSummary(XmlElement root, Type controllerType, string xmlPath)
        {
            // 查找方法的註釋節點
            string memberName = $"T:{controllerType.FullName}";
            XmlNode? memberNode = root.SelectSingleNode($"//member[@name='{memberName}']");

            // 獲取方法的 <summary> 註釋
            XmlNode? summaryNode = memberNode?.SelectSingleNode("summary");
            string? summary = summaryNode?.InnerText.Trim();

            return summary;
        }
        /// <summary>
        /// 獲取方法簽名
        /// </summary>
        /// <param name="methodInfo"></param>
        /// <returns></returns>
        static string GetMethodSignature(MethodInfo methodInfo)
        {
            StringBuilder signatureBuilder = new StringBuilder();
            signatureBuilder.Append($"M:{methodInfo.DeclaringType!.FullName}.{methodInfo.Name}");

            ParameterInfo[] parameters = methodInfo.GetParameters();
            if (parameters.Length > 0)
            {
                signatureBuilder.Append("(");
                for (int i = 0; i < parameters.Length; i++)
                {
                    ParameterInfo parameter = parameters[i];

                    // 判斷是否為泛型類型
                    if (parameter.ParameterType.IsGenericType)
                    {
                        Type genericTypeDefinition = parameter.ParameterType.GetGenericTypeDefinition();
                        Type[] genericArguments = parameter.ParameterType.GetGenericArguments();

                        string typeName = $"{genericTypeDefinition.FullName!.Remove(genericTypeDefinition.FullName.IndexOf('`'))}{{";
                        for (int j = 0; j < genericArguments.Length; j++)
                        {
                            typeName += $"{genericArguments[j].FullName},";
                        }
                        typeName = typeName.TrimEnd(',') + "}";

                        signatureBuilder.Append(typeName);
                    }
                    else
                    {
                        signatureBuilder.Append(parameter.ParameterType.FullName);
                    }

                    if (i < parameters.Length - 1)
                    {
                        signatureBuilder.Append(",");
                    }
                }
                signatureBuilder.Append(")");
            }

            return signatureBuilder.ToString();
        }

實體類:

ublic class Themeinterface
{
    /// <summary>
    /// 方法
    /// </summary>
    [Description("方法")]
    [StringLength(50)]
    [Column("Action")]
    public string Action { get; set; }

    /// <summary>
    /// 方法特性
    /// </summary>
    [Description("方法特性")]
    [Column("ActionAttributes")]
    public string? ActionAttributes { get; set; }

    /// <summary>
    /// 方法名稱
    /// </summary>
    [Description("方法名稱")]
    [Column("ActionName")]
    public string? ActionName { get; set; }

    /// <summary>
    /// 方法參數
    /// </summary>
    [Description("方法參數")]
    [Column("ActionParams")]
    public string? ActionParams { get; set; }

    /// <summary>
    /// 控制器
    /// </summary>
    [Description("控制器")]
    [StringLength(255)]
    [Column("Controller")]
    public string Controller { get; set; }

    /// <summary>
    /// 控制器名稱
    /// </summary>
    [Description("控制器名稱")]
    [Column("ControllerName")]
    public string? ControllerName { get; set; }

    [Key]
    [Column("Id")]
    public int Id { get; set; }

    /// <summary>
    /// 調用時間
    /// </summary>
    [Description("調用時間")]
    [Column("InvokeTime")]
    public int? InvokeTime { get; set; }
    /// <summary>
    /// 執行狀態
    /// </summary>
    public string Status { get; set; }
    /// <summary>
    /// 
    /// </summary>
    public int StatusCode { get; set; }
    /// <summary>
    /// 請求方法
    /// </summary>
    public string? Method { get; set; }
    /// <summary>
    /// 
    /// </summary>
    public string? IP { get; set; }
    /// <summary>
    /// 異常
    /// </summary>
    public string? Exception { get; set; }
    /// <summary>
    /// 請求路徑
    /// </summary>
    public string? Path { get; set; }
    /// <summary>
    /// 請求參數
    /// </summary>
    public string? QueryString { get; set; }
    /// <summary>
    /// 
    /// </summary>
    public DateTime? CreateTime { get; set; }
    /// <summary>
    /// 
    /// </summary>
    public DateTime? UpdateTime { get; set; }
}

使用:

        /// <summary>
        /// 獲取所有介面
        /// </summary>
        /// <returns></returns>
        public static List<Themeinterface> GetAllInterface()
        {
            // 獲取方法的 XML 文檔路徑
            string xmlPath = Assembly.GetExecutingAssembly().Location.Replace("dll", "xml");
            XmlDocument xmlDoc = new XmlDocument();
            xmlDoc.Load(xmlPath);
            XmlElement root = xmlDoc.DocumentElement!;

            var childControllers = Assembly.GetExecutingAssembly()
            .GetTypes()
            .Where(t => t.IsSubclassOf(typeof(BaseController)) && t != typeof(BaseController) && !t.IsDefined(typeof(IgnoreInterfaceAttribute)))
            .ToList();

            List<Themeinterface> themeinterfaces = new();
            foreach (var controllerType in childControllers)
            {
                var actions = controllerType.GetMethods(BindingFlags.Public | BindingFlags.Instance)
                    .Where(m => (typeof(IActionResult).IsAssignableFrom(m.ReturnType) || typeof(Task<IActionResult>).IsAssignableFrom(m.ReturnType))
                    && m.DeclaringType == controllerType && !m.IsDefined(typeof(IgnoreInterfaceAttribute)))
                    .Select(m => new
                    {
                        ActionName = m.Name,
                        Parameters = m.GetParameters()
                            .Select(p => new
                            {
                                Name = p.Name,
                                Type = p.ParameterType.FullName,
                                Attributes = p.GetCustomAttributes().Select(attr => attr.GetType().Name).ToList()
                            })
                            .ToList(),
                        ActionSummary = GetMethodSummary(root, m, xmlPath),
                        Method = m.GetCustomAttributes(typeof(HttpPostAttribute), false).Cast<HttpPostAttribute>().FirstOrDefault() == null ? "GET" : "POST"
                    })
                    .ToList();

                foreach (var action in actions)
                {

                    Dictionary<string, object> actionAttributes = new();
                    foreach (var parameter in action.Parameters)
                    {
                        var key = $"{parameter.Type} {parameter.Name}";
                        if (parameter.Attributes.Any())
                        {
                            actionAttributes.Add(key, string.Join(", ", parameter.Attributes));
                        }
                    }
                    themeinterfaces.Add(new Themeinterface
                    {
                        Action = action.ActionName,
                        ActionName = action.ActionSummary,
                        ActionAttributes = JsonConvert.SerializeObject(actionAttributes.Select(p => p.Value)),
                        //ActionParams = string.Join(", ", action.Parameters.Select(p => p.Name)),
                        Controller = controllerType.FullName!,
                        ControllerName = GetMemberSummary(root, controllerType, xmlPath),
                        Method = action.Method
                    });
                }
            }
            return themeinterfaces;
        }

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • # 平衡樹 平衡樹就是為了實現一類元素線上性結構中動態變化的功能所需要的數據結構。 平衡樹是一種基於二叉搜索樹的數據結構。 滿足:左兒子 $<$ 根 $<$ 右兒子。 也就是一切小於根節點的在左邊,一切大於根節點的在右邊。 這樣想要查找一個節點的位置時間複雜度就是 $O(\log n)$。 平衡樹主 ...
  • 解決夏令時導致日期少一天的解決方案 1. @JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8" ) 2. 啟動時JVM加入參數 -Duser.timezone=GMT+08 3. @JsonFormat(pattern = "yyyy-MM-... ...
  • Spring Boot 太狠了,今天一次性發佈了三個主要版本,三條版本線同時更新: - Spring Boot 3.1.3 - Spring Boot 3.0.10 - Spring Boot 2.7.15 ![](https://img2023.cnblogs.com/other/1218593/ ...
  • [toc] # 一、背景介紹 你好,我是[@馬哥python說](https://www.zhihu.com/people/13273183132) ,一名10年程式猿。 最近我用python開發了一個GUI桌面軟體,作用是爬取YouTube指定視頻的評論,6個關鍵欄位,含: >評論id、評論內容、 ...
  • 原文鏈接:https://www.cnblogs.com/ysmc/p/17663663.html 最近技術交流群里,還有不少小伙伴不知道 FromRoute、FromQuery、FromBody 這幾個特性是怎麼使用的,也不清楚它們之間的區別在哪裡,特意寫下這個文章,希望可以幫助到迷茫的小伙伴。 ...
  • 經過一段時間的準備,【ASP.NET Core MVC開發實戰之商城系統】已經完成,目前代碼已開發完成,先將全部內容整理分享,如有不足之處,還請指正。 ...
  • # 認識.NET 日誌系統 ## 基本概念 1. 日誌級別:Trace{ logBuilder.AddConsole() //可多個Provider }) ``` 3. 需要記錄日誌的代碼,註入ILogger即可,T一般就用當前類,這個類的名字會輸出到日誌,方便定位錯誤,然後調用LogInforma ...
  • MySqlConnector有個MySqlBulkCopy批量新增數據方法,不過只能用DataTable,需要把list轉成DataTable代碼如下: MySqlBulkCopy mySqlBulkCopy = new MySqlBulkCopy(conn) { DestinationTableN ...
一周排行
    -Advertisement-
    Play Games
  • 示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後,項目結構如下所示: MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread] 特性用於需要與 COM 組件交互的應用程式,尤其是依賴單線程模型(如 Windows Forms 應用程式)的組件。在 STA 模式下,線程擁有自己的消息迴圈,這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • 在WinForm中使用全局異常捕獲處理 在WinForm應用程式中,全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理,可以有效地捕獲並處理未預見的異常,從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • 前言 給大家推薦一款開源的 Winform 控制項庫,可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫,同時也提供了工具類庫、擴展 ...
  • 說明 該文章是屬於OverallAuth2.0系列文章,每周更新一篇該系列文章(從0到1完成系統開發)。 該系統文章,我會儘量說的非常詳細,做到不管新手、老手都能看懂。 說明:OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友,請關註我吧(*^▽^*) ...
  • 一、下載安裝 1.下載git 必須先下載並安裝git,再TortoiseGit下載安裝 git安裝參考教程:https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit,Git客戶端,32/6 ...
  • 前言 在項目開發過程中,理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼,還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程:Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 一:背景 1. 講故事 前段時間有位朋友找到我,說他的窗體程式在客戶這邊出現了卡死,讓我幫忙看下怎麼回事?dump也生成了,既然有dump了那就上 windbg 分析吧。 二:WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死,入口門檻很低,後續往下分析就不一定了,不管怎麼說先用 !clrsta ...
  • 前言 人工智慧時代,人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API,工具不僅易於集成,還具備高效處理能力。 本文將介紹一款如何利用這些API,為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...