Websockets Tomcat 7 在现有项目中不起作用

Posted 2023-02-16

【中文标题】Websockets Tomcat 7 在现有项目中不起作用

【英文标题】：Websockets Tomcat 7 does not work in existing project

【发布时间】：2016-05-18 14:35:15

【问题描述】：

我尝试在 Tomcat6 上运行的 Java 项目中运行 websocket 服务器。我已经设置了一个 Tomcat 7 服务器，现在正在运行该项目。 首先我尝试运行Tomcat7的socket示例。这完美运行。我将这个类复制到我的旧项目中。当我再次运行旧项目时，所有功能都像以前一样工作，但只有 websocket 服务器不起作用。

这是我从 Tomcat 的示例复制到旧项目中的 ChatAnnotation 类。

import java.io.IOException;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.concurrent.atomic.AtomicInteger;

import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;

import org.apache.log4j.Logger;

@ServerEndpoint(value = "/websocket/chat")
public class ChatAnnotation 
    private static Logger logger = Logger.getLogger(ChatAnnotation.class);

    private static final String GUEST_PREFIX = "Guest";
    private static final AtomicInteger connectionIds = new AtomicInteger(0);
    private static final Set<ChatAnnotation> connections = new CopyOnWriteArraySet<ChatAnnotation>();

    private final String nickname;
    private Session session;

    public ChatAnnotation() 
        nickname = GUEST_PREFIX + connectionIds.getAndIncrement();
        logger.info("ws instance");
    

    @OnOpen
    public void start(Session session) 
        this.session = session;
        connections.add(this);
        String message = String.format("* %s %s", nickname, "has joined.");
        broadcast(message);
    

    @OnClose
    public void end() 
        connections.remove(this);
        String message = String.format("* %s %s", nickname, "has disconnected.");
        broadcast(message);
    

    @OnMessage
    public void incoming(String message) 
        // Never trust the client
        String filteredMessage = String.format("%s: %s", nickname, message.toString());
        broadcast(filteredMessage);
    

    @OnError
    public void onError(Throwable t) throws Throwable 
        logger.error("Chat Error: " + t.toString(), t);
    

    private static void broadcast(String msg) 
        for (ChatAnnotation client : connections) 
            try 
                synchronized (client) 
                    client.session.getBasicRemote().sendText(msg);
                
             catch (IOException e) 
                logger.debug("Chat Error: Failed to send message to client", e);
                connections.remove(client);
                try 
                    client.session.close();
                 catch (IOException e1) 
                    // Ignore
                
                String message = String.format("* %s %s", client.nickname, "has been disconnected.");
                broadcast(message);
            
        
    

我在 web.xml 中添加了注释。在我的旧项目中也使用了 tcpsockets，这可能是问题吗？ 谁能帮我解决这个问题？

编辑 添加的类：

import java.util.HashSet;
import java.util.Set;

import javax.websocket.Endpoint;
import javax.websocket.server.ServerApplicationConfig;
import javax.websocket.server.ServerEndpointConfig;

import org.apache.log4j.Logger;

public class ExamplesConfig implements ServerApplicationConfig 

    private static Logger log = Logger.getLogger(ChatAnnotation.class);

    public Set<ServerEndpointConfig> getEndpointConfigs(Set<Class<? extends Endpoint>> endpointClasses) 
        Set<ServerEndpointConfig> result = new HashSet<ServerEndpointConfig>();
        log.info("getEndpointConfigs");
        return result;
    

    public Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned) 
        log.info("getAnnotatedEndpointClasses");            
        return scanned;
    

【问题讨论】：

有没有类实现ServerApplicationConfig interface？ （就像 Tomcat 示例中的 websocket.ExamplesConfig 类...）

是的，在示例文件夹中有一个 ExampleConfig 类，但我没有发现它在某处使用。

【参考方案1】：

Java websocket 服务器使用返回值ServerApplicationConfig interface 来部署编程端点和带注释的端点。 以 Tomcat 为例，如果您更改 ChatAnnotation 的 包名称。你也要修改websocket.ExamplesConfig。

public Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned) 
    // Deploy all WebSocket endpoints defined by annotations in the examples
    // web application. Filter out all others to avoid issues when running
    // tests on Gump
    Set<Class<?>> results = new HashSet<>();
    for (Class<?> clazz : scanned) 
        String name = clazz.getPackage().getName();
        boolean ok = name.startsWith("websocket.");
        if (ok) 
            results.add(clazz);
        
    
    return scanned;

getAnnotatedEndpointClasses(scanned) 只返回包名以 websocket 开头的类。 不匹配的类即使有 @ServerEndpoint 声明也不会部署。

【讨论】：

感谢您的回复。我添加了一个类 ExamplesConfig（见上文），但我需要在某处说必须启动套接字服务器或其他什么，因为我无法添加此类

您的实现不返回 ChatAnnotation 类。如果您不想过滤带注释的端点，getAnnotatedEndpointClasses(Set<Class<?>> scanned) 可以简单地返回 scaned 变量而不更改它。

我已经编辑过了。现在我返回scanned 但连接到套接字服务器。我尝试连接到 ws://80.0.0.10:8080/clientserverws/chat。我的服务器连接在 80.0.0.10 上，我的应用程序在 8080 上运行。我可以访问应用程序的网页。此外，我没有从上面的 websocket 代码中看到任何日志。需要我启动此服务器还是自动运行？