SpringBoot-AOP-Logback用切面拦截操作日志

2023-09-14 18:56:21

在 Spring Boot 中使用切面来拦截操作日志，以及配合使用 MyBatis-Plus 框架进行操作，并使用 Thymeleaf 视图显示商品列表，同时配置 Logback 日志输出到文件。

CREATE TABLE product (
    id BIGINT AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(255) NOT NULL,
    price DECIMAL(10, 2) NOT NULL,
    description TEXT
);

INSERT INTO product (name, price, description) VALUES
    ('商品 1', 100.00, '商品描述   1'),
    ('商品 2', 150.00, '商品描述   2'),
    ('商品 3', 200.00, '商品描述   3'),
    ('商品 4', 50.00, '商品描述   4'),
    ('商品 5', 300.00, '商品描述   5'),
    ('商品 6', 120.00, '商品描述   6'),
    ('商品 7', 80.00, '商品描述   7'),
    ('商品 8', 250.00, '商品描述   8'),
    ('商品 9', 180.00, '商品描述   9'),
    ('商品 10', 90.00, '商品描述   10');

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- MyBatis-Plus -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>最新版本</version>
    </dependency>
    
      <!-- MySQL Driver -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>最新版本</version>
    </dependency>

    <!-- Thymeleaf -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-thymeleaf</artifactId>
    </dependency>

    <!-- Jackson for JSON -->
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
    </dependency>

    <!-- Logback -->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
    </dependency>
</dependencies>

application.properties配置文件

# 数据源配置
spring.datasource.url=jdbc:mysql://localhost:3306/your_database_name
spring.datasource.username=your_database_username
spring.datasource.password=your_database_password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# MyBatis-Plus 配置
mybatis-plus.mapper-locations=classpath:mapper/*.xml
mybatis-plus.global-config.id-type=auto

# Thymeleaf 配置
spring.thymeleaf.mode=HTML
spring.thymeleaf.cache=false

# 日志配置
logging.level.root=INFO
logging.level.com.icoderoad.example=DEBUG
logging.file=logs/application.log
logging.pattern.console=%msg%n

实体类Product

@Data
@TableName("product")
public class Product {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private double price;
    private String description;
}

商品Mapper

@Repository
public interface ProductMapper extends BaseMapper<Product> {
}

Controller

@Controller
public class ProductController{
	
	@Autowired
	private final ProductService productService;

	@GetMapping("/products")
	public String listProducts(Model model){
		model.Addtttribute("product",productService.list());
		return "product/list";
	}
}

Service

public interface ProductService extends IService<Product> {
}

@Service
public class ProductServiceImpl extends ServiceImpl<ProductMapper, Product> implements ProductService {
}

日志配置信息

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration>
<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{yyyy-mm-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>logs/application.log</file>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>%d{yyyy-mm-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="INFO">
         <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE" />
    </root>
</configuration>

WebLog类

/**
 * Controller层的日志封装类
 */
@Data
@EqualsAndHashCode
public class WebLog {
    /**
     * 操作描述
     */
    private String description;

    /**
     * 操作用户
     */
    private String username;

    /**
     * 操作时间
     */
    private Long startTime;

    /**
     * 消耗时间
     */
    private Integer spendTime;

    /**
     * 根路径
     */
    private String basePath;

    /**
     * URI
     */
    private String uri;

    /**
     * URL
     */
    private String url;

    /**
     * 请求类型
     */
    private String method;

    /**
     * IP地址
     */
    private String ip;

    /**
     * 请求参数
     */
    private Object parameter;

    /**
     * 返回结果
     */
    private Object result;

}

创建切面类

拦截操作日志并将其转化为 JSON 格式，输出转换后的 JSON 数据。

@Aspect
@Component
public class LogAspect{
	
	private static final Logger LOGGER = LoggerFactory.getLogger(LogAspect.class);

	@Autowired
	public final ObjectMapper objectMapper;

