{% raw %}
# 13.3 controller設計
傳統的MVC框架大多數是基于Action設計的后綴式映射,然而,現在Web流行REST風格的架構。盡管使用Filter或者rewrite能夠通過URL重寫實現REST風格的URL,但是為什么不直接設計一個全新的REST風格的 MVC框架呢?本小節就是基于這種思路來講述如何從頭設計一個基于REST風格的MVC框架中的controller,最大限度地簡化Web應用的開發,甚至編寫一行代碼就可以實現“Hello, world”。
## controller作用
MVC設計模式是目前Web應用開發中最常見的架構模式,通過分離 Model(模型)、View(視圖)和 Controller(控制器),可以更容易實現易于擴展的用戶界面(UI)。Model指后臺返回的數據;View指需要渲染的頁面,通常是模板頁面,渲染后的內容通常是HTML;Controller指Web開發人員編寫的處理不同URL的控制器,如前面小節講述的路由就是URL請求轉發到控制器的過程,controller在整個的MVC框架中起到了一個核心的作用,負責處理業務邏輯,因此控制器是整個框架中必不可少的一部分,Model和View對于有些業務需求是可以不寫的,例如沒有數據處理的邏輯處理,沒有頁面輸出的302調整之類的就不需要Model和View,但是controller這一環節是必不可少的。
## beego的REST設計
前面小節介紹了路由實現了注冊struct的功能,而struct中實現了REST方式,因此我們需要設計一個用于邏輯處理controller的基類,這里主要設計了兩個類型,一個struct、一個interface
type Controller struct {
Ct *Context
Tpl *template.Template
Data map[interface{}]interface{}
ChildName string
TplNames string
Layout []string
TplExt string
}
type ControllerInterface interface {
Init(ct *Context, cn string) //初始化上下文和子類名稱
Prepare() //開始執行之前的一些處理
Get() //method=GET的處理
Post() //method=POST的處理
Delete() //method=DELETE的處理
Put() //method=PUT的處理
Head() //method=HEAD的處理
Patch() //method=PATCH的處理
Options() //method=OPTIONS的處理
Finish() //執行完成之后的處理
Render() error //執行完method對應的方法之后渲染頁面
}
那么前面介紹的路由add函數的時候是定義了ControllerInterface類型,因此,只要我們實現這個接口就可以,所以我們的基類Controller實現如下的方法:
func (c *Controller) Init(ct *Context, cn string) {
c.Data = make(map[interface{}]interface{})
c.Layout = make([]string, 0)
c.TplNames = ""
c.ChildName = cn
c.Ct = ct
c.TplExt = "tpl"
}
func (c *Controller) Prepare() {
}
func (c *Controller) Finish() {
}
func (c *Controller) Get() {
http.Error(c.Ct.ResponseWriter, "Method Not Allowed", 405)
}
func (c *Controller) Post() {
http.Error(c.Ct.ResponseWriter, "Method Not Allowed", 405)
}
func (c *Controller) Delete() {
http.Error(c.Ct.ResponseWriter, "Method Not Allowed", 405)
}
func (c *Controller) Put() {
http.Error(c.Ct.ResponseWriter, "Method Not Allowed", 405)
}
func (c *Controller) Head() {
http.Error(c.Ct.ResponseWriter, "Method Not Allowed", 405)
}
func (c *Controller) Patch() {
http.Error(c.Ct.ResponseWriter, "Method Not Allowed", 405)
}
func (c *Controller) Options() {
http.Error(c.Ct.ResponseWriter, "Method Not Allowed", 405)
}
func (c *Controller) Render() error {
if len(c.Layout) > 0 {
var filenames []string
for _, file := range c.Layout {
filenames = append(filenames, path.Join(ViewsPath, file))
}
t, err := template.ParseFiles(filenames...)
if err != nil {
Trace("template ParseFiles err:", err)
}
err = t.ExecuteTemplate(c.Ct.ResponseWriter, c.TplNames, c.Data)
if err != nil {
Trace("template Execute err:", err)
}
} else {
if c.TplNames == "" {
c.TplNames = c.ChildName + "/" + c.Ct.Request.Method + "." + c.TplExt
}
t, err := template.ParseFiles(path.Join(ViewsPath, c.TplNames))
if err != nil {
Trace("template ParseFiles err:", err)
}
err = t.Execute(c.Ct.ResponseWriter, c.Data)
if err != nil {
Trace("template Execute err:", err)
}
}
return nil
}
func (c *Controller) Redirect(url string, code int) {
c.Ct.Redirect(code, url)
}
上面的controller基類已經實現了接口定義的函數,通過路由根據url執行相應的controller的原則,會依次執行如下:
Init() 初始化
Prepare() 執行之前的初始化,每個繼承的子類可以來實現該函數
method() 根據不同的method執行不同的函數:GET、POST、PUT、HEAD等,子類來實現這些函數,如果沒實現,那么默認都是403
Render() 可選,根據全局變量AutoRender來判斷是否執行
Finish() 執行完之后執行的操作,每個繼承的子類可以來實現該函數
## 應用指南
上面beego框架中完成了controller基類的設計,那么我們在我們的應用中可以這樣來設計我們的方法:
package controllers
import (
"github.com/astaxie/beego"
)
type MainController struct {
beego.Controller
}
func (this *MainController) Get() {
this.Data["Username"] = "astaxie"
this.Data["Email"] = "astaxie@gmail.com"
this.TplNames = "index.tpl"
}
上面的方式我們實現了子類MainController,實現了Get方法,那么如果用戶通過其他的方式(POST/HEAD等)來訪問該資源都將返回403,而如果是Get來訪問,因為我們設置了AutoRender=true,那么在執行完Get方法之后會自動執行Render函數,就會顯示如下界面:

