Sentinel-Go：1.Sentinel-Go的基本使用（一）流控规则

灰太狼 2023-01-13 11:59 148阅读 0赞

### 文章目录 ###

*  1.创建项目
 *   *  1.1 创建Go Modules项目，并设置代理
     *  1.2 创建下面目录结构以及代码
     *   *   *  \`【埋点】\`
     *  1.3 等待idea下载完成依赖库后，启动项目并访问
     *   *  本文示例源码：

# 1.创建项目 #

`建议使用idea编译器按照下面教程创建：`

## 1.1 创建Go Modules项目，并设置代理 ##

如果[https://goproxy.cn][https_goproxy.cn]不行，试试[https://goproxy.io][https_goproxy.io]

![image][]

## 1.2 创建下面目录结构以及代码 ##

*  sentinel-go-sample
    
     *  sentinel-go-sample-provider
        
         *  flow
            
             *  qps
                
                 *  qps\_limit\_example.go

qps\_limit\_example.go

package main
    
    import (
    	"fmt"
    	sentinel "github.com/alibaba/sentinel-golang/api"
    	"github.com/alibaba/sentinel-golang/core/base"
    	"github.com/alibaba/sentinel-golang/core/config"
    	"github.com/alibaba/sentinel-golang/core/flow"
    	"github.com/alibaba/sentinel-golang/logging"
    	"log"
    	"net/http"
    	"runtime"
    	"strings"
    )
    
    const testFlowRuleUrl = "/flow"
    
    func main() { 
    	initAll()
    }
    
    func initAll() { 
    	sentinelInit()
    	// 创建流控规则：资源名 sayHello 阈值 2 统计间隔 1000毫秒
    	createFlowRule("testFlowRule", 2, 1000)
    	httpInit()
    }
    
    // 初始化http，并注册接口
    func httpInit() { 
    	server := http.Server{ 
    		Addr: "127.0.0.1:8003",
    	}
    	http.HandleFunc(testFlowRuleUrl, testFlowRule)
    	server.ListenAndServe()
    }
    
    // 初始化Sentinel
    func sentinelInit() { 
    	// We should initialize Sentinel first.
    	conf := config.NewDefaultConfig()
    	// for testing, logging output to console
    	conf.Sentinel.Log.Logger = logging.NewConsoleLogger()
    	err := sentinel.InitWithConfig(conf)
    	if err != nil { 
    		log.Fatal(err)
    	}
    }
    
    // 接口1：测试流控规则
    func testFlowRule(w http.ResponseWriter, r *http.Request) { 
    	resourceName := runFuncName()
    	// 埋点（流控规则方式）
    	e, b := sentinel.Entry(resourceName, sentinel.WithTrafficType(base.Inbound))
    	if b != nil { 
    		fmt.Fprintf(w, "限流！！！")
    	} else { 
    		fmt.Fprintf(w, "测试流控规则~~~")
    		e.Exit()
    	}
    }
    
    // 创建流控规则（默认基于QPS）
    // threshold 阈值
    // interval 统计间隔（毫秒）
    func createFlowRule(resourceName string, threshold float64, interval uint32) { 
    	_, err := flow.LoadRules([]*flow.Rule{ 
    		{ 
    			Resource:               resourceName,
    			TokenCalculateStrategy: flow.Direct,
    			ControlBehavior:        flow.Reject,
    			Threshold:              threshold,
    			StatIntervalInMs:       interval,
    		},
    	})
    	if err != nil { 
    		log.Fatalf("Unexpected error: %+v", err)
    		return
    	}
    }
    
    // 获取正在运行的函数名
    func runFuncName() string { 
    	pc := make([]uintptr, 1)
    	runtime.Callers(2, pc)
    	totalFuncName := runtime.FuncForPC(pc[0]).Name()
    	names := strings.Split(totalFuncName, ".")
    	return names[len(names)-1]
    }

#### `【埋点】` ####

*  使用 Sentinel 的 Entry API 将业务逻辑封装起来，这一步称为“埋点”。每个埋点都有一个资源名称（resource），代表触发了这个资源的调用或访问。

// 埋点函数
    Entry(resource string, opts …Option) (base.SentinelEntry, base.BlockError)
    // 其中 resource 代表埋点资源名， opts 代表埋点配置。目前支持以下埋点配置：
    
    // 标记该埋点资源的流量类型，其中 Inbound 代表入口流量，Outbound 代表出口流量。若不指定，默认为 Outbound。
    WithTrafficType(entryType base.TrafficType)
    
    // 标记该埋点资源的分类
    WithResourceType(resourceType base.ResourceType)
    
    // 标记每次触发该埋点计为几次调用（可以理解为 batch count）。若不指定，默认为 1
    WithAcquireCount(acquireCount uint32)
    
    // 埋点携带的参数列表，为热点参数统计预留
    WithArgs(args …interface{ })

## 1.3 等待idea下载完成依赖库后，启动项目并访问 ##

a. 访问[http://localhost:8003/flow][http_localhost_8003_flow]，查看接口是否正常工作

![image][image 1]

b. 1秒内连续访问，测试一下流控规则是否生效

![image][image 2]

--------------------

### 本文示例源码： ###

[GitHub：WangYe8613/sentinel-go-sample][GitHub_WangYe8613_sentinel-go-sample]

\[commit id：b26f157417a673ab20324a2936ac48969164c14f\]

[https_goproxy.cn]: https://goproxy.cn
[https_goproxy.io]: https://goproxy.io
[image]: /images/20221022/2bd8d1ccf1ef432f9d0c38e292e398d7.png
[http_localhost_8003_flow]: http://localhost:8003/flow
[image 1]: /images/20221022/ad75b745bcb1494abe29f27706e92d67.png
[image 2]: /images/20221022/9b43a50c05bb4a818dfba7b01454d9ea.png
[GitHub_WangYe8613_sentinel-go-sample]: https://github.com/WangYe8613/sentinel-go-sample.git