CN113704820A - 一种应用日志打码方法、装置及计算机可读存储介质 - Google Patents

Abstract

本发明提供了一种应用日志打码输出方法、装置、系统及计算机可读存储介质，该方法包括：利用原生日志记录器的扩展机制加载转换附加器，利用转换附加器加载日志转换器和用于输出日志消息的原生附加器，日志转换器包括一种或多种日志子转换器，以及，利用日志转换器加载初始化参数指定的日志子转换器；利用转换附加器接收原生日志记录器发来的日志消息，调用初始化参数指定的日志子转换器执行日志打码，并将经处理日志发送给原生附加器进行安全输出。利用上述方法，无需费力改造应用即可实现多样化的日志打码输出，对开发人员更友好。

Description

一种应用日志打码方法、装置及计算机可读存储介质

技术领域

本发明属于日志领域，具体涉及一种应用日志打码输出方法、装置及计算机可读存储介质。

背景技术

本部分旨在为权利要求书中陈述的本发明的实施方式提供背景或上下文。此处的描述不因为包括在本部分中就承认是现有技术。

Java应用调用诸如log4j的常规日志框架时均是原文输入输出，如果日志内容含有敏感信息，那么敏感信息将被输出到控制台或者日志文件中。此时，若需要实现针对敏感信息的打码输出，一般需要在应用调用日志框架来输出日志之前通过各种手段将带有敏感信息的日志内容按照固定逻辑进行转换，再用转换后的打码内容作为输入调用日志框架进行输出。

然而，这样相当于每次调用日志框架输出日志前，都需要显式的附带额外的打码预处理，应用调用日志的API会发生改变，应用需要做改造，这种方案对于开发人员的编程习惯有较大改变，并且如果由于疏忽导致某一处日志打印调用前漏加预处理，则达不到打码效果。此外，无法处理某些第三方类库内自主输出的日志。

因此，应用于诸如JAVA应用日志的日志打码输出是一个亟待解决的问题。

发明内容

针对上述现有技术中存在的问题，提出了一种应用日志打码输出方法、装置及计算机可读存储介质，利用这种方法、装置及计算机可读存储介质，能够解决上述问题。

本发明提供了以下方案。

第一方面，提供一种应用日志打码输出方法，包括：利用原生日志记录器的扩展机制加载转换附加器，利用转换附加器加载日志转换器和用于输出日志消息的原生附加器，日志转换器包括一种或多种日志子转换器，以及，利用日志转换器加载初始化参数指定的日志子转换器；利用转换附加器接收原生日志记录器发来的日志消息，调用初始化参数指定的日志子转换器执行日志打码，并将经处理日志发送给原生附加器进行安全输出。

在一种实施方式中，原生日志记录器和原生附加器均是JAVA日志框架的原生模块。

在一种实施方式中，日志转换器包括以下中的一种或多种日志子转换器：正则转换器、 Json转换器、Base64转换器、ISO8583转换器。

在一种实施方式中，利用原生日志记录器的扩展机制加载转换附加器，还包括：原生日志记录器基于配置文件而加载转换附加器；配置文件包括：一种或多种原生附加器的附加器类标识、一种或多种日志子转换器的日志子转换器类标识、对应于一种或多种日志子转换器的转换规则。

在一种实施方式中，对应于一种或多种日志子转换器的转换规则包括：正则转换规则，用于原始日志内容中符合正则匹配的部分按照预设替换规则进行替换；Json转换规则，用于指定Json对象的字段名和替换方法；ISO8583转换规则，用于指定8583报文对象的域编号和替换方法。

在一种实施方式中，Json转换规则和ISO8583转换规则在转换时嵌套调用正则转换器或 Base64转换器。

在一种实施方式中，原生附加器包括以下中的一种或多种：控制台附加器、文件附加器、套接字附加器、SMTP邮件附加器。

在一种实施方式中，转换附加器兼容以下任意一种或多种JAVA日志框架：slf4j、log4j、 log4j2、logback、common-logging。

