如何在 Spring Boot 3.3 中实现请求 IP 白名单拦截功能

最新推荐文章于 2024-10-08 10:30:37 发布
最新推荐文章于 2024-10-08 10:30:37 发布
阅读量416 收藏
点赞数
文章标签： java 服务器 网络
原文链接：https://mp.weixin.qq.com/s/3YsMNlWwISTEWVMR5AI2wg
版权

如何在 Spring Boot 3.3 中实现请求 IP 白名单拦截功能

在微服务和分布式系统中，确保系统的安全性至关重要。其中一种常见的安全措施是实现 IP 白名单功能，即只允许特定的 IP 地址访问系统。在这篇文章中，我们将深入探讨如何在 Spring Boot 3.3 中实现 IP 白名单拦截功能，并结合具体的代码示例来详细说明。

运行效果：

正常访问

图片

受限访问

图片

若想获取项目完整代码以及其他文章的项目源码，且在代码编写时遇到问题需要咨询交流，欢迎加入下方的知识星球。

1. 项目环境配置

首先，我们需要创建一个 Spring Boot 项目，并添加必要的依赖。

pom.xml 配置

在 pom.xml 中添加以下依赖：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>3.3.3</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.icoderoad</groupId>
	<artifactId>IpWhitelist</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>IpWhitelist</name>
	<description>IpWhitelist Demo project for Spring Boot</description>
	
	<properties>
		<java.version>17</java.version>
		<bootstrap.version>5.1.0</bootstrap.version>
		<jquery.version>3.6.0</jquery.version>
	</properties>
	<dependencies>
		<!-- Spring Boot Starter Web -->
	    <dependency>
	        <groupId>org.springframework.boot</groupId>
	        <artifactId>spring-boot-starter-web</artifactId>
	    </dependency>
	    <!-- Thymeleaf -->
	    <dependency>
	        <groupId>org.springframework.boot</groupId>
	        <artifactId>spring-boot-starter-thymeleaf</artifactId>
	    </dependency>
	    <!-- Bootstrap & jQuery -->
	    <dependency>
	        <groupId>org.webjars</groupId>
	        <artifactId>bootstrap</artifactId>
	        <version>${bootstrap.version}</version>
	    </dependency>
	    <dependency>
	        <groupId>org.webjars</groupId>
	        <artifactId>jquery</artifactId>
	        <version>${jquery.version}</version>
	    </dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>
application.yml 配置

在 src/main/resources/application.yml 中添加以下配置：

server:
  port: 8080

ip:
  whitelist:
    - 192.168.0.1
    - 127.0.0.1
    - 0:0:0:0:0:0:0:1

这里我们配置了一个 ip.whitelist 属性，用于指定允许访问系统的 IP 地址列表。

2. 创建 IP 拦截器

属性读取类

package com.icoderoad.IpWhitelist.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

import java.util.List;

@Configuration
@ConfigurationProperties(prefix = "ip")
public class IpWhitelistProperties {

    private List<String> whitelist;

    public List<String> getWhitelist() {
        return whitelist;
    }

    public void setWhitelist(List<String> whitelist) {
        this.whitelist = whitelist;
    }
}

 接下来，我们将创建一个自定义拦截器 IpWhitelistInterceptor，用于拦截请求并检查请求的 IP 是否在白名单中。

package com.icoderoad.IpWhitelist.interceptor;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;

import com.icoderoad.IpWhitelist.config.IpWhitelistProperties;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

@Component
public class IpWhitelistInterceptor implements HandlerInterceptor {

    
    private final List<String> whitelist;

    @Autowired
    public IpWhitelistInterceptor(IpWhitelistProperties properties) {
        this.whitelist = properties.getWhitelist();
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String remoteIp = request.getRemoteAddr();
        String requestUri = request.getRequestURI();
        // 排除错误页面路径，避免重定向循环
        if ("/error/ip".equals(requestUri)) {
            return true;
        }

     
        if (whitelist.contains(remoteIp)) {
            return true;
        } else {
            // 如果 IP 不在白名单中，重定向到错误页面
            response.sendRedirect("/error/ip");
            return false;
        }
    }
}

