簡體   English   中英

去休息api服務器設計好的做法

[英]go rest api server design good practice

我是Golang的新手,想制作一個待辦事項列表的小型網絡應用程序,以提高我的技能。 我想知道組織代碼的好習慣是什么。

現在,我為這個項目定義了兩個包: ticketserver ticket是關於數據庫, server是關於http處理程序。

我的數據有兩種類型:Ticket和Todo。 一張票可以有多個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))                  
}  

我有以下問題:

  1. 這種設計是一種很好的做法嗎? 如果沒有,那么正確的方法是什么?
  2. 在Donovan和Kernighan的Go編程書第194頁中,他們給出了一個示例,其中http處理程序直接定義為數據庫的方法。 這會是一個更好的設計嗎? 這是有道理的,因為我的server包僅適用於ticket數據類型。 它還使代碼更清晰。 另一方面,它混合了http和數據庫,我不確定它是否是一件好事。
  3. 如何處理數據庫表創建? 我應該創建另一個main.go ,它只創建數據庫表並將其構建為可執行文件,這樣我只能在服務器上運行一次嗎?
  1. 我認為根據你所描述的內容制作2個包是一個糟糕的決定。 如果你正在制作一個“小型網絡應用程序”,那么在擁有多個軟件包時,沒有什么可以獲得的,但是更加復雜。 如果您不確定,請始終選擇更簡單的解決方案。

  2. 我不認為有2個包裝更清潔或混合更少。 您可以將包中的東西放在幾個不同的文件中,並作為不同結構的方法。

  3. 這個怎么樣? 以冪等方式定義數據庫初始化(例如,CREATE SCHEMA IF NOT NOT EXISTS,CREATE TABLE IF NOT NOT EXISTS)並在main.go開頭每次運行它,就在db.Ping() 大多數情況下應該是毫秒,並確保db始終具有您期望的結構。

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM