JAX-RS 2打印JSON請求

Question

我希望能夠從請求中打印JAX-RS 2 JSON有效負載，無論我的應用服務器上的實際實現如何。

我在SO上嘗試了建議的解決方案，但都包含了實際實現的二進制文件（比如Jersey和類似的），我只允許在我的應用程序中使用javaee-api v 7.0。

我已嘗試在我的客戶端上實現ClientRequestFilter和ClientResponseFilter，但它們不包含序列化實體。

這是客戶的一個例子：

WebTarget target = ClientBuilder.newClient().register(MyLoggingFilter.class).target("http://localhost:8080/loggingtest/resources/accounts");
Account acc = target.request().accept(MediaType.APPLICATION_JSON).get(account.Account.class);

這是MyLoggingFilter的實現：

@Provider
public class MyLoggingFilter implements ClientRequestFilter, ClientResponseFilter {

    private static final Logger LOGGER = Logger.getLogger(MyLoggingFilter.class.getName());

    @Override
    public void filter(ClientRequestContext requestContext) throws IOException {

        LOGGER.log(Level.SEVERE, "Request method: {0}", requestContext.getMethod());

    }

    @Override
    public void filter(ClientRequestContext requestContext, ClientResponseContext responseContext) throws IOException {
        LOGGER.log(Level.SEVERE, "Response status: {0}", responseContext.getStatus());
    }        
}

Answer 1

因此，在嘗試實現此功能時需要考慮幾件事情

1. 對於請求實體，您將希望框架處理序列化，這意味着您不希望執行類似的操作

    @Override public void filter(ClientRequestContext requestContext) { Object entity = requestContext.getEntity(); String serialized = serializeEntity(entity); log(serialized); 

   在這里，您自己序列化，也許使用Jackson ObjectMapper或其他東西。 你可以這樣做，但它可以處理的類型有限。 如果讓對象按照框架已經處理的方式進行序列化，那么框架將能夠支持比JSON更多的類型。

   為了讓框架處理序列化，並且仍然能夠獲得序列化數據，我們需要使用WriterInterceptor 。 什么我們能做的就是設置實體輸出流的ByteArrayOutputStream ，然后讓序列化框架請求對象，以我們的 ByteArrayOutputStream ，然后后記記錄這些字節。 這就是Jersey LoggingFilter處理這個問題的方法。

2. 對於響應，在我們的過濾器中，我們需要從響應流中提取數據，但我們還需要確保流仍然有數據，因為它尚未針對客戶端進行反序列化。 要執行此操作，請mark()並reset()流，假設支持標記。 如果沒有，請將其包裝在BufferedOutputStream 。 同樣，這就是Jersey LoggingFilter處理這個問題的方法。

下面是一個完整的簡單實現。 其中大部分都是直接從Jersey LoggingFilter ，盡管它僅針對您的用例而被刪除。 Jersey LoggingFilter記錄了許多其他信息，除了實體之外。 我遺漏的一件事是檢查字符集。 我剛剛使用了硬編碼的UTF-8，因為Jersey使用的MessageUtil類是Jersey特有的。 如果您想讓過濾器對其他字符集更加通用，您可能需要考慮修復它。

import java.io.BufferedInputStream;
import java.io.ByteArrayOutputStream;
import java.io.FilterOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.logging.Logger;
import javax.annotation.Priority;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.client.ClientRequestFilter;
import javax.ws.rs.client.ClientResponseContext;
import javax.ws.rs.client.ClientResponseFilter;
import javax.ws.rs.ext.WriterInterceptor;
import javax.ws.rs.ext.WriterInterceptorContext;

@Priority(Integer.MIN_VALUE)
public class EntityLoggingFilter implements ClientRequestFilter, ClientResponseFilter, WriterInterceptor {

    private static final Logger logger = Logger.getLogger(EntityLoggingFilter.class.getName());
    private static final String ENTITY_STREAM_PROPERTY = "EntityLoggingFilter.entityStream";
    private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
    private final int maxEntitySize = 1024 * 8;

    private void log(StringBuilder sb) {
        logger.info(sb.toString());
    }

    private InputStream logInboundEntity(final StringBuilder b, InputStream stream, final Charset charset) throws IOException {
        if (!stream.markSupported()) {
            stream = new BufferedInputStream(stream);
        }
        stream.mark(maxEntitySize + 1);
        final byte[] entity = new byte[maxEntitySize + 1];
        final int entitySize = stream.read(entity);
        b.append(new String(entity, 0, Math.min(entitySize, maxEntitySize), charset));
        if (entitySize > maxEntitySize) {
            b.append("...more...");
        }
        b.append('\n');
        stream.reset();
        return stream;
    }

    @Override
    public void filter(ClientRequestContext requestContext) throws IOException {
        if (requestContext.hasEntity()) {
            final OutputStream stream = new LoggingStream(requestContext.getEntityStream());
            requestContext.setEntityStream(stream);
            requestContext.setProperty(ENTITY_STREAM_PROPERTY, stream);
        }
    }

    @Override
    public void filter(ClientRequestContext requestContext,
            ClientResponseContext responseContext) throws IOException {
        final StringBuilder sb = new StringBuilder();
        if (responseContext.hasEntity()) {
            responseContext.setEntityStream(logInboundEntity(sb, responseContext.getEntityStream(),
                    DEFAULT_CHARSET));
            log(sb);
        }

    }

    @Override
    public void aroundWriteTo(WriterInterceptorContext context)
            throws IOException, WebApplicationException {
        final LoggingStream stream = (LoggingStream) context.getProperty(ENTITY_STREAM_PROPERTY);
        context.proceed();
        if (stream != null) {
            log(stream.getStringBuilder(DEFAULT_CHARSET));
        }
    }

    private class LoggingStream extends FilterOutputStream {

        private final StringBuilder sb = new StringBuilder();
        private final ByteArrayOutputStream baos = new ByteArrayOutputStream();

        LoggingStream(OutputStream out) {
            super(out);
        }

        StringBuilder getStringBuilder(Charset charset) {
            // write entity to the builder
            final byte[] entity = baos.toByteArray();

            sb.append(new String(entity, 0, entity.length, charset));
            if (entity.length > maxEntitySize) {
                sb.append("...more...");
            }
            sb.append('\n');

            return sb;
        }

        @Override
        public void write(final int i) throws IOException {
            if (baos.size() <= maxEntitySize) {
                baos.write(i);
            }
            out.write(i);
        }
    }
}

也可以看看：

• Jersey LoggingFilter源代碼