上一章我们讲了如何启动一个dotweb程序,本篇文章将介绍如何注册路由。
router是dotweb用来管理路由的结构体,它提供了一些关于路由操作函数。
app := dotweb.New() router := app.HttpServer.Router()
在上一篇文章中我们讲了dotweb.New()的用处,HttpServer负责处理请求,管理路由、session、中间件等等功能。稍后我会介绍server对象。在这里我们获取路由对象也是通过httpserver获取。一般我们会声明一个函数,在该函数里注册路由,避免在main函数里有过多的代码。示例如下:
func main(){ app := dotweb.New() InitRouter(app.HttpServer) app.StartServer(8080)
} func InitRouter(hs *dotweb.HttpServer){ hs.Router().Get("/index", Index) } func Index(ctx *dotweb.HttpContext){ ctx.WitreString("Hello Dotweb!") }
在以上示例中我们声明了一个名为 InitRouter 的函数,它将在main函数被执行,在 InitRouter函数里我们注册不同的路由,而 Index 函数被我们成为 UserHandler 它用来处理请求。上述代码将返回“Hello Dotweb!”字符串。
hs.Router().GET("/index",Index)//HttpGet请求 hs.Router().POST("/post",Post)//HttpPost请求 hs.Router().HEAD("/head",Head)//HttpHead请求 hs.Router().OPTIONS("/pptions",Options)//HttpOptions请求 hs.Router().PUT("/put",Put)//HttpPut请求 hs.Router().DELETE("/delete",Delete)//httpDelete请求
HTTP定义的请求方法一共有八种,除了上述六种还有TRACE和CONNECT两种。大部分场景下我们使用上述六种请求方法就可以满足项目需求,而RESTful Web API定义请求方法也不包含TRACE和CONNECT。虽然dotweb没有提供TEACE和CONNECT请求方法,但是它额外提供了四种。
hs.Router().Any("/any",Any)
Any函数表示你可以用任何请求方法请求该地址,如果是GET函数那么这个地址只能被GET方法的请求访问,但如果是Any函数你可以用GET请求也可以用POST请求、PUT请求等等。
hs.Router().HiJack("/hijack",Hijack)
HiJack使用的是GET方法请求,但是它又和普通的GET请求不同。它一般用于长连接,一般的请求不需要用到它。如果你想要了解更多的HiJack使用方法可以参考dotweb的姊妹项目—longweb。它为web程序提供长连接服务,github地址:https://github.com/devfeel/longweb。该项目实测百万长连接,如果你有需要可以参考或者使用该项目。它是免费、开源的。
hs.Router().ServerFile("/img/xxx.jpg","/webroot/img")//第一个参数表示路由地址,第二个参数表示服务器上文件地址
ServerFile用来访问静态文件。
hs.Router().RegisterRoute("WebSocket","/websocket",Websocket)
RegisterRoute可以注册以上所有类型的路由,方法类型由第一个参数区分,WebSocket需要用这种方法注册路由。
以上就是dotweb提供注册路由的函数,更多的路由注册方式你可以通过阅读源码得知。在此我解释下路由注册函数的两个形参,第一个是string类型的参数,它表示路由地址。假设本机地址是192.168.0.1,端口号为8080.如果参数为“/”则表示根地址,你输入192。168.0.1:8080就可以访问到。如果是“/index”它的地址是192.168.0.1:8080/index。dotweb还有一种叫做参数路由的路由配置,“/news/:id”这里的“:id”表示一个参数,如果你了解restful风格你就会明白这种配置方式的含义,当然这里的参数允许有多个“/news/:uid/:id”。第二个参数是一个形参为*dotweb.HttpContext的函数,它负责处理用户请求,参数表示当前请求的上下文,你可以通过它访问session、cache、request等等对象。
需要注意的是dotweb有个设置,如果你启动它那么所有非head的路由都将会被注册一个head方法的路由,它在需要验证请求是否可用的场景下非常有用,下面是启用方法,默认值为false。
app.HttpServer.SetEnabledAutoHEAD(true)
接下来我将介绍UserHandler,如果你有过javaweb或者asp.net mvc的开发经验那么UserHandler非常好理解,它就是控制器中的方法。你可以在这里做简单的CRUD也可以做复杂的业务处理,甚至你也可以在这里使用三层的设计。你可以把UserHandler都写到一个go文件中,也可以按照业务分到不同go文件中,事实上我建议你分开。我将在后续文章中介绍UserHandler的写法,实际上你掌握了dotweb.HttpContext的用法就可以去实现UserHandler。
当然在dotweb中也支持配置文件装载路由,我会在后续文章中专门写一篇介绍如何使用配置文件,在那里我会把dotweb的配置相关的介绍一遍。随着dotweb受到的关注越来越多更多的人参与到dotweb这个项目中来,我们一起努力完善增强dotweb,在此我希望你也能参与到dotweb中来,因为我们需要你的力量。项目地址:https://github.com/devfeel/dotweb,你可以在github项目地址中找到我们的官方QQ群,我们欢迎你加入dotweb大家庭。