Java WebSocket 获取客户端 IP 地址

在开发 Web 应用程序时，我们通常需要获取客户端的 IP 地址用于日志记录、身份验证、限制访问等操作。当使用 WebSocket 协议时，我们可以使用 Java WebSocket API 来获取客户端的 IP 地址。

本文将介绍如何使用 Java WebSocket API 获取客户端 IP 地址，以及如何在常见的 WebSocket 框架中获得客户端 IP 地址。

Java WebSocket API 获取客户端 IP 地址

Java WebSocket API 是 Java EE 的一部分，提供了一套用于开发 WebSocket 服务器的 API。通过 Java WebSocket API，我们可以编写自己的 WebSocket 服务器，处理客户端的连接、消息和关闭事件。

在 Java WebSocket API 中，我们可以通过 Session 对象获取客户端的 IP 地址。Session 对象代表了客户端与服务器建立的 WebSocket 连接。

下面是一个使用 Java WebSocket API 获取客户端 IP 地址的示例代码：

@ServerEndpoint("/websocket")
public class WebSocketServer {
    @OnOpen
    public void onOpen(Session session, EndpointConfig config) {
        String clientIp = getClientIpAddress(session);
        System.out.println("New connection from IP: " + clientIp);
    }

    @OnMessage
    public void onMessage(String message, Session session) {
        // 处理收到的消息
    }

    @OnClose
    public void onClose(Session session, CloseReason closeReason) {
        String clientIp = getClientIpAddress(session);
        System.out.println("Connection closed from IP: " + clientIp);
    }

    private String getClientIpAddress(Session session) {
        String ipAddress = null;
        MessageContext messageContext = session.getUserProperties().get("javax.websocket.server.ServerEndpointConfig.MESSAGE_CONTEXT")；
        if (messageContext != null) {
            HttpServletRequest request = (HttpServletRequest) messageContext.get(ServletRequest.class.getName());
            if (request != null) {
                ipAddress = request.getRemoteAddr();
            }
        }
        return ipAddress;
    }
}

在上述代码中，@ServerEndpoint("/websocket") 注解用于标记该类是一个 WebSocket 服务器端点。通过 onOpen 方法，我们可以在建立连接时获取到客户端的 IP 地址，并进行相应的处理。同样地，在 onClose 方法中，我们也可以获取客户端 IP 地址并处理连接关闭事件。

在 getClientIpAddress 方法中，我们通过 session.getUserProperties() 获取到用户属性的 Map，从中取出 MESSAGE_CONTEXT，然后获取到 ServletRequest 对象。通过 HttpServletRequest 的 getRemoteAddr 方法，我们可以得到客户端的 IP 地址。

常见 WebSocket 框架获取客户端 IP 地址

除了使用 Java WebSocket API，我们还可以在一些常见的 WebSocket 框架中获取客户端的 IP 地址。下面将介绍几个常用的 WebSocket 框架以及如何在这些框架中获取客户端 IP 地址。

Spring WebSocket

Spring WebSocket 是 Spring 框架提供的 WebSocket 支持。在 Spring WebSocket 中，我们可以通过 WebSocketSession 对象获取客户端的 IP 地址。

下面是一个在 Spring WebSocket 中获取客户端 IP 地址的示例代码：

@Controller
public class WebSocketController extends TextWebSocketHandler {
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        String clientIp = getClientIpAddress(session);
        System.out.println("New connection from IP: " + clientIp);
    }

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 处理收到的消息
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        String clientIp = getClientIpAddress(session);
        System.out.println("Connection closed from IP: " + clientIp);
    }

    private String getClientIpAddress(WebSocketSession session) {
        String ipAddress = null;
        HttpSession httpSession = (HttpSession) session.getAttributes().get("HTTP_SESSION");
        if (httpSession != null) {
            ipAddress = httpSession.getServletContext().getRealPath();
        }
        return ipAddress;
    }
}

在上述代码中，WebSocketSession 类似于 Java WebSocket API 中的 Session 对象。通过 WebSocketSession 的 getAttributes 方法，我们可以获取到传递给 WebSocket 的属性。在这里，我们获取到了 HTTP_SESSION 属性，也就是底层的 HttpSession 对象。通过 HttpSession 对象，我们可以使用 getServletContext().getRealPath() 方法来获取客户端的 IP 地址。

Netty WebSocket

