golang+beego代码重构的一些想法

重构代码

• 在寒假和第一周的时间里，自己从头开始，使用golang+beego写了一个自己的博客系统，通过重写一遍后台管理系统的过程中，参考别人的成熟并优雅的设计，对自己以前的代码重构有着一些想法。

models文件夹

初始化文件init.go

• 此文件包含了beego的Orm初始化，包括：

//set defalut database
orm.RegisterDataBase("default", _DB_DRIVER, _DB_CONNECT_STR)

// register model
orm.RegisterModel(new(User), new(Article), new(Label))

// create table
orm.RunSyncdb("default", false, true)

其中_DB_DRIVER = "mysql"，是数据库名字，_DB_CONNECT_STR="root:golang@/myblog?charset=utf8"，root代表mysql的用户名，golang为其密码，@/之后的myblog为mysql中此项目的数据库名字，charset=utf8代表编码方式为utf8。注意：此时如果数据库中有关于时间相关的字段存入时，会发现存入的时间与实际的时间出入8个小时，原因见 Beego的ORM插入Mysql后，时区不一致的解决方案。
* 由于是初始化文件，因此最好包含初始化部分，为别人的使用留下方便，因为别人第一次使用你的系统的时候，首先他的数据库是空的，即user表中没有数据，其次对你的用户添加模式并不了解。下载的模板就是看了半天才发现其初始化是怎么做的。
* 如何使其生效？在main.go中写初始化函数，在此函数中调用它。

func init() {
    models.Init()
}

其余文件（以user.go为例）

• 最主要的是增删改查功能（以查找函数为例）

//以前的做法
//通过用户名查找用户
func (this *User) GetByUserName(UserName string) (*User, error) {
    user := &User{}
    o := orm.NewOrm()
    err := o.QueryTable(_USER_TABLE).Filter("UserName", UserName).One(user)
    if err != nil {
        return nil, err
    }
    return user, nil
}
//通过用户Id查找用户
func (this *User) UserGetById(Id int64) (*User, error) {
    user := new(User)
    err := orm.NewOrm().QueryTable(_USER_TABLE).Filter("id", Id).One(user)
    if err != nil {
        return nil, err
    }
    return user, nil
}
//现在的做法
func (u *User) Read(fields ...string) error {
    if err := orm.NewOrm().Read(u, fields...); err != nil {
        return err
    }
    return nil
}

通过以上的函数可以看出来，以前的做法是先构造一个用户（可能是通过前端的信息获得，也可能是通过Session获得登录用户），再通过其用户名或者用户Id与数据库中的数据比对，再去判断是否有此用户，有则返回此用户，错误为空；否则用户为空，错误非空。
而现在更成熟的做法是：构造一个用户之后，直接调用user.Read()函数，如果返回为空，证明此用户是合法的，直接对其进行后续的操作就可以了，否则此用户不合法，进行相应处理。

if uesr.Read()==nil{
  //用户合法
} else {
  //用户不合法，重新登录
}

• mysql的表之间的关联：之前是利用Orm的便利，直接利用orm:"rel(m2m)"和orm:"reverse(many)"来表示关联表，但其实mysql本身的索引index也可以实现相应的功能，但是这样的话中间表需要自己手动建立，这方面的知识留待后续了解使用。

controllers文件夹

• 所有的控制文件都以*Controller.go结尾，用以和models中的同名文件冲突，例如BaseController.go等。
• 写一个BaseController.go文件，其中的控制器BaseController继承beego.Controller，剩余的所有控制器都继承此控制器，这样做的好处是可以把一些公共的，大家都用得到的函数写到里面，比如说CheckLogin()函数，即登录验证，这样就不用每个控制函数里面都写一个登录验证函数了。其调用部分写在BaseController.go文件的Prepare()里面，这样就不用在每个控制器函数文件中调用了，真正的一劳永逸。

views文件夹

• 根据页面功能的不同，可以将HTML文件放入到不同的文件夹中去，这样寻找起来就非常方便。
• 不必每个HTML文件都完全的有head、body等，这些有多个页面同时共享的部分都可以写到一个页面layout.html中，然后在相应的控制器函数中多写一句this.Layout="layout.html"即可，可以使得页面的HTML文件大大简化，也使得其修改变得很方便beego的Layout设计。