diff --git a/README.md b/README.md index 120c319..5dee09d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Gee 的设计与实现参考了Gin，这个教程可以快速入门：[Go Gin简 - [第三天：Tire树路由(Router)](https://geektutu.com/post/gee-day3.html)，[Code - Github](day3-router) - [第四天：分组控制(Group)](https://geektutu.com/post/gee-day4.html)，[Code - Github](day4-group) - [第五天：中间件(Middleware)](https://geektutu.com/post/gee-day5.html)，[Code - Github](day5-middleware) -- 第六天：HTML模板(Template)，[Code - Github](day6-template) +- [第六天：HTML模板(Template)](https://geektutu.com/post/gee-day6.html)，[Code - Github](day6-template) - 第七天：错误恢复(Panic Recover)，[Code - Github](day7-panic-recover) diff --git a/day6-template/gee/gee.go b/day6-template/gee/gee.go index e48a496..357f6e9 100644 --- a/day6-template/gee/gee.go +++ b/day6-template/gee/gee.go @@ -75,7 +75,7 @@ func (group *RouterGroup) createStaticHandler(relativePath string, fs http.FileS absolutePath := path.Join(group.prefix, relativePath) fileServer := http.StripPrefix(absolutePath, http.FileServer(fs)) return func(c *Context) { - file := c.Param("/filepath") + file := c.Param("filepath") // Check if file exists and/or if we have permission to access it if _, err := fs.Open(file); err != nil { c.Status(http.StatusNotFound) diff --git a/day6-template/main.go b/day6-template/main.go index 92d4fe5..2400183 100644 --- a/day6-template/main.go +++ b/day6-template/main.go @@ -25,7 +25,7 @@ $ curl http://localhost:9999/students /* (3) serve static files -$ curl http://localhost:9999/assets/geektutu.css +$ curl http://localhost:9999/assets/css/geektutu.css p { color: orange; font-weight: 700; diff --git a/day7-panic-recover/gee/gee.go b/day7-panic-recover/gee/gee.go index 0643fb2..9eeb356 100644 --- a/day7-panic-recover/gee/gee.go +++ b/day7-panic-recover/gee/gee.go @@ -82,7 +82,7 @@ func (group *RouterGroup) createStaticHandler(relativePath string, fs http.FileS absolutePath := path.Join(group.prefix, relativePath) fileServer := http.StripPrefix(absolutePath, http.FileServer(fs)) return func(c *Context) { - file := c.Param("/filepath") + file := c.Param("filepath") // Check if file exists and/or if we have permission to access it if _, err := fs.Open(file); err != nil { c.Status(http.StatusNotFound) diff --git a/doc/gee-day6.md b/doc/gee-day6.md new file mode 100644 index 0000000..ad4845b --- /dev/null +++ b/doc/gee-day6.md @@ -0,0 +1,190 @@ +--- +title: Go语言动手写Web框架 - Gee第六天 模板(HTML Template) +date: 2019-09-08 20:10:00 +description: 7天用 Go语言 从零实现Web框架教程(7 days implement golang web framework from scratch tutorial)，用 Go语言/golang 动手写Web框架，从零实现一个Web框架，以 Gin 为原型从零设计一个Web框架。本文介绍了如何为Web框架添加HTML模板(HTML Template)以及静态文件(Serve Static Files)的功能。 +tags: +- Go +categories: +- 从零实现 +keywords: +- Go语言 +- 从零实现Web框架 +- 动手写Web框架 +- Template +image: post/gee-day6/html.png +github: https://github.com/geektutu/7days-golang +--- + +本文是 [7天用Go从零实现Web框架Gee教程系列](https://geektutu.com/post/gee.html)的第六篇。 + +- 实现静态资源服务(Static Resource)。 +- 支持HTML模板渲染。 + +## 服务端渲染 + +现在越来越流行前后端分离的开发模式，即 Web 后端提供 RESTful 接口，返回结构化的数据(通常为 JSON 或者 XML)。前端使用 AJAX 技术请求到所需的数据，利用 JavaScript 进行渲染。Vue/React 等前端框架持续火热，这种开发模式前后端解耦，优势非常突出。后端童鞋专心解决资源利用，并发，数据库等问题，只需要考虑数据如何生成；前端童鞋专注于界面设计实现，只需要考虑拿到数据后如何渲染即可。使用 JSP 写过网站的童鞋，应该能感受到前后端耦合的痛苦。JSP 的表现力肯定是远不如 Vue/React 等专业做前端渲染的框架的。而且前后端分离在当前还有另外一个不可忽视的优势。因为后端只关注于数据，接口返回值是结构化的，与前端解耦。同一套后端服务能够同时支撑小程序、移动APP、PC端 Web 页面，以及对外提供的接口。随着前端工程化的不断地发展，Webpack，gulp 等工具层出不穷，前端技术越来越自成体系了。 + +但前后分离的一大问题在于，页面是在客户端渲染的，比如浏览器，这对于爬虫并不友好。Google 爬虫已经能够爬取渲染后的网页，但是短期内爬取服务端直接渲染的 HTML 页面仍是主流。 + +今天的内容便是介绍 Web 框架如何支持服务端渲染的场景。 + +## 静态文件(Serve Static Files) + +网页的三剑客，JavaScript、CSS 和 HTML。要做到服务端渲染，第一步便是要支持 JS、CSS 等静态文件。还记得我们之前设计动态路由的时候，支持通配符`*`匹配多级子路径。比如路由规则`/assets/*filepath`，可以匹配`/assets/`开头的所有的地址。例如`/assets/js/geektutu.js`，匹配后，参数`filepath`就赋值为`js/geektutu.js`。 + +那如果我么将所有的静态文件放在`/usr/web`目录下，那么`filepath`的值即是该目录下文件的相对地址。映射到真实的文件后，将文件返回，静态服务器就实现了。 + +找到文件后，如何返回这一步，`net/http`库已经实现了。因此，gee 框架要做的，仅仅是解析请求的地址，映射到服务器上文件的真实地址，交给`http.FileServer`处理就好了。 + +[day6-template/gee/gee.go](https://github.com/geektutu/7days-golang/tree/master/day6-template/gee) + +```go +// create static handler +func (group *RouterGroup) createStaticHandler(relativePath string, fs http.FileSystem) HandlerFunc { + absolutePath := path.Join(group.prefix, relativePath) + fileServer := http.StripPrefix(absolutePath, http.FileServer(fs)) + return func(c *Context) { + file := c.Param("filepath") + // Check if file exists and/or if we have permission to access it + if _, err := fs.Open(file); err != nil { + c.Status(http.StatusNotFound) + return + } + + fileServer.ServeHTTP(c.Writer, c.Req) + } +} + +// serve static files +func (group *RouterGroup) Static(relativePath string, root string) { + handler := group.createStaticHandler(relativePath, http.Dir(root)) + urlPattern := path.Join(relativePath, "/*filepath") + // Register GET handlers + group.GET(urlPattern, handler) +} +``` + +我们给`RouterGroup`添加了2个方法，`Static`这个方法是暴露给用户的。用户可以将磁盘上的某个文件夹`root`映射到路由`relativePath`。例如： + +```go +r := gee.New() +r.Static("/assets", "/usr/geektutu/blog/static") +// 或相对路径 r.Static("/assets", "./static") +r.Run(":9999") +``` + +用户访问`localhost:9999/assets/js/geektutu.js`，最终返回`/usr/geektutu/blog/static/js/geektutu.js`。 + +## HTML 模板渲染 + +Go语言内置了`text/template`和`html/template`2个模板标准库，其中[html/template](https://golang.org/pkg/html/template/)为 HTML 提供了较为完整的支持。包括普通变量渲染、列表渲染、对象渲染等。gee 框架的模板渲染直接使用了`html/template`提供的能力。 + +```go +Engine struct { + *RouterGroup + router *router + groups []*RouterGroup // store all groups + htmlTemplates *template.Template // for html render + funcMap template.FuncMap // for html render +} + +func (engine *Engine) SetFuncMap(funcMap template.FuncMap) { + engine.funcMap = funcMap +} + +func (engine *Engine) LoadHTMLGlob(pattern string) { + engine.htmlTemplates = template.Must(template.New("").Funcs(engine.funcMap).ParseGlob(pattern)) +} +``` + +首先为 Engine 示例添加了 `*template.Template` 和 `template.FuncMap`对象，前者将所有的模板加载进内存，后者是所有的自定义模板渲染函数。 + +另外，给用户分别提供了设置自定义渲染函数`funcMap`和加载模板的方法。 + +接下来，对原来的 `(*Context).HTML()`方法做了些小修改，使之支持根据模板文件名选择模板进行渲染。 + +[day6-template/gee/context.go](https://github.com/geektutu/7days-golang/tree/master/day6-template/gee) + +```go +func (c *Context) HTML(code int, name string, data interface{}) { + c.Writer.WriteHeader(code) + c.Writer.Header().Set("Content-Type", "text/html") + if err := c.engine.htmlTemplates.ExecuteTemplate(c.Writer, name, data); err != nil { + c.Fail(500, err.Error()) + } +} +``` + +## 使用Demo + +最终的目录结构 + +```bash +---gee/ +---static/ + |---css/ + |---geektutu.css + |---file1.txt +---templates/ + |---arr.tmpl + |---css.tmpl + |---custom_func.tmpl +---main.go +``` + +```html + + + +

geektutu.css is loaded

+ +``` + +[day6-template/main.go](https://github.com/geektutu/7days-golang/tree/master/day6-template/gee) + +```go +type student struct { + Name string + Age int8 +} + +func formatAsDate(t time.Time) string { + year, month, day := t.Date() + return fmt.Sprintf("%d-%02d-%02d", year, month, day) +} + +func main() { + r := gee.New() + r.Use(gee.Logger()) + r.SetFuncMap(template.FuncMap{ + "formatAsDate": formatAsDate, + }) + r.LoadHTMLGlob("templates/*") + r.Static("/assets", "./static") + + stu1 := &student{Name: "Geektutu", Age: 20} + stu2 := &student{Name: "Jack", Age: 22} + r.GET("/", func(c *gee.Context) { + c.HTML(http.StatusOK, "css.tmpl", nil) + }) + r.GET("/students", func(c *gee.Context) { + c.HTML(http.StatusOK, "arr.tmpl", gee.H{ + "title": "gee", + "stuArr": [2]*student{stu1, stu2}, + }) + }) + + r.GET("/date", func(c *gee.Context) { + c.HTML(http.StatusOK, "custom_func.tmpl", gee.H{ + "title": "gee", + "now": time.Date(2019, 8, 17, 0, 0, 0, 0, time.UTC), + }) + }) + + r.Run(":9999") +} +``` + +访问下主页，模板正常渲染，CSS 静态文件加载成功。 + +![day6-template](gee-day6/static.jpg) \ No newline at end of file diff --git a/doc/gee-day6/html.png b/doc/gee-day6/html.png new file mode 100644 index 0000000..81cf086 Binary files /dev/null and b/doc/gee-day6/html.png differ diff --git a/doc/gee.md b/doc/gee.md index 1fa945f..03f2c79 100644 --- a/doc/gee.md +++ b/doc/gee.md @@ -67,5 +67,5 @@ func handler(w http.ResponseWriter, r *http.Request) { - [第三天：Tire树路由(Router)](https://geektutu.com/post/gee-day3.html)，[Code - Github](https://github.com/geektutu/7days-golang/tree/master/day3-router) - [第四天：分组控制(Group)](https://geektutu.com/post/gee-day4.html)，[Code - Github](https://github.com/geektutu/7days-golang/tree/master/day4-group) - [第五天：中间件(Middleware)](https://geektutu.com/post/gee-day5.html)，[Code - Github](https://github.com/geektutu/7days-golang/tree/master/day5-middleware) -- 第六天：HTML模板(Template)，[Code - Github](https://github.com/geektutu/7days-golang/tree/master/day6-template) +- [第六天：HTML模板(Template)](https://geektutu.com/post/gee-day6.html)，[Code - Github](https://github.com/geektutu/7days-golang/tree/master/day6-template) - 第七天：错误恢复(Panic Recover)，[Code - Github](https://github.com/geektutu/7days-golang/tree/master/day7-panic-recover) \ No newline at end of file