index.tpl的代碼如下所示,我們可以看到數據的設置和顯示都是相當的簡單方便:
<!DOCTYPE html>
<html>
<head>
<title>beego welcome template</title>
</head>
<body>
<h1>Hello, world!{{.Username}},{{.Email}}</h1>
</body>
</html>
## links
* [目錄](<preface.md>)
* 上一章: [自定義路由器設計](<13.2.md>)
* 下一節: [日志和配置設計](<13.4.md>)
{% endraw %}
- 目錄
- Go環境配置
- Go安裝
- GOPATH 與工作空間
- Go 命令
- Go開發工具
- 小結
- Go語言基礎
- 你好,Go
- Go基礎
- 流程和函數
- struct
- 面向對象
- interface
- 并發
- 小結
- Web基礎
- web工作方式
- Go搭建一個簡單的web服務
- Go如何使得web工作
- Go的http包詳解
- 小結
- 表單
- 處理表單的輸入
- 驗證表單的輸入
- 預防跨站腳本
- 防止多次遞交表單
- 處理文件上傳
- 小結
- 訪問數據庫
- database/sql接口
- 使用MySQL數據庫
- 使用SQLite數據庫
- 使用PostgreSQL數據庫
- 使用beedb庫進行ORM開發
- NOSQL數據庫操作
- 小結
- session和數據存儲
- session和cookie
- Go如何使用session
- session存儲
- 預防session劫持
- 小結
- 文本文件處理
- XML處理
- JSON處理
- 正則處理
- 模板處理
- 文件操作
- 字符串處理
- 小結
- Web服務
- Socket編程
- WebSocket
- REST
- RPC
- 小結
- 安全與加密
- 預防CSRF攻擊
- 確保輸入過濾
- 避免XSS攻擊
- 避免SQL注入
- 存儲密碼
- 加密和解密數據
- 小結
- 國際化和本地化
- 設置默認地區
- 本地化資源
- 國際化站點
- 小結
- 錯誤處理,調試和測試
- 錯誤處理
- 使用GDB調試
- Go怎么寫測試用例
- 小結
- 部署與維護
- 應用日志
- 網站錯誤處理
- 應用部署
- 備份和恢復
- 小結
- 如何設計一個Web框架
- 項目規劃
- 自定義路由器設計
- controller設計
- 日志和配置設計
- 實現博客的增刪改
- 小結
- 擴展Web框架
- 靜態文件支持
- Session支持
- 表單支持
- 用戶認證
- 多語言支持
- pprof支持
- 小結
- 參考資料