	//切入点定义：拦截所有Controller方法
	@Pointcut("execution(* com.icoderoad.example.product.controller.*.*(..))")
	public void webLog(){

	}

	//在方法返回后执行
	@AfterReturning(returning="result",pointcut="webLog()")
	public void doAfterReturning(JoinPoint joinPoint,Object result) throws Throwable  {
		
		//获取当前请求的属性
		ServletRequestAttributes attributes = (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
		HttpServletRequest request = attributes.getRequest();

		//创建weblog对象，并填充信息
		WebLog webLog = new WebLog();
		webLog.setStartTime(System.currentTimeMillis());
		webLog.setBasePath(request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort());
		webLog.setUri(request.getRequestURI());
        webLog.setUrl(request.getRequestURL().toString());
        webLog.setMethod(request.getMethod());
        webLog.setIp(getClientIp(request));  // 获取客户端真实 IP 地址
        webLog.setParameter(Arrays.toString(joinPoint.getArgs()));
        webLog.setResult(result);

		//将WebLog对象转换为JSON格式，并输出到控制台（实际应该输出到日志文件）
		String logJson = objectMapper.writeValueAsString(webLog);
        LOGGER.info(logJson);
	}

	// 获取客户端真实 IP 地址
    private String getClientIp(HttpServletRequest request) {
        String ipAddress = request.getHeader("X-Forwarded-For");
        if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
            ipAddress = request.getHeader("Proxy-Client-IP");
        }
        if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
            ipAddress = request.getHeader("WL-Proxy-Client-IP");
        }
        if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
            ipAddress = request.getRemoteAddr();
        }
        if (ipAddress != null && ipAddress.contains(",")) {
            ipAddress = ipAddress.split(",")[0].trim();
        }
        return ipAddress;
    }
}

项目启动类，启动的时候扫描mapper所在的包

@SpringBootApplication
@MapperScan("com.icoderoad.example.product.mapper")
public class AopLogbackProductApplication {

    public static void main(String[] args) {
        SpringApplication.run(AopLogbackProductApplication.class, args);
    }

}

视图展示层Thymeleaf

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
     <meta charset="UTF-8">
    <title>商品列表</title>
    <!-- 引入 Bootstrap 的 CSS 文件 -->
    <link href="https://cdn.jsdelivr.net/npm/bootstrap/dist/css/bootstrap.min.css" rel="stylesheet">
</head>
<body>
    <div  class="container">
        <h1>商品列表</h1>
        <table class="table table-striped">
            <thead>
                <tr>
                    <th>ID</th>
                    <th>名称</th>
                    <th>价格</th>
                    <th>描述</th>
                </tr>
            </thead>
            <tbody>
                <tr th:each="product : ${products}">
                    <td th:text="${product.id}"></td>
                    <td th:text="${product.name}"></td>
                    <td th:text="${product.price}"></td>
                    <td th:text="${product.description}"></td>
                </tr>
            </tbody>
        </table>
     </div>
</body>
</html>
更多推荐

Leetcode 01-算法入门与数组-③数组排序

LeetCode01-算法入门与数组-③数组排序一.冒泡排序1.冒泡排序算法思想冒泡排序（BubbleSort）基本思想：经过多次迭代，通过相邻元素之间的比较与交换，使值较小的元素逐步从后面移到前面，值较大的元素从前面移到后面。这个过程就像水底的气泡一样从底部向上「冒泡」到水面，这也是冒泡排序法名字的由来。接下来，我们

打破JSON的束缚：探寻Spring @JsonComponent的灵活性和扩展性

文章首发地址在Spring框架中，@JsonComponent注解用于自定义JSON序列化和反序列化的组件。它可以将一个类标记为一个Json组件，然后在对象的序列化和反序列化过程中，使用自定义的方式来处理JSON数据。使用@JsonComponent注解，需要创建一个类，并使用其中的@JsonComponent注解进行

使用 docker buildx 构建跨平台镜像 (QEMU/buildx/build)

