获取IP地址

精选原创

奇遇少年 2024-02-14 19:57:57 博主文章分类：后端 ©著作权

文章标签 IP Java SpringBoot\ 文章分类 Java 后端开发 yyds干货盘点

©著作权归作者所有：来自51CTO博客作者奇遇少年的原创作品，请联系作者获取转载授权，否则将追究法律责任

在Spring Boot框架中构建RESTful服务是现代Java开发中的一个基本任务。对于许多应用程序而言，获取客户端的IP地址是一项基本需求。许多场景中，这一需求都很常见，如安全审计、自定义用户体验、日志记录或分析和监控。

今天我们将介绍如何在Spring Boot中创建一个端点（API接口），通过该接口用户可以检索到自己的IP地址以及访问的接口详细信息。

开始之前

确保您的开发环境已经安装了以下：

Java Development Kit (JDK)，建议版本8及以上
Maven或Gradle构建工具
一个喜欢的IDE，比如IntelliJ IDEA、Eclipse等
Spring Boot的基础知识

创建Spring Boot项目

您可以使用Spring Initializr来快速初始化您的项目结构。为了本项目，我们需要选择Web依赖，因为我们将构建一个RESTful Web服务。

编写信息实体类

用户访问接口地址和用户ip

@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserInfo {
    private String ip;
    private String url;
}

编写控制器端点

在您的Spring Boot项目中，创建一个新的Java类来作为您的控制器，并添加一个方法来处理HTTP请求。这个方法将返回请求者的IP地址和请求的接口信息。

/**
 * UserIpController 类处理获取用户 IP 地址的请求。
 */
@RestController
public class UserIpController {
    /**
     * 获取用户的 IP 地址和请求 URL。
     *
     * @param request 请求的 HttpServletRequest 对象
     * @return 包含用户 IP 地址和请求 URL 的 UserInfo 对象
     */
    @RequestMapping("/myIp")
    public UserInfo getUserIp(HttpServletRequest request) {
        String remoteAddr = request.getRemoteAddr();

        // 检查 X-Forwarded-For 头是否存在
        if (request.getHeader("X-Forwarded-For") != null) {
            // 从 X-Forwarded-For 头中提取第一个 IP 地址
            remoteAddr = request.getHeader("X-Forwarded-For").split(",")[0];
        }

        // 创建并返回 UserInfo 对象
        return new UserInfo(remoteAddr, request.getRequestURL().toString());
    }
}

在上述代码中：