こんにちは、KOUKIです。
GolangのWebフレームワークであるfiberを使って、APIを開発しています。
前回は、Ranking APIとRedisのソート処理の実装を行いました。
今回からは、Checkout APIの実装に入ります。
尚、本記事は「React, NextJS and Golang: A Rapid Guide – Advanced」コースを参考にしています。解釈は私が勝手に付けているので、本物をみたい場合は受講をお勧めします!
<目次>
前回
作るもの
Checkout機能を作りたいと思います。エンドポイントは、次の通りです。
エンドポイント
- GET /api/checkout/links/{code}
- POST /api/checkout/orders
- POST /api/checkout/orders/confirm
今回は、「/api/checkout/links/{code}」、「/api/checkout/orders」への処理を実装します。
GetLink
ユーザーID(code)からLinkデータを取得するAPIを実装します。
ルートの追加
「/api/checkout/links/{code}」へのルートを追加します。
|
1 2 3 4 5 6 7 8 9 |
// routes/routes.go ... func Setup(app *fiber.App) { ... // Checkout checkout := api.Group("checkout") checkout.Get("links/:code", controllers.GetLink) } |
コントローラーの追加
コントローラーを追加します。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
// linkController.go func GetLink(ctx *fiber.Ctx) error { // URL(links/:code)からcodeを取得する code := ctx.Params("code") link := models.Link{ Code: code, } // データベース検索 // linkデータを取得する前にUser, Productsデータを取得する database.DB.Preload("User").Preload("Products").First(&link) return ctx.JSON(link) } |
Linkモデルの修正
LinkモデルのOrdersはレスポンス先に表示したくないので、「omitempty」を付与しておきます。
|
1 2 3 4 5 6 7 |
// link.go package models type Link struct { ... Orders []Order `json:"orders,omitempty" gorm:"-"` <<< omitemptyを追加 } |
検証
検証してみましょう。
まずは、Linkを作成します。
- URL: http://localhost:8000/api/ambassador/links
- 形式: POST
|
1 2 3 4 |
// Bodyパラメータ { "productIDs": [2, 4, 5] } |
次に、以下のパラメーターでCodeを取得します。
- URL: http://localhost:8000/api/ambassador/stats
- 形式: GET
|
1 2 3 4 5 6 7 |
[ { "code": "yfUVevT", "count": 0, "revenue": 0 } ] |
このコードを使って、Linkを取得します。
- URL: http://localhost:8000/api/checkout/links/yfUVevT
- 形式: GET
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
{ "id": 1, "code": "yfUVevT", "user_id": 31, "user":{ "id": 31, "first_name": "self", "last_name": "note", "email": "ambassdor@ne.jp" }, "products":[ {"id": 2, "title": "XqlRFSg", "description": "RRkTYHm", "image": "http://www.UJJHGJR.org/svPoDXd",…}, {"id": 4, "title": "fljYvbP", "description": "DtVyXKu", "image": "http://cLVxXaw.ru/RMBpJjy.html",…}, {"id": 5, "title": "lZVYbVy", "description": "IfhGxRT", "image": "http://www.gYcNeUf.ru/",…} ] } |
OKですね。
オーダーの作成
オーダーを作成するAPIを実装します。
ルートの追加
「/api/checkout/orders」へのルートを追加します。
|
1 2 3 4 5 6 7 8 9 |
// routes/routes.go ... func Setup(app *fiber.App) { ... // Checkout ... checkout.Post("orders", controllers.CreateOrder) } |
コントローラーの追加
コントローラーを追加します。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
type CreateOrderRequest struct { Code string FirstName string LastName string Email string Address string Country string City string Zip string Products []map[string]int } func CreateOrder(ctx *fiber.Ctx) error { var request CreateOrderRequest // リクエストデータを取得 if err := ctx.BodyParser(&request); err != nil { return err } // リクエストからコードを抜き出す link := models.Link{ Code: request.Code, } // DB検索 database.DB.Preload("User").First(&link) // 該当データがない場合はエラー if link.ID == 0 { ctx.Status(fiber.StatusBadRequest) return ctx.JSON(fiber.Map{ "message": "無効なリンクです", }) } // Orderを作成する order := models.Order{ Code: link.Code, UserID: link.UserID, AmbassadorEmail: link.User.Email, FirstName: request.FirstName, LastName: request.LastName, Email: request.Email, Address: request.Address, Country: request.Country, City: request.City, Zip: request.Zip, } // OrderをDBに保存 database.DB.Create(&order) // リクエストからプロダクトを取得 for _, requestProduct := range request.Products { product := models.Product{} product.ID = uint(requestProduct["product_id"]) // product検索 database.DB.First(&product) // トータルを算出 total := product.Price * float64(requestProduct["quantity"]) // OrderItemを作成 item := models.OrderItem{ OrderID: order.ID, ProductTitle: product.Title, Price: product.Price, Quantity: uint(requestProduct["quantity"]), AmbassadorRevenue: 0.1 * total, AdminRevenue: 0.9 * total, } // OrderItemをDBに保存 database.DB.Create(&item) } return ctx.JSON(order) } |
検証
以下のパラメーターで検証してみましょう。
- URL: http://localhost:8000/api/checkout/orders
- 形式: POST
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
{ "first_name": "a", "last_name": "a", "email": "a@a.com", "address": "a", "country": "a", "city": "a", "zip": "a", "code": "yfUVevT", "products": [ { "product_id": 2, "quantity": 2 }, { "product_id": 4, "quantity": 1 }, { "product_id": 5, "quantity": 3 } ] } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
{ "id": 50, "transaction_id": "", "user_id": 31, "code": "yfUVevT", "ambassador_email": "ambassdor@ne.jp", "name": "", "email": "a@a.com", "address": "a", "city": "a", "country": "a", "zip": "a", "complete": false, "total": 0, "order_items": null } |
OKですね。
トランザクション
先ほどの処理で、Order -> OrderItemの順にデータを保存しました。
しかし、この流れの中でエラーが発生した場合は、どうなるでしょうか？
例えば、Orderは保存成功、OrderItemは保存成功、みたいな感じです。
この2つのデータは全て保存されるか、全て保存されないかのどちらかでないと大変困ります。そうでないと、データの整合性を保つことができないのです。
そんな時に、トランザクションという技術が役立ちます。
トランザクションは、DBシステムで実行される処理のまとまり、または作業単位のことを指します。
「Order -> OrderItem」で保存する流れを一まとまりとし、これらの保存が全て成功した場合だけ、処理を完了させます。 失敗した場合は、ロールバック(トランザクション内の処理で問題が発生した場合に実行する処理)を実行し、データを処理前に戻すということを行います。
トランザクションは、GORMのBeginメソッドを使えば簡単に実装できます。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
// controllers/orderController.g func CreateOrder(ctx *fiber.Ctx) error { var request CreateOrderRequest // リクエストデータを取得 // リクエストからコードを抜き出す // DB検索 // 該当データがない場合はエラー // Orderを作成する // トランザクション tx := database.DB.Begin() // OrderをDBに保存 if err := tx.Create(&order).Error; err != nil { tx.Rollback() ctx.Status(fiber.StatusBadRequest) return ctx.JSON(fiber.Map{ "message": err.Error(), }) } // リクエストからプロダクトを取得 for _, requestProduct := range request.Products { // product検索 // トータルを算出 // OrderItemを作成 // トランザクション // OrderItemをDBに保存 if err := tx.Create(&item).Error; err != nil { tx.Rollback() ctx.Status(fiber.StatusBadRequest) return ctx.JSON(fiber.Map{ "message": err.Error(), }) } } // 実行 tx.Commit() return ctx.JSON(order) } |
次回
次回は、Stripe機能を実装しましょう。
Go言語まとめ
ソースコード
ここまでのソースコードを以下に記載します。
link.go
|
1 2 3 4 5 6 7 8 9 10 11 |
// link.go package models type Link struct { Model Code string `json:"code"` UserID uint `json:"user_id"` User User `json:"user" gorm:"foreignKey:UserID"` Products []Product `json:"products" gorm:"many2many:link_products"` Orders []Order `json:"orders,omitempty" gorm:"-"` } |
linkController.go
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
// linkController.go package controllers import ( "admin/src/database" "admin/src/middleware" "admin/src/models" "fmt" "strconv" "github.com/bxcodec/faker/v3" "github.com/gofiber/fiber/v2" ) func Link(ctx *fiber.Ctx) error { id, _ := strconv.Atoi(ctx.Params("id")) var links []models.Link database.DB.Where("user_id = ?", id).Find(&links) for i, link := range links { var orders []models.Order database.DB.Where("code = ? and complete = true", link.Code).Find(&orders) links[i].Orders = orders } return ctx.JSON(links) } type CreateLinkRequest struct { ProductIDs []int } func CreateLink(ctx *fiber.Ctx) error { var request CreateLinkRequest // リクエストデータからProductIDを取得 if err := ctx.BodyParser(&request); err != nil { return err } fmt.Println(request) // ユーザーIDを取得 id, _ := middleware.GetUserID(ctx) // リンク作成 link := models.Link{ UserID: id, Code: faker.Username(), } // プロダクトID, ユーザーIDを紐づける for _, productID := range request.ProductIDs { product := models.Product{} product.ID = uint(productID) link.Products = append(link.Products, product) } // DB保存 database.DB.Create(&link) return ctx.JSON(link) } func Stats(ctx *fiber.Ctx) error { // ユーザーIDを取得 id, _ := middleware.GetUserID(ctx) // DB検索 var links []models.Link database.DB.Find(&links, models.Link{ UserID: id, }) var result []interface{} var orders []models.Order for _, link := range links { // OrderItemsを先にロードしてからOrderデータを検索 database.DB.Preload("OrderItems").Find(&orders, &models.Order{ Code: link.Code, Complete: true, }) var revenue float64 = 0 for _, order := range orders { revenue += order.GetTotal() } result = append(result, fiber.Map{ "code": link.Code, "count": len(orders), "revenue": revenue, }) } return ctx.JSON(result) } func GetLink(ctx *fiber.Ctx) error { // URL(links/:code)からcodeを取得する code := ctx.Params("code") link := models.Link{ Code: code, } // データベース検索 // linkデータを取得する前にUser, Productsデータを取得する database.DB.Preload("User").Preload("Products").First(&link) return ctx.JSON(link) } |
orderController.go
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
// controllers/orderController.go package controllers import ( "admin/src/database" "admin/src/models" "github.com/gofiber/fiber/v2" ) func Orders(ctx *fiber.Ctx) error { var orders []models.Order // DB検索 database.DB.Preload("OrderItems").Find(&orders) for i, order := range orders { orders[i].Name = order.FullName() orders[i].Total = order.GetTotal() } return ctx.JSON(orders) } type CreateOrderRequest struct { Code string FirstName string LastName string Email string Address string Country string City string Zip string Products []map[string]int } func CreateOrder(ctx *fiber.Ctx) error { var request CreateOrderRequest // リクエストデータを取得 if err := ctx.BodyParser(&request); err != nil { return err } // リクエストからコードを抜き出す link := models.Link{ Code: request.Code, } // DB検索 database.DB.Preload("User").First(&link) // 該当データがない場合はエラー if link.ID == 0 { ctx.Status(fiber.StatusBadRequest) return ctx.JSON(fiber.Map{ "message": "無効なリンクです", }) } // Orderを作成する order := models.Order{ Code: link.Code, UserID: link.UserID, AmbassadorEmail: link.User.Email, FirstName: request.FirstName, LastName: request.LastName, Email: request.Email, Address: request.Address, Country: request.Country, City: request.City, Zip: request.Zip, } // トランザクション tx := database.DB.Begin() // OrderをDBに保存 if err := tx.Create(&order).Error; err != nil { tx.Rollback() ctx.Status(fiber.StatusBadRequest) return ctx.JSON(fiber.Map{ "message": err.Error(), }) } // リクエストからプロダクトを取得 for _, requestProduct := range request.Products { product := models.Product{} product.ID = uint(requestProduct["product_id"]) // product検索 database.DB.First(&product) // トータルを算出 total := product.Price * float64(requestProduct["quantity"]) // OrderItemを作成 item := models.OrderItem{ OrderID: order.ID, ProductTitle: product.Title, Price: product.Price, Quantity: uint(requestProduct["quantity"]), AmbassadorRevenue: 0.1 * total, AdminRevenue: 0.9 * total, } // トランザクション // OrderItemをDBに保存 if err := tx.Create(&item).Error; err != nil { tx.Rollback() ctx.Status(fiber.StatusBadRequest) return ctx.JSON(fiber.Map{ "message": err.Error(), }) } } // 実行 tx.Commit() return ctx.JSON(order) } |
routes.go
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
// routes/routes.go package routes import ( "admin/src/controllers" "admin/src/middleware" "github.com/gofiber/fiber/v2" ) func Setup(app *fiber.App) { // Group api := app.Group("api") // admin admin := api.Group("admin") admin.Post("register", controllers.Register) admin.Post("login", controllers.Login) adminAuthenticated := admin.Use(middleware.IsAuthenticate) adminAuthenticated.Get("user", controllers.User) adminAuthenticated.Post("logout", controllers.Logout) adminAuthenticated.Put("info", controllers.UpdateInfo) adminAuthenticated.Put("password", controllers.UpdatePassword) adminAuthenticated.Get("ambassadors", controllers.Ambassadors) adminAuthenticated.Get("products", controllers.Products) adminAuthenticated.Post("products", controllers.CreateProducts) adminAuthenticated.Get("products/:id", controllers.GetProduct) adminAuthenticated.Put("products/:id", controllers.UpdateProduct) adminAuthenticated.Delete("products/:id", controllers.DeleteProduct) adminAuthenticated.Get("users/:id/links", controllers.Link) adminAuthenticated.Get("orders", controllers.Orders) // Ambassador ambassador := api.Group("ambassador") ambassador.Post("register", controllers.Register) ambassador.Post("login", controllers.Login) ambassador.Get("products/frontend", controllers.ProductFrontend) ambassador.Get("products/backend", controllers.ProductBackend) ambassadorAuthentication := ambassador.Use(middleware.IsAuthenticate) ambassadorAuthentication.Get("user", controllers.User) ambassadorAuthentication.Post("logout", controllers.Logout) ambassadorAuthentication.Put("users/info", controllers.UpdateInfo) ambassadorAuthentication.Put("users/password", controllers.UpdatePassword) ambassadorAuthentication.Post("links", controllers.CreateLink) ambassadorAuthentication.Get("stats", controllers.Stats) ambassadorAuthentication.Get("rankings", controllers.Ranking) // Checkout checkout := api.Group("checkout") checkout.Get("links/:code", controllers.GetLink) checkout.Post("orders", controllers.CreateOrder) } |
にほんブログ村
コメントを残す
コメントを投稿するにはログインしてください。