Merge pull request #3 from citizen233/master

feat: 解决golint警告、删除未使用函数、格式化代码

Author: Ceelog

.github/FUNDING.yml

@@ -9,4 +9,4 @@ community_bridge: # Replace with a single Community Bridge project-name e.g., cl
 liberapay: # Replace with a single Liberapay username
 issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username
-custom: ['https://pic2.zhimg.com/80/v2-6b84f07b309b6e1ad1b3141c3e9d34dc_1440w.png']
+custom: [ 'https://pic2.zhimg.com/80/v2-6b84f07b309b6e1ad1b3141c3e9d34dc_1440w.png' ]

README.md

@@ -10,6 +10,7 @@ A fast [dingding](https://ding-doc.dingtalk.com/) development sdk written in Gol
 ```shell script
 go get github.com/fastwego/dingding
 ```
+
 ```go
 
 // 钉钉 AccessToken 管理器
@@ -41,15 +42,15 @@ resp, err := DingClient.Do(req)
 
 [https://github.com/fastwego/dingding-demo](https://github.com/fastwego/dingding-demo)
 
-
 ## 架构设计
 
 ![sdk](./doc/img/sdk.jpg)
 
 ## 框架特点
 
 - 使用 Go 语言，开发快、编译快、部署快、运行快，轻松服务海量用户
-- 丰富的[文档](https://pkg.go.dev/github.com/fastwego/dingding) 和 [演示代码](https://github.com/fastwego/dingding-demo) ，快速上手，5 分钟即可搭建一套完整的钉钉服务
+- 丰富的[文档](https://pkg.go.dev/github.com/fastwego/dingding) 和 [演示代码](https://github.com/fastwego/dingding-demo) ，快速上手，5
+  分钟即可搭建一套完整的钉钉服务
 - 独立清晰的模块划分，快速熟悉整个 sdk，没有意外，一切都是你期望的样子
 - 直接调用接口，最少封装，自由嵌入业务逻辑
 - 简单而强大的 AccessToken 管理：
@@ -63,7 +64,6 @@ resp, err := DingClient.Do(req)
 - 支持自定义 http.Client：
     - 默认使用 http.DefaultClient
 
-
 ## 活跃的开发者社区
 
 fastwego 是一套丰富的 Go 开发框架，支持钉钉、飞书、微信等服务，拥有庞大的开发者用户群体

access_token.go

@@ -27,13 +27,15 @@ import (
 	"github.com/faabiosr/cachego"
 )
 
+// AccessTokenManager 令牌管理器
 type AccessTokenManager interface {
 	GetName() (name string)
 	GetAccessToken() (accessToken string, err error)
 }
 
 type getRefreshRequestFunc func() *http.Request
 
+// DefaultAccessTokenManager 默认结构体
 type DefaultAccessTokenManager struct {
 	Id                    string
 	Name                  string
@@ -44,7 +46,7 @@ type DefaultAccessTokenManager struct {
 // 防止多个 goroutine 并发刷新冲突
 var getAccessTokenLock sync.Mutex
 
-// GetAccessToken
+// GetAccessToken 从缓存里面获取 access_token ，没有就重新请求
 func (m *DefaultAccessTokenManager) GetAccessToken() (accessToken string, err error) {
 
 	cacheKey := m.getCacheKey()

client.go

@@ -28,23 +28,23 @@ const (
 	contentTypeApplicationJson = "application/json"
 )
 
-var (
-	ServerUrl       = "https://oapi.dingtalk.com"
-	UserAgent       = "fastwego/dingding"
-	errorSystemBusy = errors.New("system busy")
-)
+// ServerUrl DingDing api接口地址
+var ServerUrl = "https://oapi.dingtalk.com"
+
+// UserAgent 发送请求是，使用的用户标识
+var UserAgent = "fastwego/dingding"
+
+var errorSystemBusy = errors.New("system busy")
 
-// NewClient
+// NewClient 声明一个客户端
 func NewClient(AccessTokenManager AccessTokenManager) (client *Client) {
 	return &Client{
 		AccessTokenManager: AccessTokenManager,
 		HttpClient:         http.DefaultClient,
 	}
 }
 
-/*
-Client 用于向接口发送请求
-*/
+// Client 用于向接口发送请求
 type Client struct {
 	AccessTokenManager AccessTokenManager
 	HttpClient         *http.Client

crypto.go

@@ -26,6 +26,7 @@ import (
 	"github.com/fastwego/dingding/util"
 )
 
+// Crypto 加密结构体
 type Crypto struct {
 	Token          string
 	EncodingAESKey string

dingding.go

@@ -12,17 +12,15 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-/*
-钉钉开发 SDK
+// 钉钉开发 SDK
+// See: https://ding-doc.dingtalk.com/
 
-See: https://ding-doc.dingtalk.com/
-*/
 package dingding
 
 import (
 	"log"
 	"os"
 )
 
-// 日志记录器
+// Logger 日志记录器
 var Logger = log.New(os.Stdout, "[fastwego/dingding] ", log.LstdFlags|log.Llongfile)

util/signature.go

@@ -9,6 +9,7 @@ import (
 	"time"
 )
 
+// Signature 根据给定的内容和秘钥生成签名
 func Signature(data, secret string) string {
 	h := hmac.New(sha256.New, []byte(secret))
 	h.Write([]byte(fmt.Sprintf("%v\n%s", time.Now().UnixNano()/1e6, data)))