控制器注册

这种方式将每一个请求都当做一个控制器对象来处理，比较类似且媲美于PHP的请求执行模式，当一个请求进来之后，立即初始化一个新的控制器对象进行处理，处理完成之后释放控制器资源。这种服务注册方式的优点是简单、安全、OOP设计，每个请求的控制器严格数据隔离，成员变量无法相互共享。

在这种模式下，我们可以给控制器struct对象定义一些非并发安全的成员变量，在请求中可以进行随意操作，不会影响并发安全性，因为请求一旦完成，所有的成员变量随着控制器对象销毁而销毁。

控制器注册方式当然也支持{.struct}及{.method}内置变量。

控制器注册方式与执行对象注册方式非常类似，两者除了运行机制不一样以外，其他细节大同小异。建议在开始本章节阅读之前先了解一下执行对象注册方式。

控制器注册

基本使用

我们可以通过BindController方法完成控制器的注册。

gitee.com/johng/gf/blob/master/geg/frame/mvc/controller/demo/user.go

  1. package demo
  3. import (
  4.     "gitee.com/johng/gf/g"
  5.     "gitee.com/johng/gf/g/frame/gmvc"
  6. )
  8. type User struct {
  9.     gmvc.Controller
  10. }
  12. func init() {
  13.     s := g.Server()
  14.     s.BindController("/user",                       new(User))
  15.     s.BindController("/user/{.method}/{uid}",       new(User), "Info")
  16.     s.BindController("/user/{.method}/{page}.html", new(User), "List")
  17. }
  19. func (u *User) Index() {
  20.     u.Response.Write("User")
  21. }
  23. func (u *User) Info() {
  24.     u.Response.Write("Info - Uid: ", u.Request.Get("uid"))
  25. }
  27. func (u *User) List() {
  28.     u.Response.Write("List - Page: ", u.Request.Get("page"))
  29. }

以上注册的路由列表：

  1. /user
  2. /user.index
  3. /user/info
  4. /user/list
  5. /user/{.method}/{uid}
  6. /user/{.method}/{page}.html

服务注册必须提供注册的pattern，往往是一个精准匹配规则的URI，注册时会将所有控制器的公开方法映射到指定URI末尾(示例代码中，s.BindController("/user", new(User))，其中的new(User)也可以使用&User{}来替换)。注册的控制器参数是一个ghttp.Controller接口，参数直接传递自定义的控制器对象指针即可(&ControllerUser{}，实际上只要继承了gmvc.Controller基类，控制器的指针对象便已经自动实现了ghttp.Controller接口)。

该示例也展示了内置变量{.method}来使用方法名称，当注册的规则中带有内置变量时，路由将不会自动将方法名称追加到所给规则末尾，而是使用方法名称替换该内置变量。

框架通过解析该对象指针获取对应的控制器方法，生成反射类型，处理请求时再根据该反射类型自动生成对应的控制器对象，处理客户端请求，处理完后自动销毁该控制器对象。

指定方法

控制器方法注册原理类似于执行对象方法注册，只公开控制器中的特定方法。看下面这个例子，执行后ControllerMethod的Name和Age方法将被注册到Web Server提供服务，而Info方法却不会对外公开。

  1. package demo
  3. import (
  4.     "gitee.com/johng/gf/g"
  5.     "gitee.com/johng/gf/g/frame/gmvc"
  6. )
  8. type Method struct {
  9.     gmvc.Controller
  10. }
  12. func init() {
  13.     // 第三个参数指定主要注册的方法，其他方法不注册，方法名称会自动追加到给定路由后面，构成新路由
  14.     // 以下注册会中注册两个新路由: /method/name, /method/age
  15.     g.Server().BindController("/method", new(Method), "Name, Age")
  16. }
  18. func (c *Method) Name() {
  19.     c.Response.Write("John")
  20. }
  22. func (c *Method) Age() {
  23.     c.Response.Write("18")
  24. }
  26. func (c *Method) Info() {
  27.     c.Response.Write("Info")
  28. }

