如何给框架添加API接口日志

前言

  用的公司的框架,是MVC框架,看了下里面的日志基类,是操作日志,对增删改进行记录,

  夸张的是一张业务的数据表 需要一张专门的日志表进行记录,

  就是说你写个更新,添加的方法都必须写一遍操作日志,代码看了,不多,6行。

  不懂为什么要这样做,API 简洁万岁!~  于是果断在生命周期中插入接口日志。

思路1   一次插入

  1、生命周期在未进入接口前拿到相关信息(包括:接口名称,url,参数,方法,客户端IP,访问时间,甚至类和方法等信息),

  2、然后正常往下走调用接口的方法,

  3、等待接口中的方法执行完,带着返回值回到生命周期的后半部分,在这里采集接口的调用结果,返回状态码,数据等信息。

  4、写入日志库,OK

思路2   一次插入,一次更新

  1、生命周期在未进入接口前拿到相关信息(包括:接口名称,url,参数,方法,客户端IP,访问时间,甚至类和方法等信息),

  2、直接插入日志,并记录插入的log_id

  2、然后正常往下走调用接口,

  3、等待接口中的方法执行完,带着返回值回到生命周期的后半部分,在这里采集接口的返回信息,返回状态码,返回数据、响应时间、耗时等信息。

  4、根据log_id更新日志,OK

Action

  一顿研究,发现这框架竟然跟主流框架有点合不来,生命周期中 先new 访问的类,然后执行该类的某个方法,然后没了~ Waht FK

  进去一看,原来接口调用过程结束后 是 直接在当前执行的函数中 就echo 然后exit,不是我所熟悉的 先 return  然后在生命周期中echo并exit。

  好吧,男人有苦从不说,我自清风向明月。

  因为生命周期的不完整,以及程序执行过程中随时可能exit, 故决定 分两次记录日志,一次插入,一次修改,并封装一个统一返回数据的函数,确保每个接口最终都会调用

    在生命周期的前半部分,进入接口前,找一个空地,蹭一蹭,然后采集相关信息(包括:接口名称,url,参数,方法,客户端IP,访问时间,甚至类和方法等信息)

  直接插入api_log表,返回 log_id  存到静态变量中,

    下面正常调用接口的函数,但是在函数的最后,不论成功或失败,我们都会格式化一下返回的数据结构,

    这里我们可以利用一下,在这里采集接口的返回时数据,并根据log_id进行更新操作。

仅提供插入日志的代码进行参考,毕竟每个框架的声明周期都有区别

/**
     * 添加日志
     * User: LiZheng  271648298@qq.com
     * Date: 2019/3/20
     */
    public static function log()
    {
        $log_data[‘name‘] = $_SERVER[‘REQUEST_URI‘];     //接口名
        $log_data[‘platform‘] = APP_NAME;                //本应用名称
        $url = explode("/", $log_data[‘name‘]);
        $log_data[‘controller‘] = $url[2];
        $log_data[‘action‘] = $url[3];
        $log_data[‘params‘] = is_string(lib_context::post_all()) ? lib_context::post_all() :json_encode(lib_context::post_all());         //请求参数
        $log_data[‘method‘] = $_SERVER[‘REQUEST_METHOD‘];    //请求方法
        $log_data[‘header‘] = $_SERVER[‘CONTENT_TYPE‘];  //请求头
        $log_data[‘client‘] = get_client_ip() ; //当前用户IP
        $log_data[‘server‘] = $_SERVER[‘HTTP_HOST‘];  //服务器主机的名称,端口号不是80时,会显示端口号
        self::$log_start = intval(microtime(true) * 1000);
        $log_data[‘start_time‘] = time();
        $info = self::$_module_log -> insert_id($log_data);
        self::$log_id = $info[‘info‘];
        self::$api_url = $url[2].‘/‘.$url[3];
        self::$api_folder = $url[1];
    }

/**
     * 接口json 标准输出,并更新日志
     * @param $result
     * User: LiZheng  271648298@qq.com
     * Date: 2019/3/20
     */
    public static function json_output($result)
    {
        $log_data[‘response_code‘] = $result[‘code‘];
        $log_data[‘response_msg‘] = $result[‘msg‘];
        if(isset($result[‘data‘]))
        {
            $log_data[‘response_data‘] = json_encode($result[‘data‘],true);
        }
        else
        {
            $log_data[‘response_data‘] = json_encode(array(),true);
        }
        $log_data[‘end_time‘] = time();
        $log_data[‘life‘] = intval(microtime(true) * 1000) - self::$log_start;

        self::$_module_log -> update_by_id(self::$log_id, $log_data);
        echo json_encode($result);
        exit;
    }

原文地址:https://www.cnblogs.com/lz0925/p/10573598.html

时间: 2024-11-13 09:25:49

如何给框架添加API接口日志的相关文章

android框架Java API接口总注释/**@hide*/和internal API

