如何使用Log4j2将Gzip字节数组写入磁盘？

问题根源 #

你当前的代码中，log.info(baos.toByteArray())会触发Log4j调用字节数组的toString()方法，生成类似[B@xxxxxx的字符串，而非写入原始的GZIP二进制数据，导致日志文件无法被识别为GZIP格式。

解决方案：自定义二进制消息与Layout #

要直接写入原始GZIP字节，需要绕过Log4j默认的字符串处理流程，通过自定义Message类型和Layout来实现二进制输出：

1. 定义二进制消息类

import org.apache.logging.log4j.message.Message;

public class ByteArrayMessage implements Message {
    private final byte[] bytes;

    public ByteArrayMessage(byte[] bytes) {
        this.bytes = bytes;
    }

    @Override
    public String getFormattedMessage() {
        return new String(bytes); // 仅用于字符串日志场景，二进制输出不依赖此方法
    }

    @Override
    public String getFormat() {
        return null;
    }

    @Override
    public Object[] getParameters() {
        return new Object[]{bytes};
    }

    @Override
    public Throwable getThrowable() {
        return null;
    }

    public byte[] getBytes() {
        return bytes;
    }
}

2. 自定义二进制输出Layout

import org.apache.logging.log4j.core.Layout;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.layout.AbstractLayout;

import java.nio.charset.Charset;

@Plugin(name = "BinaryFileLayout", category = "Core", elementType = "layout", printObject = true)
public class BinaryFileLayout extends AbstractLayout<byte[]> {

    protected BinaryFileLayout(Charset charset) {
        super(charset);
    }

    @PluginFactory
    public static BinaryFileLayout createLayout() {
        return new BinaryFileLayout(Charset.defaultCharset());
    }

    @Override
    public byte[] toByteArray(LogEvent event) {
        Message message = event.getMessage();
        // 仅处理自定义的二进制消息
        if (message instanceof ByteArrayMessage) {
            return ((ByteArrayMessage) message).getBytes();
        }
        // 非二进制消息转为字节（可选逻辑）
        return event.getMessage().getFormattedMessage().getBytes(getCharset());
    }

    @Override
    public String getContentType() {
        return "application/octet-stream";
    }
}

3. 配置Log4j2使用自定义Layout
   在log4j2.xml中配置使用自定义Layout的文件Appender：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <File name="GZIPLogFile" fileName="logs/compressed-log.gz">
            <BinaryFileLayout/>
        </File>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="GZIPLogFile"/>
        </Root>
    </Loggers>
</Configuration>

4. 修改业务代码使用自定义消息

ByteArrayOutputStream baos = new ByteArrayOutputStream();
// 使用try-with-resources自动关闭流
try (GZIPOutputStream gzip = new GZIPOutputStream(baos)) {
    gzip.write(myLogString.getBytes());
} catch (IOException e) {
    log.error("压缩日志内容失败", e);
    return;
}
// 传入自定义的二进制消息
log.info(new ByteArrayMessage(baos.toByteArray()));

说明 #

通过上述配置，Log4j会直接将GZIP压缩后的原始字节写入日志文件，生成的文件可直接用GZIP解压工具打开查看原始日志内容。

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