Golang 创建一个带有处理程序的模拟数据库并使用接口调用数据库

让我试着帮助你弄清楚如何实现这些目标.我稍微重构了您的代码，但总体思想和使用的工具仍然与您的相同.首先，我将分享分布在两个文件中的生产代码:handlers/handlers.go和repo/repo.go.

handlers/handlers.go file

package handlers

import (
    "context"
    "database/sql"
    "encoding/json"
    "io"
    "net/http"
    "time"

    "handlertest/repo"
)

type SignUpJson struct {
    Username string `json:"username"`
    Password string `json:"password"`
    Email    string `json:"email"`
}

func SignUp(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Content-Type", "application/json")

    var newUser SignUpJson
    bs, _ := io.ReadAll(r.Body)
    if err := json.Unmarshal(bs, &newUser); err != nil {
        w.WriteHeader(http.StatusBadRequest)
        w.Write([]byte(err.Error()))
        return
    }

    ctx, cancel := context.WithTimeout(r.Context(), time.Minute*2)
    defer cancel()

    db, _ := ctx.Value("DB").(*sql.DB)
    if isExistingUserName := repo.GetUserName(ctx, db, newUser.Username); isExistingUserName {
        w.WriteHeader(http.StatusBadRequest)
        w.Write([]byte("username already present"))
        return
    }
    w.WriteHeader(http.StatusOK)
}

在这里，有两个主要的区别:

1. 用过的context个.您不必实例化另一个ctx，只需使用http.Request附带的那个即可.
2. 使用的sql客户端.正确的方法是通过context.Context号公路.对于此场景，您不必构建任何 struct 或使用任何接口等.只需编写一个将*sql.DB作为参数的函数.记住这个，Functions are first-class citizens.

当然，还有重构的空间."DB"应该是一个常量，我们必须判断上下文值中是否存在此条目，但为简洁起见，我省略了这些判断.

repo/repo.go file

package repo

import (
    "context"
    "database/sql"

    "github.com/jackc/pgx/v5"
)

func GetUserName(ctx context.Context, db *sql.DB, username string) bool {
    row := db.QueryRowContext(ctx, "SELECT username FROM users WHERE username = $1", username)
    return row.Scan() != pgx.ErrNoRows
}

这里的代码与您的非常相似，除了这两个小问题:

1. 当您想要考虑上下文时，有一种称为QueryRowContext的专用方法.
2. 当您必须构建一个SQL查询时，请使用预准备语句功能.出于两个原因:安全性和可测试性，不要将内容与fmt.Sprintf连接在一起.

现在，我们来看看测试代码.

handlers/handlers_test.go file

package handlers

import (
    "context"
    "net/http"
    "net/http/httptest"
    "strings"
    "testing"

    "github.com/DATA-DOG/go-sqlmock"
    "github.com/jackc/pgx/v5"
    "github.com/stretchr/testify/assert"
)

func TestSignUp(t *testing.T) {
    db, mock, err := sqlmock.New(sqlmock.QueryMatcherOption(sqlmock.QueryMatcherEqual))
    if err != nil {
        t.Fatalf("err not expected while open a mock db, %v", err)
    }
    defer db.Close()
    t.Run("NewUser", func(t *testing.T) {
        mock.ExpectQuery("SELECT username FROM users WHERE username = $1").WithArgs("john.doe@example.com").WillReturnError(pgx.ErrNoRows)

        w := httptest.NewRecorder()
        r := httptest.NewRequest(http.MethodPost, "/signup", strings.NewReader(`{"username": "john.doe@example.com", "password": "1234", "email": "john.doe@example.com"}`))

        ctx := context.WithValue(r.Context(), "DB", db)
        r = r.WithContext(ctx)

        SignUp(w, r)

        assert.Equal(t, http.StatusOK, w.Code)
        if err := mock.ExpectationsWereMet(); err != nil {
            t.Errorf("not all expectations were met: %v", err)
        }
    })

    t.Run("AlreadyExistentUser", func(t *testing.T) {
        rows := sqlmock.NewRows([]string{"username"}).AddRow("john.doe@example.com")
        mock.ExpectQuery("SELECT username FROM users WHERE username = $1").WithArgs("john.doe@example.com").WillReturnRows(rows)

        w := httptest.NewRecorder()
        r := httptest.NewRequest(http.MethodPost, "/signup", strings.NewReader(`{"username": "john.doe@example.com", "password": "1234", "email": "john.doe@example.com"}`))

        ctx := context.WithValue(r.Context(), "DB", db)
        r = r.WithContext(ctx)

        SignUp(w, r)

        assert.Equal(t, http.StatusBadRequest, w.Code)
        if err := mock.ExpectationsWereMet(); err != nil {
            t.Errorf("not all expectations were met: %v", err)
        }
    })
}

在这里，与您的版本相比，有很多变化.让我简单地概括一下:

• 使用子测试功能为测试提供分层 struct .
• 使用httptest包，该包提供用于构建和断言HTTP请求和响应的内容.
• 使用sqlmock套餐.当涉及到嘲笑数据库时，这是事实上的标准.
• 使用context将sql客户端与http.Request一起传递.
• 已经对包github.com/stretchr/testify/assert进行了断言.

同样的道理也适用于这里:有重构的空间(例如，您可以通过使用表驱动测试特性来修改测试).

出类拔萃

这可以被认为是编写Go代码的惯用方式.我知道这可能是非常具有挑战性的，特别是在一开始.如果您需要进一步的细节，请让我知道，我很乐意为您服务，谢谢！