Android有两种类型的API是不能经由SDK访问的 l 第一种是位于com.android.internal包中的API我,位于frameworks/base/core/java/com/android/internal/.我将称之为internal API. l 第二种API类型是一系列被标记为@hide属性的类和方法.从严格意义上来讲,这不是一个单一的API和类,而是一些的被隐藏的API和类,称之为hidden API Internal和hidden API的区别 Hidden API之

php后台对接ios,安卓,API接口设计和实践完全攻略,涨薪必备技能

2016年12月29日13:45:27 关于接口设计要说的东西很多,可能写一个系列都可以,vsd图都得画很多张,但是由于个人时间和精力有限,所有有些东西后面再补充 说道接口设计第一反应就是restful api 请明白一点,这个只是设计指导思想,也就是设计风格 ,比如你需要遵循这些原则 原则条件REST 指的是一组架构约束条件和原则.满足这些约束条件和原则的应用程序或设计就是 RESTful.Web 应用程序最重要的 REST 原则是,客户端和服务器之间的交互在请求之间是无状态的.从客户端到服务

API接口幂等性框架设计

表单重复提价问题 rpc远程调用时候 发生网络延迟  可能有重试机制 MQ消费者幂等(保证唯一)一样 解决方案: token 令牌 保证唯一的并且是临时的  过一段时间失效 分布式: redis+token 注意在getToken() 这种方法代码一定要上锁  保证只有一个线程执行  否则会造成token不唯一 步骤 调用接口之前生成对应的 token,存放在redis中 调用接口的时候,将该令牌放到请求头中 (获取请求头中的令牌) 接口获取对应的令牌,如果能够获取该令牌 (将当前令牌删除掉),

测开大佬告诉你:如何5分钟快速创建restful风格的API接口-使用django restframework框架

一.思考?? 1.创建API接口难吗? 软件测试工程师: 只测过API接口, 从没创建过 应该需要掌握一门后端开发语言和后端开发框架吧!? 脑容量有限,想想就可怕 2.如何创建API接口呢? 使用Django restframework能快速创建符合restful风格的API接口 通过Django restframework框架提供的序列化器.视图集可轻轻松松实现 简单高效,学习成本低 二.搭建项目工程???? 1.创建项目 打开pycharm 创建项目 使用豆瓣源安装Django Django

调用API接口下载腾讯CDN访问日志

公司使用腾讯cdn为网站静态内容加速,由于业务需求,需要每天下载昨天的日志(因为腾讯方面给出回复,访问日志会有2个小时或以上时间的延迟,所以不建议下载当天日志,所以每天统计前一天的日志以做分析).因为cdn是由运维来管理,但是这个需求是业务的,如果每天都由运维进行下载,再通过邮件或其他工具发送,可能就显得麻烦.所幸腾讯CDN提供了API接口,因此采用shell脚本调用API进行下载的方式,定期下载日志,这样只要业务人员运行这个脚本就能自行下载日志,解放了运维的工作. #!/bin/bash ##

zabbix调用api接口批量添加主机

zabbix调用api接口批量添加主机,这里用的是python 2.7(需安装xlrd模块处理表格). (1)到官网下载xlrd模块:https://pypi.python.org/pypi/xlrd (2)解压压缩包:tar xvf xlrd-1.0.0.tar.gz(3)进入到解压的文件夹运行python setup.py install命令安装 1.整理一个excel表格(test.xlsx),格式如下: 2.addhost.py脚本,添加主机名.显示名称.dns主机名.群组.模板字段(网

REST API 自动化测试 利器Rest Assured(API接口自动化测试框架体系)

现在,越来越多的 Web 应用转向了 RESTful 的架构,很多产品和应用暴露给用户的往往就是一组 REST API,这样有一个好处,用户可以根据需要,调用不同的 API,整合出自己的应用出来.从这个角度来讲,Web 开发的成本会越来越低,人们不必再维护自己的信息孤岛,而是使用 REST API 互联互通 那么,作为 REST API 的提供者,如何确保 API 的稳定性与正确性呢?全面系统的测试是必不可少的.Java 程序员常常借助于 JUnit 来测试自己的 REST API,不,应该这样

SpringBoot2.0系列教程(六)Springboot框架添加Swagger2来在线自动生成接口的文档+测试功能

Hello大家好,本章我们添加Swagger2来在线自动生成接口的文档+测试功能.有问题可以联系我[email protected].另求各路大神指点,感谢 一:什么是Swagger Swagger是一款通过我们添加的注解来对方法进行说明,来自动生成项目的在线api接口文档的web服务. 二:添加Swagger2依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swag

前后端分离后台api接口框架探索

前言 很久没写文章了,今天有时间,把自己一直以来想说的,写出来,算是一种总结吧!  这篇文章主要说前后端分离模式下(也包括app开发),自己对后台框架和与前端交互的一些理解和看法.     前后端分离,一般传递json数据,对于出参,现在通用的做法是,包装一个响应类,里面包含code,msg,data三个属性,code代表状态码,msg是状态码对应的消息,data是返回的数据. 如  {"code":"10008","message":"