在一种实施方式中，被配置为用于执行如第一方面的方法，且包括：原生日志记录器，被配置为用于基于扩展机制加载转换附加器；转换附加器，被配置为用于加载日志转换器和用于输出日志消息的原生附加器，日志转换器包括一种或多种日志子转换器；日志转换器，被配置为用于加载初始化参数指定的日志子转换器；转换附加器，被配置为还用于接收原生日志记录器发来的日志消息，调用初始化参数指定的日志子转换器执行日志打码，并将经处理日志发送给原生附加器进行安全输出。

第三方面，提供一种日志打码输出装置，包括：至少一个处理器；以及，与至少一个处理器通信连接的存储器；其中，存储器存储有可被至少一个处理器执行的指令，指令被至少一个处理器执行，以使至少一个处理器能够执行：如第一方面的方法。

第四方面，提供一种计算机可读存储介质，计算机可读存储介质存储有程序，当程序被多核处理器执行时，使得多核处理器执行如第一方面的方法。

本申请实施例采用的上述至少一个技术方案能够达到以下有益效果：本实施例中在原生日志记录器和原生附加器之间引入用于日志打码的转换附加器，如此无需费力改造应用即可实现多样化的日志打码输出，对于开发者更友好，并且提供一种或多种日志子转换器供选择，可以进一步适应多样化转换需求。

应当理解，上述说明仅是本发明技术方案的概述，以便能够更清楚地了解本发明的技术手段，从而可依照说明书的内容予以实施。为了让本发明的上述和其它目的、特征和优点能够更明显易懂，以下特举例说明本发明的具体实施方式。

附图说明

通过阅读下文的示例性实施例的详细描述，本领域普通技术人员将明白本文的优点和益处以及其他优点和益处。附图仅用于示出示例性实施例的目的，而并不认为是对本发明的限制。而且在整个附图中，用相同的标号表示相同的部件。在附图中：

图1为根据本发明一实施例的应用日志打码输出装置的结构示意图；

图2为根据本发明一实施例的应用日志打码输出方法的流程示意图；

图3为根据本发明一实施例的应用日志打码输出方法的实现示意图。

在附图中，相同或对应的标号表示相同或对应的部分。

具体实施方式

下面将参照附图更详细地描述本公开的示例性实施例。虽然附图中显示了本公开的示例性实施例，然而应当理解，可以以各种形式实现本公开而不应被这里阐述的实施例所限制。相反，提供这些实施例是为了能够更透彻地理解本公开，并且能够将本公开的范围完整的传达给本领域的技术人员。

在本申请实施例的描述中，应理解，诸如“包括”或“具有”等术语旨在指示本说明书中所公开的特征、数字、步骤、行为、部件、部分或其组合的存在，并且不旨在排除一个或多个其他特征、数字、步骤、行为、部件、部分或其组合存在的可能性。

除非另有说明，“/”表示或的意思，例如，A/B可以表示A或B；本文中的“和/或”仅仅是一种描述关联对象的关联关系，表示可以存在三种关系，例如，A和/或B，可以表示：单独存在A，同时存在A和B，单独存在B这三种情况。

术语“第一”、“第二”等仅用于描述目的，而不能理解为指示或暗示相对重要性或者隐含指明所指示的技术特征的数量。由此，限定有“第一”、“第二”等的特征可以明示或者隐含地包括一个或者更多个该特征。在本申请实施例的描述中，除非另有说明，“多个”的含义是两个或两个以上。

本申请中的所有代码都是示例性的，本领域技术人员根据所使用的编程语言，具体的需求和个人习惯等因素会在不脱离本申请的思想的条件下想到各种变型。

为清楚阐述本申请实施例，首先将介绍一些后续实施例中可能会出现的概念。

概念描述

API(Application Programming Interface，应用程序接口)，是预先定义的接口，如函数或HTTP接口。

Logger，原生日志记录器，是Java原生的日志记录API。

slf4j(Simple logging facade for Java)，是一种简单Java日志外观，用于为日志 API提供一个简单统一的接口，使用户能够在部署的时候配置日志外观的实现。

Log4j(Logging for Java)，是一种开源的Java日志组件，用于控制日志输出的目的地，如控制台、文件等，Log4j2是log4j升级版本。

Logback，是另一种日志组件。

Common-logging，是一种通用日志，其具有开源的通用日志接口组件，且兼容轻量级和不依赖于具体的日志实现工具。

