go - 我应该如何在代码中的几个地方传递 *sql.DB 变量？

Question

我读到你不应该关闭 *sql.DB 变量。

http://go-database-sql.org/accessing.html

它还说我应该:“根据需要传递它，或者以某种方式在全局范围内提供它，但要保持开放。”

但是这篇文章说我不应该使用全局变量而应该使用闭包: https://medium.com/@benbjohnson/structuring-applications-in-go-3b04be4ff091

我在这里找到了一个闭包的例子: https://gist.github.com/tsenart/5fc18c659814c078378d

我的问题是:我应该如何将这个变量传递给不同的包？

例如，如果我有这样一个名为 User 的包:

package user

import "errors"

var userNotFound = errors.New("User was not found.")

// Should I have a pointer to sql.DB as a property of the User type?
type User struct {
    // db *sql.DB
    Id       int
    Email    string
    Username string
}

// Should I pass in *sql.DB as parameter in the function?
func FindById(id int) (*User, error) {
    // Access *sql.DB somehow

    // Do query and look if user with id is found

    // Should I return an error if the user is not found?
    return &User{}, nil
}

然后我应该有一个指向 sql.DB 的指针作为 User 类型的属性吗？ 或者我应该在 findById 方法中传递指向它的指针吗？

如果我想通过用户 ID 查找用户，我应该如何从如下所示的主函数中执行所有这些操作？

func getUserById(db *sql.DB) httprouter.Handle {
    return func(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
        fmt.Fprint(w, ps.ByName("id"))

        // I will create a new(User) here, how should I use the *sql.DB in the user package?
    }
}

func main() {

    dsn := fmt.Sprintf("%s:%s@%s(%s:%s)/%s?charset=utf8",
        cfg.DbUser, cfg.DbPass, cfg.DbProtocol, cfg.DbAddress, cfg.DbPort, cfg.DbName)

    db, err := sql.Open("mysql", dsn)
    err = db.Ping()
    if err != nil {
        log.Fatal(err)
    }

    router := httprouter.New()
    router.GET("/api/user/:id", getUserById(db))
    router.NotFound = &DefaultHandler{}
    log.Fatal(http.ListenAndServe(":8080", router))
}

我应该怎么做？什么是好的首选方式或最佳实践？

Answer 1

super 简单？全局 var db *sql.DB 对象。 *sql.DB 是线程安全的，因此可以并发访问。

或者，您可以在包装 *sql.DB 的类型上定义查询方法。我认为 func (u *User) FindByID(id string) (*User, error) 没有多大意义——你接受一个 User 指针但是返回一个指向用户？

作为一个简化示例，您可以将代码更改为类似于以下内容:

type DB struct {
    *sql.DB
}

func NewDB(host, port string) (*DB, error) {
    db, err := sql.Open(...)
    if err != nil {
        return nil, err
    }

    return &DB{db}, nil 
}

func (db *DB) UserByID(id string) (*User, error) {
    res, err := db.Query(...)
    // etc.
}

func (db *DB) UsersList(limit int) ([]*User, error) {
    res, err := db.Query(...)
    // etc.
}

为了从您的处理程序中调用这些函数，您可以:

• 使用闭包(就像你现在所做的那样)
• 定义一个“环境”或“服务”结构，其中包含您的 DB 类型或只是普通的 *sql.DB 作为一个字段，并将您的处理程序创建为方法.这也可以是全局的(注意任何成员都必须是线程安全的)。
• 定义一个自定义处理程序类型(我的方法)，您可以在其中调用 router.GET("/user/:id", GetUserByID(env) 而不是使用闭包。

一些补充阅读:

1. http://www.alexedwards.net/blog/organising-database-access (涵盖多种方法 - 最全面的文章之一)
2. https://robots.thoughtbot.com/interface-with-your-database-in-go
3. https://medium.com/@benbjohnson/structuring-applications-in-go-3b04be4ff091
4. http://elithrar.github.io/article/http-handler-error-handling-revisited/#a-little-different