1

我有一个基于 Tyrus 实现的标准 websocket 端点,它有时会触发java.lang.IllegalStateException: Cannot set WriteListener for non-async or non-upgrade request. 我们在 Payara 4.1 上运行。

我的标准实现

@ServerEndpoint(value = "...", decoders=MessageDecoder.class, encoders=MessageEncoder.class)
public class EndpointImpl extends AbstractEndpoint{
    // onOpen, onClose, onMessage, onError methods
}

抽象类在哪里

public abstract class AbstractEndpoint{

    // irrelevant onOpen, onOpen handling method

117        protected void sendMessage(Session session, Message message){
118            if(message == null){
119                LOGGER.error("null message");
120            } else if(!session.isOpen()){
121                LOGGER.error("session is not opened");
122            } else{
>>>123                session.getAsyncRemote().sendObject(message, (result) -> {
124                    if (result.isOK()) {
125                        LOGGER.info("success! yeah!");
126                    } else {
127                        LOGGER.error("error when sending message", result.getException());
128                    }
129                });
130            }
    } 
}

非法状态异常

到目前为止,没有什么特别的。我可以完美地沟通和响应我收到的请求,并且,websocket FTW,我可以推送信息并取回反馈。但是,我有时会收到异常:

java.lang.IllegalStateException: Cannot set WriteListener for non-async or non-upgrade request
        at org.apache.catalina.connector.OutputBuffer.setWriteListener(OutputBuffer.java:536)
        at org.apache.catalina.connector.CoyoteOutputStream.setWriteListener(CoyoteOutputStream.java:223)
        at org.glassfish.tyrus.servlet.TyrusServletWriter.write(TyrusServletWriter.java:140)
        at org.glassfish.tyrus.core.ProtocolHandler.write(ProtocolHandler.java:486)
        at org.glassfish.tyrus.core.ProtocolHandler.send(ProtocolHandler.java:274)
        at org.glassfish.tyrus.core.ProtocolHandler.send(ProtocolHandler.java:332)
        at org.glassfish.tyrus.core.TyrusWebSocket.sendText(TyrusWebSocket.java:317)
        at org.glassfish.tyrus.core.TyrusRemoteEndpoint.sendSyncObject(TyrusRemoteEndpoint.java:429)
        at org.glassfish.tyrus.core.TyrusRemoteEndpoint$Async.sendAsync(TyrusRemoteEndpoint.java:352)
        at org.glassfish.tyrus.core.TyrusRemoteEndpoint$Async.sendObject(TyrusRemoteEndpoint.java:249)
        at com.mycompany.websocket.AbstEndpoint.sendMessage(AbstEndpoint.java:123)

第二次 sendMessage 方法尝试

起初,我认为我的异步端点配置错误,所以我尝试了 Future<> 方式而不是回调方式:

RemoteEndpoint.Async async = session.getAsyncRemote();
async.setSendTimeout(5000); // 5 seconds
Future<Void> future = async.sendObject(message);
try{
    future.get();
}
catch(InterruptedException | ExecutionException ex){
    LOGGER.error("error when sending message", ex);
}

我也有例外。

到目前为止和症状

令人惊讶的是,我只发现一个链接谈论这个问题。

  1. github 链接突出显示了缓冲区大小问题。我不使用部分消息,只使用完整消息。此外,无论我使用默认缓冲区大小还是设置新缓冲区,都会出现异常
  2. 我找不到关于如何重现错误的全局规则
  3. 引发异常后,客户端可以继续发送消息,服务器会处理它,但服务器从未回复客户端。传出通信通道似乎被阻塞
  4. 由于服务器一直在处理传入的消息,异常后websocket通道没有关闭

挖掘 Tyrus 的实现

我浏览了 tyrus-core 的实现,发现发送方法依赖于一些 Grizzly 组件。我对灰熊一无所知,但由于灰熊的一些限制,发送似乎无论如何都必须是同步的

问题

  1. 有人遇到过这种情况吗?如果是,异常是否真的意味着某处存在瓶颈,或者它意味着其他什么?
  2. tyrus 异步端点真的是异步的,即像“处理后忘记”吗?
  3. 我还没有找到任何方法来排队和传出消息:如果消息 A 很长,请在发送消息 B 之前等待消息 A 发送完成。有没有办法在 websocket 中处理大消息或异步端点是唯一的方式?
  4. 我想确保发送没有遇到任何问题,因此我选择了异步解决方案。我应该回到同步方式吗?

我没有详细说明我的 Tyrus 调查。如果您觉得它相关,请随时询问,我会很乐意发展。

4

1 回答 1

1

java.lang.IllegalStateException:无法为非异步或非升级请求设置 WriteListener

为了使请求完全异步,请求-响应链中的任何一个 Filter都必须显式设置为支持异步请求。特别是那些映射在/*.

如果过滤器是通过<filter>entry in注册的web.xml,这可以通过将子元素设置<async-supported>为 来完成true

<filter>
    ...
    <async-supported>true</async-supported>
</filter>

如果过滤器是通过@WebFilter注释注册的,这可以通过将其asyncSupported属性设置为 来完成true

@WebFilter(..., asyncSupported="true")

如果过滤器是通过注册的ServletContext#addFilter(),这可以通过设置来完成Registration.Dynamic#setAsyncSupported()true.

Dynamic filter = servletContext.addFilter(name, type);
filter.setAsyncSupported(true);

原因是,WebSocket 实现ServletRequest#startAsync()在握手请求期间在内部使用,以保持请求-响应管道“永远”打开,直到响应被显式关闭。它的 javadoc说明如下:

抛出
IllegalStateException- 如果此请求在不支持异步操作的过滤器或 servlet 的范围内(即isAsyncSupported()返回false),或者如果在没有任何异步调度的情况下再次调用此方法(由其中一种AsyncContext.dispatch()方法引起),则在外部调用任何此类调度的范围,或者在同一调度的范围内再次调用,或者如果响应已经关闭

isAsyncSupported()默认false是为了不破坏现有的 web 应用程序使用实现不佳的 servlet 过滤器。从技术上讲,仅将目标标记Servlet为支持异步就足够了,并且不理会过滤器。一个理智的“包罗万象”Filter不会明确地向 HTTP 响应写入任何内容,但 Servlet API 从未禁止这样做,因此不幸的是,此类过滤器可能存在。

如果您有一个这样的过滤器,那么您应该修复它以不再向响应写入任何内容,以便您可以安全地将其标记为支持异步请求,或者调整其 URL 模式以不覆盖 WebSocket 请求。即不再映射它/*

于 2017-08-13T20:30:00.787 回答