wego框架支持以字符串、json、xml、html等格式响应HTTP请求,相应的函数定义如下:
Write(code int, contentType string, data []byte)
WriteText(code int, data string)
WriteJSON(code int, obj interface{})
WriteXML(code int, obj interface{})
WriteHTML(code int, filename string, data interface{})
wego对于JSON的支持非常好,可以非常方便的开发一个基于JSON输出的API。若要返回JSON格式的请求结果,可以使用WriteJSON()函数:
func writeJson(c *wego.WebContext) {
var user User
user.ID = 1
user.Name = "demo"
user.Age = 12
c.WriteJSON(200, user)
}
/*输出结果为:
{"Name":"demo","ID":1,"Age":12}
*/
使用WriteJSON函数输出的JSON字符串是扁平的,没有进行缩进显示。若需要输出更加美观的json数据,则可以使用WriteIndentedJSON()函数:
func writeIndentedJSON(c *wego.WebContext) {
var user User
user.ID = 1
user.Name = "demo"
user.Age = 12
c.WriteIndentedJSON(200, user)
}
/*输出结果为:
{
"Name": "demo",
"ID": 1,
"Age": 12
}*/
JSONP可以跨域,主要是利用了script标签跨域的能力,script标签可以引用任何域名下的JS文件。wego支持输出JSONP请求结果。示例代码如下:
<html lang="en">
<head>
<meta charset="utf-8">
<title>file upload</title>
<script type="text/javascript" src="http://127.0.0.1:8080/jsonp?callback=alert"></script>
</head>
<body>
</body>
</html>
func writeJSONP(c *wego.WebContext) {
var user User
user.ID = 1
user.Name = "demo"
user.Age = 12
c.WriteJSONP(200, user)
}
说明:http的请求中必须有:callback参数,若不存在callback参数,则返回正常的json数据。
返回xml数据的处理方式跟json类似,要返回XML数据,只需要使用WriteXML()方法即可:
func writeXML(c *wego.WebContext) {
var user User
user.ID = 1
user.Name = "demo"
user.Age = 12
c.WriteXML(200, user)
}
wego框架采用了Go语言默认的模板引擎,所以和Go的模板语法一样。以下是一个输出HTML页面的例子:
func writeHtml(c *wego.WebContext) {
c.WriteHTML(200, "./views/index.html", nil)
}
若您的页面有多个HTML模板组成,您可以使用WriteHTMLS:
WriteHTMLS(code int, filenames []string, data interface{})
其中:filenames是模板文件的数组,数组中的第一个文件是主文件模板。示例代码:
<html lang="en">
<head>
<meta charset="utf-8">
</head>
<body>
<h1>this is layout</h1>
{{ template "content" .}}
</body>
</html>
<h2>this is index</h2>
{{define "content"}}
<h2>hello : {{.Name}}</h2>
{{end}}
*服务端代码
func writeHtmls(c *wego.WebContext) {
var user User
user.ID = 1
user.Name = "demo"
user.Age = 12
files := []string {
"./views/layout.html",
"./views/index.html",
}
c.WriteHTMLS(200, files, user)
}
func writeLayoutHtml(c *wego.WebContext) {
var user User
user.ID = 1
user.Name = "demo"
user.Age = 12
c.WriteLayoutHTML(200, "./views/layout.html", "./views/index.html",user)
}
如果您的模板文件中使用了模板函数,需要预先将所需的模板函数进行登记, 一般在web.Run()之前进行模板函数的初始化。示例代码:
func GetUserID(id int64) string {
return fmt.Sprintf("ID_%d", id)
}
func main() {
web, err := wego.NewWeb()
if err != nil{
log.Error(err)
return
}
wego.AddTemplFunc("GetUserID", GetUserID)
web.GET("/templfunc", ShowHtmlWithTemplFunc)
err = web.Run(":8080")
if err != nil {
log.Error(err)
}
}
<html lang="en">
<body>
<h2>hello : {{.Name}}</h2>
<h2>id : {{GetUserID .ID}}</h2>
</body>
</html>
func ShowHtmlWithTemplFunc(c *wego.WebContext) {
var user User
user.ID = 1
user.Name = "demo"
user.Age = 12
c.WriteHTML(200, "./views/content.html", user)
}
项目中的js、css、jpg之类的文件文件称之为静态资源。在wego中访问静态资源需要使用StaticPath进行静态资源注册,或者使用StaticFile来为一个文件注册路由:
func main() {
web, err := wego.NewWeb()
if err != nil{
log.Error(err)
return
}
web.StaticPath("/static", "./static")
web.StaticFile("/favicon.ico", "./rfavicon.ico")
err = web.Run(":8080")
if err != nil {
log.Error(err)
}
}
如果你想实现动态处理文件下载,例如在文件下载的时候验证下用户的权限,这种情况下可以使用WriteFile来实现输出文件:
func writeFile(c *wego.WebContext) {
c.WriteFile("./demo.xls", "demo.xls" )
}
输出内容时若需要使用Gzip,可以在调用WriteXXX函数之前调用UseGzip()来设置是否使用Gzip进行压缩输出:
func main() {
web, err := wego.NewWeb()
if err != nil{
log.Error(err)
return
}
web.GET("/gzip", ShowHtmlWithGzip)
err = web.Run(":8080")
if err != nil {
log.Error(err)
}
}
func ShowHtmlWithGzip(c *wego.WebContext) {
c.UseGzip(true).WriteHTML(200, "./content.html", nil)
}
另外,也可以通过配置文件设置是否开启Gzip功能:
#是否开启 gzip
gzip_on = true
#压缩长度阈值,只有超过gzip_size的会被压缩返回
gzip_size = 256
开启Gzip后所有超过gzip_sized大小的返回数据都会被压缩处理。若开启全局Gzip后某些请求不需要Gzip,您可以使用拦截器来控制是否采用gzip来输出内容。
func setCookie(c *wego.WebContext) {
val, err := c.Input.Cookie("demo")
if err != nil {
log.Error(err)
}
cookie := &http.Cookie{
Name: "demo",
Value: "test",
Path: "/",
HttpOnly: true,
}
c.SetCookie(cookie)
}
func main() {
web, err := wego.NewWeb()
if err != nil{
log.Error(err)
return
}
web.GET("/redirect", func(c *wego.WebContext) {
c.Redirect(302, "/index")
})
err = web.Run(":8080")
if err != nil {
log.Error(err)
}
}
在web开发的中,如果遇到错误,需要输出一个错误提示给用户,例如500错误。wego框架提供了一些列函数用于错误输出:
示例代码:
func main() {
web, err := wego.NewWeb()
if err != nil{
log.Error(err)
return
}
web.GET("/abort", func(c *wego.WebContext) {
name := c.Param.GetString("name")
if name.Error != nil {
c.AbortWithError(500, name.Error)
return
}
c.WriteText(200, "hello " + name.Value)
})
err = web.Run(":8080")
if err != nil {
log.Error(err)
}
}
除了上面的错误处理函数,用户还可以定义全局的错误处理函数:
示例代码:定义全局500错误处理函数
func Handler500(c *wego.WebContext) {
c.WriteText(500, "这是一个500错误")
}
示例代码:设置500错误处理函数
func main() {
web, err := wego.NewWeb()
if err != nil{
log.Error(err)
return
}
web.GET("/abort", abort_500)
web.SetHandler500(Handler500)
err = web.Run(":8080")
if err != nil {
log.Error(err)
}
}
示例代码:使用500错误处理函数
func abort_500(c *wego.WebContext) {
name := c.Param.GetString("name")
if name.Error != nil {
c.Abort500()
return
}
c.WriteText(200, "hello " + name.Value)
}