上一篇文章我們介紹了GET請(qǐng)求處理,在本節(jié)我們將繼續(xù)構(gòu)建我們的應(yīng)用程序,并添加一個(gè)全新的API接口堕绩,允許客戶端更新特定mvoie數(shù)據(jù)虐秋。
Method | URL Pattern | Handler | 操作 |
---|---|---|---|
PUT | /v1/movies/:id | updateMovieHandler | 更新特定movie信息 |
更準(zhǔn)確地說,我們將添加接口稻艰,以便客戶端可以更新數(shù)據(jù)庫中movie的title、year侈净、runtime和genres內(nèi)容尊勿。在我們的項(xiàng)目中,id和created_at一旦創(chuàng)建它們就不應(yīng)該改變畜侦,并且版本值不應(yīng)該由客戶端控制元扔,所以不允許編輯這些字段。
現(xiàn)在旋膳,我們將配置這個(gè)接口澎语,使它對(duì)movie的值進(jìn)行替換。這意味著客戶端需要在其JSON請(qǐng)求體中為所有可編輯字段提供值……即使他們只想改變其中一個(gè)字段。
例如咏连,如果用戶想要在數(shù)據(jù)庫中添加科幻電影《黑豹》盯孙,需要發(fā)送一個(gè)JSON請(qǐng)求體,如下所示:
{
"title": "Black Panther",
"year": 2018,
"runtime": "134 mins",
"genres": [
"action",
"adventure",
"sci-fi"
]
}
執(zhí)行SQL查詢
讓我們?cè)俅伍_始數(shù)據(jù)庫模型處理祟滴,并編輯Update()方法來執(zhí)行下面SQL語句:
UPDATE movies
SET title = $1, year = $2, runtime = $3, genres = $4, version = version + 1
WHERE id = $5
RETURNING version
注意到這里我們將版本值作為查詢的一部分進(jìn)行遞增振惰,最后我們用return子句返回這個(gè)加1后的版本值。
和前面一樣這個(gè)SQL語句返回一條數(shù)據(jù)垄懂,因此我們需要使用Go的QueryRow()方法執(zhí)行骑晶。如果你跟隨本系列文章操作,返回到internal/data/movies.go文件草慧,然后在Update方法中添加如下代碼:
File: internal/data/movies.go
package data
...
func (m MovieModel) Update(movie *Movie) error {
//聲明SQL更新記錄并返回最新版本號(hào)
query := `
UPDATE movies
set title = $1, year = $2, runtime = $3, genres = $4, version = version + 1
WHERE id = $5
RETURNING version`
//創(chuàng)建args切片包含所有占位符參數(shù)值
args := []interface{}{
movie.Title,
movie.Year,
movie.Runtime,
pq.Array(movie.Genres),
movie.ID,
}
//使用QueryRow()方法執(zhí)行桶蛔,并以可變參數(shù)傳入args切片,讀取最新version值到movie結(jié)構(gòu)體
return m.DB.QueryRow(query, args...).Scan(&movie.Version)
}
需要強(qiáng)調(diào)的是:就像我們的Insert()方法一樣Update()方法接受一個(gè)指向Movie結(jié)構(gòu)體的指針作為參數(shù)漫谷,并再次原地修改它——這一次只使用新版本號(hào)更新仔雷。
創(chuàng)建API處理程序(handler)
現(xiàn)在,我們?cè)赾md/api/movies.go文件中舔示,添加updateMovieHandler方法碟婆。
Method | URL Pattern | Handler | 操作 |
---|---|---|---|
PUT | /v1/movies/:id | updateMovieHandler | 更新特定movie信息 |
這個(gè)處理程序的好處在于,我們已經(jīng)為它打好了所有的基礎(chǔ)惕稻。這里的工作主要是將代碼和已經(jīng)編寫的幫助函數(shù)串起來即可處理請(qǐng)求竖共。
具體來說,我們需要:
1俺祠、 使用app.readIDParam()幫助函數(shù)從URL中提取電影ID公给。
2、使用我們?cè)谏弦黄?a href="http://www.reibang.com/p/1c4b5494a9fd" target="_blank">文章創(chuàng)建的Get()方法從數(shù)據(jù)庫中獲取相應(yīng)的movie記錄蜘渣。
3淌铐、將包含更新movie數(shù)據(jù)的JSON請(qǐng)求體讀入一個(gè)input結(jié)構(gòu)。
4蔫缸、將數(shù)據(jù)從input結(jié)構(gòu)體復(fù)制到movie記錄腿准。
5、使用data.ValidateMovie()函數(shù)檢查更新的movie記錄各個(gè)字段是否有效捂龄。
6、調(diào)用Update()方法將新的movie信息存儲(chǔ)到數(shù)據(jù)庫中加叁。
7倦沧、使用app.writeJSON()幫助函數(shù)將更新的movie數(shù)據(jù)寫入JSON響應(yīng)中。
下面開始寫代碼:
File: cmd/api/movies.go
package main
...
func (app *application) updateMovieHandler(w http.ResponseWriter, r *http.Request) {
//從URL中讀取要更新的movie ID
id, err := app.readIDParam(r)
if err != nil {
app.notFoundResponse(w, r)
return
}
//根據(jù)ID從數(shù)據(jù)庫中讀取舊movie信息它匕,如果不存在就返回404 Not Found
movie, err := app.models.Movies.Get(id)
if err != nil {
switch {
case errors.Is(err, data.ErrRecordNotFound):
app.notFoundResponse(w, r)
default:
app.serverErrorResponse(w, r, err)
}
return
}
//聲明input結(jié)構(gòu)體存放客戶端發(fā)送來的數(shù)據(jù)
var input struct {
Title string `json:"title"`
Year int32 `json:"year"`
Runtime data.Runtime `json:"runtime"`
Genres []string `json:"genres"`
}
//讀取JSON請(qǐng)求體到input結(jié)構(gòu)體中
err = app.readJSON(w, r, &input)
if err != nil {
app.badRequestResponse(w, r, err)
return
}
//從請(qǐng)求體中將值拷貝到數(shù)據(jù)庫movie記錄對(duì)應(yīng)字段
movie.Title = input.Title
movie.Year = input.Year
movie.Runtime = input.Runtime
movie.Genres = input.Genres
//校驗(yàn)更新后的movie字段展融,如果校驗(yàn)失敗返回422 Unprocessable Entity響應(yīng)給客戶端
v := validator.New()
if data.ValidateMovie(v, movie); !v.Valid() {
app.failedValidationResponse(w, r, v.Errors)
return
}
//將檢驗(yàn)后的movie傳給Update()方法
err = app.models.Movies.Update(movie)
if err != nil {
app.serverErrorResponse(w, r, err)
return
}
//將更新后到movie返回給客戶端
err = app.writeJSON(w, http.StatusOK, envelope{"movie": movie}, nil)
if err != nil {
app.serverErrorResponse(w, r, err)
}
}
最后,為了完成這個(gè)任務(wù)豫柬,我們還需要更新應(yīng)用程序路由以包含更新movie的API告希。像這樣:
File:cmd/api/routers.go
package main
...
func (app *application) routes() http.Handler {
router := httprouter.New()
router.NotFound = http.HandlerFunc(app.notFoundResponse)
router.MethodNotAllowed = http.HandlerFunc(app.methodNotAllowedResponse)
router.HandlerFunc(http.MethodGet, "/v1/healthcheck", app.healthcheckHandler)
router.HandlerFunc(http.MethodPost, "/v1/movies", app.createMovieHandler)
router.HandlerFunc(http.MethodGet, "/v1/movies/:id", app.showMovieHandler)
//為"/v1/movies/:id"接口添加路由
router.HandlerFunc(http.MethodPut, "/v1/movies/:id", app.updateMovieHandler)
return app.recoverPanic(app.rateLimit(router))
}
測試更新接口
現(xiàn)在扑浸,我們可以試試更新movie接口。
為了演示燕偶,讓我們繼續(xù)之前給出的例子喝噪,并更新我們的記錄,使《黑豹》包含科幻題材指么。提醒一下酝惧,目前的記錄是這樣的:
$ curl -i localhost:4000/v1/movies/2
HTTP/1.1 200 OK
Content-Type: application/json
Date: Sun, 28 Nov 2021 13:48:43 GMT
Content-Length: 145
{
"movie": {
"id": 2,
"title": "Black Panther",
"runtime": "134 mins",
"genres": [
"action",
"adventure"
],
"Version": 1
}
}
為了更新genres字段,我們可以執(zhí)行以下API調(diào)用:
$ BODY='{"title":"Black Panther","year":2018,"runtime":"134 mins","genres":["sci-fi","action","adventure"]}'
$ curl -X PUT -d "$BODY" localhost:4000/v1/movies/2
{
"movie": {
"id": 2,
"title": "Black Panther",
"runtime": "134 mins",
"genres": [
"sci-fi",
"action",
"adventure"
],
"Version": 2
}
}
這看起來很棒伯诬,我們可以從響應(yīng)中看到genres已經(jīng)更新并包含“sci-fi”晚唇,版本號(hào)已經(jīng)像我們預(yù)期的那樣增加到2。
你也能夠通過GET /v1/movies/2請(qǐng)求來驗(yàn)證更改是否被持久化盗似,如下所示:
curl -i localhost:4000/v1/movies/2
HTTP/1.1 200 OK
Content-Type: application/json
Date: Sun, 28 Nov 2021 13:52:52 GMT
Content-Length: 158
{
"movie": {
"id": 2,
"title": "Black Panther",
"runtime": "134 mins",
"genres": [
"sci-fi",
"action",
"adventure"
],
"Version": 2
}
}