JSON(JavaScript Object Notation，JS对象简谱)，是一种轻量级数据交互格式。

BASE64，是指一种基于64个可打印字符来表示二进制数据的编码

ISO8583(International organization for standardization 8583message，8583 报文国际标准包)，是指一种国际标准的报文格式，广泛应用于银行卡。

另外还需要说明的是，在不冲突的情况下，本发明中的实施例及实施例中的特征可以相互组合。下面将参考附图并结合实施例来详细说明本发明。

如图1所示，图1是本发明实施例方案涉及的硬件运行环境的结构示意图。

需要说明的是，图1即可为日志打码输出设备的硬件运行环境的结构示意图。本发明实施例基于日志打码输出设备可以是PC，便携计算机等终端设备。

如图1所示，该日志打码输出设备可以包括：处理器1001，例如CPU，网络接口1004，用户接口1003，存储器1005，通信总线1002。其中，通信总线1002用于实现这些组件之间的连接通信。用户接口1003可以包括显示屏(Display)、输入单元比如键盘(Keyboard)，可选用户接口1003还可以包括标准的有线接口、无线接口。网络接口1004可选的可以包括标准的有线接口、无线接口(如WI-FI接口)。存储器1005可以是高速RAM存储器，也可以是稳定的存储器(non-volatile memory)，例如磁盘存储器。存储器1005可选的还可以是独立于前述处理器1001的存储装置。

本领域技术人员可以理解，图1中示出的日志打码输出设备结构并不构成对日志打码输出设备的限定，可以包括比图示更多或更少的部件，或者组合某些部件，或者不同的部件布置。

如图1所示，作为一种计算机存储介质的存储器1005中可以包括操作系统、网络通信模块、用户接口模块以及日志打码输出指令(程序)。其中，操作系统是管理和控制日志打码输出设备硬件和软件资源的程序，支持日志打码输出程序以及其它软件或程序的运行。

在图1所示的日志打码输出设备中，用户接口1003主要用于发送的请求、数据等；网络接口1004主要用于连接后台服务器与后台服务器进行数据通信；而处理器1001可以用于调用存储器1005中存储的日志打码输出程序，并执行以下操作：

初始化步骤：利用原生日志记录器的扩展机制加载转换附加器，利用所述转换附加器加载日志转换器和用于输出日志消息的原生附加器，所述日志转换器包括一种或多种日志子转换器，以及，利用所述日志转换器加载初始化参数指定的所述日志子转换器；

运行步骤：利用所述转换附加器接收所述原生日志记录器发来的日志消息，调用所述初始化参数指定的所述日志子转换器执行日志打码，并将经处理日志发送给所述原生附加器进行安全输出。

通过在原生日志记录器和原生附加器之间引入转换附加器，如此无需费力改造应用即可实现多样化的日志打码输出。此外，由于可以从业务逻辑中将日志转换逻辑剥离出来，便于维护业务代码。并且提供一种或多种日志子转换器供选择，可以进一步适应多样化转换需求。

图2为根据本申请一实施例的日志打码输出方法的流程示意图，用于对日志进行打码输出，在该流程中，从设备角度而言，执行主体可以是一个或者多个电子设备；从程序角度而言，执行主体相应地可以是搭载于这些电子设备上的程序。

如图2所示，本实施例提供的方法可以包括以下步骤：

S201、利用原生日志记录器的扩展机制加载转换附加器，利用转换附加器加载日志转换器和用于输出日志消息的原生附加器，利用日志转换器加载初始化参数指定的日志子转换器；其中，日志转换器包括一种或多种日志子转换器，

上述S201为初始化步骤，具体来说，需要初始化参数来执行上述初始化，该初始化参数指定日志子转换器。可选地，该初始化参数还可以指定原生附加器。

一个示例中，以正则转换器为例详细说明，原生日志记录器初始化为Logger.getLogger("正则转换器标识")，这里Logger是Java原生日志记录器，原生日志记录器对应配置的appender-ref ref＝"正则转换器名"指定日志子转换器。

可选地，可以声明或初始化多个不同的原生日志记录器，比如Logger1、Logger2，进一步将不同的原生日志记录器对应不同的日志子转换器，比如对应于分别对应于正则转换器和 BASE64转换器。以便程序员在应用代码拟输出日志的位置根据待输出日志内容具体选择所声明的不同原生日志记录器来完成日志打码输出。

