Невозможно загрузить шаблоны HTML с помощью Gin

У меня возникли проблемы с загрузкой HTML-шаблонов с использованием фреймворка Gin через параметр r.HTMLRender.

Казалось бы, шаблоны не находят.

Я пробовал использовать следующие помощники:

Ни один из них, похоже, не работает при установке пути по умолчанию для шаблонов (в моем случае app/views); для того, чтобы заставить это работать, моя файловая структура шаблона html выглядит следующим образом:

/workspace
|-app
  |-views
    |-layouts
      |-application.html
    |-test.html

Вот пример кода загрузки Gin:

import (
    "github.com/gin-contrib/location"
    "github.com/gin-gonic/gin"
    "fmt"
    "os"
    "github.com/gin-gonic/contrib/static"
    "github.com/michelloworld/ez-gin-template"
)

//CORSMiddleware ...
func CORSMiddleware() gin.HandlerFunc {
    /** CORS middleware **/
}

func Router() {

    if os.Getenv("ENVIRONMENT") == "production" {
        gin.SetMode(gin.ReleaseMode)
    }

    // Initialize Gin object
    r := gin.Default()

    // Cors Middleware
    r.Use(CORSMiddleware())

    // Rate limiting
    rl, err := helpers.RateLimiterMiddleware()
    if err != nil {
        panic("Rate Limiting Initialization error")
    }
    r.Use(rl)

    // Asset provision
    r.Use(static.ServeRoot("/public","app/assets"))

    // Get URL information
    r.Use(location.Default())

    // Attempt with EZ Template, fails
    // I ge this error: "runtime error: invalid memory address or nil pointer dereference" when calling c.HTML(...)
    render := eztemplate.New()
    render.TemplatesDir = "app/views/" // default
    render.Layout = "layouts/application"     // default
    render.Ext = ".html"               // default
    render.Debug = true               // default
    r.HTMLRender = render.Init()


    // Attempt with GinHTMLRender, fails
    // I get this error: https://gist.github.com/madhums/4340cbeb36871e227905#file-gin_html_render-go-L110
    /* 
    htmlRender := GinHTMLRender.New()
    htmlRender.TemplatesDir = "app/views/"
    htmlRender.Debug = gin.IsDebugging()
    htmlRender.Layout = "layouts/application"

    log.Println("Dir:"+htmlRender.TemplatesDir)

    r.HTMLRender = htmlRender.Create()*/

    /** Some Routes **/

    // Start web listener

    r.Run(":8009") // listen and serve on 0.0.0.0:8080
}

Соответствующий вызов рендеринга представляет собой следующий код:

/* c is of type *gin.Context */
c.HTML(200, "test", "")

По какой-то причине кажется, что функция r.HTMLRender не учитывает путь к шаблону; Я пытался сделать это:

_, err := template.ParseFiles("app/views/test.html")
if err != nil {
    log.Println("Template Error")
} else {
    log.Println("No Template Error")
}

В этом коде постоянно отображается сообщение «Нет ошибки шаблона», что наводит меня на мысль, что присвоение HTMLRender не учитывает переменную набора TemplatesDir.

Я какое-то время сталкивался с этой проблемой, и я не совсем уверен, как ее решить.

Любая помощь, чтобы заставить это работать, будет принята с благодарностью.


person autronix    schedule 27.11.2017    source источник
comment
Вы пробовали LoadHTMLGlob() или LoadHTMLFiles() из gin-gonic / gin # html-rendering? ?   -  person assefamaru    schedule 27.11.2017
comment
Я хочу воспользоваться вспомогательным способом, чтобы уменьшить загрузку каждого шаблона вручную при рендеринге страницы. Я действительно нашел источник своей проблемы с EZ Gin Template, хотя я не пробовал снова с GinRenderHTML. Я опубликую свои выводы в качестве ответа на мой вопрос. Спасибо за предложение.   -  person autronix    schedule 27.11.2017


Ответы (3)


Проведя дополнительное исследование, я нашел источник своей проблемы с EZ Gin Template.

Я надеюсь, что это поможет любому, у кого возникнет такая же проблема.

После более глубокого изучения вспомогательного кода я понял, что шаблон сопоставления шаблонов является строгим и не выполняет рекурсивный поиск файлов; т.е. он ожидает, что для поиска файлов шаблонов будет определенная файловая структура:

По умолчанию для работы EZ Gin Template требуется следующая файловая структура:

/workspace
- app
  - views
    - layouts
      - some_layout.html
    - some_dir
      - template_file.html
      - _partial_template.html
    - partials
      - _some_other_partial.html