视图控制器

package com.icoderoad.IpWhitelist.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class IndexController {

    @GetMapping("/")
    public String index(Model model) {
        return "index";
    }

}

配置错误控制器

最后，我们需要创建一个控制器来处理 /error/ip 请求，并返回错误页面。

package com.icoderoad.IpWhitelist.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class ErrorController {

    @GetMapping("/error/ip")
    public String ipError() {
        // 返回自定义的错误页面
        return "error/ip";
    }
    
}

代码说明：

  • ErrorController 控制器负责处理 /error/ip 请求，并返回 ip.html 页面。

  • 创建错误页面

    接下来，我们创建一个新的错误页面，提示用户 IP 不在白名单中。

    在 src/main/resources/templates/error/ip.html 中创建错误页面：

    <!DOCTYPE html>
<html lang="zh">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>访问受限</title>
    <link rel="stylesheet" th:href="@{/webjars/bootstrap/css/bootstrap.min.css}">
    <script th:src="@{/webjars/jquery/jquery.min.js}"></script>
    <script th:src="@{/webjars/bootstrap/js/bootstrap.bundle.min.js}"></script>
</head>
<body>
<div class="container">
    <h1 class="mt-5">访问受限</h1>
    <div class="alert alert-danger" role="alert">
        您的 IP 地址不在白名单中，无法访问此页面。
    </div>
</div>
</body>
</html>

  • 代码说明：

    • 页面标题为“访问受限”。

    • 页面内容包含一个警告信息，告知用户其 IP 地址不在白名单中，因此无法访问。

  • 3. 注册拦截器

    为了使拦截器生效，我们需要将其注册到 Spring Boot 的拦截器链中。创建一个 WebConfig 类来注册拦截器。

    package com.icoderoad.IpWhitelist.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import com.icoderoad.IpWhitelist.interceptor.IpWhitelistInterceptor;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private IpWhitelistInterceptor ipWhitelistInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(ipWhitelistInterceptor).addPathPatterns("/**");
    }
}

代码说明：

  • addInterceptors 方法：将 IpWhitelistInterceptor 注册到拦截器链中，拦截所有路径的请求。

4. 前端页面展示

我们使用 Thymeleaf、Bootstrap 和 jQuery 创建一个简单的页面，展示请求 IP 的拦截情况。

在 src/main/resources/templates/index.html 中创建一个简单的前端页面：

<!DOCTYPE html>
<html lang="zh">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>IP 白名单示例</title>
    <link rel="stylesheet" th:href="@{/webjars/bootstrap/css/bootstrap.min.css}">
    <script th:src="@{/webjars/jquery/jquery.min.js}"></script>
    <script th:src="@{/webjars/bootstrap/js/bootstrap.bundle.min.js}"></script>
</head>
<body>
<div class="container">
    <h1 class="mt-5">IP 白名单示例</h1>
    <div class="alert alert-info" role="alert">
        只有在白名单中的 IP 地址才能访问此页面。
    </div>
</div>
</body>
</html>

 

代码说明：

  • 使用 Bootstrap 提供了简单的页面样式。

  • 使用 Thymeleaf 渲染 HTML 页面。

5. 测试与验证

启动 Spring Boot 应用程序，在浏览器中访问 http://localhost:8080/ 。尝试从不同的 IP 地址访问系统。

  • 如果请求 IP 在白名单中，将看到页面正常显示。

  • 如果请求 IP 不在白名单中，将返回 403 Forbidden 错误。

结语

