springboot cloud，不同模块，记录接口操作日志

如夜了我衣衫太薄便归家靠路灯°

于 2024-07-19 14:24:12 发布

阅读量441

点赞数 5

本文链接：https://blog.csdn.net/weixin_42487883/article/details/140548362

版权

在 Spring Boot Cloud 中实现请求接口操作记录通常涉及多个模块和组件。可以使用 Spring Boot 提供的功能以及 Spring Cloud 的一些组件来完成这个任务。

1. 架构设计

假设你的系统包括以下模块：

API Gateway：接收客户端请求并路由到不同的服务。
Service A 和 Service B：具体的业务服务模块。
Logging Service：用于集中存储和管理操作日志的服务。

我们将通过以下步骤实现请求接口操作记录：

API Gateway：拦截请求并将操作信息传递到日志服务。
Service A / Service B：在处理请求时记录操作信息。
Logging Service：接收并存储日志信息。

2. 关键代码示例

2.1 API Gateway

使用 Spring Cloud Gateway 实现 API Gateway，并在网关中记录日志。

pom.xml（依赖）

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-sleuth</artifactId>
</dependency>

GatewayConfig.java（配置）

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;

@Configuration
public class GatewayConfig {

    @Bean
    public LoggingFilter loggingFilter() {
        return new LoggingFilter();
    }

    public static class LoggingFilter extends AbstractGatewayFilterFactory<Object> {
        
        public LoggingFilter() {
            super(Object.class);
        }

        @Override
        public GatewayFilter apply(Object config) {
            return (exchange, chain) -> {
                logRequest(exchange);
                return chain.filter(exchange).then(Mono.fromRunnable(() -> logResponse(exchange)));
            };
        }

        private void logRequest(ServerWebExchange exchange) {
            String path = exchange.getRequest().getURI().getPath();
            // Log request details (e.g., using a logging framework)
            System.out.println("Request Path: " + path);
        }

        private void logResponse(ServerWebExchange exchange) {
            // Log response details
            System.out.println("Response Status: " + exchange.getResponse().getStatusCode());
        }
    }
}

2.2 Service A / Service B

在每个服务中，可以使用 Spring AOP 来记录请求的操作信息。

pom.xml（依赖）

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

LoggingAspect.java（切面）

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class LoggingAspect {

    @AfterReturning(pointcut = "execution(* com.example.service..*(..))", returning = "result")
    public void logAfter(JoinPoint joinPoint, Object result) {
        // Log method execution details
        String methodName = joinPoint.getSignature().getName();
        System.out.println("Method: " + methodName + " executed with result: " + result);
        // You can also log additional information like arguments or execution time
    }
}

2.3 Logging Service

记录日志到集中存储（如数据库或 Elasticsearch）。

pom.xml（依赖）

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>

LogEntry.java（日志实体）

import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;

@Document(collection = "logs")
public class LogEntry {

    @Id
    private String id;
    private String message;
    private String level;
    private long timestamp;

    // Getters and setters
}

LogRepository.java（日志存储）

import org.springframework.data.mongodb.repository.MongoRepository;

public interface LogRepository extends MongoRepository<LogEntry, String> {
}

LogService.java（日志服务）

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class LogService {

    @Autowired
    private LogRepository logRepository;

    public void saveLog(String message, String level) {
        LogEntry logEntry = new LogEntry();
        logEntry.setMessage(message);
        logEntry.setLevel(level);
        logEntry.setTimestamp(System.currentTimeMillis());
        logRepository.save(logEntry);
    }
}

LoggingController.java（接收日志）

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class LoggingController {

    @Autowired
    private LogService logService;

    @PostMapping("/log")
    public void log(@RequestBody LogEntry logEntry) {
        logService.saveLog(logEntry.getMessage(), logEntry.getLevel());
    }
}