Gorazor 使用教程

1. 项目介绍

Gorazor 是一个 Go 语言实现的视图引擎，它是 ASP.NET 中 Razor 视图引擎的一个端口。Gorazor 以其高性能、简洁的语法和代码生成方式著称。它能够将模板转换成 Go 代码，然后编译并优化，从而提供极快的执行速度。Gorazor 支持原生 Razor 语法，可以在视图模板中直接嵌入 Go 代码，并提供了布局和区块支持等功能。

2. 项目快速启动

安装

首先，确保你的 Go 版本为 1.10 或以上。对于更好的编译优化，建议使用 1.12 或以上版本。使用以下命令安装 Gorazor：

go install github.com/sipin/gorazor@latest

使用

处理文件夹

要处理一个文件夹中的模板，可以使用以下命令：

gorazor template_folder output_folder

处理文件

要处理单个模板文件，可以使用以下命令：

gorazor template_file output_file

示例

以下是使用 Gorazor 的一个简单示例：

1. 克隆项目：

git clone https://github.com/sipin/gorazor.git
cd gorazor

2. 编译项目：

go build

3. 运行示例：

./gorazor -prefix github.com/sipin/gorazor ./examples/tpl ./examples/tpl
go run example/main.go

3. 应用案例和最佳实践

变量使用

在模板中插入字符串变量：

<div>
Hello @user.Name
</div>

可以使用 Go 函数包装变量：

<div>
Hello @strings.ToUpper(req.CurrentUser.Name)
</div>

使用 raw 以跳过转义：

<div>
@raw(user.Name)
</div>

注意： 只在你完全确定的情况下使用 raw，请始终注意 XSS 攻击。

流程控制

使用 if 条件语句：

@if user.IsActive {
    <p>User is active</p>
} else {
    <p>User is not active</p>
}

使用 for 循环：

@for index, item := range items {
    <p>@index: @item</p>
}

使用 switch 语句：

@{
    switch msg {
    case "info":
        <p>Info message</p>
    case "error":
        <p>Error message</p>
    default:
        <p>Unknown message</p>
    }
}

代码块

在模板中可以嵌入任意的 Go 代码：

 @{
    username := u.Name
    if u.Email != "" {
        username += "(" + u.Email + ")"
    }
 }
<div class="welcome">
    <h4>Hello @username</h4>
</div>

注意： 保持视图和逻辑的清晰分离，尽可能将逻辑移动到 Go 代码中，而不是在模板中创建代码块。

声明

模板的第一个代码块用于声明：

 @{
    import (
        "kp/models"
        "tpl/layout"
    )
    layout := layout.Base
    var user *models.User
    var blog *models.Blog
}

第一个代码块必须在模板的开头，即任何 HTML 之前。在此代码块中声明的变量将是模板的模型，即生成函数的参数。

帮助器/包含其他模板

Gorazor 将模板编译为 Go 函数，因此嵌入另一个模板只是调用生成的函数。如果模板被设计为可嵌入的，它们必须放在 helper 命名空间下，即放在 helper 子文件夹中。

使用帮助器模板的示例：

@if msg != "" {
    <div>
        @helper.ShowMsg(msg)
    </div>
}

注意： helper.ShowMsg 的输出不会被 HTML 转义。

布局和区块

声明布局的语法有些特殊：

 @{
    import (
        "tpl/layout"
    )
    layout := layout.Base
}

在这里，tpl/layout 是布局包的命名空间，layout 变量指向 layout.Base 函数，该函数应该由 tpl/layout/base.gohtml 文件生成。

布局文件 tpl/layout/base.gohtml 可能看起来像这样：

 @{
    var body string
    var sidebar string
    var footer string
}

4. 典型生态项目

Gorazor 作为 Go 语言的一个视图引擎，可以与许多生态项目结合使用，例如：

• 与 Web 框架（如 Beego、Iris 等）集成，提供动态页面渲染。
• 与数据库工具（如 GORM、XORM 等）结合，进行数据展示。
• 与前端构建工具（如Webpack、Gulp 等）配合，优化前后端分离的开发流程。

Gorazor 的灵活性和高性能使其成为构建复杂 Web 应用程序的理想选择。