我是 golang 的新手,想制作一个小型的待办事项网络应用程序来提高我的 go 技能。我想知道组织代码的最佳做法是什么。
现在,我为这个项目定义了两个包:ticket
和server
。 ticket
是关于数据库的,server
是关于 http 处理程序的。
我的数据有两种类型:Ticket 和 Todo。一张 Ticket 中可以有多个 Todo。它们在 ticket
包中定义。
type Ticket struct {
Id int64 `db:"id" json:"id"`
Label string `db:"label" json:"label"`
Description string `db:"description" json:"description"`
StartTime time.Time `db:"start_time" json:"start_time"`
EndTime *time.Time `db:"end_time" json:"end_time"`
Priority bool `db:"priority" json:"priority"`
}
type Todo struct {
Id int64 `db:"id" json:"id"`
Item int64 `db:"item" json:"item"`
TicketId int64 `db:"ticket_id" json:"ticket_id"`
Active bool `db:"active" json:"active"`
}
在ticket
包中,我也定义了
type AppDB struct {
db *sqlx.DB
}
*sqlx.DB
的封装允许我将所有数据库访问函数放在 ticket
包中,例如,
func (adb *AppDB) MustInit()
func (adb *AppDB) AddTicket(i *Ticket) (int64, error)
在server
包中,我定义
type Application struct {
db ticket.AppDB
}
并且 http 处理函数被定义为 Application
的方法,例如,
func (app *Application) CreateTicket(w http.ResponseWriter, req *http.Request)
在 main.go
中,我注册了句柄函数。
func main() {
app := server.NewApplication()
fmt.Println("now listening...")
router := mux.NewRouter()
router.HandleFunc("/", app.Hello).Methods("GET")
router.HandleFunc("/get", app.Get).Methods("GET")
log.Fatal(http.ListenAndServe(":"+os.Getenv("PORT"), router))
}
我有以下问题:
- 这种设计是好的做法吗?如果不是,正确的方法是什么?
- 在 Donovan 和 Kernighan 的 Go 编程书籍 p.194 中,他们给出了一个示例,其中 http 处理程序直接定义为数据库的方法。那会是更好的设计吗?这是有道理的,因为我的
server
包只适用于ticket
中的数据类型。它还使代码编写起来更简洁。另一方面,它混合了 http 和数据库,我不确定这是否是一件好事。 - 如何处理数据库表创建?我是否可以创建另一个
main.go
,它只创建数据库表并将其构建为可执行文件,这样我就可以在服务器上运行一次?
最佳答案
根据您的描述,我认为制作 2 个软件包是一个错误的决定。如果你正在制作一个“小型网络应用程序”,那么拥有多个包除了会增加额外的复杂性外,没有任何好处。如果您不确定,请始终选择更简单的解决方案。
我不认为拥有 2 个包裹会更干净或混合更少。您可以将包内容放在多个不同的文件中,并作为不同结构的方法。
这个怎么样?以幂等方式定义您的数据库初始化(例如,如果不存在则创建模式,如果不存在则创建表)并在
main.go
的开头每次运行它,就在您之后db.Ping()
。大多数情况下应该是毫秒,并且您确保数据库始终具有您期望的结构。
关于database - go rest api 服务器设计良好实践,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/41304058/