periodlimit.html


<!DOCTYPE HTML>
<html lang="zh-hans" >
    <head>
        <meta charset="UTF-8">
        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
        <title>periodlimit · go-zero使用文档</title>
        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
        <meta name="description" content="">
        <meta name="generator" content="GitBook 3.2.3">
        <meta name="author" content="松妹子">
        
        
    <link rel="stylesheet" href="gitbook/style.css">

    
                <link rel="stylesheet" href="gitbook/gitbook-plugin-back-to-top-button/plugin.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-chapter-fold/chapter-fold.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-code/plugin.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-search-pro/search.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-splitter/splitter.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-tbfed-pagefooter/footer.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-flexible-alerts/style.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-page-toc-button/plugin.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-pageview-count/plugin.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-prism/prism-tomorrow.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
                
            
                <link rel="stylesheet" href="gitbook/gitbook-plugin-theme-comscore/test.css">
                
            
    <meta name="HandheldFriendly" content="true"/>
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-status-bar-style" content="black">
    <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
    <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">

    
    <link rel="next" href="tokenlimit.html" />
    
    
    <link rel="prev" href="redis-lock.html" />
    

    </head>
    <body>
        
<div class="book">
    <div class="book-summary">
        
            
<div id="book-search-input" role="search">
    <input type="text" placeholder="输入并搜索" />
</div>

            
                <nav role="navigation">
                

