百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 热门文章 > 正文

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

bigegpt 2024-08-07 17:48 8 浏览

有个项目需要获取项目内所有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(#34;//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 = #34;T:{controllerType.FullName}";
            XmlNode? memberNode = root.SelectSingleNode(#34;//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(#34;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 = #34;{genericTypeDefinition.FullName!.Remove(genericTypeDefinition.FullName.IndexOf('`'))}{{";
                        for (int j = 0; j < genericArguments.Length; j++)
                        {
                            typeName += #34;{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 = #34;{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;
        }

相关推荐

pyproject.toml到底是什么东西?(py trim)

最近,在Twitter上有一个Python项目的维护者,他的项目因为构建失败而出现了一些bug(这个特别的项目不提供wheel,只提供sdist)。最终,发现这个bug是由于这个项目使用了一个pypr...

BDP服务平台SDK for Python3发布(bdp数据平台)

下载地址https://github.com/imysm/opends-sdk-python3.git说明最近在开发和bdp平台有关的项目,用到了bdp的python的sdk,但是官方是基于p...

Python-for-Android (p4a):(python-for-android p4a windows)

一、Python-for-Android(p4a)简介Python-for-Android(p4a),一个强大的开发工具,能够将你的Python应用程序打包成可在Android设备上运行...

Qt for Python—Qt Designer 概览

前言本系列第三篇文章(QtforPython学习笔记—应用程序初探)、第四篇文章(QtforPython学习笔记—应用程序再探)中均是使用纯代码方式来开发PySide6GUI应用程序...

Python:判断质数(jmu-python-判断质数)

#Python:判断质数defisPrime(n):foriinrange(2,n):ifn%i==0:return0re...

为什么那么多人讨厌Python(为什么python这么难)

Python那么棒,为什么那么多人讨厌它呢?我整理了一下,主要有这些原因:用缩进替代大括号许多人抱怨Python完全依赖于缩进来创建代码块,代码多一点就很难看到函数在哪里结束,那么你就需要把一个函数拆...

一文了解 Python 中带有 else 的循环语句 for-else/while-else

在本文中,我们将向您介绍如何在python中使用带有else的for/while循环语句。可能许多人对循环和else一起使用感到困惑,因为在if-else选择结构中else正常...

python的numpy向量化语句为什么会比for快?

我们先来看看,python之类语言的for循环,和其它语言相比,额外付出了什么。我们知道,python是解释执行的。举例来说,执行x=1234+5678,对编译型语言,是从内存读入两个shor...

开眼界!Python遍历文件可以这样做

来源:【公众号】Python技术Python对于文件夹或者文件的遍历一般有两种操作方法,一种是至二级利用其封装好的walk方法操作:import osfor root,d...

告别简单format()!Python Formatter类让你的代码更专业

Python中Formatter类是string模块中的一个重要类,它实现了Python字符串格式化的底层机制,允许开发者创建自定义的格式化行为。通过深入理解Formatter类的工作原理和使用方法,...

python学习——038如何将for循环改写成列表推导式

在Python里,列表推导式是一种能够简洁生成列表的表达式,可用于替换普通的for循环。下面是列表推导式的基本语法和常见应用场景。基本语法result=[]foriteminite...

详谈for循环和while循环的区别(for循环语句与while循环语句有什么区别)

初九,潜龙勿用在刚开始使用python循环语句时,经常会遇到for循环和while循环的混用,不清楚该如何选择;今天就对这2个循环语句做深入的分析,让大家更好地了解这2个循环语句以方便后续学习的加深。...

Python编程基础:循环结构for和while

Python中的循环结构包括两个,一是遍历循环(for循环),一是条件循环(while循环)。遍历循环遍历循环(for循环)会挨个访问序列或可迭代对象的元素,并执行里面的代码块。foriinra...

学习编程第154天 python编程 for循环输出菱形图

今天学习的是刘金玉老师零基础Python教程第38期,主要内容是python编程for循环输出菱形※。(一)利用for循环输出菱形形状的*号图形1.思路:将菱形分解为上下两个部分三角形图案,分别利用...

python 10个堪称完美的for循环实践

在Python中,for循环的高效使用能显著提升代码性能和可读性。以下是10个堪称完美的for循环实践,涵盖数据处理、算法优化和Pythonic编程风格:1.遍历列表同时获取索引(enumerate...