目录1.使用buildx构建跨平台镜像1.1.简介1.2.安装1.3.构建跨平台镜像1.4.跨平台镜像构建策略1.4.1.在内核中使用QEMU仿真支持1.4.2.使用相同的构建器实例在多个本机节点上构建。1.4.3.使用Dockerfile中的多阶段构建,交叉编译到不同的平台架构中。1.5.创建builder1.6.启

Vue系列（四）之 Vue路由介绍和Node.js的环境搭建

目录一.Vue路由1.1Vue路由是什么1.2SPA是什么1.3Vue路由的使用步骤二.Node.js环境搭建2.1Node.js是什么2.2npm是什么2.3Node.js环境搭建1.下载Node.js2.解压3.配置环境变量4.配置npm全局模块路径和cache默认安装位置5.修改npm镜像提高下载速度6.验证安装

MFC扩展库BCGControlBar Pro v33.6亮点 - 流程图、Ribbon Bar功能升级

BCGControlBar库拥有500多个经过全面设计、测试和充分记录的MFC扩展类。我们的组件可以轻松地集成到您的应用程序中，并为您节省数百个开发和调试时间。BCGControlBar专业版v33.6已正式发布了，此版本包含了对图表组件的改进、带隐藏标签的单类功能区栏，标签控制通知徽章和其他新功能、改进等。最新版点击

腾讯云16核服务器配置大全_16核CPU型号性能测评

腾讯云16核CPU服务器有哪些配置可以选择？可以选择标准型S6、标准型SA3、计算型C6或标准型S5等，目前标准型S5云服务器有优惠活动，性价比高，计算型C6云服务器16核性能更高，轻量16核32G28M带宽优惠价3468元15个月，腾讯云百科分享腾讯云16核CPU服务器可以选择的云服务器CVM规格列表：目录腾讯云16

前端笔试2

1.下面哪一个是检验对象是否有一个以自身定义的属性?foo.hasOwnProperty("bar")barinfoofoo["bar"]!==undefinedfoo.bar!=null解析：`barinfoo`检查`foo`对象是否包含名为`bar`的属性，但是这个属性可以是从原型链继承来的，因此不是检验对象是否有

保障半导体生产安全：半导体厂务漏液监测的重要性

半导体产业作为高科技领域的瑰宝，在现代社会中扮演着举足轻重的角色。无论是手机、电脑还是其他电子设备，半导体元件都承载着信息传输和处理的核心任务。为了确保半导体生产的可靠性和安全性，半导体厂务必须关注一个看似微小但却至关重要的方面：液体管理与漏液监测。半导体制造的精密性与挑战半导体制造是一门高度精密的工艺，涉及到复杂的设

ASfP: 增强AOSP平台开发的利器——Android Studio for Platform

ASfP:增强AOSP平台开发的利器——AndroidStudioforPlatformAndroidStudioforPlatform(ASfP)是一个为使用Soong构建系统构建的Android开源项目（AOSP）平台开发者而设计的AndroidStudioIDE版本。与标准AndroidStudio不同，ASfP

[篇五章五]-如何禁用 Windows Defender-我的创作纪念日

##################################################目录禁用掉烦人的WindowsDefender在本地组策略编辑器中禁用WindowsDefende关闭MicrosoftDefender防病毒禁止Defender开机自动运行重新激活WindowsDefender####

HarmonyOS创作激励计划启动：助力技术创作突破边界

即日起推出HarmonyOS创作激励计划，成功投稿并入选的文章将在HarmonyOS开发者公众号上线，9大技术社区同步宣发，不仅有丰厚稿酬，还有机会赢取创作奖品！活动时间即日起-2024年12月31日，每季度按照活动规则评审奖项活动面向用户对HarmonyOS怀抱热情的开发者奖项设置注：每季度评审，稿费和一二三等奖可叠

