去休息api服务器设计良好做法

时间:2016-12-23 15:30:15

标签: database rest go

我是Golang的新手,并希望制作一个待办事项列表的小型网络应用程序,以提高我的技能。我想知道组织代码的好习惯。

现在,我为此项目定义了两个包:ticketserverticket与数据库有关,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的编程手册第194页中,他们给出了一个示例,其中http处理程序直接定义为数据库的方法。这会是一个更好的设计吗?这是有道理的,因为我的server包仅适用于ticket中的数据类型。它还使代码更清晰。另一方面,它混合了http和数据库,我不确定它是否是一件好事。
  3. 如何处理数据库表创建?我应该创建另一个main.go,它只创建数据库表并将其构建为可执行文件,这样我只能在服务器上运行一次吗?

1 个答案:

答案 0 :(得分:0)

  1. 根据你所描述的内容,我认为制作2个套餐是一个糟糕的决定。如果您正在制作一个小型网络应用程序,那么在获得多个软件包时,没有什么可以获得的,但却更加复杂。如果您不确定,请始终选择更简单的解决方案。

  2. 我不认为有两个包装更清洁或混合更少。您可以将包中的东西放在几个不同的文件中,并作为不同结构的方法。

  3. 这个怎么样?以幂等方式定义数据库初始化(例如,CREATE SCHEMA IF NOT NOT EXISTS,CREATE TABLE IF NOT NOT EXISTS)并在main.go开始时每隔一次运行它db.Ping()。大多数情况下应该是毫秒,并确保db始终具有您期望的结构。