使用spring interceptor拦截器实现API并发调用限流

限流拦截器辅助类,用于存储每个请求的并发访问数:

/**
 * @date 2017年8月4日
 */
package com.wedoctor.health.card.cloud.api.home.interceptor;

import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * 限流拦截器辅助类,用于存储每个请求的访问数
 * @author wangshuai
 * @date 2017年8月4日
 */
public class AccessCounts {

    /**
     * 统计KEY值
     */
    public static final String URL = "AccessCounts.URL";
    /**
     * 并发计数
     */
    private ConcurrentHashMap<Object, AtomicInteger> map = new ConcurrentHashMap<>();

    //静态内部类实现单例
    private AccessCounts() {
        
    }

    private static class Instance {
        static AccessCounts counts = new AccessCounts();
    }

    public static AccessCounts getInstance() {
        return Instance.counts;
    }

    /**
     * 获取对应api的访问次数
     * @param key
     * @return
     */
    public int get(Object key) {
        AtomicInteger counter = map.get(key);
        if (counter == null) {
            counter = new AtomicInteger(0);
            AtomicInteger c = map.putIfAbsent(key, counter);
            if(c != null) {
                counter = c;
            }
        }
        return counter.intValue();
    }

    /**
     * 自增1
     * @param key
     * @return
     */
    public int incrementAndGet(Object key) {
        AtomicInteger counter = map.get(key);
        if (counter == null) {
            counter = new AtomicInteger(0);
            AtomicInteger c = map.putIfAbsent(key, counter);
            if(c != null) {
                counter = c;
            }
        }
        return counter.incrementAndGet();
    }

    /**
     * 自减1
     * @param key
     * @return
     */
    public int decrementAndGet(Object key) {
        AtomicInteger counter = map.get(key);
        if (counter == null) {
            return 0;
        }
        return counter.decrementAndGet();
    }
    
}

拦截器代码:

/**
 * @date 2017年8月4日
 */
package com.wedoctor.health.card.cloud.api.home.interceptor;

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.URLConnection;
import java.util.Timer;
import java.util.TimerTask;
import java.util.concurrent.ConcurrentHashMap;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.log4j.Logger;
import org.apache.log4j.MDC;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

/**
 * 限流拦截器
 * 
 * @author wangshuai
 * @date 2017年8月4日
 */
public class InServiceAccessInterceptor extends HandlerInterceptorAdapter {

    private static final Logger logger = Logger.getLogger(InServiceAccessInterceptor.class);

    /**
     * 配置信息
     */
    private ConcurrentHashMap<String, Integer> config = new ConcurrentHashMap<String, Integer>();

    /**
     * 默认的限制次数
     */
    private int defaultLimit = 100;

    /**
     * 配置文件的URL
     */
    private String configUrl = null;
    
    /**
     * 加载配置文件的频率
     */
    private int loadInterval = 1, loadDelay = 5;
    
    /**
     * 是否合法
     */
    private boolean valid;

    /**
     * 拦截器构造函数, 传入的参数在xml中配置
     * @param defaultLimit
     * @param configUrl
     * @param loadInterval
     * @param loadDelay
     * @param valid
     */
    public InServiceAccessInterceptor(int defaultLimit, String configUrl, int loadInterval, int loadDelay, boolean valid) {
        this.defaultLimit = defaultLimit;
        this.configUrl = configUrl;
        this.loadInterval = loadInterval;
        this.loadDelay = loadDelay;
        this.valid = valid;
        if (valid) {
            task();
        }
    }

    /**
     * 拦截器逻辑
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (valid) {
            if (handler instanceof HandlerMethod) {
                HandlerMethod handlerMethod = (HandlerMethod) handler;
                String callpath = handlerMethod.getMethod().getDeclaringClass().getSimpleName() + "."
                        + handlerMethod.getMethod().getName();
                System.out.println(callpath);
                int counter = AccessCounts.getInstance().get(callpath);
                boolean limit = limit(callpath, counter);
                if (limit) {
                    throw new IllegalAccessException("调用次数超出限制." + callpath + "=" + counter);
                }
                MDC.put(AccessCounts.CALLPATH, callpath);
                AccessCounts.getInstance().incrementAndGet(callpath);
            }
        }
        return true;
    }

    /**
     * 每次执行完后,清除计数,实现限制同一个API同时调用的次数
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        if (valid) {
            Object callpath = MDC.get(AccessCounts.CALLPATH);
            if (null != callpath) {
                AccessCounts.getInstance().decrementAndGet(callpath);
            }
            MDC.remove(AccessCounts.CALLPATH);
        }
    }

    /**
     * 
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        // TODO Auto-generated method stub

    }

    /**
     * 判断是否超出限制次数
     * @date 2017年8月4日
     * @author wangshuai
     * @param callpath
     * @param counter
     * @return
     */
    private boolean limit(String callpath, int counter) {
        //每次都从配置中读取限制的次数
        Integer obj = config.get(callpath);
        int limit = defaultLimit;
        if (obj != null) {
            limit = obj.intValue();
        }
        System.out.println("check callpath:" + callpath + " limit:" + limit + " counter:" + counter);
        if (logger.isDebugEnabled()) {
            logger.debug("check callpath:" + callpath + " limit:" + limit + " counter:" + counter);
        }
        if (counter >= limit) {
            System.out.println("the call[" + callpath + "] is over limit:" + limit + " counter:" + counter);
            logger.warn("the call[" + callpath + "] is over limit:" + limit + " counter:" + counter);
            return true;
        }
        return false;
    }

    /**
     * 定时更新拦截器配置
     * @date 2017年8月4日
     * @author wangshuai
     */
    public void task() {
        TimerTask task = new TimerTask() {
            @Override
            public void run() {
                if (null == configUrl)
                    return;
                String text = sendGet(configUrl, null);
                logger.info("load config:" + text);
                if (null == text || "".equals(text.trim()))
                    return;

                text = text.replaceAll("[\\{\\}\"\n]", "");
                config.clear();
                for (String line : text.split(",")) {
                    String fields[] = line.split(":");
                    if (fields.length < 2)
                        continue;
                    try {
                        config.put(fields[0].trim(), Integer.valueOf(fields[1].trim()));
                    } catch (Exception e) {
                        logger.error("load config fail.", e);
                    }
                }
            }
        };
        Timer timer = new Timer();
        long delay = 1000 * loadDelay;
        long intevalPeriod = 1000 * loadInterval;
        // schedules the task to be run in an interval
        logger.info("Task setting  delay:" + delay + "  intevalPeriod:" + intevalPeriod);
        timer.scheduleAtFixedRate(task, delay, intevalPeriod);

        new Thread(new Runnable() {
            @Override
            public void run() {
                while (true) {
                    try {
                        Thread.sleep(60 * 1000);
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }
                    System.out.println("AccessCounts status:" + AccessCounts.getInstance().status());
                }
            }
        }).start();
    }
    
    /**
     *  从url中获取配置字符串
     */
    public static String sendGet(String url, String param) {
        String result = "";
        BufferedReader in = null;
        try {
            String urlNameString = url + (param == null ? "" : "?" + param);
            URL realUrl = new URL(urlNameString);
            // 打开和URL之间的连接
            URLConnection connection = realUrl.openConnection();
            // 设置通用的请求属性
            connection.setRequestProperty("accept", "*/*");
            connection.setRequestProperty("connection", "Keep-Alive");
            connection.setRequestProperty("user-agent", "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1)");
            // 建立实际的连接
            connection.connect();
            // 获取所有响应头字段
            /*
             * Map<String, List<String>> map = connection.getHeaderFields(); for
             * (String key : map.keySet()) { System.out.println(key + "--->" +
             * map.get(key)); }
             */
            // 定义 BufferedReader输入流来读取URL的响应
            in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
            String line;
            while ((line = in.readLine()) != null) {
                result += line;
            }
        } catch (Exception e) {
            logger.error("request url fail=" + url, e);
        }
        // 使用finally块来关闭输入流
        finally {
            try {
                if (in != null) {
                    in.close();
                }
            } catch (Exception e) {
            }
        }
        return result;
    }

}

xml配置:

    <mvc:interceptors>    
        <mvc:interceptor>    
            <mvc:mapping path="/**" />    
            <bean class="com.wedoctor.health.card.cloud.api.home.interceptor.InServiceAccessInterceptor" >    
                <constructor-arg index="0" value="5" /> <!-- defaultLimit 默认设置 -->    
                <constructor-arg index="1" value="http://localhost/web.limit" /> <!-- configUrl    -->    
                <constructor-arg index="2" value="60" /> <!-- loadInterval unit : second -->    
                <constructor-arg index="3" value="5" /> <!-- loadDelay unit : second -->    
                <constructor-arg index="4" value="true" /> <!-- valid  true: used -->    
            </bean>    
        </mvc:interceptor>    
    </mvc:interceptors>   

http://localhost/web.limit配置文件内容:

{"IndexController.index":500,
"ProductController.searchProducts":500
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,026评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,655评论 1 296
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,726评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,204评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,558评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,731评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,944评论 2 314
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,698评论 0 203
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,438评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,633评论 2 247
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,125评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,444评论 3 255
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,137评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,103评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,888评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,772评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,669评论 2 271

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,102评论 18 139
  • 接上文的聊聊高并发系统限流特技-1 原文来自开涛的博客,找不到第此原文链接了 接入层限流 接入层通常指请求流量的入...
    望月成三人阅读 3,886评论 0 4
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,368评论 6 343
  • 转载来自开涛的聊聊高并发系统限流特技-2 上一篇《聊聊高并发系统限流特技-1》讲了限流算法、应用级限流、分布式限流...
    meng_philip123阅读 4,073评论 0 10
  • 在我的人生中,我一直渴望有一个人 对我有着无条件的爱和包容 无论我表现如何 他都像一位智者 笑容轻松 又或者像一个...
    梁超文阅读 318评论 2 5