Netty 是一个异步事件驱动的网络应用程序框架，它也提供了 WebSocket 的支持。在 Netty WebSocket 中，我们可以通过 ChannelHandlerContext 对象获取客户端的 IP 地址。

下面是一个在 Netty WebSocket 中获取客户端 IP 地址的示例代码：

@ChannelHandler.Sharable
public class WebSocketHandler extends SimpleChannelInboundHandler<WebSocketFrame> {
    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        SocketAddress socketAddress = ctx.channel().remoteAddress();
        if (socketAddress instanceof InetSocketAddress) {
            InetSocketAddress inetSocketAddress = (InetSocketAddress) socketAddress;
            String clientIp = inetSocketAddress.getAddress().getHostAddress();
            System.out.println("New connection from IP: " + clientIp);
        }
    }

    @Override
    protected void channelRead0(ChannelHandlerContext ctx, WebSocketFrame frame) throws Exception {
        // 处理收到的消息
    }

    @Override
    public void channelInactive(ChannelHandlerContext ctx) throws Exception {
        SocketAddress socketAddress = ctx.channel().remoteAddress();
        if (socketAddress instanceof InetSocketAddress) {
            InetSocketAddress inetSocketAddress = (InetSocketAddress) socketAddress;
            String clientIp = inetSocketAddress.getAddress().getHostAddress();
            System.out.println("Connection closed from IP: " + clientIp);
        }
    }
}

在上述代码中，channelActive 方法在客户端建立连接时被调用，我们可以通过 ChannelHandlerContext 中的 remoteAddress 获取客户端的 IP 地址。同样地，channelInactive 方法在连接关闭时被调用，我们也可以在这里获取客户端 IP 地址并进行相应的处理。
以下是一个基本的Java学习大纲，可用于初学者的学习路线。根据您的学习进度和需求，您可以自行调整和扩展。

第一阶段：基础概念

理解编程的基本概念
学习计算机科学基础知识，如数据类型、变量、常量等
掌握基本的控制流程，如条件语句、循环语句等
学习面向对象编程概念，如类、对象、封装、继承和多态
学习基本的数据结构和算法知识，如数组、链表、栈和队列
理解异常处理机制和错误处理方法
学习基本的输入输出操作和文件处理

第二阶段：核心Java知识

学习Java语言的核心特性，如包、接口、枚举等
学习Java集合框架，如List、Set、Map等
掌握泛型编程和类型擦除的概念
学习多线程编程，如线程创建、同步和通信等
学习反射机制和动态代理模式
掌握异常处理和自定义异常类
学习文件操作和流处理

第三阶段：高级Java技术

学习网络编程基础，如Socket编程、HTTP和TCP/IP协议等
掌握Java数据库编程，如连接数据库、执行SQL语句等
学习Java GUI编程，如Swing和JavaFX框架
了解Web开发基础，如Servlet、JSP和Java Web框架（如SpringMVC）
学习使用Java开发常见的应用程序，如图像处理、数据分析等
学习常用的开发工具和集成开发环境（IDE），如Eclipse和IntelliJ IDEA

第四阶段：实战项目

开展自己的Java项目，如学生管理系统、图书馆管理系统等
学习使用版本控制系统，如Git或SVN，进行团队合作开发
掌握调试技巧和解决bug的方法
学习编写高质量的代码，包括代码风格、注释和文档编写等
参与开源项目或实习，获得实际项目经验
不断学习和练习，掌握更多的Java知识和技能

通过按照这个学习大纲来学习Java，您将能够逐步掌握Java语言的基础和核心知识，并能够应用于实际的开发项目中。记住要不断练习和实践，参与开源社区和项目，以增强自己的技能和经验。

总结

本文介绍了如何使用 Java WebSocket API 和常见的 WebSocket 框架获取客户端的 IP 地址。通过 Java WebSocket API，我们可以在建立连接和关闭连接时获取客户端 IP 地址，通过一些框架提供的接口，我们可以在相应的事件中获取客户端 IP 地址，并做出相应的处理。

在开发 WebSocket 应用程序时，了解如何获取客户端的 IP 地址是非常重要的，它可以帮助我们做出更好的决策和实现更高级的功能。希望本文对您有所帮助，并能在实际的开发中提供一些指导和参考。

文章出处登录后可见！

已经登录？立即刷新

Java WebSocket 获取客户端 IP 地址

Java WebSocket API 获取客户端 IP 地址

常见 WebSocket 框架获取客户端 IP 地址

Spring WebSocket

Netty WebSocket

总结

相关推荐