通过以上步骤，我们在 Spring Boot 3.3 中实现了一个简单的 IP 白名单拦截功能。这个功能在实际应用中非常实用，可以有效地限制对系统的访问，确保系统的安全性。通过自定义拦截器和配置文件的结合，我们可以灵活地控制允许访问的 IP 地址列表。这种方法不仅实现简单，而且易于扩展和维护。

买女孩的火柴盒
关注
电商平台核心组件之财务系统设计及实现系列文章
AI天才研究院
09-13 2604
随着互联网行业的蓬勃发展，传统的实体零售模式正在被数字化、网络化所取代。而在电商平台上也将成为新的流量入口。为了能够顺应这个快速发展趋势，电商公司必须要面对一个复杂的财务系统。这里主要讨论电商平台中的财务系统设计及其相关技术。我们认为，电商财务系统应该集成完整的订单处理、支付处理、结算处理等流程模块，实现订单实时性、多渠道支付、全网货币结算、客户积分体系、消费者数据分析、流量变现等能力的集成，达到金钱自由流通的目的。首先，本文通过分析一个典型的电商财务系统，为读者展示了一个实际可行的解决方案。
SpringCloud快速入门
black210的博客
04-02 580
文章目录1.初识 SpringCloud1.1.微服务1.2.简介2.Eureka 注册中心2.1.简易模拟一个微服务2.1.1.搭建EurekaServer:2.1.2.注册到Eureka2.1.3.从Eureka获取服务2.2.Eureka详解2.2.1.基础架构2.2.2.高可用的Eureka Server2.2.3.服务提供者2.2.4.服务消费者2.2.5.失效剔除和自我保护3.Ribb...
springboot 集成IP白名单配置
m0_51392342的博客
09-20 390
3.最后一步也是最关键的一步，让我们的拦截器生效是要把拦截器注册进来。以下主要是使用拦截器（Interceptor）添加白名单黑名单的目的是控制请求。使用拦截器或者过滤器都是可以的！
基于Spring Boot实现IP黑白名单功能
勤劳的小琪
04-29 2498
基于Spring Boot实现IP黑白名单的功能，可以通过自定义一个过滤器（Filter）来完成。这只是一个基础的实现，根据你的具体需求，可能还需要考虑其他因素，例如：缓存黑白名单以提高性能、支持CIDR表示法的IP地址范围等。这个示例中，IP地址是硬编码在过滤器注册中的。过滤器的顺序（通过setOrder方法设置）可能会影响其他过滤器的执行顺序，确保这个顺序符合你的需求。对于非黑白名单的IP，这个示例中默认是允许访问的。创建一个自定义的过滤器，用于检查请求的IP是否在黑白名单中。
springboot 拦截器 配置白名单 放行url
面朝大海，春暖花开
12-03 9421
实现接口自定义一个拦截器 重写方法 判断是否登录 注册自定义的拦截器 重写此方法 添加白名单 放行静态资源以及指定controller url 记得加上注解 ...
不想被恶意访问？SpringBoot 的 IP 白名单限制了解一下！
最新发布
犬小哈
10-08 107
来源：https://blog.csdn.net/andyLyysh???? 欢迎加入小哈的星球，你将获得:专属的项目实战 /1v1 提问/Java 学习路线 /学习打卡/每月赠书/社群讨论新项目:《从零手撸：仿小红书（微服务架构）》正在持续爆肝中，基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17...,点击查看项目介绍；《从零手...
Springboot接口添加IP白名单限制
second_place_zyj的博客
04-23 7468
添加白名单限制，为我们的项目保驾护航
Spring Boot 完整讲解
可乐的博客
02-28 2万+
SpringBoot学习笔记 文章写得比较详细，所以很长（105336 字数），可以参考目录 文章目录SpringBoot学习笔记@[toc]一、 Spring Boot 入门预：必须掌握的技术：1. Spring Boot 简介背景解决的问题优点缺点2.微服务What are Microservices?单体应用微服务3.环境准备Maven设置：Idea设置4.Spring Boot Hel...
鉴权 OAuth 2.0的实现（Spring_Security_Oauth2）
qq_25156781的博客
01-28 2999
可以理解为客户端和服务器之间的一次私密谈话，在一次对话中可能会有多个请求和响应；同时要具有鉴别多个请求是来自同一个客户端的一次对话的功能；用户认证通过后，为了避免用户的每次操作都进行认证，可将用户的信息保证在会话中。会话就是系统为了保持当前用户的登录状态所提供的机制，常见的有基于session方式、基于token方式等。
苍穹外卖-day02
weixin_73933655的博客
05-04 3474
ThreadLocal 并不是一个Thread，而是Thread的局部变量。ThreadLocal为每个线程提供单独一份存储空间，具有线程隔离的效果，只有在线程内才能获取到对应的值，线程外则不能访问。
springboot 项目通过过滤器（Filter）实现白名单过滤以及拦截客户端请求服务接口进行统一日志记录的实现方式
跟着飞哥学编程（全栈联盟）
03-31 2146
Filter 拦截非法host请求，以及统一日志记录所有接口请求
springboot配置白名单yml
weixin_43762113的博客
12-28 2076
springboot配置白名单yml
springboot拦截器-处理跨域问题与添加IP白名单
u010014465的博客
12-07 6130
跨域概念不再论述，详细定义可自行百度。 解决类似报错  Access-Control-Allow，拦截器中为header添加属性： @Configuration public class CommonInterceptor implements HandlerInterceptor{ @Override public boolean preHandle(HttpServletRequest r...
获取客户端真实IP地址
chucuo1135的博客
06-27 361
/** * 获取用户真实IP地址，不使用request.getRemoteAddr()的原因是有可能用户使用了代理软件方式避免真实IP地址, * 可是，如果通过了多级反向代理的话，X-Forwarded-For的值并不止一个，而是一串IP值 * *https://my.oschin...
java 跨越拦截器_Spring Boot配置拦截器及实现跨域访问的方法
weixin_39714191的博客
02-27 570
拦截器功能强大，能够深入方法前后，常应用于日志记录、权限检查和性能检测等，几乎是项目中不可或缺的一部分，本文就来实现Spring Boot自定义拦截器的配置。理论指导问：Spring Boot怎么配置拦截器？答：配置一个拦截器需要两步完成。自定义拦截器，实现HandlerInterceptor这个接口。这个接口包括三个方法，preHandle是请求执行前执行的，postHandler是请求结束执行...
Spring boot之拦截器与定时任务的实现
Stay Focused And Work Hard !!!
09-09 1万+
场景：由于用Spring boot编写了关于Ranger策略以及Hive脱敏相关的接口，并以http方式向外部提供。为了防止请求被非法模仿，因而编写了一个访问Ip 鉴权类，也就是设置了访问ip白名单，只有在白名单上的ip才可以访问接口。 Spring boot自带HandlerInterceptor，可通过继承它来实现拦截功能，其的功能跟过滤器类似，但是提供更精细的的控制能力：在request被响应
springboot中拦截器的配置及原理
afdfdd的博客
04-03 343
本文主要介绍了在springboot中拦截器的配置及其相关原理
Spring Boot拦截器配置拦截登陆
热门推荐
qq_30745307的博客
07-09 10万+
一，pom.xml的配置 这里很简单，先引入spring-boot-starter-parent，parent 是父模块，由父模块统一进行 spring-boot 版本管理，dependencies 中与 spring-boot 启动绑定的包不需要再指定版本。 <parent> <groupId>org.springframework.boot<...
Spring Boot应用中实现STOMP协议WebSocket教程
"本文主要介绍如何在Spring Boot项目中实现基于STOMP协议的WebSocket功能，同时探讨了Java泛型构造函数的概念和应用。" 在Spring Boot应用中，WebSocket的实现通常用于实现实时通信，例如推送通知、实时图表更新等...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值