Go 模板中整数范围迭代指南

在 go 模板中直接迭代整数范围（例如 `for i := 1 to 10`）并不直接支持。本文将介绍两种主要方法来解决此问题：一是利用第三方库 `github.com/bradfitz/iter` 提供的 `n` 函数，通过注册自定义函数实现简洁的范围迭代；二是通过编写一个返回整数流的自定义 go 函数，并将其注册到模板中，以获得更大的灵活性和控制。这两种方法都能有效在 go 模板中实现基于数字范围的迭代需求，尤其适用于分页等场景。

Go 模板中的迭代挑战

Go 模板语言设计简洁，其 range 关键字主要用于迭代切片、数组、映射或通道。然而，对于常见的编程需求，例如需要从 1 迭代到 10 来生成分页链接，Go 模板本身并没有提供类似 {{range $i := 1 .. 10}} 的语法糖。这使得开发者需要寻找替代方案来实现整数范围的迭代。

方法一：使用 github.com/bradfitz/iter 包

github.com/bradfitz/iter 是一个轻量级的第三方库，专门为 Go 模板提供了一种简洁的整数范围迭代方式。它通过提供一个名为 N 的函数，允许模板以 Go 风格的 range 循环来模拟数字迭代。

1. 安装 iter 包

首先，需要将 iter 包添加到项目中：

go get github.com/bradfitz/iter

2. 注册 N 函数到模板

在使用 iter.N 之前，必须将其注册为模板的自定义函数。这通过 template.FuncMap 实现。

package main

import (
    "html/template"
    "os"
    "github.com/bradfitz/iter" // 导入 iter 包
)

func main() {
    // 创建一个新的模板实例
    t := template.New("pagination").Funcs(template.FuncMap{
        "N": iter.N, // 将 iter.N 函数注册为模板函数 "N"
    })

    // 解析模板内容
    t, err := t.Parse(`
        
        
        
            Pagination Example
        
        
            使用 iter.N 的分页
            
                {{range $i, $_ := N 10}}
                    {{if $i}} {{/* 忽略索引0，从1开始 */}}
                        {{$i}}
                    {{end}}
                {{end}}
            
        
        
    `)
    if err != nil {
        panic(err)
    }

    // 执行模板并输出到标准输出
    err = t.Execute(os.Stdout, nil)
    if err != nil {
        panic(err)
    }
}

3. 在模板中使用 N 函数

注册后，就可以在模板中使用 N 函数了。N 函数接受一个整数参数 m，并生成一个从 0 到 m-1 的序列。

{{range $i, $_ := N 10}}
    {{/* 这里的 $i 将依次是 0, 1, ..., 9 */}}
    {{$i}}
{{end}}

注意事项：

iter.N 生成的序列是从 0 开始的。如果需要从 1 开始迭代到 m，可以传入 m+1 作为参数，并在模板中使用 {{if $i}} 来跳过索引 0。
$_ 是一个占位符，表示我们不关心 range 提供的第二个返回值（通常是切片元素或映射值）。

例如，要生成从 1 到 10 的分页链接：

{{range $i, $_ := N 11}} {{/* 生成 0 到 10 的序列 */}}
    {{if $i}} {{/* 当 $i 不为 0 时才渲染 */}}
        {{$i}}
    {{end}}
{{end}}

方法二：实现自定义整数范围函数

如果不想引入第三方库，或者需要更精细的控制（例如指定起始和结束值），可以编写一个自定义的 Go 函数，并将其注册到模板中。这种方法通常使用 Go 的通道（channel）来流式传输整数序列。

1. 定义自定义函数

创建一个返回 chan int 的函数，该通道将按顺序发送整数。

package main

import (
    "html/template"
    "os"
)

// N 是一个自定义函数，用于生成从 start 到 end 的整数序列
func N(start, end int) chan int {
    stream := make(chan int) // 创建一个整数通道
    go func() {
        defer close(stream) // 确保通道在函数退出时关闭
        for i := start; i <= end; i++ {
            stream <- i // 将整数发送到通道
        }
    }()
    return stream
}

func main() {
    // 创建一个新的模板实例，并注册自定义的 N 函数
    t := template.New("custom_pagination").Funcs(template.FuncMap{
        "N": N, // 将自定义的 N 函数注册为模板函数 "N"
    })

    // 解析模板内容
    t, err := t.Parse(`
        
        
        
            Custom Pagination Example
        
        
            使用自定义 N 函数的分页
            
                {{range $i := N 1 10}} {{/* 从 1 迭代到 10 */}}
                    {{$i}}
                {{end}}
            
        
        
    `)
    if err != nil {
        panic(err)
    }

    // 执行模板并输出到标准输出
    err = t.Execute(os.Stdout, nil)
    if err != nil {
        panic(err)
    }
}

2. 在模板中使用自定义函数

注册后，可以在模板中直接调用该函数，并使用 range 关键字迭代其返回的通道。

{{range $i := N 1 10}} {{/* $i 将依次是 1, 2, ..., 10 */}}
    {{$i}}
{{end}}

这种方法的优势在于，N 函数现在可以接受 start 和 end 两个参数，提供了更灵活的范围控制，无需额外的条件判断来处理起始值。

总结与选择

使用 github.com/bradfitz/iter：
- 优点： 最少的工作量，代码简洁，无需自己实现通道逻辑。
- 缺点： 引入第三方依赖，默认从 0 开始计数，需要额外处理 1 到 N 的情况。
- 适用场景： 对性能要求不高，追求快速实现，且可以接受从 0 开始的计数习惯或少量条件判断的场景。
实现自定义整数范围函数：
- 优点： 无第三方依赖，完全控制逻辑，可以轻松实现任意起始和结束的范围，更具灵活性。
- 缺点： 需要编写额外的 Go 代码，涉及 Goroutine 和 Channel 的使用。
- 适用场景： 对依赖有严格限制，需要高度定制化范围逻辑，或对 Go 并发模型有一定了解的场景。