Tomcat8.0 支持的WebSocket 总结

Posted 2020-09-20

Java WebSocket

依赖环境tomcat8.0及以上

两种配置方式

1.注解式配置

//示例代码

@ServerEndpoint("/chat")

public class Chat{

//建立连接时调用,可传入的参数Session(WebSocket的Session,在SpringWebSocket里面则是WebSocketSession),EndpointConfig,和带@PathParam注的参数

@OnOpen

public void onOpen(Session session,EndpoingConfig config){

}

//消息到来时调用,可传入的参数Session(WebSocket的Session,在SpringWebSocket里面则是WebSocketSession),根据消息的形式，如果是文本消息，传入String类型参数或者Reader，如果是二进制消息，传入byte[]类型参数或者InputStream，如果Pong消息传入实现了PongMessage接口的类型参数，方法还可以带返回类型，如果有返回类型，比如String（还可以是byte[]或ByteBuffer）,则是立即向客户端发送String消息，如果是分片消息（消息有whole，partial两种，全部消息和分片消息），还可传入boolean类型的参数，判断是否到了分片的结尾。

@OnMessage//处理文本消息

public void onMessage(Session session,String message,boolean isLast){

}

@OnMessage//处理二进制消息,参数随便搭配

public void onMessage(Session session,byte[] message,boolean isLast){

}

//传输发生错误时调用,可传入参数Session,Throwable

@OnError

public void onError(Session session,Throwable t){

}

@OnClose//连接关闭时调用,可能一方主动关闭，或者连接超时的关闭

public void onClose(CloseReason cr){

}

}

2.编程式配置//继承Endpoint

public class Program extends Endpoint{

@Override

public void onOpen(Session session, EndpointConfig endpointConfig) {

session.addMessageHandler(new MessageHandler.Whole<String>() {

@Override

public void onMessage(String text) {

try {

//可以获取同步的远程端点和同步的，以此发送同步消息或异步消息

mySession.getBasicRemote().sendText("I got this (" +text + ") so I am sending it back !");

} catch (IOException ioe) {

System.out.println("oh dear, something went wrong trying to send the message back: " + ioe.getMessage());

}

}

});

}

//还有onError()和onClose()方法，不写了

}

//配置映射uri,实现ServerApplicationConfig

public class ProgramAppConfig implements ServerApplicationConfi{

//参数是WebSocket会传入扫描到的所有带有@ServerEndpoint注解的类集合,WebSocket会调用这个方法获取这些集合，如果没什么要做的，直接把参数返回就行了

public Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned){

return scanned;

}

//WebSocket会传入继承了Endpoint类的集合，但是返回的是ServerEndpointConfig集合，需要做一个转换

public Set<ServerEndpointConfig> getEndpointConfigs(Set<Class<? extends Endpoint>> endpointClasses){

Set<ServerEndpointConfiguration> configs = new HashSet<ServerEndpointConfiguration>();

ServerEndpointConfiguration sec = ServerEndpointConfigurationBuilder.create(Program .class, "/program").build();

configs.add(sec);

return configs;

}

}

线程安全问题

每次请求Webocket都会实例化一个新的端点，就像HttpSession一样，请求之间互补干扰，不需要我们处理多线程问题