<ul class="summary">
    
    
        <li class="chapter " data-level="1.1" data-path="./">
            
                <a href="./">
            
                    
                    简介
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.2" data-path="about-us.html">
            
                <a href="about-us.html">
            
                    
                    关于我们
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.3" data-path="join-us.html">
            
                <a href="join-us.html">
            
                    
                    加入我们
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.4" data-path="concept-introduction.html">
            
                <a href="concept-introduction.html">
            
                    
                    概念介绍
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.5" data-path="quick-start.html">
            
                <a href="quick-start.html">
            
                    
                    快速开发
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.5.1" data-path="monolithic-service.html">
            
                <a href="monolithic-service.html">
            
                    
                    单体服务
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.5.2" data-path="micro-service.html">
            
                <a href="micro-service.html">
            
                    
                    微服务
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.6" data-path="framework-design.html">
            
                <a href="framework-design.html">
            
                    
                    框架设计
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.6.1" data-path="go-zero-design.html">
            
                <a href="go-zero-design.html">
            
                    
                    go-zero设计理念
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.6.2" data-path="go-zero-features.html">
            
                <a href="go-zero-features.html">
            
                    
                    go-zero特点
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.6.3" data-path="api-grammar.html">
            
                <a href="api-grammar.html">
            
                    
                    api语法介绍
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.6.4" data-path="api-dir.html">
            
                <a href="api-dir.html">
            
                    
                    api目录结构
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.6.5" data-path="rpc-dir.html">
            
                <a href="rpc-dir.html">
            
                    
                    rpc目录结构
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.7" data-path="project-dev.html">
            
                <a href="project-dev.html">
            
                    
                    项目开发
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.7.1" data-path="prepare.html">
            
                <a href="prepare.html">
            
                    
                    准备工作
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.7.1.1" data-path="golang-install.html">
            
                <a href="golang-install.html">
            
                    
                    golang安装
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.1.2" data-path="gomod-config.html">
            
                <a href="gomod-config.html">
            
                    
                    go modudle配置
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.1.3" data-path="goctl-install.html">
            
                <a href="goctl-install.html">
            
                    
                    goctl安装
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.1.4" data-path="protoc-install.html">
            
                <a href="protoc-install.html">
            
                    
                    protoc&protoc-gen-go安装
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.1.5" data-path="prepare-other.html">
            
                <a href="prepare-other.html">
            
                    
                    其他
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.7.2" data-path="dev-specification.html">
            
                <a href="dev-specification.html">
            
                    
                    开发规范
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.7.2.1" data-path="naming-spec.html">
            
                <a href="naming-spec.html">
            
                    
                    命名规范
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.2.2" data-path="route-naming-spec.html">
            
                <a href="route-naming-spec.html">
            
                    
                    路由规范
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.2.3" data-path="coding-spec.html">
            
                <a href="coding-spec.html">
            
                    
                    编码规范
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.7.3" data-path="dev-flow.html">
            
                <a href="dev-flow.html">
            
                    
                    开发流程
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.4" data-path="config-introduction.html">
            
                <a href="config-introduction.html">
            
                    
                    配置介绍
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.7.4.1" data-path="api-config.html">
            
                <a href="api-config.html">
            
                    
                    api配置
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.4.2" data-path="rpc-config.html">
            
                <a href="rpc-config.html">
            
                    
                    rpc配置
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.7.5" data-path="business-dev.html">
            
                <a href="business-dev.html">
            
                    
                    业务开发
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.7.5.1" data-path="service-design.html">
            
                <a href="service-design.html">
            
                    
                    目录拆分
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.5.2" data-path="model-gen.html">
            
                <a href="model-gen.html">
            
                    
                    model生成
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.5.3" data-path="api-coding.html">
            
                <a href="api-coding.html">
            
                    
                    api文件编写
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.5.4" data-path="business-coding.html">
            
                <a href="business-coding.html">
            
                    
                    业务编码
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.5.5" data-path="jwt.html">
            
                <a href="jwt.html">
            
                    
                    jwt鉴权
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.5.6" data-path="middleware.html">
            
                <a href="middleware.html">
            
                    
                    中间件使用
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.5.7" data-path="rpc-call.html">
            
                <a href="rpc-call.html">
            
                    
                    rpc服务编写与调用
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.5.8" data-path="error-handle.html">
            
                <a href="error-handle.html">
            
                    
                    错误处理
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.7.6" data-path="ci-cd.html">
            
                <a href="ci-cd.html">
            
                    
                    CI/CD
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.7" data-path="service-deployment.html">
            
                <a href="service-deployment.html">
            
                    
                    服务部署
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.8" data-path="log-collection.html">
            
                <a href="log-collection.html">
            
                    
                    日志收集
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.9" data-path="trace.html">
            
                <a href="trace.html">
            
                    
                    链路追踪
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.7.10" data-path="service-monitor.html">
            
                <a href="service-monitor.html">
            
                    
                    服务监控
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.8" data-path="goctl.html">
            
                <a href="goctl.html">
            
                    
                    Goctl
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.8.1" data-path="goctl-commands.html">
            
                <a href="goctl-commands.html">
            
                    
                    命令大全
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.8.2" data-path="goctl-api.html">
            
                <a href="goctl-api.html">
            
                    
                    api命令
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.8.3" data-path="goctl-rpc.html">
            
                <a href="goctl-rpc.html">
            
                    
                    rpc命令
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.8.4" data-path="goctl-model.html">
            
                <a href="goctl-model.html">
            
                    
                    model命令
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.8.5" data-path="goctl-plugin.html">
            
                <a href="goctl-plugin.html">
            
                    
                    plugin命令
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.8.6" data-path="goctl-other.html">
            
                <a href="goctl-other.html">
            
                    
                    其他命令
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.9" data-path="component-center.html">
            
                <a href="component-center.html">
            
                    
                    组件中心
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.9.1" data-path="logx.html">
            
                <a href="logx.html">
            
                    
                    logx
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.2" data-path="bloom.html">
            
                <a href="bloom.html">
            
                    
                    bloom
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.3" data-path="executors.html">
            
                <a href="executors.html">
            
                    
                    executors
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.4" data-path="fx.html">
            
                <a href="fx.html">
            
                    
                    fx
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.5" data-path="mysql.html">
            
                <a href="mysql.html">
            
                    
                    mysql
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.6" data-path="redis-lock.html">
            
                <a href="redis-lock.html">
            
                    
                    redis-lock
            
                </a>
            

        </li>
    
        <li class="chapter active" data-level="1.9.7" data-path="periodlimit.html">
            
                <a href="periodlimit.html">
            
                    
                    periodlimit
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.8" data-path="tokenlimit.html">
            
                <a href="tokenlimit.html">
            
                    
                    tokenlimit
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.9.9" data-path="timing-wheel.html">
            
                <a href="timing-wheel.html">
            
                    
                    TimingWheel
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.10" data-path="tool-center.html">
            
                <a href="tool-center.html">
            
                    
                    工具中心
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.10.1" data-path="intellij.html">
            
                <a href="intellij.html">
            
                    
                    intellij插件
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.10.2" data-path="vscode.html">
            
                <a href="vscode.html">
            
                    
                    vscode插件
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.11" data-path="plugin-center.html">
            
                <a href="plugin-center.html">
            
                    
                    插件中心
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.12" data-path="learning-resource.html">
            
                <a href="learning-resource.html">
            
                    
                    学习资源
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.12.1" data-path="wechat.html">
            
                <a href="wechat.html">
            
                    
                    公众号
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.12.2" data-path="goreading.html">
            
                <a href="goreading.html">
            
                    
                    Go夜读
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.12.3" data-path="gotalk.html">
            
                <a href="gotalk.html">
            
                    
                    Go开源说
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.13" data-path="practise.html">
            
                <a href="practise.html">
            
                    
                    开发实践
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.13.1" data-path="redis-cache.html">
            
                <a href="redis-cache.html">
            
                    
                    go-zero缓存设计之持久层缓存
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.13.2" data-path="buiness-cache.html">
            
                <a href="buiness-cache.html">
            
                    
                    go-zero缓存设计之业务层缓存
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.13.3" data-path="go-queue.html">
            
                <a href="go-queue.html">
            
                    
                    go-zero分布式定时任务
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.13.4" data-path="datacenter.html">
            
                <a href="datacenter.html">
            
                    
                    我是如何用go-zero 实现一个中台系统
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.13.5" data-path="stream.html">
            
                <a href="stream.html">
            
                    
                    流数据处理利器
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.13.6" data-path="online-exchange.html">
            
                <a href="online-exchange.html">
            
                    
                    10月3日线上交流问题汇总
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.14" data-path="dev-log.html">
            
                <a href="dev-log.html">
            
                    
                    开发日志
            
                </a>
            

            <ul class="articles">
                
    
        <li class="chapter " data-level="1.14.1" data-path="goctl-log.html">
            
                <a href="goctl-log.html">
            
                    
                    goctl开发日志
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.14.2" data-path="intellij-log.html">
            
                <a href="intellij-log.html">
            
                    
                    intellij开发日志
            
                </a>
            

        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.15" data-path="contributor.html">
            
                <a href="contributor.html">
            
                    
                    贡献人员
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.16" data-path="doc-contibute.html">
            
                <a href="doc-contibute.html">
            
                    
                    文档贡献
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.17" data-path="error.html">
            
                <a href="error.html">
            
                    
                    常见错误处理
            
                </a>
            

        </li>
    
        <li class="chapter " data-level="1.18" data-path="source.html">
            
                <a href="source.html">
            
                    
                    相关源码
            
                </a>
            

        </li>
    

    <li class="divider"></li>

    <li>
        <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
            本书使用 GitBook 发布
        </a>
    </li>
