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

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

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

有个项目需要获取项目内所有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;
        }

相关推荐

php-fpm的配置和优化

目录概述php-fpm配置php-fpm进程优化配置慢日志查询配置php7进阶到架构师相关阅读概述这是关于php进阶到架构之php7核心技术与实战学习的系列课程:php-fpm的配置和优化学习目标:理...

成功安装 Magento2.4.3最新版教程「技术干货」

外贸独立站设计公司xingbell.com经过多次的反复实验,最新版的magento2.4.3在oneinstack的环境下的详细安装教程如下:一.vps系统:LinuxCentOS7.7.19...

十分钟让你学会LNMP架构负载均衡

业务架构、应用架构、数据架构和技术架构一、几个基本概念1、pv值pv值(pageviews):页面的浏览量概念:一个网站的所有页面,在一天内,被浏览的总次数。(大型网站通常是上千万的级别)2、u...

php从远程URL获取(mp4 mp3)音视频的流媒体数据

/***从远程URL中获取媒体(如mp4mp3)的内容*@parammixed$file_url*@parammixed$media_type...

Zabbix5.0安装部署

全盘展示运行状态,减轻运维人员的重复性工作量,提高系统排错速度,加速运维知识学习积累。1.png1、环境安装关闭SELinux并重启系统2.png安装httpd、mariadb、php运行yum-...

php 常见配置详解

以下是PHP常见的配置项及其含义:error_reporting:设置错误报告级别,可以控制PHP显示哪些错误。例如,设置为E_ALL将显示所有错误,而设置为0将禁止显示任何错误。displa...

实践分享|基于基石智算 DeepSeek API + WordPress 插件自动生成访客回复

基石智算举办的DeepSeek案例大赛汇集了不少基于CoresHubDeepSeekAPI服务或模型部署服务的精彩实践。本次我们将分享个人实践:通过DeepSeekAPI+Word...

如何在Eclipse中搭建Zabbix源码的调试和开发环境

Zabbix是一款非常优秀的企业级软件,被设计用于对数万台服务器、虚拟机和网络设备的数百万个监控项进行实时监控。Zabbix是开放源码和免费的,这就意味着当出现bug时,我们可以很方便地通过调试源码来...

MySQL自我保护参数

#头条创作挑战赛#之前(MySQL自我保护工具--pt-kill)提到用pt-kill工具来kill相关的会话,来达到保护数据库的目的,本文再通过修改数据库参数的方式达到阻断长时间运行的SQL的目...

Python闭包深度解析:掌握数据封装的高级技巧

闭包作为Python高级编程特性之一,为开发者提供了一种优雅的方式来实现数据封装和状态保持。这一概念源于函数式编程理论,在现代Python开发中发挥着重要作用。理解和掌握闭包的使用不仅能够提升代码的表...

Java服务网格故障注入与熔断实战

在分布式系统的高可用性挑战中,服务网格的故障注入与熔断机制是检验系统韧性的终极试金石。以下是10道逐步升级的"地狱关卡",每个关卡都对应真实生产环境中可能遇到的致命场景,并附具体场景示...

MySQL数据库性能优化全攻略:程序员必知的七大核心策略

作为程序员,我们每天都要与数据库打交道。当系统用户量突破百万级时,数据库往往成为性能瓶颈的首要怀疑对象。本文将深入探讨MySQL优化的七大核心策略,并提供可直接落地的优化方案,助您构建高效稳定的数据库...

如何在 Windows 11 上使用单个命令安装 XAMPP

XAMPP是一种广泛使用的软件,用于在Windows操作系统上快速运行LAMP服务器包,包括Windows11。尽管LAMP通常用于Linux系统,但XAMPP并不使用Li...

uTorrent怎样将bt种子转换为磁力

如何用uTorrent把BT种子转为磁力链接?以下方法希望能帮到你。1、在uTorrent窗口里,点击工具栏的按钮,所示。2、在打开窗口里,选取要转为磁力的种子文件,然后点击打开按钮,参照图示操作...

支持向量机SVM 分类和回归的实例

支持向量机(SupportVectorMachine)是Cortes和Vapnik于1995年首先提出的,它在解决小样本、非线性及高维模式识别中表现出许多特有的优势,并能够推广应用到函数拟合等其他...