Чтобы разрешить использование других шаблонов файлов, необходимо изменить вспомогательный набор функций.

В моем случае я локально разветвил вспомогательный код, чтобы разрешить сопоставление файлов шаблонов 1-го уровня:

func (r Render) Init() Render {
    globalPartials := r.getGlobalPartials()

    layout := r.TemplatesDir + r.Layout + r.Ext

    // Match multiple levels of templates
    viewDirs, _ := filepath.Glob(r.TemplatesDir + "**" + string(os.PathSeparator) + "*" + r.Ext)
    // Added the following two lines to match for app/views/some_file.html as well as files on the **/*.html matching pattern
    tmp, _ := filepath.Glob(r.TemplatesDir + "*" + r.Ext)
    viewDirs = append(viewDirs, tmp...)
    // Can be extended by replicating those two lines above and adding search paths within the base template path.

    fullPartialDir := filepath.Join(r.TemplatesDir + r.PartialDir)
    for _, view := range viewDirs {
        templateFileName := filepath.Base(view)
        //skip partials
        if strings.Index(templateFileName, "_") != 0 && strings.Index(view, fullPartialDir) != 0 {
            localPartials := r.findPartials(filepath.Dir(view))

            renderName := r.getRenderName(view)
            if r.Debug {
                log.Printf("[GIN-debug] %-6s %-25s --> %s\n", "LOAD", view, renderName)
            }
            allFiles := []string{layout, view}
            allFiles = append(allFiles, globalPartials...)
            allFiles = append(allFiles, localPartials...)
            r.AddFromFiles(renderName, allFiles...)
        }
    }

    return r
}

Я не пробовал аналогичное решение с GinHTMLRenderer, но полагаю, что проблема может быть связана с ним с точки зрения ожидаемой файловой структуры.

person autronix    schedule 27.11.2017

Вы также можете привязать шаблоны к коду. jessevdk / go-assets-builder создаст файл go, содержащий ресурсы в указанный каталог. Убедитесь, что сгенерированный файл находится там, где находится основной пакет. Джин также привел это в качестве примера в своей документации Для получения дополнительной информации. Он также будет включать в двоичный файл подпапки и их файлы (т.е. активы).

Получите инструмент генератора:

go get github.com/jessevdk/go-assets-builder

Сгенерировать:

# go-assets-builder <dir> -o <generated file name>
go-assets-builder app -o assets.go

Обратите внимание, что <generated file name> также может быть похож на cmd/client/assets.go для указания места назначения файла, который должен быть сгенерирован.

Загрузить шаблон:

package main

// ... imports

func main() {
    r := gin.New()

    t, err := loadTemplate()
    if err != nil {
        panic(err)
    }
    r.SetHTMLTemplate(t)

    r.GET("/", func(c *gin.Context) {
        c.HTML(http.StatusOK, "app/views/layouts/application.html", nil)
    })
    r.GET("/test", func(c *gin.Context) {
        c.HTML(http.StatusOK, "app/views/test.html", nil)
    })
    r.Run(":8080")
}

// loadTemplate loads templates embedded by go-assets-builder
func loadTemplate() (*template.Template, error) {
    t := template.New("")
    // Assets is the templates
    for name, file := range Assets.Files {
        if file.IsDir() || !strings.HasSuffix(name, ".html") {
            continue
        }
        h, err := ioutil.ReadAll(file)
        if err != nil {
            return nil, err
        }
        t, err = t.New(name).Parse(string(h))
        if err != nil {
            return nil, err
        }
    }
    return t, nil
}
person go je jo    schedule 19.01.2020

Вот как я это делаю. Это проходит по каталогу и собирает файлы, отмеченные моим суффиксом шаблона, то есть .html, а затем я просто включаю их все. Я нигде не видел этого ответа, поэтому решил опубликовать его.

// START UP THE ROUTER
router := gin.Default()

var files []string
filepath.Walk("./views", func(path string, info os.FileInfo, err error) error {
    if strings.HasSuffix(path, ".html") {
        files = append(files, path)
    }
    return nil
})

router.LoadHTMLFiles(files...)

// SERVE STATICS
router.Use(static.Serve("/css", static.LocalFile("./css", true)))
router.Use(static.Serve("/js", static.LocalFile("./js", true)))
router.Use(static.Serve("/images", static.LocalFile("./images", true)))

routers.LoadBaseRoutes(router)
routers.LoadBlog(router)

router.Run(":8080")

Теперь они не должны быть вложены на точную глубину, как другие предложения ... структура файла может быть неравномерной.

person Cengleby    schedule 10.01.2021