</ul>


                </nav>
            
        
    </div>

    <div class="book-body">
        
            <div class="body-inner">
                
                    
<div class="book-header" role="navigation">
    

    <!-- Title -->
    <h1>
        <i class="fa fa-circle-o-notch fa-spin"></i>
        <a href="." >periodlimit</a>
    </h1>
</div>


                    <div class="page-wrapper" tabindex="-1" role="main">
                        <div class="page-inner">
                            
<div id="book-search-results">
    <div class="search-noresults">
    
                                <section class="normal markdown-section">
                                
                                <h1 id="periodlimit">periodlimit</h1>
<p>&#x4E0D;&#x7BA1;&#x662F;&#x5728;&#x5355;&#x4F53;&#x670D;&#x52A1;&#x4E2D;&#x8FD8;&#x662F;&#x5728;&#x5FAE;&#x670D;&#x52A1;&#x4E2D;&#xFF0C;&#x5F00;&#x53D1;&#x8005;&#x4E3A;&#x524D;&#x7AEF;&#x63D0;&#x4F9B;&#x7684;API&#x63A5;&#x53E3;&#x90FD;&#x662F;&#x6709;&#x8BBF;&#x95EE;&#x4E0A;&#x9650;&#x7684;&#xFF0C;&#x5F53;&#x8BBF;&#x95EE;&#x9891;&#x7387;&#x6216;&#x8005;&#x5E76;&#x53D1;&#x91CF;&#x8D85;&#x8FC7;&#x5176;&#x627F;&#x53D7;&#x8303;&#x56F4;&#x65F6;&#x5019;&#xFF0C;&#x6211;&#x4EEC;&#x5C31;&#x5FC5;&#x987B;&#x8003;&#x8651;&#x9650;&#x6D41;&#x6765;&#x4FDD;&#x8BC1;&#x63A5;&#x53E3;&#x7684;&#x53EF;&#x7528;&#x6027;&#x6216;&#x8005;&#x964D;&#x7EA7;&#x53EF;&#x7528;&#x6027;&#x3002;&#x5373;&#x63A5;&#x53E3;&#x4E5F;&#x9700;&#x8981;&#x5B89;&#x88C5;&#x4E0A;&#x4FDD;&#x9669;&#x4E1D;&#xFF0C;&#x4EE5;&#x9632;&#x6B62;&#x975E;&#x9884;&#x671F;&#x7684;&#x8BF7;&#x6C42;&#x5BF9;&#x7CFB;&#x7EDF;&#x538B;&#x529B;&#x8FC7;&#x5927;&#x800C;&#x5F15;&#x8D77;&#x7684;&#x7CFB;&#x7EDF;&#x762B;&#x75EA;&#x3002;</p>
<p>&#x672C;&#x6587;&#x5C31;&#x6765;&#x4ECB;&#x7ECD;&#x4E00;&#x4E0B; <code>periodlimit</code> &#x3002;</p>
<h2 id="&#x4F7F;&#x7528;">&#x4F7F;&#x7528;</h2>
<pre class="language-"><code class="lang-go"><span class="token keyword">const</span> <span class="token punctuation">(</span>
    seconds <span class="token operator">=</span> <span class="token number">1</span>
    total   <span class="token operator">=</span> <span class="token number">100</span>
    quota   <span class="token operator">=</span> <span class="token number">5</span>
<span class="token punctuation">)</span>
<span class="token comment">// New limiter</span>
l <span class="token operator">:=</span> <span class="token function">NewPeriodLimit</span><span class="token punctuation">(</span>seconds<span class="token punctuation">,</span> quota<span class="token punctuation">,</span> redis<span class="token punctuation">.</span><span class="token function">NewRedis</span><span class="token punctuation">(</span>s<span class="token punctuation">.</span><span class="token function">Addr</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> redis<span class="token punctuation">.</span>NodeType<span class="token punctuation">)</span><span class="token punctuation">,</span> <span class="token string">&quot;periodlimit&quot;</span><span class="token punctuation">)</span>

