Springboot外部api调用请求和响应在数据库中捕获

Question

从我的后端应用程序（springboot，java8）中，我将进行多个外部api调用。我需要将所有请求和响应数据（包括头、请求和响应体）记录到数据库（MongoDB）中。

下面是我的示例代码，这是我如何尝试捕获每个外部api调用的请求和响应。在异常情况下，我将存储状态为“失败”。

在我的项目中，将在新的第三方api集成上添加多个模块，因此在每个模块中，对于每个不同的外部api调用，我必须捕获所有这样的请求和响应。我对以下方法不满意。请建议解决此问题的最佳方法。

示例服务层方法

public ResponseDTOFromExternalApi externalApiCallServiceMethod(String clientId, RequestDTO requestDTO) {

        ExternalApiCallRequestObj externalApiCallRequestObj = prepareExternalApiRequestObjFromRequestDTO(requestDTO);
        ApiCall apiCall = ApiCall.builder()
                .clientId(clientId)
                .status("SUBMITTED")
                .requestPayload(externalApiCallRequestObj)
                .build();

        apiCall = apiCallRepository.save(apiCall);

        ExternalApiCallReponseObj externalApiCallReponseObj = externalApiCallService.callExternalApi1(externalApiCallRequestObj);

        apiCall = apiCallRepository.findById(apiCall.getId());

        apiCall.setResponsePayload(externalApiCallReponseObj);
        apiCall.setStatus("COMPLETED");

        apiCallRepository.save(apiCall);

        return toDTO(externalApiCallReponseObj);
}

api调用的示例域

@Document("api_calls")
@Builder
@Data
public class ApiCall {

    @Id
    private String id;

    private String clientId;

    private String status;

    private Object requestPayload;

    private Object responsePayload;

}

Answer 1

您可以使用Spring AOP来解决这个交叉问题。

假设ExternalApiCallService是一个spring管理的bean，下面的代码将截获所有callExternalApi1（），并将其记录到数据库中。

@Component
@Aspect
public class ExternalCallLoggerAspect {

    @Autowired
    ApiCallRepository apiCallRepository;

    @Pointcut("execution(* *..ExternalApiCallService.callExternalApi1(..))")
    public void externalApiCallService(){}


    @Around("externalApiCallService() && args(request)")
    public ExternalApiCallReponseObj logCalls(ProceedingJoinPoint pjp,ExternalApiCallRequestObj request){

      Object result=null;
      String status = "COMPLETED";
      ExternalApiCallReponseObj response = null;

        // Build the apiCall from request 
        ApiCall apiCall = ApiCall.builder()
                .clientId(clientId)
                .status("SUBMITTED")
                .requestPayload(request)
                .build();

        //save the same to db
        apiCall = apiCallRepository.save(apiCall);

        // Proceed to call the external Api and get the result
        try {
           result = pjp.proceed();
        } catch (Throwable e) {
           status = "FAILED";
        }

        //Update the response           
        apiCall = apiCallRepository.findById(apiCall.getId());            
        apiCall.setStatus(status);
        apiCallRepository.save(apiCall);

        if(result != null) {
          response = (ExternalApiCallReponseObj)result;
          apiCall.setResponsePayload(response);
        }

        //continue with response
        return response;
    }

}

笔记

1.名称为ExternalApiCallReponseObj的错字

2、方面代码已验证其工作正常，并且后来未测试该逻辑。请进行必要的更正

理想情况下，原始方法应该简化为

public ResponseDTOFromExternalApi externalApiCallServiceMethod(String clientId, RequestDTO requestDTO) {

       return toDTO(externalApiCallService.callExternalApi1(prepareExternalApiRequestObjFromRequestDTO(requestDTO)));
}

更多关于Spring AOP的信息

更新：转念一想，如果所有的外部api调用都通过一个方法，比如ExternalApiCallService.callExternalApi1（），这个日志逻辑可以移动到那个公共点，不是吗？

Answer 2

Spring的WebClient已经能够通过添加exchange筛选器来记录所有请求和响应数据。

通过将其用于您的网络请求，唯一要做的就是将此信息写入您的mongoDB。

以下是记录请求和响应的教程：https://www.baeldung.com/spring-log-webclient-calls

干杯