【Go Web开发】创建movies数据库模型

备注:【Go Web开发】是一个从零开始创建关于电影管理的Web项目。

数据库CRUD操作

接下来的内容我们将重点介绍如何在我们的项目中创建、查询、更新和删除movies。

我们将在接下来的几节中将取得重大进展,在本节结束时,我们将完成以下API接口并使其生效:

Method URL 动作
GET /v1/healthcheck 显示应用程序运行状况和版本信息
POST /v1/movies 添加新的电影
GET /v1/movies/:id 根据id查询特定电影
PUT /v1/movies/:id 更新特定电影
DELETE /v1/movies/:id 删除特定电影

下面将学习到以下内容:

  • 如何创建一个数据库模型,将所有执行SQL查询的逻辑与数据库隔离。
  • 如何在API上下文中对特定资源实现四个基本CRUD(创建、查询、更新和删除)操作。

建立movie模型

在本章中,我们将为我们的movie数据库模型设置代码框架。

如果您不喜欢模型这个术语,那么您可以将其视为数据访问或存储层。但不管你喜欢怎么称呼,原理都是一样的——它封装了所有从PostgreSQL数据库中读取和写入movie数据的代码。

我们回到internal/data/movies.go文件,创建MovieModel结构体类型以及一些对movie数据库表执行CURD(create,read,update和delete)操作。

File:internal/data/movies.go


package data

import (
    "database/sql"
    "encoding/json"
    "fmt"
    "time"

    "greenlight.alexedwards.net/internal/validator"
)

...

//定义MovieModel结构体,包含一个sql.DB连接池字段
type MovieModel struct {
    DB *sql.DB
}

//添加一个占位符方法,用于在movies表中插入一条新记录。
func (m MovieModel)Insert(movie *Movie) error {
    return nil
}

//Get 查询特定movie方法
func (m MovieModel)Get(id int64) (*Movie, error) {
    return nil, nil
}

//Update 更新数据库特定movie
func (m MovieModel)Update(movie *Movie) error {
    return nil
}

//Delete 删除数据库中特定movie
func (m MovieModel)Delete(id int64) error {
    return nil
}

另外,我们将MovieModel包装在一个Models结构中。这么做完全是可选的,但它的好处是可以为项目中所有需要存储数据库的模型集中管理。

创建internal/data/models.go文件,添加如下代码:

$ touch internal/data/models.go

File: internal/data/models.go


package data

import (
    "database/sql"
    "errors"
)

//自定义错误ErrRecordNotFound常量。在Get()方法中如果查询的moive数据库中不存在就返回该错误。
var (
    ErrRecordNotFound = errors.New("record not found")
)

// Models结构体包装MovieModel。后面会将所有其他models都添加到这个结构体中。
type Models struct {
    Movies MovieModel
}

//为了便于使用,我们添加一个New()方法,它返回一个Models结构体,其中包含初始化的MovieModel。
func NewModels(db *sql.DB) Models {
    return Models{
        Movies: MovieModel{DB: db},
    }
}

接下来,编辑cmd/api/main.go文件,在main函数中初始化Models结构体实例,作为依赖项传递给我们的处理程序。像这样:

package main

import (
    "context"
    "database/sql"
    "flag"
    "greenlight.alexedwards.net/internal/data"
    "os"
    "time"

    _ "github.com/lib/pq"
    "greenlight.alexedwards.net/internal/jsonlog"
)

...

//添加models字段
type application struct {
    config config
    logger *jsonlog.Logger
    models data.Models
}

// 添加models字段,引入数据库模型为接口处理程序所用
app := &application {
    config: cfg,
    logger: logger,
    models: data.NewModels(db),
}

...

现在你可以重启应用程序。以上代码可以正常编译和运行。

$ go run ./cmd/api
2021/11/28 21:01:22 database connection pool established 
2021/11/28 21:01:22 starting development server on :4000

这个模式的优点之一是,从API处理程序的角度来看,在movie表上执行操作的代码非常清晰且可读。例如,我们可以简单地通过以下代码来执行Insert()方法:

app.models.Movie.Insert(...)

通用结构体也很容易扩展。以后创建更多的数据库模型时,所要做的就是将它们添加到models结构体中,将自动在API处理程序中可用。

附加内容

Mocking models

通过对该模式进行小调整,还可以为单元测试而mock数据库模型。但是作为一个简单的例子,你可以创建一个类似于下面这样的MockMovieModel结构提:

File: internal/data/movies.go


package main

...

type MockMovieModel struct {}

func (m MockMovieModel)Insert(movie *Movie) error {
    //Mock操作
    return nil
}

func (m MockMovieModel)Update(movie *Movie) error {
    //Mock操作
    return nil
}

func (m MockMovieModel)Delete(id int64) error {
    //Mock操作
    return nil
}

然后更新internal/data/models.go文件,如下所示:

File:internal/data/models.go


package data

import (
    "database/sql"
    "errors"
)

var (
    ErrRecordNotFound = errors.New("record not found")
)

type Models struct {
        //将Movies字段设置为接口类型,支持model和mockmodel赋值
    Movies interface {
        Insert(movie *Movie) error
        Get(id int64) (*Movie, error)
        Update(movie *Movie) error
        Delete(id int64) error
    }
}

...

//创建一个new函数,返回一个包含mock Models实例
func NewMockModels() Models {
    return Models{Movies: MockMovieModel{}}
}

只要在单元测试中用NewMockModels()来代替“真正的”NewModels()函数,就可以调用它。

你可能感兴趣的:(【Go Web开发】创建movies数据库模型)