<span class="token comment">// take source</span>
code<span class="token punctuation">,</span> err <span class="token operator">:=</span> l<span class="token punctuation">.</span><span class="token function">Take</span><span class="token punctuation">(</span><span class="token string">&quot;first&quot;</span><span class="token punctuation">)</span>
<span class="token keyword">if</span> err <span class="token operator">!=</span> <span class="token boolean">nil</span> <span class="token punctuation">{</span>
    logx<span class="token punctuation">.</span><span class="token function">Error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span>
    <span class="token keyword">return</span> <span class="token boolean">true</span>
<span class="token punctuation">}</span>

<span class="token comment">// switch val =&gt; process request</span>
<span class="token keyword">switch</span> code <span class="token punctuation">{</span>
    <span class="token keyword">case</span> limit<span class="token punctuation">.</span>OverQuota<span class="token punctuation">:</span>
        logx<span class="token punctuation">.</span><span class="token function">Errorf</span><span class="token punctuation">(</span><span class="token string">&quot;OverQuota key: %v&quot;</span><span class="token punctuation">,</span> key<span class="token punctuation">)</span>
        <span class="token keyword">return</span> <span class="token boolean">false</span>
    <span class="token keyword">case</span> limit<span class="token punctuation">.</span>Allowed<span class="token punctuation">:</span>
        logx<span class="token punctuation">.</span><span class="token function">Infof</span><span class="token punctuation">(</span><span class="token string">&quot;AllowedQuota key: %v&quot;</span><span class="token punctuation">,</span> key<span class="token punctuation">)</span>
        <span class="token keyword">return</span> <span class="token boolean">true</span>
    <span class="token keyword">case</span> limit<span class="token punctuation">.</span>HitQuota<span class="token punctuation">:</span>
        logx<span class="token punctuation">.</span><span class="token function">Errorf</span><span class="token punctuation">(</span><span class="token string">&quot;HitQuota key: %v&quot;</span><span class="token punctuation">,</span> key<span class="token punctuation">)</span>
        <span class="token comment">// todo: maybe we need to let users know they hit the quota</span>
        <span class="token keyword">return</span> <span class="token boolean">false</span>
    <span class="token keyword">default</span><span class="token punctuation">:</span>
        logx<span class="token punctuation">.</span><span class="token function">Errorf</span><span class="token punctuation">(</span><span class="token string">&quot;DefaultQuota key: %v&quot;</span><span class="token punctuation">,</span> key<span class="token punctuation">)</span>
        <span class="token comment">// unknown response, we just let the sms go</span>
        <span class="token keyword">return</span> <span class="token boolean">true</span>
<span class="token punctuation">}</span>
</code></pre>
<h2 id="periodlimit">periodlimit</h2>
<p><code>go-zero</code> &#x91C7;&#x53D6; <strong>&#x6ED1;&#x52A8;&#x7A97;&#x53E3;</strong> &#x8BA1;&#x6570;&#x7684;&#x65B9;&#x5F0F;&#xFF0C;&#x8BA1;&#x7B97;&#x4E00;&#x6BB5;&#x65F6;&#x95F4;&#x5185;&#x5BF9;&#x540C;&#x4E00;&#x4E2A;&#x8D44;&#x6E90;&#x7684;&#x8BBF;&#x95EE;&#x6B21;&#x6570;&#xFF0C;&#x5982;&#x679C;&#x8D85;&#x8FC7;&#x6307;&#x5B9A;&#x7684; <code>limit</code> &#xFF0C;&#x5219;&#x62D2;&#x7EDD;&#x8BBF;&#x95EE;&#x3002;&#x5F53;&#x7136;&#x5982;&#x679C;&#x4F60;&#x662F;&#x5728;&#x4E00;&#x6BB5;&#x65F6;&#x95F4;&#x5185;&#x8BBF;&#x95EE;&#x4E0D;&#x540C;&#x7684;&#x8D44;&#x6E90;&#xFF0C;&#x6BCF;&#x4E00;&#x4E2A;&#x8D44;&#x6E90;&#x8BBF;&#x95EE;&#x91CF;&#x90FD;&#x4E0D;&#x8D85;&#x8FC7; <code>limit</code> &#xFF0C;&#x6B64;&#x79CD;&#x60C5;&#x51B5;&#x662F;&#x5141;&#x8BB8;&#x5927;&#x91CF;&#x8BF7;&#x6C42;&#x8FDB;&#x6765;&#x7684;&#x3002;</p>
<p>&#x800C;&#x5728;&#x4E00;&#x4E2A;&#x5206;&#x5E03;&#x5F0F;&#x7CFB;&#x7EDF;&#x4E2D;&#xFF0C;&#x5B58;&#x5728;&#x591A;&#x4E2A;&#x5FAE;&#x670D;&#x52A1;&#x63D0;&#x4F9B;&#x670D;&#x52A1;&#x3002;&#x6240;&#x4EE5;&#x5F53;&#x77AC;&#x95F4;&#x7684;&#x6D41;&#x91CF;&#x540C;&#x65F6;&#x8BBF;&#x95EE;&#x540C;&#x4E00;&#x4E2A;&#x8D44;&#x6E90;&#xFF0C;&#x5982;&#x4F55;&#x8BA9;&#x8BA1;&#x6570;&#x5668;&#x5728;&#x5206;&#x5E03;&#x5F0F;&#x7CFB;&#x7EDF;&#x4E2D;&#x6B63;&#x5E38;&#x8BA1;&#x6570;&#xFF1F; &#x540C;&#x65F6;&#x5728;&#x8BA1;&#x7B97;&#x8D44;&#x6E90;&#x8BBF;&#x95EE;&#x65F6;&#xFF0C;&#x53EF;&#x80FD;&#x4F1A;&#x6D89;&#x53CA;&#x591A;&#x4E2A;&#x8BA1;&#x7B97;&#xFF0C;&#x5982;&#x4F55;&#x4FDD;&#x8BC1;&#x8BA1;&#x7B97;&#x7684;&#x539F;&#x5B50;&#x6027;&#xFF1F;</p>
<ul>
<li><code>go-zero</code> &#x501F;&#x52A9; <code>redis</code> &#x7684; <code>incrby</code> &#x505A;&#x8D44;&#x6E90;&#x8BBF;&#x95EE;&#x8BA1;&#x6570;</li>
<li>&#x91C7;&#x7528; <code>lua script</code> &#x505A;&#x6574;&#x4E2A;&#x7A97;&#x53E3;&#x8BA1;&#x7B97;&#xFF0C;&#x4FDD;&#x8BC1;&#x8BA1;&#x7B97;&#x7684;&#x539F;&#x5B50;&#x6027;</li>
</ul>
<p>&#x4E0B;&#x9762;&#x6765;&#x770B;&#x770B; <code>lua script</code> &#x63A7;&#x5236;&#x7684;&#x51E0;&#x4E2A;&#x5173;&#x952E;&#x5C5E;&#x6027;&#xFF1A;</p>
<table>
<thead>
<tr>
<th><strong>argument</strong></th>
<th><strong>mean</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>key[1]</td>
<td>&#x8BBF;&#x95EE;&#x8D44;&#x6E90;&#x7684;&#x6807;&#x793A;</td>
</tr>
<tr>
<td>ARGV[1]</td>
<td>limit =&gt; &#x8BF7;&#x6C42;&#x603B;&#x6570;&#xFF0C;&#x8D85;&#x8FC7;&#x5219;&#x9650;&#x901F;&#x3002;&#x53EF;&#x8BBE;&#x7F6E;&#x4E3A; QPS</td>
</tr>
<tr>
<td>ARGV[2]</td>
<td>window&#x5927;&#x5C0F; =&gt; &#x6ED1;&#x52A8;&#x7A97;&#x53E3;&#xFF0C;&#x7528; ttl &#x6A21;&#x62DF;&#x51FA;&#x6ED1;&#x52A8;&#x7684;&#x6548;&#x679C;</td>
</tr>
</tbody>
</table>
<pre class="language-"><code class="lang-lua"><span class="token comment">-- to be compatible with aliyun redis, </span>
<span class="token comment">-- we cannot use `local key = KEYS[1]` to reuse thekey</span>
<span class="token keyword">local</span> limit <span class="token operator">=</span> <span class="token function">tonumber</span><span class="token punctuation">(</span>ARGV<span class="token punctuation">[</span><span class="token number">1</span><span class="token punctuation">]</span><span class="token punctuation">)</span>
<span class="token keyword">local</span> window <span class="token operator">=</span> <span class="token function">tonumber</span><span class="token punctuation">(</span>ARGV<span class="token punctuation">[</span><span class="token number">2</span><span class="token punctuation">]</span><span class="token punctuation">)</span>
<span class="token comment">-- incrbt key 1 =&gt; key visis++</span>
<span class="token keyword">local</span> current <span class="token operator">=</span> redis<span class="token punctuation">.</span><span class="token function">call</span><span class="token punctuation">(</span><span class="token string">&quot;INCRBY&quot;</span><span class="token punctuation">,</span> KEYS<span class="token punctuation">[</span><span class="token number">1</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token number">1</span><span class="token punctuation">)</span>
<span class="token comment">-- &#x5982;&#x679C;&#x662F;&#x7B2C;&#x4E00;&#x6B21;&#x8BBF;&#x95EE;&#xFF0C;&#x8BBE;&#x7F6E;&#x8FC7;&#x671F;&#x65F6;&#x95F4; =&gt; TTL = window size</span>
<span class="token comment">-- &#x56E0;&#x4E3A;&#x662F;&#x53EA;&#x9650;&#x5236;&#x4E00;&#x6BB5;&#x65F6;&#x95F4;&#x7684;&#x8BBF;&#x95EE;&#x6B21;&#x6570;</span>
<span class="token keyword">if</span> current <span class="token operator">==</span> <span class="token number">1</span> <span class="token keyword">then</span>
    redis<span class="token punctuation">.</span><span class="token function">call</span><span class="token punctuation">(</span><span class="token string">&quot;expire&quot;</span><span class="token punctuation">,</span> KEYS<span class="token punctuation">[</span><span class="token number">1</span><span class="token punctuation">]</span><span class="token punctuation">,</span> window<span class="token punctuation">)</span>
    <span class="token keyword">return</span> <span class="token number">1</span>
<span class="token keyword">elseif</span> current <span class="token operator">&lt;</span> limit <span class="token keyword">then</span>
    <span class="token keyword">return</span> <span class="token number">1</span>
<span class="token keyword">elseif</span> current <span class="token operator">==</span> limit <span class="token keyword">then</span>
    <span class="token keyword">return</span> <span class="token number">2</span>
<span class="token keyword">else</span>
    <span class="token keyword">return</span> <span class="token number">0</span>
<span class="token keyword">end</span>
</code></pre>
<p>&#x81F3;&#x4E8E;&#x4E0A;&#x8FF0;&#x7684; <code>return code</code> &#xFF0C;&#x8FD4;&#x56DE;&#x7ED9;&#x8C03;&#x7528;&#x65B9;&#x3002;&#x7531;&#x8C03;&#x7528;&#x65B9;&#x6765;&#x51B3;&#x5B9A;&#x8BF7;&#x6C42;&#x540E;&#x7EED;&#x7684;&#x64CD;&#x4F5C;&#xFF1A;</p>
<table>
<thead>
<tr>
<th><strong>return code</strong></th>
<th><strong>tag</strong></th>
<th>call code</th>
<th><strong>mean</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>0</td>
<td>OverQuota</td>
<td>3</td>
<td><strong>over limit</strong></td>
</tr>
<tr>
<td>1</td>
<td>Allowed</td>
<td>1</td>
<td><strong>in limit</strong></td>
</tr>
<tr>
<td>2</td>
<td>HitQuota</td>
<td>2</td>
<td><strong>hit limit</strong></td>
</tr>
</tbody>
</table>
<p>&#x4E0B;&#x9762;&#x8FD9;&#x5F20;&#x56FE;&#x63CF;&#x8FF0;&#x4E86;&#x8BF7;&#x6C42;&#x8FDB;&#x5165;&#x7684;&#x8FC7;&#x7A0B;&#xFF0C;&#x4EE5;&#x53CA;&#x8BF7;&#x6C42;&#x89E6;&#x53D1; <code>limit</code> &#x65F6;&#x540E;&#x7EED;&#x53D1;&#x751F;&#x7684;&#x60C5;&#x51B5;&#xFF1A;
<img src="https://cdn.nlark.com/yuque/0/2020/png/261626/1605430483430-92415ed3-e88f-487d-8fd6-8c58a9abe334.png#align=left&amp;display=inline&amp;height=524&amp;margin=%5Bobject%20Object%5D&amp;name=image.png&amp;originHeight=524&amp;originWidth=1051&amp;size=90836&amp;status=done&amp;style=none&amp;width=1051" alt="image.png">
<img src="https://cdn.nlark.com/yuque/0/2020/png/261626/1605495120249-f6b05ac2-7090-47b0-a3c0-da50df6206dd.png#align=left&amp;display=inline&amp;height=557&amp;margin=%5Bobject%20Object%5D&amp;name=image.png&amp;originHeight=557&amp;originWidth=456&amp;size=53785&amp;status=done&amp;style=none&amp;width=456" alt="image.png"></p>
<h2 id="&#x540E;&#x7EED;&#x5904;&#x7406;">&#x540E;&#x7EED;&#x5904;&#x7406;</h2>
<p>&#x5982;&#x679C;&#x5728;&#x670D;&#x52A1;&#x67D0;&#x4E2A;&#x65F6;&#x95F4;&#x70B9;&#xFF0C;&#x8BF7;&#x6C42;&#x5927;&#x6279;&#x91CF;&#x6253;&#x8FDB;&#x6765;&#xFF0C;<code>periodlimit</code> &#x77ED;&#x671F;&#x65F6;&#x95F4;&#x5185;&#x8FBE;&#x5230; <code>limit</code> &#x9608;&#x503C;&#xFF0C;&#x800C;&#x4E14;&#x8BBE;&#x7F6E;&#x7684;&#x65F6;&#x95F4;&#x8303;&#x56F4;&#x8FD8;&#x8FDC;&#x8FDC;&#x6CA1;&#x6709;&#x5230;&#x8FBE;&#x3002;&#x540E;&#x7EED;&#x8BF7;&#x6C42;&#x7684;&#x5904;&#x7406;&#x5C31;&#x6210;&#x4E3A;&#x95EE;&#x9898;&#x3002;</p>
<p><code>periodlimit</code> &#x4E2D;&#x5E76;&#x6CA1;&#x6709;&#x5904;&#x7406;&#xFF0C;&#x800C;&#x662F;&#x8FD4;&#x56DE; <code>code</code> &#x3002;&#x628A;&#x540E;&#x7EED;&#x8BF7;&#x6C42;&#x7684;&#x5904;&#x7406;&#x4EA4;&#x7ED9;&#x4E86;&#x5F00;&#x53D1;&#x8005;&#x81EA;&#x5DF1;&#x5904;&#x7406;&#x3002;</p>
<ol>
<li>&#x5982;&#x679C;&#x4E0D;&#x505A;&#x5904;&#x7406;&#xFF0C;&#x90A3;&#x5C31;&#x662F;&#x7B80;&#x5355;&#x7684;&#x5C06;&#x8BF7;&#x6C42;&#x62D2;&#x7EDD;</li>
<li>&#x5982;&#x679C;&#x9700;&#x8981;&#x5904;&#x7406;&#x8FD9;&#x4E9B;&#x8BF7;&#x6C42;&#xFF0C;&#x5F00;&#x53D1;&#x8005;&#x53EF;&#x4EE5;&#x501F;&#x52A9; <code>mq</code> &#x5C06;&#x8BF7;&#x6C42;&#x7F13;&#x51B2;&#xFF0C;&#x51CF;&#x7F13;&#x8BF7;&#x6C42;&#x7684;&#x538B;&#x529B;</li>
<li>&#x91C7;&#x7528; <code>tokenlimit</code>&#xFF0C;&#x5141;&#x8BB8;&#x6682;&#x65F6;&#x7684;&#x6D41;&#x91CF;&#x51B2;&#x51FB;</li>
</ol>
<p>&#x6240;&#x4EE5;&#x4E0B;&#x4E00;&#x7BC7;&#x6211;&#x4EEC;&#x5C31;&#x6765;&#x804A;&#x804A; <code>tokenlimit</code></p>
<h2 id="&#x603B;&#x7ED3;">&#x603B;&#x7ED3;</h2>
<p><code>go-zero</code> &#x4E2D;&#x7684; <code>periodlimit</code> &#x9650;&#x6D41;&#x65B9;&#x6848;&#x662F;&#x57FA;&#x4E8E; <code>redis</code> &#x8BA1;&#x6570;&#x5668;&#xFF0C;&#x901A;&#x8FC7;&#x8C03;&#x7528; <code>redis lua script</code> &#xFF0C;&#x4FDD;&#x8BC1;&#x8BA1;&#x6570;&#x8FC7;&#x7A0B;&#x7684;&#x539F;&#x5B50;&#x6027;&#xFF0C;&#x540C;&#x65F6;&#x4FDD;&#x8BC1;&#x5728;&#x5206;&#x5E03;&#x5F0F;&#x7684;&#x60C5;&#x51B5;&#x4E0B;&#x8BA1;&#x6570;&#x662F;&#x6B63;&#x5E38;&#x7684;&#x3002;&#x4F46;&#x662F;&#x8FD9;&#x79CD;&#x65B9;&#x6848;&#x5B58;&#x5728;&#x7F3A;&#x70B9;&#xFF0C;&#x56E0;&#x4E3A;&#x5B83;&#x8981;&#x8BB0;&#x5F55;&#x65F6;&#x95F4;&#x7A97;&#x53E3;&#x5185;&#x7684;&#x6240;&#x6709;&#x884C;&#x4E3A;&#x8BB0;&#x5F55;&#xFF0C;&#x5982;&#x679C;&#x8FD9;&#x4E2A;&#x91CF;&#x7279;&#x522B;&#x5927;&#x7684;&#x65F6;&#x5019;&#xFF0C;&#x5185;&#x5B58;&#x6D88;&#x8017;&#x4F1A;&#x53D8;&#x5F97;&#x975E;&#x5E38;&#x4E25;&#x91CD;&#x3002;</p>
<h2 id="&#x53C2;&#x8003;">&#x53C2;&#x8003;</h2>
<ul>
<li><a href="https://github.com/tal-tech/go-zero/blob/master/core/limit/periodlimit.go" target="_blank">go-zero periodlimit</a></li>
<li><a href="https://www.infoq.cn/article/Qg2tX8fyw5Vt-f3HH673" target="_blank">&#x5206;&#x5E03;&#x5F0F;&#x670D;&#x52A1;&#x9650;&#x6D41;&#x5B9E;&#x6218;&#xFF0C;&#x5DF2;&#x7ECF;&#x4E3A;&#x4F60;&#x6392;&#x597D;&#x5751;&#x4E86;</a></li>
<li><a href="tokenlimit.html">tokenlimit</a></li>
</ul>
<p><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/gitalk@1/dist/gitalk.css"></p>
<script src="./javascript/gitalk.js"></script>
<div id="gitalk-container"></div>
<script>
var gitalk = new Gitalk({
  "clientID": "b9f61eecd453fb93cefc",
  "clientSecret": "8e70a3944fa689c13136aa56ea5bfb9945802bd2",
  "repo": "go-zero-doc",
  "owner": "zeromicro",
  "admin": ["anqiansong"],
  "id": window.location.pathname,      
  "distractionFreeMode": false  
});
gitalk.render("gitalk-container");
</script>


<footer class="page-footer"><span class="copyright">Copyright &#xA9; 2019-2021 go-zero all right reserved&#xFF0C;powered by Gitbook</span><span class="footer-modification">&#x6700;&#x540E;&#x66F4;&#x65B0;&#x65F6;&#x95F4;&#xFF1A;
2021-04-10 07:21:07
</span></footer>
<script>console.log("plugin-popup....");document.onclick = function(e){ e.target.tagName === "IMG" && window.open(e.target.src,e.target.src)}</script><style>img{cursor:pointer}</style>
                                
                                </section>
                            
    </div>
    <div class="search-results">
        <div class="has-results">
            
            <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
            <ul class="search-results-list"></ul>
            
        </div>
        <div class="no-results">
            
            <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
            
        </div>
    </div>
</div>

                        </div>
                    </div>
                
            </div>

            
                <a href="redis-lock.html" class="navigation navigation-prev " aria-label="Previous page: redis-lock">
                    <i class="fa fa-angle-left"></i>
                </a>
                
                
                <a href="tokenlimit.html" class="navigation navigation-next " aria-label="Next page: tokenlimit">
                    <i class="fa fa-angle-right"></i>
                </a>
                
            
    </div>

    <script>
        var gitbook = gitbook || [];
        gitbook.push(function() {
            gitbook.page.hasChanged({"page":{"title":"periodlimit","level":"1.9.7","depth":2,"next":{"title":"tokenlimit","level":"1.9.8","depth":2,"path":"tokenlimit.md","ref":"tokenlimit.md","articles":[]},"previous":{"title":"redis-lock","level":"1.9.6","depth":2,"path":"redis-lock.md","ref":"redis-lock.md","articles":[]},"dir":"ltr"},"config":{"plugins":["back-to-top-button","chapter-fold","code","-lunr","-search","search-pro","github","splitter","-sharing","sharing-plus","tbfed-pagefooter","flexible-alerts","page-toc-button","pageview-count","popup","hide-element","edit-link","-highlight","prism","theme-comscore"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"tbfed-pagefooter":{"copyright":"Copyright © 2019-2021 go-zero","modify_label":"最后更新时间：","modify_format":"YYYY-MM-DD HH:mm:ss"},"chapter-fold":{},"prism":{"lang":{"shell":"bash"},"css":["prismjs/themes/prism-tomorrow.css"]},"github":{"url":"https://github.com/tal-tech/go-zero"},"splitter":{},"search-pro":{},"sharing-plus":{"qq":false,"all":["facebook","google","twitter","instapaper","linkedin","pocket","stumbleupon"],"douban":false,"facebook":true,"weibo":false,"instapaper":false,"whatsapp":false,"hatenaBookmark":false,"twitter":true,"messenger":false,"line":false,"vk":false,"pocket":true,"google":false,"viber":false,"stumbleupon":false,"qzone":false,"linkedin":false},"popup":{},"code":{"copyButtons":true},"hide-element":{"elements":[".gitbook-link"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-comscore":{},"page-toc-button":{"maxTocDepth":2,"minTocSize":2},"back-to-top-button":{},"pageview-count":{},"flexible-alerts":{"danger":{"className":"danger","icon":"fa fa-ban","label":"Attention"},"note":{"className":"info","icon":"fa fa-info-circle","label":"Note"},"style":"callout","tip":{"className":"tip","icon":"fa fa-lightbulb-o","label":"Tip"},"warning":{"className":"warning","icon":"fa fa-exclamation-triangle","label":"Warning"}},"sharing":{"qq":false,"all":["douban","facebook","google","linkedin","twitter","weibo","qq","qzone","weibo"],"douban":false,"facebook":false,"weibo":true,"instapaper":false,"whatsapp":false,"hatenaBookmark":false,"twitter":false,"messenger":false,"line":true,"vk":false,"pocket":false,"google":true,"viber":false,"stumbleupon":false,"qzone":true,"linkedin":true},"edit-link":{"label":"编辑此页","base":"https://github.com/zeromicro/go-zero-doc/blob/master"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","author":"松妹子","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"go-zero使用文档","language":"zh-hans","gitbook":"3.2.3"},"file":{"path":"periodlimit.md","mtime":"2021-04-10T07:21:07.996Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2021-04-10T07:22:08.598Z"},"basePath":".","book":{"language":""}});
        });
    </script>
</div>

        
    <script src="gitbook/gitbook.js"></script>
    <script src="gitbook/theme.js"></script>
    
        
        <script src="gitbook/gitbook-plugin-back-to-top-button/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-chapter-fold/chapter-fold.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-code/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-search-pro/jquery.mark.min.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-search-pro/search.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-github/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-splitter/splitter.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-sharing-plus/buttons.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-flexible-alerts/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-page-toc-button/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-pageview-count/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-hide-element/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-edit-link/plugin.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
        
    
        <script src="gitbook/gitbook-plugin-theme-comscore/test.js"></script>
        
    
    </body>
</html>