Log4j-Audit 技术文档

1. 安装指南

环境要求

• Java 8 或更高版本
• Log4j API 和 Core 2.9 或更高版本
• Apache Maven 3.x

源码构建

从源码构建 Log4j Audit 并安装到本地 Maven 仓库，请执行以下命令：

mvn clean install

2. 项目的使用说明

Log4j-Audit 提供了一个框架，用于定义审计事件并使用 Log4j 进行记录。该框架专注于定义事件，并为应用程序提供了一种简单的机制来记录这些事件，使产品能够为记录的事件提供一致性和有效性。它不关注如何将日志事件写入数据存储。Log4j 本身为此提供了许多选项。

预期的流程是业务分析师或产品经理将管理目录，定义事件和属性，以便事件消费者有一个一致的体验。例如，如果一个事件使用名为 "custAddr" 的属性，而另一个事件使用名为 "customerAddress" 的属性，那么这两个事件将使用相同名称的属性，它们具有相同的意义。

一旦在 Web 应用程序中修改了目录，它将保存为 JSON 到 Git 仓库。预期持续集成系统会注意到更改并开始构建该项目。构建将使用 Log4j Audit Maven 插件生成 Java 接口，Java 开发人员将使用这些接口在应用程序中实现审计日志记录。非 Java 应用程序通过发送适当的 JSON 形式的数据传输对象 (DTO) 并由审计服务执行与通过 Java 接口记录相同的验证。

Log4j Audit 本身不可完全使用。Log4j Audit 的用户必须有一个 Git 项目，其中包含 JSON 目录，该目录在构建后包含目录中定义的事件的 Java 接口。他们需要修改随 Log4j Audit 提供的审计服务，以包括 JSON 目录（通过包含前面讨论的 Git 项目作为依赖项），并按需配置审计服务。Log4j Audit 样例项目 (Log4j Audit Samples) 是一个示例项目，说明了如何执行这些任务。

3. 项目 API 使用文档

Log4j Audit API

Java 应用程序使用 Log4j Audit API 执行审计日志记录。

Log4j Audit Maven 插件

该插件用于从目录生成 Java 接口。

审计服务

非 Java 应用程序通过发送适当的 JSON 形式的数据传输对象 (DTO) 与审计服务交互，执行审计日志记录。

Log4j Catalog API

用于处理目录的 API。

Java Persistence Architecture (JPA)

用于持久化目录的模块。

JSON 目录读写模块

用于将目录的 JSON 版本读写到远程 Git 仓库的模块。

Web 应用程序

提供一个可以编辑目录各种组件的 Web 应用程序。

4. 项目安装方式

请按照以下步骤安装 Log4j Audit：

1. 从 Apache Log4j Audit 官方网站下载 Log4j Audit 的最新版本。
2. 解压下载的文件到指定的目录。
3. 打开命令行窗口，切换到解压后的目录。
4. 执行以下命令构建项目：

mvn clean install

构建完成后，Log4j Audit 将被安装到本地 Maven 仓库，可供其他项目使用。