SpringBoot3实战集成mzt-biz-log实现日志记录

<!-- 定义bizlog-sdk版本号，推荐在pom.xml properties节点统一管理 -->
<properties>
    <bizlog-sdk.version>3.0.6</bizlog-sdk.version>
</properties>
 
<!-- mzt-biz-log 正确核心依赖，适配SpringBoot 3.2.5 -->
<dependency>
    <groupId>io.github.mouzt</groupId>
    <artifactId>bizlog-sdk</artifactId>
    <version>${bizlog-sdk.version}</version>
</dependency>

import com.mzt.logapi.beans.Operator;
import com.mzt.logapi.service.IOperatorGetService;
import org.springframework.stereotype.Component;
 
@Component
public class CustomOperatorGetService implements IOperatorGetService {
 
    @Override
    public Operator getUser() {
        // 替换为项目真实获取登录用户逻辑
        // 示例：return UserContext.getCurrentUser().getUsername();
        // 测试阶段可暂用固定值，上线后对接登录体系
        return new Operator("admin");
    }
}

import com.mzt.logapi.beans.LogRecord;
import com.mzt.logapi.service.ILogRecordService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import java.util.List;
 
@Slf4j
@Component
public class CustomLogRecordService implements ILogRecordService {
 
    /**
     * 日志核心保存方法
     */
    @Override
    public void record(LogRecord logRecord) {
        // 调试阶段：控制台打印日志
        log.info("=====================业务日志=====================");
        log.info("操作人：{}", logRecord.getOperator());
        log.info("业务类型：{}", logRecord.getType());
        log.info("业务ID：{}", logRecord.getBizNo());
        log.info("操作内容：{}", logRecord.getAction());
        log.info("操作时间：{}", logRecord.getCreateTime());
        log.info("==================================================");
 
        // 生产环境：对接数据库，实现日志入库
        // BizLogEntity logEntity = buildLogEntity(logRecord);
        // bizLogMapper.insert(logEntity);
    }
 
    @Override
    public List<LogRecord> queryLog(String bizNo, String type) {
        return List.of();
    }
 
    @Override
    public List<LogRecord> queryLogByBizNo(String bizNo, String type, String subType) {
        return List.of();
    }
}

import com.mzt.logapi.starter.annotation.EnableLogRecord;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
@SpringBootApplication
@EnableLogRecord(tenant = "")
public class Springboot3BizLogApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(Springboot3BizLogApplication.class, args);
    }
}

import lombok.Data;
 
@Data
public class UserInfo {
    private Long userId;
    private String username;
    private String phone;
    private Integer age;
}

import com.example.bizlogdemo.entity.UserInfo;
 
/**
 * 用户服务接口
 * 提供用户信息的更新和删除操作
 */
public interface UserService {
 
    /**
     * 更新用户信息
     * <p>
     * 根据传入的用户信息对象，更新对应用户的数据，包括用户名、手机号、年龄等信息
     * </p>
     *
     * @param user 包含更新信息的用户对象，必须包含有效的 userId
     * @return 更新成功返回 true，失败返回 false
     */
    boolean updateUser(UserInfo user);
 
    /**
     * 删除用户
     * <p>
     * 根据用户 ID 删除对应的用户信息
     * </p>
     *
     * @param userId 要删除的用户 ID
     * @return 删除成功返回 true，失败返回 false
     */
    boolean deleteUser(Long userId);
}

import com.example.bizlogdemo.entity.UserInfo;
import com.mzt.logapi.context.LogRecordContext;
import com.mzt.logapi.starter.annotation.LogRecord;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
 
@Service
@Slf4j
public class UserServiceImpl implements UserService {
    /**
     * 编辑用户信息，记录变更前后数据
     */
    @Override
    @LogRecord(
            bizNo = "{{#user.userId}}",
            success = "编辑用户信息，用户ID：{{#user.userId}}，修改前用户名：{{#oldUser.username}}，修改后用户名：{{#user.username}}，修改前手机号：{{#oldUser.phone}}，修改后手机号：{{#user.phone}}",
            type = "user"
    )
    public boolean updateUser(UserInfo user) {
        // 查询数据库旧数据
        UserInfo oldUser = getUserById(user.getUserId());
        log.info("执行用户更新操作，用户ID：{}", user.getUserId());
        // 旧数据存入上下文，供日志注解读取
        LogRecordContext.putVariable("oldUser", oldUser);
        return true;
    }
 
    /**
     * 删除用户，记录删除操作
     */
    @Override
    @LogRecord(
            bizNo = "{{#userId}}",
            success = "删除用户，用户ID：{{#userId}}",
            type = "user"
    )
    public boolean deleteUser(Long userId) {
        log.info("执行用户删除操作，用户ID：{}", userId);
        return true;
    }
 
    /**
     * 模拟根据ID查询用户旧数据
     */
    private UserInfo getUserById(Long userId) {
        UserInfo oldUser = new UserInfo();
        oldUser.setUserId(userId);
        oldUser.setUsername("测试用户");
        oldUser.setPhone("13800138000");
        oldUser.setAge(20);
        return oldUser;
    }
}

import com.example.shardingspheredemo.entity.UserInfo;
import com.example.shardingspheredemo.service.UserService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.annotation.Resource;
import org.springframework.web.bind.annotation.*;
 
@RestController
@RequestMapping("/user")
@Tag(name = "用户管理接口", description = "用户增删改查接口")
public class UserController {
 
    @Resource
    private UserService userService;
 
    @PostMapping("/update")
    @Operation(summary = "更新用户", description = "传入用户信息，返回用户ID")
    @ApiResponse(responseCode = "200", description = "新增成功", content = @Content(schema = @Schema(implementation = String.class)))
    public String updateUser(@RequestBody UserInfo user) {
        boolean result = userService.updateUser(user);
        return result ? "修改成功" : "修改失败";
    }
 
    @GetMapping("/delete/{userId}")
    @Operation(summary = "根据ID删除用户", description = "传入用户ID，删除用户数据")
    public String deleteUser(@PathVariable Long userId) {
        boolean result = userService.deleteUser(userId);
        return result ? "删除成功" : "删除失败";
    }
}