goquの導入 #899

Kubosaka · 2024-12-25T04:21:45Z

https://nut-m-e-g.slack.com/archives/C020WQ3GY07/p1734923921611839

概要

sqlを直接記述するのは、sqlインジェクションなどセキュリティ的にも良くないので、クエリビルダーgoquを導入しました。
ORMを使うことも有用だったが、既存コードのリファクタリング箇所が大きくなる（dbの接続周りなど）ので、クエリビルダーを使うことで対応します。
クエリビルダーにはgoquを使いました
sponsorsのみリファクタリングしました

goquの採用理由

この記事参考にした　https://zenn.dev/kmrok/articles/e306daeb936e78
ダイアレクトサポート（MySQL対応）
複雑なクエリも構築可能
など

テスト項目

変更箇所（/sponsors）のapiが機能するか確認してください

備考

golinesという自動整形ツールを導入しました
run on save拡張機能をインストールしてください
https://github.com/segmentio/golines

hikahana

goquの構文はよさそう

hikahana · 2024-12-26T17:30:19Z

api/externals/repository/sponsor_repository.go

-	query := "SELECT * FROM sponsors WHERE id = " + id
+	dialect := goqu.Dialect("mysql")
+	query, _, err := dialect.From("sponsors").Where(goqu.Ex{"id": id}).ToSQL()
+	fmt.Println(query)


Suggested change

fmt.Println(query)

消し忘れっぽそう

hikahana · 2024-12-26T17:36:55Z

api/externals/repository/sponsor_repository.go

dialect毎回呼ぶの疲れそう
試してないけど参考になりそう

https://chatgpt.com/share/676d941f-1e90-800b-b560-cdabbfc470f6

https://www.m3tech.blog/entry/2023/08/29/110000#:~:text=UUID%2C%20error)%0A%7D-,mapper%E3%81%AE%E5%AE%9F%E8%A3%85,-%E8%AA%AC%E6%98%8E%E3%81%8C%E3%81%97

repositoryパッケージで共有
dialectをrepo内で共有するようにしました

学びです。

hikahana · 2024-12-26T17:42:18Z

api/externals/repository/sponsor_repository.go

-			sponsors (name, tel, email, address, representative)
-		VALUES ("` + name + `","` + tel + `","` + email + `","` + address + `","` + representative + `")`
+	dialect := goqu.Dialect("mysql")
+	ds := dialect.Insert("sponsors").Rows(goqu.Record{"name": name, "tel": tel, "email": email, "address": address, "representative": representative})


dsって何の略称ですか？
dialect sponsorとか？

なんだろう
公式が使っていたから他に良い名前が思いつかずという感じです
https://github.com/doug-martin/goqu

datasetっぽそう

hikahana · 2024-12-26T17:46:56Z

api/externals/repository/sponsor_repository.go

-			sponsors (name, tel, email, address, representative)
-		VALUES ("` + name + `","` + tel + `","` + email + `","` + address + `","` + representative + `")`
+	dialect := goqu.Dialect("mysql")
+	ds := dialect.Insert("sponsors").Rows(goqu.Record{"name": name, "tel": tel, "email": email, "address": address, "representative": representative})


Suggested change

ds := dialect.Insert("sponsors").Rows(goqu.Record{"name": name, "tel": tel, "email": email, "address": address, "representative": representative})

ds := dialect.Insert("sponsors").

Rows(goqu.Record{

"name": name,

"tel": tel,

"email": email,

"address": address,

"representative": representative})

長くなりそうならこんな感じにしてもよさそう
lintされないかな勝手に

長くなりそうだなー、
フォーマッターあるならこっちでもいいけど、整形するのにコストかかるな
既存でもそこまで読みにくくないけどどう？

https://github.com/segmentio/golines
長くなるの折り返しならこれ良さそう

innerjoinが若干見切れるのが悲しい気持ちになるけど、だいぶ改善されてよさそう

hikahana · 2024-12-26T17:47:34Z

api/externals/repository/sponsor_repository.go

-		`", representative = "` + representative +
-		`" WHERE id = ` + id
+	dialect := goqu.Dialect("mysql")
+	ds := dialect.Update("sponsors").Set(goqu.Record{"name": name, "tel": tel, "email": email, "address": address, "representative": representative}).Where(goqu.Ex{"id": id})


Suggested change

ds := dialect.Update("sponsors").Set(goqu.Record{"name": name, "tel": tel, "email": email, "address": address, "representative": representative}).Where(goqu.Ex{"id": id})

ds := dialect.Update("sponsors").

Set(goqu.Record{

"name": name,

"tel": tel,

"email": email,

"address": address,

"representative": representative}).

Where(goqu.Ex{"id": id})

自動整形

hikahana · 2024-12-26T17:49:16Z

api/externals/repository/sponsor_repository.go

