[发明专利]一种API调试日志打印方法及装置

说明书

本发明提供一种API调试日志打印方法，包括步骤：接收调用方发送的调试日志打印请求，所述打印请求中包括调试令牌；根据所述调试令牌对应的预设特征信息，判断所述调试令牌是否有效，所述预设特征信息用于表征所述调试令牌的有效属性；当判断所述调试令牌有效时，查找并打印所述调试日志打印请求对应的调试日志。另，本发明还提供一种API调试日志打印装置。所述API调试日志打印方法通过引入调试令牌来实现对调试日志的打印权限及配额管理，可有效提升API调试日志打印的可控性及安全性。

技术领域

本发明涉及计算机软件技术领域，尤其涉及一种API调试日志打印方法及装置。

背景技术

API(Application Programming Interface，应用程序编程接口)是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。

API在对外提供接口调用服务的时候，往往需要调用方传入若干个(或一个)参数，通过给不同的参数传入不同的值来获取想要的数据，这一般需要API本身做若干种(或一种)逻辑处理，API通过分析传入参数并利用上述逻辑处理获取到调用方想要的数据之后把这些数据传输给调用方。当在API逻辑处理比较复杂的情况下，可能出现调用方得到返回数据与预期不符的情况，这有可能是调用方没有完全理解API的逻辑处理细节导致。在这种情况下，API需要提供相应的调试方法给调用方，比如提供详细的调试日志，让调用方明白API逻辑处理的细节，让调用方清晰的明白为什么会返回这样的数据。

一般现有的API服务进程的启动参数中都会有一个用于设置调试级别的参数，API服务进程启动的时候增加了这个参数就可以让API打印出相应级别的调试日志。然而，现有的调试方法有以下缺点：首先，打开和关闭调试日志必须重新启动API服务进程，在生产环境下重启API进程服务一般都会有一定的风险，一般的原则都是尽量避免在生产环境下重启API服务进程，而且生产环境下的重要API进程服务一般都需要审批才能被允许重启，这就导致了调试相对比较困难。其次，现有的调试方法只能整体控制API服务进程打印或者不打印详细的调试日志，这会导致很多不必要的调试日志被打印出来，在生产环境下打开高级别的调试日志可能会让日志文件暴涨，引起日志文件填满磁盘空间或持续负载过高的问题，有很大的风险。而实际上往往只需要打印出某个(或某些)调用方调用而产生的调试日志就能达到当次调试的目的。此外，在现有的调试方法中，所有因调用方调用而产生的调试日志一般会混合到一起，不能(或不易)通过关键字来区分查找。

发明内容

为解决现有技术中所存在的上述问题，本发明提供一种API调试日志打印方法，通过在API和调用方之间引入调试令牌来实现对调试日志的打印权限，以提升API调试日志打印的可控性及安全性。

另，本发明还提供一种API调试日志打印装置。

一种API调试日志打印方法，包括步骤：

接收调用方发送的调试日志打印请求，所述打印请求中包括调试令牌；

根据所述调试令牌对应的预设特征信息，判断所述调试令牌是否有效，所述预设特征信息用于表征所述调试令牌的有效属性；

当判断所述调试令牌有效时，查找并打印所述调试日志打印请求对应的调试日志。

其中，所述接收调用方发送的调试日志打印请求之前，还包括：

接收调试令牌预设指令，预设所述调试令牌对应的特征信息，所述特征信息包括所述调试令牌的令牌值。

其中，所述判断所述调试令牌是否有效，包括：

读取所述调试令牌的令牌值，并将所述令牌值与所述调试令牌的预设令牌值比较，当所述令牌值与所述预设令牌值相同时，判断所述调试令牌有效。