基於springmvc開發注解式ip攔截器

一、注解類

@Documented
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface IPFilter {

    /**
     * 訪問ip白名單
     * @return
     */
    String[] allow() default {};
    
    /**
     * 訪問ip黑名單
     * @return
     */
    String[] deny() default {};
}

1. @Documented —— 指明擁有這個注解的元素可以被javadoc此類的工具文檔化。這種類型應該用於注解那些影響客戶使用帶注釋的元素聲明的類型。如果一種聲明使用Documented進行注解，這種類型的注解被作為被標注的程序成員的公共API。

2. @Target——指明該類型的注解可以注解的程序元素的范圍。該元注解的取值可以為TYPE,METHOD,CONSTRUCTOR,FIELD等。如果Target元注解沒有出現，那么定義的注解可以應用於程序的任何元素。

3. @Inherited——指明該注解類型被自動繼承。如果用戶在當前類中查詢這個元注解類型並且當前類的聲明中不包含這個元注解類型，那么也將自動查詢當前類的父類是否存在Inherited元注解，這個動作將被重復執行知道這個標注類型被找到，或者是查詢到頂層的父類。
4.@Retention——指明了該Annotation被保留的時間長短。RetentionPolicy取值為SOURCE,CLASS,RUNTIME。

 

二、注解實現

public class AuthorityIPInterceptor extends HandlerInterceptorAdapter {
    private final static Logger logger = LoggerFactory.getLogger(AuthorityIPInterceptor.class);
    
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        if (handler instanceof HandlerMethod) {
            IPFilter ipFilter = ((HandlerMethod) handler).getMethodAnnotation(IPFilter.class);
            if (ipFilter == null) {
                return true;
            }
            String ipAddress = getIpAddress(request);
            ArrayList<String> deny = Lists.newArrayList(ipFilter.deny());
            ArrayList<String> allow = Lists.newArrayList(ipFilter.allow());
            
            //設置了黑名單,  黑名單內ip不給通過
            if (CollectionUtils.isNotEmpty(deny)) {
                if (deny.contains(ipAddress)) {
                    logger.info("IP: "+ipAddress+" 被攔截");
                    response.setStatus(500);
                    return false;
                }
            }
            //設置了白名單,  只有白名單內的ip給通過
            if (CollectionUtils.isNotEmpty(allow)) {
                if (allow.contains(ipAddress)) {
                    logger.info("IP: "+ipAddress+" 被放行");
                    return true;
                }else {
                    logger.info("IP: "+ipAddress+" 沒有放行權利");
                    response.setStatus(500);
                    return false;
                }
            }
        }
        return true;
    }
    
    /** 
     * 獲取請求主機IP地址,如果通過代理進來，則透過防火牆獲取真實IP地址; 
     *  
     * @param request 
     * @return 
     * @throws IOException 
     */  
    public final static String getIpAddress(HttpServletRequest request) throws IOException {  
        // 獲取請求主機IP地址,如果通過代理進來，則透過防火牆獲取真實IP地址  
  
        String ip = request.getHeader("X-Forwarded-For");  
        if (logger.isInfoEnabled()) {  
            logger.info("getIpAddress(HttpServletRequest) - X-Forwarded-For - String ip=" + ip);  
        }  
  
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {  
            if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {  
                ip = request.getHeader("Proxy-Client-IP");  
                if (logger.isInfoEnabled()) {  
                    logger.info("getIpAddress(HttpServletRequest) - Proxy-Client-IP - String ip=" + ip);  
                }  
            }  
            if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {  
                ip = request.getHeader("WL-Proxy-Client-IP");  
                if (logger.isInfoEnabled()) {  
                    logger.info("getIpAddress(HttpServletRequest) - WL-Proxy-Client-IP - String ip=" + ip);  
                }  
            }  
            if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {  
                ip = request.getHeader("HTTP_CLIENT_IP");  
                if (logger.isInfoEnabled()) {  
                    logger.info("getIpAddress(HttpServletRequest) - HTTP_CLIENT_IP - String ip=" + ip);  
                }  
            }  
            if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {  
                ip = request.getHeader("HTTP_X_FORWARDED_FOR");  
                if (logger.isInfoEnabled()) {  
                    logger.info("getIpAddress(HttpServletRequest) - HTTP_X_FORWARDED_FOR - String ip=" + ip);  
                }  
            }  
            if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {  
                ip = request.getRemoteAddr();  
                if (logger.isInfoEnabled()) {  
                    logger.info("getIpAddress(HttpServletRequest) - getRemoteAddr - String ip=" + ip);  
                }  
            }  
        } else if (ip.length() > 15) {  
            String[] ips = ip.split(",");  
            for (int index = 0; index < ips.length; index++) {  
                String strIp = (String) ips[index];  
                if (!("unknown".equalsIgnoreCase(strIp))) {  
                    ip = strIp;  
                    break;  
                }  
            }  
        }  
        return ip;  
    }  
}

 

通過繼承springmvc的攔截器，對所有訪問當前加了注解的controller接口和方法進行攔截

 

三、路徑攔截

 <mvc:interceptor> 2 <mvc:mapping path="/**/xxx/**"/> 3 <bean class="com.xxx..AuthorityIPInterceptor"/> 4 </mvc:interceptor>  

通過在mvc的配置文件配置請求的攔截路徑，防止所有的請求都被攔截，做到精准控制