Design and implementation of general interface open platform - (44) log processing of API services

I won't say much about the importance of logs , For time tracing and troubleshooting , We save the complete data of the request and response of the interface service call in the database , And for the convenience of performance analysis , The time difference between receiving the request and returning the response of each interface call is also saved , This point , It is very important in practical work , Early warning and prediction can be made , Find problems before the interface slows or crashes .
​

Whether the result of the interface call is success or failure , Normal or abnormal , We all hope to record the log completely , therefore , Processing of logs , Not through filters , Instead, it is put into the exception handling finally In block .
​

/** * ' * API Service technology framework implementation  * * @author wqliu * @date 2022-2-10 14:44 **/
@Service
public class ApiRestServiceImpl implements ApiRestService {
    
    private ApiFilterChain filterChain;

    @Autowired
    private ApiServiceLogService apiServiceLogService;

    public ApiRestServiceImpl(FrameworkValidateFilter frameworkValidateFilter,
                              BusinessFilter businessFilter, BasicValidateFilter basicValidateFilter) {
    
        filterChain=new ApiFilterChain(basicValidateFilter,frameworkValidateFilter,businessFilter);

    }

    @Override
    public ApiResponse handle(ApiRequest apiRequest) {
    

        LocalDateTime receiveTime = LocalDateTime.now();
        ApiResponse apiResponse = new ApiResponse();
        try {
    
            filterChain.doFilter(apiRequest,apiResponse);
            apiResponse = this.filterChain.getResponse();
            apiResponse.setExecuteResult(ApiServiceExecuteResultEnum.SUCCESS.name());
        } catch (CustomException ex) {
    
            // Custom exception handling 
            apiResponse.setExecuteResult(ApiServiceExecuteResultEnum.ERROR.name());
            apiResponse.setErrorCode("S00");
            apiResponse.setErrorMessage(ex.getMessage());
        } catch (ApiException ex) {
    
            //API exception handling 
            apiResponse.setExecuteResult(ApiServiceExecuteResultEnum.ERROR.name());
            apiResponse.setErrorCode(ex.getErrorCode());
            apiResponse.setErrorMessage(ex.getMessage());
        } catch (Exception ex) {
    
            // Unexpected exception handling 
            apiResponse.setExecuteResult(ApiServiceExecuteResultEnum.ERROR.name());
            apiResponse.setErrorCode("S99");
            apiResponse.setErrorMessage(" Undefined exception ：" + ex.getMessage());
        } finally {
    
            // Reset required , For the next request 
            filterChain.reset();
            // Log 
            apiServiceLogService.recordLog(apiRequest,apiResponse,receiveTime);

        }

        return apiResponse;
    }
}

The log is saved as follows ：

 @Override
    public void recordLog(ApiRequest request, ApiResponse response, LocalDateTime receiveTime) {
    

        LocalDateTime responseTime = LocalDateTime.now();
        ApiServiceLog apiServiceLog = new ApiServiceLog();
            apiServiceLog.setAppCode(request.getAppCode());
            apiServiceLog.setServiceCode(request.getServiceCode());
            apiServiceLog.setRequestTime(DateUtils.toLocalDateTime(request.getRequestTime()));
            apiServiceLog.setReceiveTime(receiveTime);
            apiServiceLog.setRequestBusinessData(request.getData());
            apiServiceLog.setExecuteResult(response.getExecuteResult());
            apiServiceLog.setErrorCode(response.getErrorCode());
            apiServiceLog.setErrorMessage(response.getErrorMessage());
            apiServiceLog.setResponseTime(responseTime);
            apiServiceLog.setResponseBusinessData(response.getData());
            // Calculate execution time 
            apiServiceLog.setExecutionTime(Duration.between(receiveTime, responseTime).toMillis());
            // preservation 
            add(apiServiceLog);

    }