feat: add render template logic

coderi421 · coderi421 · commit d6089c5c8c24 · 2023-08-25T16:03:47.000+08:00
diff --git a/context.go b/context.go
@@ -29,6 +29,9 @@ type Context struct {
 
 	// 命中的路由
 	MatchedRoute string
+
+	// 通过 ctx 将 template engine 传递下去
+	tplEngine TemplateEngine
 }
 
 func (c *Context) BindJSON(val any) error {
@@ -50,6 +53,20 @@ func (c *Context) BindJSON(val any) error {
 	return decoder.Decode(val)
 }
 
+func (c *Context) Render(tplName string, data any) error {
+	// 不要这样子去做
+	// tplName = tplName + ".gohtml"
+	// tplName = tplName + c.tplPrefix
+	var err error
+	c.RespData, err = c.tplEngine.Render(c.Req.Context(), tplName, data)
+	if err != nil {
+		c.RespStatusCode = http.StatusInternalServerError
+		return err
+	}
+	c.RespStatusCode = http.StatusOK
+	return nil
+}
+
 // FormValue returns the first value for the named component of the query.
 func (c *Context) FormValue(key string) StringValue {
 	// ParseForm parses the raw query from the URL and updates r.Form.
diff --git a/server.go b/server.go
@@ -11,6 +11,8 @@ type HandleFunc func(ctx *Context)
 // 确保 HTTPServer 肯定实现了 Server 接口
 var _ Server = (*HTTPServer)(nil)
 
+type HTTPServerOption func(server *HTTPServer)
+
 // Server is the interface that wraps the basic ServeHTTP method.
 // here is the interface of core API
 type Server interface {
@@ -39,13 +41,27 @@ type Server interface {
 type HTTPServer struct {
 	// addr string 创建的时候传递，而不是 Start 接收。这个都是可以的
 	router
-	mdls []Middleware
+	mdls      []Middleware
+	tplEngine TemplateEngine
 }
 
-func NewHTTPServer() *HTTPServer {
-	return &HTTPServer{
+func NewHTTPServer(opts ...HTTPServerOption) *HTTPServer {
+	s := &HTTPServer{
 		router: newRouter(),
 	}
+
+	// 不是核心逻辑，无需在 server interface 中实现，放在 struct 就可以
+	for _, opt := range opts {
+		opt(s)
+	}
+
+	return s
+}
+
+func ServerWithTemplateEngine(tplEngine TemplateEngine) HTTPServerOption {
+	return func(server *HTTPServer) {
+		server.tplEngine = tplEngine
+	}
 }
 
 // Use 可以通过调用方法注册 Middleware 也可以改成 Opts 函数选项模式
@@ -72,6 +88,8 @@ func (s *HTTPServer) ServeHTTP(writer http.ResponseWriter, request *http.Request
 	ctx := &Context{
 		Req:  request,
 		Resp: writer,
+		// 将 template engine 实例到 ctx 中
+		tplEngine: s.tplEngine,
 	}
 
 	// Middleware 和 serve 一起的时候， HTTPServer 执行路由匹配，应该是最后一个，最后一个执行用户的逻辑
diff --git a/template.go b/template.go
@@ -0,0 +1,58 @@
+package kyuu
+
+import (
+	"bytes"
+	"context"
+	"html/template"
+	"io/fs"
+)
+
+type TemplateEngine interface {
+	// Render 渲染页面
+	// data 是渲染页面所需要的数据
+	Render(ctx context.Context, tplName string, data any) ([]byte, error)
+}
+
+var _ TemplateEngine = (*GoTemplateEngine)(nil)
+
+type GoTemplateEngine struct {
+	T *template.Template
+	// 也可以考虑设计为 map[string]*template.Template
+	// 但是其实没太大必要，因为 template.Template 本身就提供了按名索引的功能
+}
+
+// Render
+// 渲染页面
+//
+//	@Description:
+//	@receiver g
+//	@param ctx
+//	@param tplName
+//	@param data
+//	@return []byte
+//	@return error
+func (g *GoTemplateEngine) Render(ctx context.Context, tplName string, data any) ([]byte, error) {
+	res := &bytes.Buffer{}
+	err := g.T.ExecuteTemplate(res, tplName, data)
+	return res.Bytes(), err
+}
+
+// 以下这三个方法，可以加可以不加，看你是什么风格的设计者
+
+func (g *GoTemplateEngine) LoadFromGlob(pattern string) error {
+	var err error
+	g.T, err = template.ParseGlob(pattern)
+	return err
+}
+
+func (g *GoTemplateEngine) LoadFromFiles(filenames ...string) error {
+	var err error
+	g.T, err = template.ParseFiles(filenames...)
+	return err
+}
+
+func (g *GoTemplateEngine) LoadFromFS(fs fs.FS, patterns ...string) error {
+	var err error
+	g.T, err = template.ParseFS(fs, patterns...)
+	return err
+}
diff --git a/template_e2e_test.go b/template_e2e_test.go
@@ -0,0 +1,24 @@
+package kyuu
+
+import (
+	"html/template"
+	"testing"
+)
+
+func TestLoginPage(t *testing.T) {
+	tpl, err := template.ParseGlob("testdata/tpls/*.gohtml")
+	if err != nil {
+		t.Fatal(err)
+	}
+	s := NewHTTPServer(ServerWithTemplateEngine(&GoTemplateEngine{T: tpl}))
+	s.Get("/login", func(ctx *Context) {
+		er := ctx.Render("login.gohtml", nil)
+		if er != nil {
+			t.Fatal(er)
+		}
+	})
+	err = s.Start(":8081")
+	if err != nil {
+		t.Fatal(err)
+	}
+}
diff --git a/testdata/tpls/login.gohtml b/testdata/tpls/login.gohtml
@@ -0,0 +1,9 @@
+<html>
+<body>
+<form>
+    邮箱：<input type="email" placeholder="邮箱">
+    密码：<input type="password">
+    <button>登录</button>
+</form>
+</body>
+</html>