在一实施例中，原生日志记录器和原生附加器可以均是JAVA日志框架的原生模块。

在一实施例中，S201中，原生日志记录器基于配置文件而加载转换附加器，配置文件包括：一种或多种原生附加器的附加器类标识、一种或多种日志子转换器的日志子转换器类标识、对应于一种或多种日志子转换器的转换规则。上述原生附加器和日志子转换器以类名的形式包含在配置文件中，转换附加器可以基于类名加载需要的任意一种或多种原生附加器和日志子转换器。

在一实施例中，原生附加器包括但不限于以下中的一种或多种：控制台附加器、文件附加器、套接字附加器、SMTP邮件附加器等多种原生附加器。当然还可以包括其他的原生附加器，本申请对此不作具体限制。从而可以按照需求实现将日志输出至控制台或者文件中。

一个示例中，上述控制台附加器可以是org.apache.log4j.ConsoleAppender等。在一实施例中，转换附加器兼容以下任意一种或多种JAVA日志框架：slf4j、log4j、log4j2、logback、common-logging。

在一实施例中，日志转换器包括以下中的一种或多种日志子转换器：正则转换器、Json 转换器、Base64转换器、ISO8583转换器，从而可以提供多种类型的打码转换。当然还可以包括其他的日志子转换器，本申请对此不作具体限制。

进一步地，除Base64转换器是直接将日志内容进行Base64编码外，其他子转换器还依赖配置文件中的转换规则进行转换，转换规则具体包括：

