Beego 框架學習(一)

 Beego官網本身已經整理的非常詳細了，但是作為一個學習者，我還是決定自己好好整理一下，這樣在后面使用的時候自己對每部分才能非常熟悉，即使忘記了，也可以迅速定位自己要用的知識在哪里。當然也是對官網的一個精簡整理，同時結合一些例子，更好的理解和學習Beego

Beego官網地址：https://beego.me

這次整理也是一個初步的整理，正好在這個之后把之前通過net/http實現的短url項目通過beego框架實現一遍

Beego的安裝

go get github.com/astaxie/beego

bee 工具是一個為了協助快速開發 beego 項目而創建的項目，通過 bee 您可以很容易的進行 beego 項目的創建、熱編譯、開發、測試、和部署。

go get github.com/beego/bee

當我們安裝好bee之后，bee命令默認是放在GOPATH/bin里面，所以需要把GOPATH/bin里面，所以需要把GOPATH/bin 添加到您的環境變量中

bee常用的命令

bee new <項目名> ：創建一個項目,這樣的項目一般是web項目
需要注意的是這個命令須在 $GOPATH/src 下執行，最后生成的目錄結構為：

├── conf
│   └── app.conf
├── controllers
│   └── default.go
├── main.go
├── models
├── routers
│   └── router.go
├── static
│   ├── css
│   ├── img
│   └── js
│       └── reload.min.js
├── tests
│   └── default_test.go
└── views
    └── index.tpl

bee api myapi : 創建一個api項目，生成的目錄結構為

├── conf
│   └── app.conf
├── controllers
│   ├── object.go
│   └── user.go
├── main.go
├── models
│   ├── object.go
│   └── user.go
├── routers
│   └── router.go
└── tests
    └── default_test.go

bee run 命令是監控 beego 的項目，通過 fsnotify監控文件系統。但是注意該命令必須在 $GOPATH/src/appname 下執行。這樣當我們在開發過程中，beego可以實時監測我們的代碼文件發生變化，這樣我們就不用重新編譯運行，非常方便我們調試，我們可以將上面的myweb2項目通過bee run運行起來

localhost:myweb2 zhaofan$ go run
go run: no go files listed
localhost:myweb2 zhaofan$ bee run
______
| ___ \
| |_/ /  ___   ___
| ___ \ / _ \ / _ \
| |_/ /|  __/|  __/
\____/  \___| \___| v1.9.1
2018/03/19 23:59:20 INFO     ▶ 0001 Using 'myweb2' as 'appname'
2018/03/19 23:59:20 INFO     ▶ 0002 Initializing watcher...
myweb2/controllers
myweb2/routers
myweb2
2018/03/19 23:59:22 SUCCESS  ▶ 0003 Built Successfully!
2018/03/19 23:59:22 INFO     ▶ 0004 Restarting 'myweb2'...
2018/03/19 23:59:22 SUCCESS  ▶ 0005 './myweb2' is running...
2018/03/19 23:59:22.572 [I] [asm_amd64.s:2337] http server Running on http://:8080

我們通過打開瀏覽器訪問：http://127.0.0.1:8080,可以看到如圖：

Beego 架構了解

Beego架構圖如：

這就是Beegode 八大獨立的模塊

Beego的執行邏輯，beego 是一個典型的 MVC 架構

我們從上面myweb2的目錄接口也可以看出來：
M（models 目錄）、V（views 目錄）和 C（controllers 目錄）的結構

Beego路由設置

我們看一下Beego的入口函數：

 

package main

import (
    _ "myweb2/routers"
    "github.com/astaxie/beego"
)

func main() {
    beego.Run()
}

引入了一個包 _ "myweb2/routers 我們看一下這個包的內容

package routers

import (
    "myweb2/controllers"
    "github.com/astaxie/beego"
)

func init() {
    beego.Router("/", &controllers.MainController{})
}

這里僅僅做了一個初始化，路由包里面我們看到執行了路由注冊 beego.Router, 這個函數的功能是映射 URL 到 controller，第一個參數是 URL (用戶請求的地址)，這里我們注冊的是 /，也就是我們訪問的不帶任何參數的 URL，第二個參數是對應的 Controller，也就是我們即將把請求分發到那個控制器來執行相應的邏輯。這里對路由設置的一個小結：

• Router方法設置url和處理url的controller
• 程序啟動時，路由配置加載好，保存在map中
• 請求處理時，通過請求的url進行查找對應的controller,把處理路由到controller進行執行
• 我們就只需要編寫自己的controller就好啦

我們看一下controller的代碼：

package controllers

import (
    "github.com/astaxie/beego"
)

type MainController struct {
    beego.Controller  // 這里可以看做是其他語言中的繼承
}

func (c *MainController) Get() {
    c.Data["Website"] = "beego.me"
    c.Data["Email"] = "astaxie@gmail.com"
    c.TplName = "index.tpl"
}

對上述代碼進行簡單分析：

• 用戶的controller嵌套bee.Controller， 繼承bee.Controller所有屬性和
• 方法
• Controller默認使用restful的風格，Get請求對應Get方法
• 請求處理時，通過請求的url進行查找對應的controller，把處理路由到 controller進行執行
• 通過業務邏輯處理之后，把數據賦值給Controller.Data這個map即可

上述代碼中：c.TplName = "index.tpl"默認回去views下面去找模板文件
除了上面的C.Data這種方法之外，還有很多方法，如常用的c.ServerJson()這樣就會去c.Data中尋找key為json的值

用戶設置了模板之后系統會自動的調用 Render 函數（這個函數是在 beego.Controller 中實現的），所以無需用戶自己來調用渲染。

當然也可以不使用模版，直接用 this.Ctx.WriteString 輸出字符串，如：

 

