v1.0.4 (#20)

* perf(version): 修改 useragent 信息，并增加新版本的 readme 说明

* perf(sample): 遵循阿里云规范，通过环境变量设置 ak、sk

* revert(dependency): go.mod 版本回退

* ci(gitignore): add pkg ignore

1. add pkg to .gitignore

* doc(readme): 修改 README.md

* doc(changelog): 修改 CHANGELOG.md，增加 1.0.3 版本更新的说明

* doc(format): md 文件不用引用格式

* feat(client): MNSClient 支持传入 fasthttp 的 maxConnsPerHost

* docs(changelog): 补充上次改动的 changelog

* docs(changelog): 更新 1.0.4 版本的 changelog

---------

Co-authored-by: Asassi <[email protected]>

Author: Kayne666

.gitignore

@@ -23,3 +23,5 @@ _testmain.go
 *.exe
 *.test
 *.prof
+
+pkg/

CHANGELOG.md

@@ -0,0 +1,19 @@
+# Change log
+
+## 1.0.4
+- add version and platform information to the user agent
+- following Alibaba standards, provide new recommended methods for creating MNS client, and update the example code
+- support custom maxConnsPerHost value for the client.
+
+## 1.0.3
+
+- support custom transport configuration
+
+## 1.0.2
+
+- support OpenService API
+
+## 1.0.1
+
+- support setting timeout
+- add request id to response

README-CN.md

@@ -0,0 +1,40 @@
+# Aliyun MNS Go SDK
+
+[![Github version](https://badgen.net/badge/color/1.0.3/green?label=version)](https://badgen.net/badge/color/1.0.3/green?label=version)
+
+Aliyun MNS Go SDK 是 MNS 在 Go 编译语言的官方 SDK
+
+## [Readme in English](README.md)
+
+## [Change Log](CHANGELOG.md)
+
+## 关于
+
+- 此 Go SDK 基于[阿里云消息服务 MNS](https://www.aliyun.com/product/mns/) 官方 API 构建
+- 阿里云消息服务（Message Service，简称 MNS）是一种高效、可靠、安全、便捷、可弹性扩展的分布式消息服务
+- MNS 能够帮助应用开发者在他们应用的分布式组件上自由的传递数据、通知消息，构建松耦合系统
+- 使用此 SDK，用户可以快速构建高可靠、高并发的一对一消费模型和一对多的发布订阅模型
+
+## 运行环境
+
+- Go 1.18 及以上
+
+## 安装方法
+
+- 执行命令 `go get github.com/aliyun/aliyun-mns-go-sdk` 获取远程代码包
+- 在您的代码中通过 `import "github.com/aliyun/aliyun-mns-go-sdk"` 引入 MNS Go SDK
+
+## 快速使用
+
+- 下载最新版 Go SDK，进入 example 目录
+- 修改 endpoint 为您自己的接入点，可登录 [MNS 控制台](https://mns.console.aliyun.com/)
+  查看，具体操作，请参考[获取接入点](https://help.aliyun.com/zh/mns/user-guide/manage-queues-in-the-console?spm=a2c4g.11186623.0.i25#section-yhc-ix5-300)
+- 在环境变量中设置您的 `ALIBABA_CLOUD_ACCESS_KEY_ID` 和
+  `ALIBABA_CLOUD_ACCESS_KEY_SECRET`，阿里云身份验证信息在 [RAM 控制台](https://ram.console.aliyun.com/)
+  创建。获取方式请参考[获取 AccessKey](https://help.aliyun.com/document_detail/53045.html?spm=a2c4g.11186623.0.i29#task-354412)
+- 根据阿里云规范，您应该将 AK SK
+  信息设置为环境变量使用，请参考[设置环境变量](https://help.aliyun.com/zh/sdk/developer-reference/configure-the-alibaba-cloud-accesskey-environment-variable-on-linux-macos-and-windows-systems)
+
+## 许可协议
+
+- Apache-2.0 请参阅[许可文件](LICENSE)

README.md

@@ -1,7 +1,50 @@
-# MNS GO SDK
-1.0.2
-  - support OpenService API
+# Aliyun MNS Go SDK
+
+[![Github version](https://badgen.net/badge/color/1.0.3/green?label=version)](https://badgen.net/badge/color/1.0.3/green?label=version)
+
+The Aliyun MNS Go SDK is the official SDK for MNS in the Go programming language
+
+## [Readme in Simplified Chinese](README-CN.md)
+
+## [Change Log](CHANGELOG.md)
+
+## About
+
+- This Go SDK is built on the official API
+  of [Alibaba Cloud Message Service (MNS)](https://www.aliyun.com/product/mns/)
+- Alibaba Cloud Message Service (MNS) is an efficient, reliable, secure, convenient, and elastically scalable
+  distributed messaging service
+- MNS enables application developers to freely transmit data and notification messages across the distributed
+  components of their applications, building loosely coupled systems
+- Using this SDK, users can quickly build highly reliable and concurrent one-to-one consumption models as well as
+  one-to-many publish-subscribe models
+
+## Running Environment
+
+- Go 1.18 or above
+
+## Installing
+
+- Run the`go get github.com/aliyun/aliyun-mns-go-sdk` command to get the remote code package.
+- Use `import "github.com/aliyun/aliyun-mns-go-sdk"` in your code to introduce MNS Go SDK package
+
+## Getting Start
+
+- Download the latest version of the Go SDK and enter the example directory
+- Modify 'endpoint' to your own access point, which can be viewed by logging into
+  the [MNS console](https://mns.console.aliyun.com/). For more detail,
+  see [How to get endpoint](https://help.aliyun.com/zh/mns/user-guide/manage-queues-in-the-console?spm=a2c4g.11186623.0.i25#section-yhc-ix5-300)
+- Set your `ALIBABA_CLOUD_ACCESS_KEY_ID` and
+  `ALIBABA_CLOUD_ACCESS_KEY_SECRET` in the environment variables, Alibaba Cloud authentication information can be
+  created in the [RAM console](https://ram.console.aliyun.com/).
+  For more detail,
+  see [How to get AccessKey](https://help.aliyun.com/document_detail/53045.html?spm=a2c4g.11186623.0.i29#task-354412)
+- Follow the Alibaba Cloud standards and set the AK (Access Key) and SK (Secret Key) in the environment variables. For
+  more details,
+  see [How to set environment variables](https://help.aliyun.com/zh/sdk/developer-reference/configure-the-alibaba-cloud-accesskey-environment-variable-on-linux-macos-and-windows-systems)
+
+## License
+
+- Apache-2.0 see [license file](LICENSE)
+
 
-1.0.1
-  - support setting timeout
-  - add request id to response

client.go

@@ -9,6 +9,7 @@ import (
 	"net/http"
 	neturl "net/url"
 	"os"
+	"runtime"
 	"strings"
 	"sync"
 	"time"
@@ -24,16 +25,21 @@ const (
 )
 
 const (
-	GLOBAL_PROXY = "MNS_GLOBAL_PROXY"
+	GlobalProxy = "MNS_GLOBAL_PROXY"
 )
 
 const (
 	version = "2015-06-06"
 )
 
 const (
-	ClientName           = "mns-go-sdk/1.0.2(fasthttp)"
-	DefaultTimeout int64 = 35
+	DefaultTimeout         int64 = 35
+	DefaultMaxConnsPerHost int   = 512
+)
+
+const (
+	AliyunAkEnvKey = "ALIBABA_CLOUD_ACCESS_KEY_ID"
+	AliyunSkEnvKey = "ALIBABA_CLOUD_ACCESS_KEY_SECRET"
 )
 
 type Method string
@@ -57,22 +63,21 @@ type MNSClient interface {
 	Send(method Method, headers map[string]string, message interface{}, resource string) (*fasthttp.Response, error)
 	SetProxy(url string)
 	SetTransport(transport fasthttp.RoundTripper)
-	getAccountID() (accountId string)
+	getAccountId() (accountId string)
 	getRegion() (region string)
 }
 
 type aliMNSClient struct {
-	Timeout     int64
-	url         *neturl.URL
-	credential  Credential
-	accessKeyId string
-	client      *fasthttp.Client
-	proxyURL    string
-
-	accountId string
-	region    string
-
-	clientLocker sync.Mutex
+	Timeout         int64
+	MaxConnsPerHost int
+	url             *neturl.URL
+	credential      Credential
+	accessKeyId     string
+	client          *fasthttp.Client
+	proxyURL        string
+	accountId       string
+	region          string
+	clientLocker    sync.Mutex
 }
 
 type AliMNSClientConfig struct {
@@ -81,25 +86,49 @@ type AliMNSClientConfig struct {
 	AccessKeySecret string
 	Token           string
 	TimeoutSecond   int64
+	MaxConnsPerHost int
+}
+
+// NewClient Follow the Alibaba Cloud standards and set the AK (Access Key) and SK (Secret Key) in the environment variables.
+// For more details, see: https://help.aliyun.com/zh/sdk/developer-reference/configure-the-alibaba-cloud-accesskey-environment-variable-on-linux-macos-and-windows-systems
+func NewClient(endpoint string) MNSClient {
+	return NewClientWithToken(endpoint, "")
+}
+
+// NewClientWithToken Follow the Alibaba Cloud standards and set the AK (Access Key) and SK (Secret Key) in the environment variables.
+// For more details, see: https://help.aliyun.com/zh/sdk/developer-reference/configure-the-alibaba-cloud-accesskey-environment-variable-on-linux-macos-and-windows-systems
+func NewClientWithToken(endpoint, token string) MNSClient {
+	return NewAliMNSClientWithConfig(AliMNSClientConfig{
+		EndPoint:        endpoint,
+		AccessKeyId:     os.Getenv(AliyunAkEnvKey),
+		AccessKeySecret: os.Getenv(AliyunSkEnvKey),
+		Token:           token,
+		TimeoutSecond:   DefaultTimeout,
+		MaxConnsPerHost: DefaultMaxConnsPerHost,
+	})
 }
 
+// Deprecated: Use NewClient instead.
 func NewAliMNSClient(inputUrl, accessKeyId, accessKeySecret string) MNSClient {
 	return NewAliMNSClientWithConfig(AliMNSClientConfig{
 		EndPoint:        inputUrl,
 		AccessKeyId:     accessKeyId,
 		AccessKeySecret: accessKeySecret,
 		Token:           "",
 		TimeoutSecond:   DefaultTimeout,
+		MaxConnsPerHost: DefaultMaxConnsPerHost,
 	})
 }
 
+// Deprecated: Use NewClientWithToken instead.
 func NewAliMNSClientWithToken(inputUrl, accessKeyId, accessKeySecret, token string) MNSClient {
 	return NewAliMNSClientWithConfig(AliMNSClientConfig{
 		EndPoint:        inputUrl,
 		AccessKeyId:     accessKeyId,
 		AccessKeySecret: accessKeySecret,
 		Token:           token,
 		TimeoutSecond:   DefaultTimeout,
+		MaxConnsPerHost: DefaultMaxConnsPerHost,
 	})
 }
 
@@ -109,42 +138,43 @@ func NewAliMNSClientWithConfig(clientConfig AliMNSClientConfig) MNSClient {
 	}
 
 	credential := NewAliMNSCredential(clientConfig.AccessKeySecret, clientConfig.Token)
-
 	cli := new(aliMNSClient)
 	cli.credential = credential
 	cli.accessKeyId = clientConfig.AccessKeyId
 	cli.Timeout = clientConfig.TimeoutSecond
+	if clientConfig.MaxConnsPerHost != 0 {
+		cli.MaxConnsPerHost = clientConfig.MaxConnsPerHost
+	} else {
+		cli.MaxConnsPerHost = DefaultMaxConnsPerHost
+	}
 
 	var err error
 	if cli.url, err = neturl.Parse(clientConfig.EndPoint); err != nil {
 		panic("err parse url")
 	}
 
-	// 1. parse region and accountid
+	// 1. parse region and accountId
 	pieces := strings.Split(clientConfig.EndPoint, ".")
 	if len(pieces) != 5 {
 		panic("ali-mns: message queue url is invalid")
 	}
 
 	accountIdSlice := strings.Split(pieces[0], "/")
 	cli.accountId = accountIdSlice[len(accountIdSlice)-1]
-
 	regionSlice := strings.Split(pieces[2], "-internal")
 	cli.region = regionSlice[0]
-
-	if globalurl := os.Getenv(GLOBAL_PROXY); globalurl != "" {
-		cli.proxyURL = globalurl
+	if globalUrl := os.Getenv(GlobalProxy); globalUrl != "" {
+		cli.proxyURL = globalUrl
 	}
 
 	// 2. now init http client
 	cli.initFastHttpClient()
 	//change to dial dual stack to support both ipv4 and ipv6
 	cli.client.DialDualStack = true
-
 	return cli
 }
 
-func (p aliMNSClient) getAccountID() (accountId string) {
+func (p aliMNSClient) getAccountId() (accountId string) {
 	return p.accountId
 }
 
@@ -163,16 +193,13 @@ func (p *aliMNSClient) SetProxy(url string) {
 func (p *aliMNSClient) initFastHttpClient() {
 	p.clientLocker.Lock()
 	defer p.clientLocker.Unlock()
-
 	timeoutInt := DefaultTimeout
-
 	if p.Timeout > 0 {
 		timeoutInt = p.Timeout
 	}
 
 	timeout := time.Second * time.Duration(timeoutInt)
-
-	p.client = &fasthttp.Client{ReadTimeout: timeout, WriteTimeout: timeout, Name: ClientName}
+	p.client = &fasthttp.Client{ReadTimeout: timeout, WriteTimeout: timeout, MaxConnsPerHost: p.MaxConnsPerHost, Name: getDefaultUserAgent()}
 }
 
 func (p *aliMNSClient) SetTransport(transport fasthttp.RoundTripper) {
@@ -182,7 +209,7 @@ func (p *aliMNSClient) SetTransport(transport fasthttp.RoundTripper) {
 	}
 }
 
-func (p *aliMNSClient) proxy(req *http.Request) (*neturl.URL, error) {
+func (p *aliMNSClient) proxy() (*neturl.URL, error) {
 	if p.proxyURL != "" {
 		return neturl.Parse(p.proxyURL)
 	}
@@ -309,6 +336,11 @@ func initMNSErrors() {
 	}
 }
 
+func getDefaultUserAgent() string {
+	goVersion := strings.TrimPrefix(runtime.Version(), "go")
+	return fmt.Sprintf("%s/%s(%s/%s/%s;%s)", SdkName, Version, runtime.GOOS, "-", runtime.GOARCH, goVersion)
+}
+
 func ParseError(resp ErrorResponse, resource string) (err error) {
 	if errCodeTemplate, exist := errMapping[resp.Code]; exist {
 		err = errCodeTemplate.New(errors.Params{"resp": resp, "resource": resource})

example/.gitignore

@@ -1,37 +1,17 @@
 package main
 
 import (
-	"encoding/json"
 	"fmt"
-	"io/ioutil"
-
-	ali_mns "github.com/aliyun/aliyun-mns-go-sdk"
+	"github.com/aliyun/aliyun-mns-go-sdk"
 )
 
-type appConf struct {
-	Url             string `json:"url"`
-	AccessKeyId     string `json:"access_key_id"`
-	AccessKeySecret string `json:"access_key_secret"`
-}
-
 func main() {
-	conf := appConf{}
-
-	if bFile, e := ioutil.ReadFile("app.conf"); e != nil {
-		panic(e)
-	} else {
-		if e := json.Unmarshal(bFile, &conf); e != nil {
-			panic(e)
-		}
-	}
-
-	client := ali_mns.NewAliMNSClient(conf.Url,
-		conf.AccessKeyId,
-		conf.AccessKeySecret)
-
+	// Replace with your own endpoint.
+	endpoint := "http://xxx.mns.cn-hangzhou.aliyuncs.com"
+	client := ali_mns.NewClient(endpoint)
 	if resp, err := ali_mns.NewAccountManager(client).OpenService(); err != nil {
 		fmt.Println(err)
 	} else {
-		fmt.Printf("reqId:%s, orderId:%s", resp.RequestId, resp.OrderId)
+		fmt.Printf("reqId: %s, orderId: %s", resp.RequestId, resp.OrderId)
 	}
 }