1、正则转换规则，其用于原始日志内容中符合正则匹配的部分按照预设替换规则进行替换。示例包括：{\"regex\":\"^(\\\\d{6})\\\\d+(\\\\d{4})$\","replacement\":\"$1****$2\"}，可以支持多个规则同时配置，该正则转换规则表示过滤所收到原始日志内容中符合正则匹配则按照 replacement所指向的替换规则进行替换。比如可以将“6228880000000008”转换为“622888******0008”。

2、Json转换规则，用于指定Json对象的字段名和替换方法；Json转换器的转换配置则需要指定Json对象的字段名和替换方法，具体实施中可以嵌套调用正则转换(此处也可以通过调用所实现的Base64转换而实现该Json转换)。

3、ISO8583转换规则，用于指定8583报文对象的域编号和替换方法。ISO8583转换器的转换配置则需要指定8583报文对象的域编号和替换方法，具体实施中可以嵌套调用正则转换。

本实施例中，通过指定Json对象字段名或者ISO8583报文对象的字段名是为提高转换效率，因为采用正则转换理论上可以实现对各种打码场景，比如针对银行卡字符串、手机号字符串、证件号字符串等，但存在误判导致过度打码或者全输入日志内容多正则过滤的效率问题，故本申请进一步提供了针对日常开发过程中常见的Json对象和ISO8583对象的子转换器。

S202、利用转换附加器接收原生日志记录器发来的日志消息，调用初始化参数指定的日志子转换器执行日志打码，并将经处理日志发送给原生附加器进行安全输出。

该S202也即日志打码输出的实际运行步骤，一个示例中，参考图3，示出了本实施例的实现示意图，其中箭头表示本申请的应用日志打码装置的逻辑关系，上部白色块是Java原生或者第三方日志组件，比如JAVA应用、原生日志记录器、控制台附加器、文件附加器等。灰色块部分是本申请中用于日志打码的各个元件，包括转换附加器、日志转换器、各个日志子转换器(正则转换器、JSON转换器、Base64转换器、ISO8583转换器)。利用各日志框架提供的扩展机制，扩展实现转换附加器，该转换附加器内部集成兼容各日志框架的原生附加器和日志转换器。其中，1、原生日志记录器从JAVA应用中获得日志消息。2、原生日志记录器调用转换附加器，并将日志消息传递给该转换附加器。3、转换附加器调用日志转换器，并将日志内容传递给日志转换器。4、日志转换器调用日志子转换器，以利用日志子转换器将日志内容中的敏感信息打码或转换。5、日志转换器将打码转换后的日志消息传递回转换附加器。6、转换附加器将转换后的日志消息传递给日志框架的原生附加器进行内容输出，从而保证输出信息安全。

在传统JAVA应用日志输出方案中，原生日志记录器在获得JAVA应用中生成的日志消息之后，会直接通过控制台附加器或者文件附加器输出，而在本方案中，通过在原生日志记录器和原生附加器之间插入转换附加器等，从而可以对原生日志记录器发来的日志消息进行打码转换，再将打码转换之后的日志消息通过原生附加器输出，整个过程对JAVA应用端无感。

以下结合应用实例的伪代码对本实施例提供的技术方案进行详细说明：

执行本申请实施例的示例性程序后的输出为：

>INFO Main-622888******0008

>INFO Main-aGVsbG8＝

换言之，如上例中logger1/2，只需要初始化原生日志记录器，即可在其作用域内重复试用，而且其作用域内可声明并初始化多个不同的原生日志记录器，以便程序员在应用代码拟输出日志的位置根据待输出日志内容具体选择所声明的不同原生日志记录器来完成日志打码输出。如此，对于编程习惯几乎没有变化，拟输出的日志内容、形参等均无任何变化，而原生日志记录器的名称logger1/2本身就是临时变量，其作用域内记住即可。

在本说明书的描述中，参考术语“一些可能的实施方式”、“一些实施例”、“示例”、“具体示例”、或“一些示例”等的描述意指结合该实施例或示例描述的具体特征、结构、材料或者特点包含于本发明的至少一个实施例或示例中。在本说明书中，对上述术语的示意性表述不必须针对的是相同的实施例或示例。而且，描述的具体特征、结构、材料或者特点可以在任一个或多个实施例或示例中以合适的方式结合。此外，在不相互矛盾的情况下，本领域的技术人员可以将本说明书中描述的不同实施例或示例以及不同实施例或示例的特征进行结合和组合。

此外，术语“第一”、“第二”仅用于描述目的，而不能理解为指示或暗示相对重要性或者隐含指明所指示的技术特征的数量。由此，限定有“第一”、“第二”的特征可以明示或者隐含地包括至少一个该特征。在本发明的描述中，“多个”的含义是至少两个，例如两个，三个等，除非另有明确具体的限定。

流程图中或在此以其他方式描述的任何过程或方法描述可以被理解为，表示包括一个或更多个用于实现特定逻辑功能或过程的步骤的可执行指令的代码的模块、片段或部分，并且本发明的优选实施方式的范围包括另外的实现，其中可以不按所示出或讨论的顺序，包括根据所涉及的功能按基本同时的方式或按相反的顺序，来执行功能，这应被本发明的实施例所属技术领域的技术人员所理解。

关于本申请实施例的方法流程图，将某些操作描述为以一定顺序执行的不同的步骤。这样的流程图属于说明性的而非限制性的。可以将在本文中所描述的某些步骤分组在一起并且在单个操作中执行、可以将某些步骤分割成多个子步骤、并且可以以不同于在本文中所示出的顺序来执行某些步骤。可以由任何电路结构和/或有形机制(例如，由在计算机设备上运行的软件、硬件(例如，处理器或芯片实现的逻辑功能)等、和/或其任何组合)以任何方式来实现在流程图中所示出的各个步骤。

基于相同的技术构思，本发明实施例还提供一种日志打码输出装置，用于执行上述任一实施例所提供的日志打码输出方法。

该装置包括：原生日志记录器，被配置为用于基于扩展机制加载转换附加器；转换附加器，被配置为用于加载日志转换器和用于输出日志消息的原生附加器，日志转换器包括一种或多种日志子转换器；日志转换器，被配置为用于加载初始化参数指定的日志子转换器；转换附加器，被配置为还用于接收原生日志记录器发来的日志消息，调用初始化参数指定的日志子转换器执行日志打码，并将经处理日志发送给原生附加器进行安全输出。

根据本申请的一些实施例，提供了日志打码输出方法的非易失性计算机存储介质，其上存储有计算机可执行指令，该计算机可执行指令设置为在由处理器运行时执行：上述实施例所述的方法。

本申请中的各个实施例均采用递进的方式描述，各个实施例之间相同相似的部分互相参见即可，每个实施例重点说明的都是与其他实施例的不同之处。尤其，对于装置、设备和计算机可读存储介质实施例而言，由于其基本相似于方法实施例，所以其描述进行了简化，相关之处可参见方法实施例的部分说明即可。

本申请实施例提供的装置、设备和计算机可读存储介质与方法是一一对应的，因此，装置、设备和计算机可读存储介质也具有与其对应的方法类似的有益技术效果，由于上面已经对方法的有益技术效果进行了详细说明，因此，这里不再赘述装置、设备和计算机可读存储介质的有益技术效果。

虽然已经参考若干具体实施方式描述了本发明的精神和原理，但是应该理解，本发明并不限于所公开的具体实施方式，对各方面的划分也不意味着这些方面中的特征不能组合以进行受益，这种划分仅是为了表述的方便。本发明旨在涵盖所附权利要求的精神和范围内所包括的各种修改和等同布置。

Claims (11)

1.一种应用日志打码输出方法，其特征在于，包括：

利用原生日志记录器的扩展机制加载转换附加器，利用所述转换附加器加载日志转换器和用于输出日志消息的原生附加器，所述日志转换器包括一种或多种日志子转换器，以及，利用所述日志转换器加载初始化参数指定的所述日志子转换器；

利用所述转换附加器接收所述原生日志记录器发来的日志消息，调用所述初始化参数指定的所述日志子转换器执行日志打码，并将经处理日志发送给所述原生附加器进行安全输出。

2.根据权利要求1所述的方法，其特征在于，所述原生日志记录器和所述原生附加器均是JAVA日志框架的原生模块。

3.根据权利要求1所述的方法，其特征在于，所述日志转换器包括以下中的一种或多种日志子转换器：正则转换器、Json转换器、Base64转换器、ISO8583转换器。

4.根据权利要求1所述的方法，其特征在于，利用原生日志记录器的扩展机制加载转换附加器，还包括：

所述原生日志记录器基于配置文件而加载所述转换附加器；

所述配置文件包括：一种或多种原生附加器的附加器类标识、一种或多种日志子转换器的日志子转换器类标识、对应于所述一种或多种日志子转换器的转换规则。

5.根据权利要求4所述的方法，其特征在于，对应于所述一种或多种日志子转换器的转换规则包括：

正则转换规则，用于原始日志内容中符合正则匹配的部分按照预设替换规则进行替换；

Json转换规则，用于指定Json对象的字段名和替换方法；

ISO8583转换规则，用于指定8583报文对象的域编号和替换方法。

6.根据权利要求5所述的方法，其特征在于，所述Json转换规则和所述ISO8583转换规则在转换时嵌套调用所述正则转换器或所述Base64转换器。

7.根据权利要求1所述的方法，其特征在于，所述原生附加器包括以下中的一种或多种：控制台附加器、文件附加器、套接字附加器、SMTP邮件附加器。

8.根据权利要求1所述的方法，其特征在于，所述转换附加器兼容以下任意一种或多种JAVA日志框架：slf4j、log4j、log4j2、logback、common-logging。

9.一种日志打码输出装置，其特征在于，被配置为用于执行如权利要求1-8中任意一项所述的方法，且包括：

原生日志记录器，被配置为用于基于扩展机制加载转换附加器；

所述转换附加器，被配置为用于加载日志转换器和用于输出日志消息的原生附加器，所述日志转换器包括一种或多种日志子转换器；

所述日志转换器，被配置为用于加载初始化参数指定的所述日志子转换器；

所述转换附加器，被配置为还用于接收所述原生日志记录器发来的日志消息，调用所述初始化参数指定的所述日志子转换器执行日志打码，并将经处理日志发送给所述原生附加器进行安全输出。

10.一种日志打码输出装置，其特征在于，包括：

至少一个处理器；以及，与至少一个处理器通信连接的存储器；其中，存储器存储有可被至少一个处理器执行的指令，指令被至少一个处理器执行，以使至少一个处理器能够执行：如权利要求1-8中任一项所述的方法。

11.一种计算机可读存储介质，所述计算机可读存储介质存储有程序，当所述程序被多核处理器执行时，使得所述多核处理器执行如权利要求1-8中任一项所述的方法。

Images