-		years.year = ` + year +
-		" ORDER BY sponsors.id;"
+	dialect := goqu.Dialect("mysql")
+	query, _, err := dialect.Select("sponsors.*").From("sponsors").InnerJoin(goqu.I("year_periods"), goqu.On(goqu.I("sponsors.created_at").Gt(goqu.I("year_periods.started_at")), goqu.I("sponsors.created_at").Lt(goqu.I("year_periods.ended_at")))).InnerJoin(goqu.I("years"), goqu.On(goqu.I("year_periods.year_id").Eq(goqu.I("years.id")))).Where(goqu.Ex{"years.year": year}).Order(goqu.I("sponsors.id").Desc()).ToSQL()


Suggested change

query, _, err := dialect.Select("sponsors.*").From("sponsors").InnerJoin(goqu.I("year_periods"), goqu.On(goqu.I("sponsors.created_at").Gt(goqu.I("year_periods.started_at")), goqu.I("sponsors.created_at").Lt(goqu.I("year_periods.ended_at")))).InnerJoin(goqu.I("years"), goqu.On(goqu.I("year_periods.year_id").Eq(goqu.I("years.id")))).Where(goqu.Ex{"years.year": year}).Order(goqu.I("sponsors.id").Desc()).ToSQL()

query, _, err := dialect.Select("sponsors.*").

From("sponsors").

InnerJoin(goqu.I("year_periods"),

goqu.On(goqu.I("sponsors.created_at").Gt(goqu.I("year_periods.started_at")),

goqu.I("sponsors.created_at").Lt(goqu.I("year_periods.ended_at")))).InnerJoin(goqu.I("years"),

goqu.On(goqu.I("year_periods.year_id").

Eq(goqu.I("years.id")))).

Where(goqu.Ex{"years.year": year}).

Order(goqu.I("sponsors.id").Desc()).ToSQL()

ここいい感じにならない。。。

hikahana

hikahana · 2024-12-27T17:17:56Z

api/externals/repository/sponsor_repository.go

-			sponsors (name, tel, email, address, representative)
-		VALUES ("` + name + `","` + tel + `","` + email + `","` + address + `","` + representative + `")`
+	dialect := goqu.Dialect("mysql")
+	ds := dialect.Insert("sponsors").Rows(goqu.Record{"name": name, "tel": tel, "email": email, "address": address, "representative": representative})


innerjoinが若干見切れるのが悲しい気持ちになるけど、だいぶ改善されてよさそう

hikahana · 2024-12-27T17:20:00Z

api/externals/repository/sponsor_repository.go

学びです。

hikahana · 2024-12-27T17:25:24Z

.vscode/settings.json

run on saveっていう拡張機能なんですね
これ他の人に共有してもいいかも

mergeされたらslackで共有します
prの備考にも追記しておきました

クエリビルダー導入とリファクタリング

b599284

Kubosaka self-assigned this Dec 25, 2024

Kubosaka added the backend label Dec 26, 2024

hikahana reviewed Dec 26, 2024

View reviewed changes

Kubosaka added 3 commits December 27, 2024 11:03

repositoryパッケージで共有

7f0f9f9

自動整形

e8a43bf

golines導入

8c1ceaa

hikahana approved these changes Dec 27, 2024

View reviewed changes

Kubosaka merged commit dcc36ad into develop Dec 30, 2024
1 check passed

Kubosaka deleted the feat/kubosaka/intro-query-builder branch December 30, 2024 05:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

goquの導入 #899

goquの導入 #899

Kubosaka commented Dec 25, 2024 •

edited

Loading

hikahana left a comment

hikahana Dec 26, 2024

hikahana Dec 26, 2024

Kubosaka Dec 27, 2024 •

edited

Loading

hikahana Dec 27, 2024

hikahana Dec 26, 2024

Kubosaka Dec 27, 2024 •

edited

Loading

hikahana Dec 27, 2024

hikahana Dec 26, 2024

Kubosaka Dec 27, 2024 •

edited

Loading

Kubosaka Dec 27, 2024

hikahana Dec 27, 2024

hikahana Dec 26, 2024

Kubosaka Dec 27, 2024

hikahana Dec 26, 2024

hikahana left a comment

hikahana Dec 27, 2024

hikahana Dec 27, 2024

hikahana Dec 27, 2024

Kubosaka Dec 30, 2024

goquの導入 #899

goquの導入 #899

Conversation

Kubosaka commented Dec 25, 2024 • edited Loading

概要

テスト項目

備考

hikahana left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kubosaka Dec 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kubosaka Dec 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kubosaka Dec 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hikahana left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kubosaka commented Dec 25, 2024 •

edited

Loading

Kubosaka Dec 27, 2024 •

edited

Loading

Kubosaka Dec 27, 2024 •

edited

Loading

Kubosaka Dec 27, 2024 •

edited

Loading