
2024年在線市場平臺的11大最佳支付解決方案
├── conf
│ └── app.ini
├── go.mod
├── go.sum
├── middleware
├── models
├── pkg
│ └── setting.go
├── routers
└── runtime
建立錯誤碼的e
模塊,在go-gin-example
的pkg
目錄下新建e
目錄(注意新增 replace 配置),新建code.go
和msg.go
文件,寫入內容:
1、 code.go:
package e
const (
SUCCESS = 200
ERROR = 500
INVALID_PARAMS = 400
ERROR_EXIST_TAG = 10001
ERROR_NOT_EXIST_TAG = 10002
ERROR_NOT_EXIST_ARTICLE = 10003
ERROR_AUTH_CHECK_TOKEN_FAIL = 20001
ERROR_AUTH_CHECK_TOKEN_TIMEOUT = 20002
ERROR_AUTH_TOKEN = 20003
ERROR_AUTH = 20004
)
2、 msg.go:
package e
var MsgFlags = map[int]string {
SUCCESS : "ok",
ERROR : "fail",
INVALID_PARAMS : "請求參數錯誤",
ERROR_EXIST_TAG : "已存在該標簽名稱",
ERROR_NOT_EXIST_TAG : "該標簽不存在",
ERROR_NOT_EXIST_ARTICLE : "該文章不存在",
ERROR_AUTH_CHECK_TOKEN_FAIL : "Token鑒權失敗",
ERROR_AUTH_CHECK_TOKEN_TIMEOUT : "Token已超時",
ERROR_AUTH_TOKEN : "Token生成失敗",
ERROR_AUTH : "Token錯誤",
}
func GetMsg(code int) string {
msg, ok := MsgFlags[code]
if ok {
return msg
}
return MsgFlags[ERROR]
}
在go-gin-example
的pkg
目錄下新建util
目錄(注意新增 replace 配置),并拉取com
的依賴包,如下:
$ go get -u github.com/unknwon/com
在util
目錄下新建pagination.go
,寫入內容:
package util
import (
"github.com/gin-gonic/gin"
"github.com/unknwon/com"
"github.com/EDDYCJY/go-gin-example/pkg/setting"
)
func GetPage(c *gin.Context) int {
result := 0
page, _ := com.StrTo(c.Query("page")).Int()
if page > 0 {
result = (page - 1) * setting.PageSize
}
return result
}
拉取gorm
的依賴包,如下:
$ go get -u github.com/jinzhu/gorm
拉取mysql
驅動的依賴包,如下:
$ go get -u github.com/go-sql-driver/mysql
完成后,在go-gin-example
的models
目錄下新建models.go
,用于models
的初始化使用
package models
import (
"log"
"fmt"
"github.com/jinzhu/gorm"
_ "github.com/jinzhu/gorm/dialects/mysql"
"github.com/EDDYCJY/go-gin-example/pkg/setting"
)
var db *gorm.DB
type Model struct {
ID int gorm:"primary_key" json:"id"
CreatedOn int json:"created_on"
ModifiedOn int json:"modified_on"
}
func init() {
var (
err error
dbType, dbName, user, password, host, tablePrefix string
)
sec, err := setting.Cfg.GetSection("database")
if err != nil {
log.Fatal(2, "Fail to get section 'database': %v", err)
}
dbType = sec.Key("TYPE").String()
dbName = sec.Key("NAME").String()
user = sec.Key("USER").String()
password = sec.Key("PASSWORD").String()
host = sec.Key("HOST").String()
tablePrefix = sec.Key("TABLE_PREFIX").String()
db, err = gorm.Open(dbType, fmt.Sprintf("%s:%s@tcp(%s)/%s?charset=utf8&parseTime=True&loc=Local",
user,
password,
host,
dbName))
if err != nil {
log.Println(err)
}
gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string {
return tablePrefix + defaultTableName;
}
db.SingularTable(true)
db.LogMode(true)
db.DB().SetMaxIdleConns(10)
db.DB().SetMaxOpenConns(100)
}
func CloseDB() {
defer db.Close()
}
最基礎的準備工作完成啦,讓我們開始編寫 Demo 吧!
在go-gin-example
下建立main.go
作為啟動文件(也就是main
包),我們先寫個Demo,幫助大家理解,寫入文件內容:
package main
import (
"fmt"
"net/http"
"github.com/gin-gonic/gin"
"github.com/EDDYCJY/go-gin-example/pkg/setting"
)
func main() {
router := gin.Default()
router.GET("/test", func(c *gin.Context) {
c.JSON(200, gin.H{
"message": "test",
})
})
s := &http.Server{
Addr: fmt.Sprintf(":%d", setting.HTTPPort),
Handler: router,
ReadTimeout: setting.ReadTimeout,
WriteTimeout: setting.WriteTimeout,
MaxHeaderBytes: 1 << 20,
}
s.ListenAndServe()
}
執行go run main.go
,查看命令行是否顯示
[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.
[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
- using env: export GIN_MODE=release
- using code: gin.SetMode(gin.ReleaseMode)
[GIN-debug] GET /test --> main.main.func1 (3 handlers)
在本機執行curl 127.0.0.1:8000/test
,檢查是否返回{"message":"test"}
。
那么,我們來延伸一下 Demo 所涉及的知識點!
type Engine struct{...}
,里面包含RouterGroup
,相當于創建一個路由Handlers
,可以后期綁定各類的路由規則和函數、中間件等Handlers
中,也支持 POST、PUT、DELETE、PATCH、OPTIONS、HEAD 等常用的 Restful 方法map[string]interface{}
Context
是gin
中的上下文,它允許我們在中間件之間傳遞變量、管理流、驗證 JSON 請求、響應 JSON 請求等,在gin
中包含大量Context
的方法,例如我們常用的DefaultQuery
、Query
、DefaultPostForm
、PostForm
等等1、http.Server:
type Server struct {
Addr string
Handler Handler
TLSConfig *tls.Config
ReadTimeout time.Duration
ReadHeaderTimeout time.Duration
WriteTimeout time.Duration
IdleTimeout time.Duration
MaxHeaderBytes int
ConnState func(net.Conn, ConnState)
ErrorLog *log.Logger
}
:8000
ServeHTTP
,用于處理程序響應 HTTP 請求nil
則默認以日志包的標準日志記錄器完成(也就是在控制臺輸出)2、 ListenAndServe:
func (srv *Server) ListenAndServe() error {
addr := srv.Addr
if addr == "" {
addr = ":http"
}
ln, err := net.Listen("tcp", addr)
if err != nil {
return err
}
return srv.Serve(tcpKeepAliveListener{ln.(*net.TCPListener)})
}
開始監聽服務,監聽 TCP 網絡地址,Addr 和調用應用程序處理連接上的請求。
我們在源碼中看到Addr
是調用我們在&http.Server
中設置的參數,因此我們在設置時要用&
,我們要改變參數的值,因為我們ListenAndServe
和其他一些方法需要用到&http.Server
中的參數,他們是相互影響的。
3、 http.ListenAndServe
和 連載一 的r.Run()
有區別嗎?
我們看看r.Run
的實現:
func (engine *Engine) Run(addr ...string) (err error) {
defer func() { debugPrintError(err) }()
address := resolveAddress(addr)
debugPrint("Listening and serving HTTP on %s\n", address)
err = http.ListenAndServe(address, engine)
return
}
通過分析源碼,得知本質上沒有區別,同時也得知了啟動gin
時的監聽 debug 信息在這里輸出。
4、 為什么 Demo 里會有WARNING
?
首先我們可以看下Default()
的實現
// Default returns an Engine instance with the Logger and Recovery middleware already attached.
func Default() *Engine {
debugPrintWARNINGDefault()
engine := New()
engine.Use(Logger(), Recovery())
return engine
}
大家可以看到默認情況下,已經附加了日志、恢復中間件的引擎實例。并且在開頭調用了debugPrintWARNINGDefault()
,而它的實現就是輸出該行日志
func debugPrintWARNINGDefault() {
debugPrint([WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.<br>
)
}
而另外一個Running in "debug" mode. Switch to "release" mode in production.
,是運行模式原因,并不難理解,已在配置文件的管控下 :-),運維人員隨時就可以修改它的配置。
5、 Demo 的router.GET
等路由規則可以不寫在main
包中嗎?
我們發現router.GET
等路由規則,在 Demo 中被編寫在了main
包中,感覺很奇怪,我們去抽離這部分邏輯!
在go-gin-example
下routers
目錄新建router.go
文件,寫入內容:
package routers
import (
"github.com/gin-gonic/gin"
"github.com/EDDYCJY/go-gin-example/pkg/setting"
)
func InitRouter() *gin.Engine {
r := gin.New()
r.Use(gin.Logger())
r.Use(gin.Recovery())
gin.SetMode(setting.RunMode)
r.GET("/test", func(c *gin.Context) {
c.JSON(200, gin.H{
"message": "test",
})
})
return r
}
修改main.go
的文件內容:
package main
import (
"fmt"
"net/http"
"github.com/EDDYCJY/go-gin-example/routers"
"github.com/EDDYCJY/go-gin-example/pkg/setting"
)
func main() {
router := routers.InitRouter()
s := &http.Server{
Addr: fmt.Sprintf(":%d", setting.HTTPPort),
Handler: router,
ReadTimeout: setting.ReadTimeout,
WriteTimeout: setting.WriteTimeout,
MaxHeaderBytes: 1 << 20,
}
s.ListenAndServe()
}
當前目錄結構:
go-gin-example/
├── conf
│ └── app.ini
├── main.go
├── middleware
├── models
│ └── models.go
├── pkg
│ ├── e
│ │ ├── code.go
│ │ └── msg.go
│ ├── setting
│ │ └── setting.go
│ └── util
│ └── pagination.go
├── routers
│ └── router.go
├── runtime
重啟服務,執行 curl 127.0.0.1:8000/test
查看是否正確返回。
下一節,我們將以我們的 Demo 為起點進行修改,開始編碼!
本系列示例代碼:https://github.com/EDDYCJY/go-gin-example
文章轉自微信公眾號@SDL安全