如何在Zalando LogBook响应日志中忽略指定JSON字段？

一、自定义BodyFilter实现字段过滤 #

如果默认的BodyFilters未生效，推荐自定义过滤器来精准处理JSON响应，避免字符串替换带来的不可靠问题。以下是基于Jackson的实现：

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.zalando.logbook.BodyFilter;

import java.io.IOException;

public class SensitiveFieldFilter implements BodyFilter {

    private final ObjectMapper objectMapper = new ObjectMapper();
    private final String[] fieldsToRemove;

    public SensitiveFieldFilter(String... fieldsToRemove) {
        this.fieldsToRemove = fieldsToRemove;
    }

    @Override
    public String filter(String contentType, String body) {
        // 仅处理JSON类型响应
        if (contentType != null && contentType.contains("application/json")) {
            try {
                JsonNode rootNode = objectMapper.readTree(body);
                removeTargetFields(rootNode);
                return objectMapper.writeValueAsString(rootNode);
            } catch (IOException e) {
                // 解析失败时返回原响应体，避免日志异常
                return body;
            }
        }
        // 非JSON类型直接返回原内容
        return body;
    }

    // 递归移除目标字段（支持嵌套结构）
    private void removeTargetFields(JsonNode node) {
        if (node.isObject()) {
            var objectNode = (com.fasterxml.jackson.databind.node.ObjectNode) node;
            for (String field : fieldsToRemove) {
                objectNode.remove(field);
            }
            // 处理子节点
            node.elements().forEachRemaining(this::removeTargetFields);
        } else if (node.isArray()) {
            // 处理数组内的每个元素
            node.elements().forEachRemaining(this::removeTargetFields);
        }
    }
}

二、注册自定义过滤器到LogBook #

以Spring Boot项目为例，通过配置类将过滤器绑定到LogBook实例：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.zalando.logbook.Logbook;

@Configuration
public class LogBookConfig {

    @Bean
    public Logbook logbook() {
        return Logbook.builder()
                // 为响应绑定过滤器，指定要忽略的字段
                .responseFilter(response -> response
                        .bodyFilter(new SensitiveFieldFilter("fieldTwo")))
                .build();
    }
}

三、排查未生效的常见原因 #

1. 过滤器注册错误：确认是给responseFilter绑定过滤器，而非requestFilter
2. Content-Type不匹配：过滤器仅处理application/json类型响应，需确认接口返回的Content-Type符合要求
3. 字段名不匹配：JSON字段名区分大小写，确保要忽略的字段名与响应体完全一致
4. 嵌套字段处理：如果目标字段在嵌套对象/数组中，需使用递归逻辑（如上述示例），默认的BodyFilters.remove仅处理顶层字段

内容的提问来源于stack exchange，提问作者Maksym Rybalkin