当前位置：首页 > article >正文

在Spring Boot中实现请求IP白名单拦截

article 2024/11/15 11:16:49

在Web应用中，通过IP白名单机制，我们可以允许特定的IP地址访问应用，而阻止其他IP地址。这种机制在保护管理后台、API接口等敏感资源时尤为有效。Spring Boot作为一个流行的Java框架，提供了丰富的配置和扩展能力，使得我们可以方便地实现IP白名单功能。

什么是IP白名单

IP白名单是一种访问控制机制，通过维护一个允许访问的IP地址列表，只有列表中的IP地址才可以访问特定资源。相比之下，黑名单机制则是阻止特定的IP地址访问。这两种机制都可以用于增强应用的安全性，但在某些场景下，白名单机制可能更加有效和安全。

实现IP白名单拦截的步骤

创建IP白名单配置

首先，我们需要创建一个配置类，用于存储和管理允许访问的IP地址列表。我们可以使用Spring Boot的@ConfigurationProperties注解来实现这一点。

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.List;

@Component
@ConfigurationProperties(prefix = "ip.whitelist")
public class IpWhitelistProperties {
    private List<String> addresses;

    public List<String> getAddresses() {
        return addresses;
    }

    public void setAddresses(List<String> addresses) {
        this.addresses = addresses;
    }
}

在application.yml中配置允许访问的IP地址：

ip:  whitelist:    addresses:      - "192.168.1.1"      - "192.168.1.2"

创建IP白名单拦截器

接下来，我们需要创建一个拦截器，来检查请求的IP地址是否在白名单中。我们可以实现Spring的HandlerInterceptor接口来完成这一任务。

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

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Componentpublic
class IpWhitelistInterceptor implements HandlerInterceptor {
    @Autowired
    private IpWhitelistProperties ipWhitelistProperties;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws IOException {
        String remoteAddr = request.getRemoteAddr();
        if (ipWhitelistProperties.getAddresses().contains(remoteAddr)) {
            return true;
        } else {
            response.sendError(HttpServletResponse.SC_FORBIDDEN, "Access Denied");
            return false;
        }
    }
}

注册拦截器

最后，我们需要将拦截器注册到Spring Boot应用中。我们可以通过实现WebMvcConfigurer接口来完成这一任务。

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;

@Configurationpublic
class WebConfig implements WebMvcConfigurer {
    @Autowired
    private IpWhitelistInterceptor ipWhitelistInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(ipWhitelistInterceptor).addPathPatterns("/**"); // 这里可以根据需要指定拦截的路径    }}