func (c *MainController) Get() {
        c.Ctx.WriteString("hello")
}

正則路由
beego.Router(“/api/?:id”, &controllers.RController{}) 默認匹配 //匹配 /api/123 :id = 123 可以匹配 /api/ 這個URL

beego.Router(“/api/:id”, &controllers.RController{}) 默認匹配 //匹配 /api/123 :id = 123 不可以匹配 /api/ 這個URL

beego.Router(“/api/:id([0-9]+)“, &controllers.RController{}) 自定義正則匹配 //匹配 /api/123 :id = 123

beego.Router(“/user/:username([\w]+)“, &controllers.RController{}) 正則字符串匹配 //匹配 /user/astaxie :username = astaxie

beego.Router(“/download/*.*”, &controllers.RController{}) *匹配方式 //匹配 /download/file/api.xml :path= file/api :ext=xml

beego.Router(“/download/ceshi/*“, &controllers.RController{}) *全匹配方式 //匹配 /download/ceshi/file/api.json :splat=file/api.json

beego.Router(“/:id:int”, &controllers.RController{}) int 類型設置方式，匹配 :id為int 類型，框架幫你實現了正則 ([0-9]+)

beego.Router(“/:hi:string”, &controllers.RController{}) string 類型設置方式，匹配 :hi 為 string 類型。框架幫你實現了正則 ([\w]+)

beego.Router(“/cms_:id([0-9]+).html”, &controllers.CmsController{}) 帶有前綴的自定義正則 //匹配 :id 為正則類型。匹配 cms_123.html 這樣的 url :id = 123

可以在 Controller 中通過如下方式獲取上面的變量：
this.Ctx.Input.Param(":id")
this.Ctx.Input.Param(":username")
this.Ctx.Input.Param(":splat")
this.Ctx.Input.Param(":path")
this.Ctx.Input.Param(":ext")

自定義方法及 RESTful 規則:
beego.Router("/",&IndexController{},"*:Index")
使用第三個參數，第三個參數就是用來設置對應 method 到函數名，定義如下

• *表示任意的 method 都執行該函數
• 使用 httpmethod:funcname 格式來展示
• 多個不同的格式使用 ; 分割
• 多個 method 對應同一個 funcname，method 之間通過 , 來分割

beego.Router("/api",&RestController{},"get,post:ApiFunc")

可用的 HTTP Method：

• *: 包含以下所有的函數
• get: GET 請求
• post: POST 請求
• put: PUT 請求
• delete: DELETE 請求
• patch: PATCH 請求
• options: OPTIONS 請求
• head: HEAD 請求

如果同時存在 * 和對應的 HTTP Method，那么優先執行 HTTP Method 的方法

Beego的model

我們知道 Web 應用中我們用的最多的就是數據庫操作，而 model 層一般用來做這些操作，我們的 bee new 例子不存在 Model 的演示，但是 bee api 應用中存在 model 的應用。說的簡單一點，如果您的應用足夠簡單，那么 Controller 可以處理一切的邏輯，如果您的邏輯里面存在着可以復用的東西，那么就抽取出來變成一個模塊。因此 Model 就是逐步抽象的過程，

Beego的views層

• Beego模板默認支持:.tpl和.html兩種后綴
• beego.AddTemplateExt增加新的模板后綴
• Beego模板用的就是Go官網自帶的模板

靜態文件

beego 默認注冊了 static 目錄為靜態處理的目錄，注冊樣式：URL 前綴和映射的目錄（在/main.go文件中beego.Run()之前加入）：StaticDir["/static"] = "static"

Beego默認使用static目錄作為靜態文件目錄
beego.SetStaticPath增加新的靜態文件目錄

配置文件讀取

默認的配置文件內容：

 

appname = myweb2
httpport = 8080
runmode = dev

當然前提是你已經在自己配置文件中添加了下面這些字段：
beego.AppConfig.String("mysql_user")
beego.AppConfig.String("mysql_pwd")

如果我們將配置文件更改為：

appname = myweb2
httpport = 8080
runmode = dev

[dbconfig]
mysqlhost = 127.0.0.1
mysqlport = 3308
username = root
passwd = 123

我們可以通過[命名]的方式將配置文件進行分組
這樣當我們獲取變量的時候，可以通過下面方式獲取：

beego.AppConfig.String("dbconfig::mysql_user")
beego.AppConfig.String("dbconfig::mysql_port")

AppConfig 的方法如下：

Set(key, val string) error
String(key string) string
Strings(key string) []string
Int(key string) (int, error)
Int64(key string) (int64, error)
Bool(key string) (bool, error)
Float(key string) (float64, error)
DefaultString(key string, defaultVal string) string
DefaultStrings(key string, defaultVal []string)
DefaultInt(key string, defaultVal int) int
DefaultInt64(key string, defaultVal int64) int64
DefaultBool(key string, defaultVal bool) bool
DefaultFloat(key string, defaultVal float64) float64
DIY(key string) (interface{}, error)
GetSection(section string) (map[string]string, error)
SaveConfigFile(filename string) error

獲取用戶提交的參數

Controller中的方法獲取

• GetString(key string) string
• GetStrings(key string) []string
• GetInt(key string) (int64, error)
• GetBool(key string) (bool, error)
• GetFloat(key string) (float64, error)

不管是post還是get的其他方式提交的數據都可以通過上面的方式獲取

如果在平常開發中肯定設計到和其他語言的對接數據，這個時候對方發過來的數據可能就是一個json格式的數據，如果想要獲取可以通過下面方法：

• 直接通過Ctx.Input.RequestBody獲取原始的數據
• 配置文件里設置 copyrequestbody = true

這樣就可以通過c.Ctx.Input.RequestBody 獲取