启动外层的main.go，我们尝试着访问http://127.0.0.1:8199/method/info，因为没有对该方法执行注册，因此会发现返回404；而http://127.0.0.1:8199/method/name及http://127.0.0.1:8199/method/age却能够正常访问。这个例子比较简单，没有用复杂的动态路由，因此不在赘述。

绑定路由方法

  1. package demo
  3. import (
  4.     "gitee.com/johng/gf/g"
  5.     "gitee.com/johng/gf/g/frame/gmvc"
  6. )
  8. type Method struct {
  9.     gmvc.Controller
  10. }
  12. func init() {
  13.     // 绑定路由到指定的方法执行，以下注册只会注册一个路由: /method-name
  14.     g.Server().BindControllerMethod("/method-name", new(Method), "Name")
  15. }
  17. func (c *Method) Name() {
  18.     c.Response.Write("John")
  19. }
  21. func (c *Method) Age() {
  22.     c.Response.Write("18")
  23. }
  25. func (c *Method) Info() {
  26.     c.Response.Write("Info")
  27. }

RESTful控制器注册

这种方式注册的控制器，运行模式和“控制器注册”模式相同。我们可以通过BindControllerRest方法完成RESTful控制器的注册。

以下是一个示例：

gitee.com/johng/gf/blob/master/geg/frame/mvc/controller/demo/rest.go

  1. package demo
  3. import (
  4.     "gitee.com/johng/gf/g"
  5.     "gitee.com/johng/gf/g/frame/gmvc"
  6. )
  8. type Rest struct {
  9.     gmvc.Controller
  10. }
  12. func init() {
  13.     g.Server().BindControllerRest("/rest", &Rest{})
  14. }
  16. // RESTFul - GET
  17. func (c *Rest) Get() {
  18.     c.Response.Write("RESTFul HTTP Method GET")
  19. }
  21. // RESTFul - POST
  22. func (c *Rest) Post() {
  23.     c.Response.Write("RESTFul HTTP Method POST")
  24. }
  26. // RESTFul - DELETE
  27. func (c *Rest) Delete() {
  28.     c.Response.Write("RESTFul HTTP Method DELETE")
  29. }
  31. // 该方法无法映射，将会无法访问到
  32. func (c *Rest) Hello() {
  33.     c.Response.Write("Hello")
  34. }

Init与Shut回调方法

ghttp.Controller接口中的Init和Shut是两个在HTTP请求流程中被Web Server自动调用的特殊方法(类似构造函数和析构函数的作用)。gmvc.Controller基类中已经实现了这两个方法，用户自定义的控制器类直接继承gmvc.Controller即可。如果需要自定义请求初始化以及请求结束时的一些业务逻辑操作，可以在自定义控制器中重载这两个方法。

  1. Init回调方法

    控制器初始化方法，参数是当前请求的对象。gmvc.Controller基类中的Init方法是对自身成员对象的初始化。

    方法定义：

    1.  // "构造函数"控制器方法
    2.  func (c *Controller) Init(r *ghttp.Request) {
    4.  }

  2. Shut回调方法

    当请求结束时被Web Server自动调用，可以用于控制器一些收尾处理的操作。默认不执行任何操作。

    方法定义：

    1.  // "析构函数"控制器方法
    2.  func (c *Controller) Shut(r *ghttp.Request) {
    4.  }

Exit方法

在控制器注册中，控制器对象还有一个Exit方法，供业务层直接调用，该方法的作用是标识该控制器已退出，不再执行后续的服务处理（但是不影响事件回调处理）。它仅仅是做一个标识作用，并不会马上停止服务执行。假如在Init回调方法中调用Exit，那么后续的服务逻辑将不会执行。假如在Shut方法中调用Exit，如果事件回调方法不做任何处理的话，那么该标识操作其实没有任何意义。

同 ghttp.Request.Exit()方法功能类似，控制器的Exit()方法可以看做ghttp.Request.Exit()方法的别名。