gobox中的http请求处理框架

奇技指南

今天和大家介绍下我们自主开发的go语言轻型框架gobox，为什么叫gobox呢？因为我们设计让每一个单独的模块都作为一个box，那这些box的集合就称为gobox，再使用go的pkg管理机制引入到项目中。随着go官方推出了dep这个包管理工具，我们把gobox中的每一个box都单独拿出来作为一个项目管理，这就是现在的gobox。

今天这一期，主要来说下使用gobox中的http请求处理框架。

http请求处理架构图

重要的对象

System

system用于实现go官方包中的http.Handler接口，它的ServeHTTP方法中实现了请求处理框架。

Router

定义和实现MVC的路由查找过程。

1. type Router interface {Router interface {

2.     MapRouteItems(cls ...controller.Controller)     // 自动将Controller对象中的Action方法映射到路由表MapRouteItems(cls ...controller.Controller)     // 自动将Controller对象中的Action方法映射到路由表

3.     DefineRouteItem(pattern string, cl controller.Controller, actionName string)   // 手动添加路由规则，pattern为正则表达式DefineRouteItem(pattern string, cl controller.Controller, actionName string)   // 手动添加路由规则，pattern为正则表达式

4. 
   

5.     FindRoute(path string) *Route    // 实现路由查找过程FindRoute(path string) *Route    // 实现路由查找过程

6. }

SimpleRouter

Router接口的一个实现，自动映射规则为：

1. controller名称规则为： ([A-Z][A-Za-z0-9_]*)Controller$，匹配内容转小写即为controllerName

2. action名称规则为： ^([A-Z][A-Za-z0-9_]*)Action$，匹配内容转小写后过滤掉 before和after即为actionName

自动路由查找规则如下：

1. 将request_uri视为： /controller/action

2. controller不存在，则默认为 index，可以修改

3. action不存在，则默认为 index，可以修改

自定义路由查找规则如下：

1. 对request_uri做正则匹配

2. 如果匹配后存在捕获，则捕获内容会作为action中除context外的参数，依次传入，都是string类型

ActionContext和Controller

ActionContext

处理每个请求会创建一个对应Controller的ActionContext对象：

1. type ActionContext interface {ActionContext interface {

2.     Request() *http.RequestRequest() *http.Request

3.     ResponseWriter() http.ResponseWriterResponseWriter() http.ResponseWriter

4. 
   

5.     ResponseBody() []byteResponseBody() []byte

6.     SetResponseBody(body []byte)SetResponseBody(body []byte)

7. 
   

8.     BeforeAction()BeforeAction()

9.     AfterAction()AfterAction()

10.     Destruct()Destruct()

11. }

Controller

组织Action：

1. type Controller interface {Controller interface {

2.     NewActionContext(req *http.Request, respWriter http.ResponseWriter) ActionContextNewActionContext(req *http.Request, respWriter http.ResponseWriter) ActionContext

3. }

gracehttp

这是一个支持平滑重启的httpserver，平滑重启过程如下：

示例代码

最后附上一个最简单的使用示例：

1. package main main

2. 
   

3. import ( (

4.     "github.com/goinbox/gohttp/controller""github.com/goinbox/gohttp/controller"

5.     "github.com/goinbox/gohttp/gracehttp""github.com/goinbox/gohttp/gracehttp"

6.     "github.com/goinbox/gohttp/router""github.com/goinbox/gohttp/router"

7.     "github.com/goinbox/gohttp/system""github.com/goinbox/gohttp/system"

8. 
   

9.     "net/http""net/http"

10. )

11. 
    

12. func main() {() {

13.     dcl := new(DemoController):= new(DemoController)

14.     r := router.NewSimpleRouter():= router.NewSimpleRouter()

15. 
    

16.     r.DefineRouteItem("^/g/([0-9]+)$", dcl, "get").DefineRouteItem("^/g/([0-9]+)$", dcl, "get")

17.     r.MapRouteItems(new(IndexController), dcl).MapRouteItems(new(IndexController), dcl)

18. 
    

19.     sys := system.NewSystem(r):= system.NewSystem(r)

20. 
    

21.     gracehttp.ListenAndServe(":8001", sys).ListenAndServe(":8001", sys)

22. }

23. 
    

24. type BaseActionContext struct {BaseActionContext struct {

25.     Req        *http.RequestReq        *http.Request

26.     RespWriter http.ResponseWriterRespWriter http.ResponseWriter

27.     RespBody   []byteRespBody   []byte

28. }

29. 
    

30. func (this *BaseActionContext) Request() *http.Request {(this *BaseActionContext) Request() *http.Request {

31.     return this.Reqreturn this.Req

32. }

33. 
    

34. func (this *BaseActionContext) ResponseWriter() http.ResponseWriter {(this *BaseActionContext) ResponseWriter() http.ResponseWriter {

35.     return this.RespWriterreturn this.RespWriter

36. }

37. 
    

38. func (this *BaseActionContext) ResponseBody() []byte {(this *BaseActionContext) ResponseBody() []byte {

39.     return this.RespBodyreturn this.RespBody

40. }

41. 
    

42. func (this *BaseActionContext) SetResponseBody(body []byte) {(this *BaseActionContext) SetResponseBody(body []byte) {

43.     this.RespBody = bodythis.RespBody = body

44. }

45. 
    

46. func (this *BaseActionContext) BeforeAction() {(this *BaseActionContext) BeforeAction() {

47.     this.RespBody = append(this.RespBody, []byte(" index before ")...)this.RespBody = append(this.RespBody, []byte(" index before ")...)

48. }

49. 
    

50. func (this *BaseActionContext) AfterAction() {(this *BaseActionContext) AfterAction() {

51.     this.RespBody = append(this.RespBody, []byte(" index after ")...)this.RespBody = append(this.RespBody, []byte(" index after ")...)

52. }

53. 
    

54. func (this *BaseActionContext) Destruct() {(this *BaseActionContext) Destruct() {

55.     println(" index destruct ")(" index destruct ")

56. }

57. 
    

58. type IndexController struct {IndexController struct {

59. }

60. 
    

61. func (this *IndexController) NewActionContext(req *http.Request, respWriter http.ResponseWriter) controller.ActionContext {(this *IndexController) NewActionContext(req *http.Request, respWriter http.ResponseWriter) controller.ActionContext {

62.     return &BaseActionContext{return &BaseActionContext{

63.         Req:        req,Req:        req,

64.         RespWriter: respWriter,RespWriter: respWriter,

65.     }}

66. }

67. 
    

68. func (this *IndexController) IndexAction(context *BaseActionContext) {(this *IndexController) IndexAction(context *BaseActionContext) {

69.     context.RespBody = append(context.RespBody, []byte(" index action ")...).RespBody = append(context.RespBody, []byte(" index action ")...)

70. }

71. 
    

72. func (this *IndexController) RedirectAction(context *BaseActionContext) {(this *IndexController) RedirectAction(context *BaseActionContext) {

73.     system.Redirect302("https://github.com/goinbox").Redirect302("https://github.com/goinbox")

74. }

75. 
    

76. type DemoActionContext struct {DemoActionContext struct {

77.     *BaseActionContext*BaseActionContext

78. }

79. 
    

80. func (this *DemoActionContext) BeforeAction() {(this *DemoActionContext) BeforeAction() {

81.     this.RespBody = append(this.RespBody, []byte(" demo before ")...)this.RespBody = append(this.RespBody, []byte(" demo before ")...)

82. }

83. 
    

84. func (this *DemoActionContext) AfterAction() {(this *DemoActionContext) AfterAction() {

85.     this.RespBody = append(this.RespBody, []byte(" demo after ")...)this.RespBody = append(this.RespBody, []byte(" demo after ")...)

86. }

87. 
    

88. func (this *DemoActionContext) Destruct() {(this *DemoActionContext) Destruct() {

89.     println(" demo destruct ")(" demo destruct ")

90. }

91. 
    

92. type DemoController struct {DemoController struct {

93. }

94. 
    

95. func (this *DemoController) NewActionContext(req *http.Request, respWriter http.ResponseWriter) controller.ActionContext {(this *DemoController) NewActionContext(req *http.Request, respWriter http.ResponseWriter) controller.ActionContext {

96.     return &DemoActionContext{return &DemoActionContext{

97.         &BaseActionContext{&BaseActionContext{

98.             Req:        req,Req:        req,

99.             RespWriter: respWriter,RespWriter: respWriter,

100.         },},

101.     }}

102. }

103. 
     

104. func (this *DemoController) DemoAction(context *DemoActionContext) {(this *DemoController) DemoAction(context *DemoActionContext) {

105.     context.RespBody = append(context.RespBody, []byte(" demo action ")...).RespBody = append(context.RespBody, []byte(" demo action ")...)

106. }

107. 
     

108. func (this *DemoController) GetAction(context *DemoActionContext, id string) {(this *DemoController) GetAction(context *DemoActionContext, id string) {

109.     context.RespBody = append(context.RespBody, []byte(" get action id = "+id)...).RespBody = append(context.RespBody, []byte(" get action id = "+id)...)

110. }

运行这个代码，请求示例及输出如下：

1. curl http://127.0.0.1:8001/://127.0.0.1:8001/

2. index before  index action  index after 

3. 
   

4. curl http://127.0.0.1:8001/index/redirect -I://127.0.0.1:8001/index/redirect -I

5. HTTP/1.1 302 Found/1.1 302 Found

6. Content-Type: text/html; charset=utf-8-Type: text/html; charset=utf-8

7. Location: https://github.com/goinbox: https://github.com/goinbox

8. Date: Fri, 24 Aug 2018 11:57:11 GMT: Fri, 24 Aug 2018 11:57:11 GMT

9. Content-Length: 14-Length: 14

10. 
    

11. curl http://127.0.0.1:8001/demo/demo://127.0.0.1:8001/demo/demo

12. demo before  demo action  demo after

13. 
    

14. curl http://127.0.0.1:8001/g/123://127.0.0.1:8001/g/123

15. demo before  get action id = 123 demo after get action id = 123 demo after 

所有destruct输出为：

1. index destruct 

2. index destruct 

3. index destruct 

4. demo destruct 

5. demo destruc

欢迎大家使用，使用中有遇到问题随时反馈，我们会尽快响应，谢谢！

推荐阅读

• gobox中的异常定义和杂项工具

• 基于inotify实现配置文件热更新

• Go配置文件热加载 - 发送系统信号
  

界世的你当不

只做你的肩膀

无

 360官方技术公众号 

技术干货|一手资讯|精彩活动

空·