springboot增加logback日志记录ip详解

小蓝

2023 年 07 月 03 日

455 次浏览

暂无评论

1917字数

Linux 技术杂烩

在Spring Boot中使用Logback记录IP地址的步骤如下：

导入Logback依赖：
在Spring Boot项目的pom.xml文件中，确保已经导入Logback的相关依赖。通常，Spring Boot默认使用Logback作为日志记录框架，因此无需额外配置。
创建logback-spring.xml文件：
在src/main/resources目录下创建一个名为logback-spring.xml的文件，用于配置Logback的日志记录规则和格式。

配置IP地址记录：
在logback-spring.xml文件中，可以使用Logback的编程式配置或XML配置来记录IP地址。以下是两种配置方式的示例：

编程式配置：

<appender name="FILE" class="ch.qos.logback.core.FileAppender">
  <file>log/application.log</file>
  <encoder>
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %level %logger{50} - %msg [%X{clientIp}]%n</pattern>
  </encoder>
</appender>

XML配置：

<appender name="FILE" class="ch.qos.logback.core.FileAppender">
  <file>log/application.log</file>
  <encoder>
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %level %logger{50} - %msg %X{clientIp}%n</pattern>
  </encoder>
</appender>

上述配置中的 %X{clientIp}用于记录名为"clientIp"的MDC（Mapped Diagnostic Context）变量的值，该变量可以存储客户端的IP地址。

在代码中设置IP地址：
在处理请求的代码中，可以通过HttpServletRequest对象获取客户端的IP地址，并将其设置到MDC变量中。以下是一个示例代码片段：

import org.slf4j.MDC;
import javax.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @GetMapping("/hello")
    public String hello(HttpServletRequest request) {
        String clientIp = request.getRemoteAddr();
        MDC.put("clientIp", clientIp);
        // 执行其他业务逻辑
        MDC.remove("clientIp");
        return "Hello";
    }

}

上述代码中，通过request.getRemoteAddr()方法获取客户端的IP地址，并使用MDC.put()方法将其设置到MDC变量中。在代码执行完毕后，需要使用MDC.remove()方法将变量从MDC中移除，以避免内存泄漏。