Springboot-注解驱动的操作日志组件安装与配置完全攻略

侯秋婉

于 2024-09-13 22:29:25 发布

阅读量373

点赞数 4

本文链接：https://blog.csdn.net/gitblog_09316/article/details/142232659

版权

Springboot-注解驱动的操作日志组件安装与配置完全攻略

mzt-biz-log 支持Springboot，基于注解的可使用变量、可以自定义函数的通用操作日志组件项目地址: https://gitcode.com/gh_mirrors/mz/mzt-biz-log

项目基础介绍与主要编程语言

mzt-biz-log 是一款专为Spring Boot设计的开源组件，它利用注解简化操作日志的记录过程。该组件让开发者能够轻松地跟踪“谁”、“何时”、“对什么”进行了“何种操作”，无需繁琐的手动日志编写。它支持使用变量和自定义函数，以生成更加丰富的日志内容。项目采用的主要编程语言是Java，并基于Apache-2.0许可协议发布。

关键技术和框架

Spring Boot: 作为基础框架，使得配置简单，快速启动。
注解（Annotations）: 核心特性，用于声明哪些方法的操作应该被记录，以及如何记录。
SpEL (Spring Expression Language): 用于在日志模板中动态插入变量和执行简单的逻辑。
自定义函数（IParseFunction）: 允许用户通过实现接口定义自己的日志处理逻辑，增强日志内容的灵活性。
数据库存储: 默认支持将操作日志持久化到数据库，便于后续分析和审查。

安装与配置步骤

准备工作

确保环境: 确认你的开发环境中已安装Java JDK 1.8或更高版本，且配置好环境变量。
IDE准备: 使用IntelliJ IDEA或Eclipse等Java集成开发环境。
Git客户端: 安装Git工具用于克隆项目源码。

克隆项目

打开命令行工具，克隆项目到本地：

git clone https://github.com/mouzt/mzt-biz-log.git

引入到您的Spring Boot项目

Maven配置

添加依赖: 在您的Spring Boot项目的pom.xml文件中，加入mzt-biz-log的依赖。注意替换版本号为最新稳定版或SNAPSHOT版（如示例所示）：

<dependencies>
    <!-- mzt-biz-log依赖 -->
    <dependency>
        <groupId>io.github.mouzt</groupId>
        <artifactId>bizlog-sdk</artifactId>
        <version>3.0.7-SNAPSHOT</version> <!-- 替换成发布的版本 -->
    </dependency>
</dependencies>

启用日志记录: 在主应用类上添加@EnableLogRecord注解，指定必要的配置，比如租户标识（tenant）：

@SpringBootApplication
@EnableTransactionManagement
@EnableLogRecord(tenant = "your.tenant.id")
public class YourApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

配置数据库存储（可选，如果使用默认数据库存储）

数据库表结构: 根据项目文档或源码中的数据库模型创建相应的表。
Spring Boot数据源配置: 在application.properties或application.yml中配置数据库连接。

示例（application.properties）:

spring.datasource.url=jdbc:mysql://localhost:3306/logdb?useSSL=false&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=rootpassword
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

使用注解进行日志记录

在需记录日志的方法上添加注解。例如，在一个创建订单的方法上添加@LogRecord注解，指定日志类型、业务ID等信息，并使用SpEL引用方法内的变量：

@LogRecord(success = "用户 [[#user.name]] 创建了订单 [[#order.no]]",
           type = LogRecordType.ORDER,
           bizNo = "[[#order.orderNo]]")
public boolean createOrder(Order order, User user) {
    // 方法体
}