基于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;  }  }