基于Spring Boot实现IP黑白名单功能

在Web应用开发中，控制对特定IP地址的访问权限是一个常见的需求。通过实现IP黑白名单功能，我们可以允许某些IP地址访问应用，同时拒绝其他IP地址的访问。在Spring Boot框架中，我们可以通过自定义过滤器（Filter）来实现这一功能。本文将详细介绍如何在Spring Boot应用中实现IP黑白名单功能，并附上相应的代码片段。

一、配置IP黑白名单

首先，我们需要在配置文件中定义IP黑白名单。在application.yml文件中，我们可以添加如下配置：

ip:  
  whitelist: 192.168.1.1,192.168.1.2  

  blacklist: 192.168.1.3,192.168.1.4

这里我们定义了两个列表，分别表示白名单和黑名单中的IP地址。

二、创建IP黑白名单过滤器

接下来，我们需要创建一个自定义的过滤器，用于检查请求的IP地址是否在黑白名单中。过滤器类IpFilter的实现如下：

import javax.servlet.*;  
import javax.servlet.http.HttpServletRequest;  
import javax.servlet.http.HttpServletResponse;  
import java.io.IOException;  
import java.util.Arrays;  
import java.util.List;  
import java.util.stream.Collectors;  
import org.springframework.beans.factory.annotation.Value;  
import org.springframework.stereotype.Component;  
  
@Component  
public class IpFilter implements Filter {  
  
    @Value("${ip.whitelist}")  
    private String whitelistStr;  
  
    @Value("${ip.blacklist}")  
    private String blacklistStr;  
  
    private List<String> whitelist;  
    private List<String> blacklist;  
  
    @Override  
    public void init(FilterConfig filterConfig) throws ServletException {  
        whitelist = Arrays.stream(whitelistStr.split(","))  
                .map(String::trim)  
                .collect(Collectors.toList());  
        blacklist = Arrays.stream(blacklistStr.split(","))  
                .map(String::trim)  
                .collect(Collectors.toList());  
    }  
  
    @Override  
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {  
        HttpServletRequest httpRequest = (HttpServletRequest) request;  
        String ip = httpRequest.getRemoteAddr();  
  
        if (whitelist.contains(ip)) {  
            // 白名单IP，直接通过  
            chain.doFilter(request, response);  
        } else if (blacklist.contains(ip)) {  
            // 黑名单IP，拒绝访问  
            HttpServletResponse httpResponse = (HttpServletResponse) response;  
            httpResponse.sendError(HttpServletResponse.SC_FORBIDDEN, "IP is in blacklist");  
        } else {  
            // 非黑白名单IP，根据业务需求处理（例如：允许或拒绝）  
            chain.doFilter(request, response);  
        }  
    }  
  
    @Override  
    public void destroy() {  
        // 清理资源，如果有的话  
    }  

}

在IpFilter类中，我们使用@Value注解从配置文件中读取黑白名单配置，并在init方法中将其转换为列表。在doFilter方法中，我们获取请求的IP地址，并根据其是否在黑白名单中决定是否允许访问。

三、注册过滤器

最后，我们需要在Spring Boot的配置类中注册这个过滤器。通过创建一个FilterRegistrationBean实例并将其添加到Spring容器中，我们可以实现过滤器的注册。配置类FilterConfig的实现如下：

import org.springframework.boot.web.servlet.FilterRegistrationBean;  
import org.springframework.context.annotation.Bean;  
import org.springframework.context.annotation.Configuration;  
  
@Configuration  
public class FilterConfig {  
  
    @Bean  
    public FilterRegistrationBean<IpFilter> ipFilterRegistration() {  
        FilterRegistrationBean<IpFilter> registrationBean = new FilterRegistrationBean<>();  
        registrationBean.setFilter(new IpFilter());  
        registrationBean.addUrlPatterns("/*"); // 设置过滤器拦截的路径  
        registrationBean.setName("ipFilter");  
        registrationBean.setOrder(1); // 设置过滤器的顺序  
        return registrationBean;  
    }  

}

在FilterConfig类中，我们创建了一个FilterRegistrationBean实例，并将其返回的Bean注册到Spring容器中。通过设置addUrlPatterns方法，我们指定了过滤器需要拦截的路径（这里拦截所有路径）。通过setOrder方法，我们可以设置过滤器的执行顺序。

四、总结

通过以上步骤，我们成功在Spring Boot应用中实现了IP黑白名单功能。通过自定义过滤器IpFilter，并结合Spring的配置类FilterConfig，我们能够在请求到达应用之前对IP地址进行校验，确保只有符合黑白名单规则的IP能够访问应用。

在实际应用中，可能还需要考虑一些额外的细节，比如：

1. 动态更新黑白名单：当前实现中，黑白名单是从配置文件中读取的，如果需要动态更新黑白名单，可以考虑使用数据库或缓存等方式存储黑白名单，并在过滤器中实时查询。

2. 性能优化：对于大型应用或高并发场景，频繁查询黑白名单可能会影响性能。可以考虑使用缓存机制，将黑白名单缓存到内存中，减少数据库或配置文件的读取次数。

3. 异常处理：在过滤器中处理请求时，可能会出现各种异常情况（如网络问题、配置错误等）。应该合理处理这些异常，确保应用的稳定性和可用性。

总之，基于Spring Boot实现IP黑白名单功能是一个相对简单的任务，通过自定义过滤器和配置类的组合，我们可以轻松实现这一功能，并根据实际需求进行扩展和优化。希望本文对您有所帮助！