无法将内容类型标头添加到SSE终结点

Question

我有一个Java服务器和一个JavaScript客户端，成功地使用服务器发送事件来发送更新。最近，我们被迫在使用内置在kubernetes中的NGINX作为服务器和客户端之间的代理与使用基于Kong的代理之间进行切换，该代理以不同的配置扩展NGINX。新的代理缓冲上交所通过它打破了协议，因为其他应用程序正在使用新的代理，我不允许关闭所有缓冲，这是以前的代理如何绕过这个问题。作为一种选择，我一直试图向SSE响应添加3个超文本传输协议标头，以触发NGINX关闭此特定endpoint的缓冲：

"Content-Type" : "text/event-stream"
"Cache-Control", "no-cache"
"X-Accel-Buffering", "no"

我已经能够相对容易地添加“缓存控制”和“X-加速缓冲”标头，但是我尝试了几种不同的方法来添加“内容类型”标头，没有任何效果。

下面是第一次尝试，请注意，“Content Type”标题的设置与RestServiceImpl中的其他两个标题相同，但从我的日志中添加了其他两个标题，而“Content Type”则没有。

@Api
@Path("/service")
public interface RestService {

    @GET
    @Path("/sseconnect")
    @Produces(SseFeature.SERVER_SENT_EVENTS)
    EventOutput listenToBroadcast(@Context HttpServletResponse response);

}

@Component
public class RestServiceImpl implements RestService {

    @Autowired
    private Broadcaster broadcaster;

    public RestServiceImpl() {
    }

    @Override
    public EventOutput listenToBroadcast(HttpServletResponse response) {
        response.addHeader("Content-Type", "text/event-stream");
        response.addHeader("Cache-Control", "no-cache");
        response.addHeader("X-Accel-Buffering", "no");
        return broadcaster.add();
    }
}

public class Broadcaster extends SseBroadcaster {

    private final OutboundEvent.Builder eventBuilder =
        new OutboundEvent.Builder();

    public EventOutput add() {
        final EventOutput eventOutput = new EventOutput();
        super.add(eventOutput);
        return eventOutput;
    }

    public void sendEvents(Events events, String name) {
        final OutboundEvent outboundEvent = eventBuilder.name(name)
            .mediaType(MediaType.APPLICATION_JSON_TYPE)
            .data(Events.class, events).build();
        super.broadcast(outboundEvent);
    }
}

在第二次尝试中，我尝试修改“Content Type”标题的添加方式，如下所示：

@Override
public EventOutput listenToBroadcast(HttpServletResponse response) {
    response.setContentType("text/event-stream");
    response.addHeader("Cache-Control", "no-cache");
    response.addHeader("X-Accell-Buffering", no);
    return broadcaster.add();
}

这具有相同的效果，添加了“缓存控制”和“X-Accell-Bufferig”，但没有添加“内容类型”。

对于第三次尝试，我将HttpServletResponse替换为ContainerResponse

@Override
public EventOutput listenToBroadcast(ContainerResponse containerResponse)
{
    final MultivaluedMap<String, Object> headers =
        containerResponse.getHeaders();
    headers.add("Content-Type", "text/event-stream");
    headers.add("Cache-Control", "no-cache");
    headers.add("X-Accel-Buffering", "no");
    return broadcaster.add();
}

这个解决方案破坏了endpoint，最后给了我一个406错误，所以我不能肯定地说它不起作用。可能是一个糟糕的实现，但我没有看到任何东西。

在第四次尝试中，我尝试使用ContainerResponseFilter添加标题。

@Provider
@PreMatching
public class SseResponseFilter implements ContainerResponseFilter {

    @Override
    public void filter(ContainerRequestContext requestContext,
        ContainerResponseContext responseContext)
            throws IOException {

        final MultivaluedMap<String, Object> headers =
            responseContext.getHeaders();
        final List<Object> contentTypeValues = new ArrayList<Object>();
        contentTypeValues.add("text/event-stream");
        headers.put("Content-Type", contentTypeValues);

        final List<Object> cacheControlValues = new ArrayList<Object>();
        cacheControlValues.add("no-cache");
        headers.put("Cache-Control", cacheControlValues);

        final List<Object> xAccelBufferingValues =
            new ArrayList<Object>();
        xAccelBufferingValues.add("no");
        headers.put("X-Accel-Buffering", xAccelBufferingValues);
    }
}

此尝试将“缓存控制”和“X-Accel-Buffering”头添加到应用程序中的每个endpoint，但没有在任何位置添加“内容类型”。注意，这些其他api中的一些正在返回允许设置“内容类型”的响应对象，而这些剩余endpoint正在为每个特定endpoint正确设置“内容类型”头。SSE库返回EventOutput，很遗憾，它不允许我像Response一样设置内容类型头。

在第五次尝试中，我将ContainerResponseFilter替换为WriterInterceptor

@Provider
public class SseWriterInterceptor implements WriterInterceptor {

    @Override
    public void arroundWriteTo(WriterInterceptorContext context)
        throws IOException, WebApplicationException {

        final MultivaluedMap<String, Object> headers =
            context.getHeaders();
        final List<Object> contentTypeValues = new ArrayList<Object>();
        contentTypeValues.add("text/event-stream");
        headers.put("Content-Type", contentTypeValues);

        final List<Object> cacheControlValues = new ArrayList<Object>();
        cacheControlValues.add("no-cache");
        headers.put("Cache-Control", cacheControlValues);

        final List<Object> xAccelBufferingValues =
            new ArrayList<Object>();
        xAccelBufferingValues.add("no");
        headers.put("X-Accel-Buffering", xAccelBufferingValues);
    }
}

此解决方案与之前的解决方案类似，在之前的解决方案中，它向应用程序中的所有endpoint添加了“缓存控制”和“X-加速缓冲”，但再次放弃了“内容类型”。

总而言之，我似乎无法找出是什么阻止我成功地将“Content-Type”头添加到SSEendpoint。

这个问题类似于：Jersey为什么要吞下我的“Content Encoding”头？然而，将“Content Type”添加到响应对象的给定解决方案不起作用，因为我使用的是SSE，它返回的EventOutput对象无法添加“Content Type”头。

Answer 1

事实证明，泽西并不是未设置“内容类型”标题的罪魁祸首。该应用程序是作为连续部署环境的一部分构建的，该环境为日志记录和安全扫描等事项添加了大量过滤器。其中一个过滤器是防止在使用SSE库时填充“Content Type”标题。

在本地机器上运行应用程序，而不是在基于kubernetes的开发环境中运行应用程序，并且看到“Content-Type”头正确地填充了本地的第一个解决方案后，我能够确定这是原因。