热文推荐
  1. typescript type 类型别名详解

    TypeScript中的Type类型别名是一种强大的工具，用于创建自定义类型。通过类型别名，我们可以为复杂的类型结构创建更具可读性和可维护性的名字。TypeScript中的Type类型别名简介在TypeScript中，我们可以使用type关键字来定义一个类型的别名，这就是所谓的类型别名。通过类型别名，我们可以为复杂的类

  2. Zookeeper集群 + Kafka集群

    Zookeeper概述//Zookeeper定义*Zookeeper是一个开源的分布式的，为分布式框架提供协调服务的Apache项目。//Zookeeper工作机制*****Zookeeper从设计模式角度来理解：是一个基于观察者模式设计的分布式服务管理框架，它负责存储和管理大家都关心的数据，然后接受观察者的注册，一旦

  3. javascript基础第二天笔记

    JavaScript基础-第2天理解什么是流程控制，知道条件控制的种类并掌握其对应的语法规则，具备利用循环编写简易ATM取款机程序能力运算符语句综合案例运算符算术运算符数字是用来计算的，比如：乘法*、除法/、加法+、减法-等等，所以经常和算术运算符一起。算术运算符：也叫数学运算符，主要包括加、减、乘、除、取余（求模）等

  4. 易基因｜ONT：三代原核甲基化在痤疮杆菌噬菌体表观遗传印迹中的工程选择性研究

    大家好，这里是专注表观组学十余年，领跑多组学科研服务的易基因。痤疮表皮杆菌（Cutibacteriumacnes，C.acnes）是一种革兰氏阳性细菌，是人类皮肤微生物组成员。尽管是最丰富的皮肤共生体，但某些成员与常见的炎症性疾病（如痤疮）有关。各种C.acnes分支的完整基因组序列可以鉴定推定的甲基转移酶，其中一些可

  5. 如何用CRM软件系统提升销售成绩

    现如今，不少企业通过办公软件优化业务效率，加强销售管理。其中CRM销售管理系统能够有效提升销售人员的工作效率，提高销售成功率。为什么CRM系统能够提升销售业绩？下面小编从三个方面来概括说一下：为什么CRM系统能够提升销售业绩？1、CRM系统帮助企业建立“以客户为中心”的商业策略。传统企业大多是“以产品为中心，只管推出产

  6. 群晖 Docker版qbittorrent 下载显示错误 解决方法

    这些天在折腾AIO玩，PVE虚拟机底层，核显直通，群晖安装，免不了踩些坑。今天写篇博客，讲述一下群晖Docker版qbittorrent下载显示错误的解决方法，顺便记录一下配置，以便日后折腾可以参考。直接说结论如果下载显示错误，并且由于自己更改了存储路径，那多半是由于权限设置。去相关的文件夹中添加Owner用户的完全控

  7. 透过《眼睛的故事》：需求为何成为纪录片的“价值锚点”？

    我们正处在一个内容过载、追求流量的时代。对于观众来说，这是幸运的，也是不幸的。一方面，相比以前能接受到的内容指数级增长，自己的视野无限扩大，但另一方面，“流量思维”下粗制滥制的内容不在少数，对观众来说极其不友好。在内容极为丰盛的时代，观众越来越占主导地位。早在1935年，诺贝尔经济学奖得主哈耶克就提出了“soverei

  8. springboot 调用第三方接口的方式（一）使用RestTemplate方法

    简介常用的调用第三方接口的方式：方式一：使用RestTemplate方法方式二：使用原始httpClient请求方式三：使用Feign进行消费通过HTTPClient进行访问第三方接口。但是过程比较复杂，Feign比较适合在springCLoud多模块项目中使用，所以平时基本都是使用RestTemplate方式，这样比

  9. 如何使用正则表达式实现Java日志信息的抓取与收集

    首先，什么是Java日志信息？简单来说，Java应用程序在运行过程中会输出一些信息，这些信息可以用来追踪程序运行状态、调试错误等。而Java日志信息就是这些输出信息的集合。那么为什么要抓取和收集Java日志信息呢？一方面，这些信息可以帮助我们更好地了解程序的运行情况，及时发现和解决问题；另一方面，对于大型应用程序来说，