使用Boilr快速创建Golang项目模板

Boilr是一个简单高效的Golang项目模板工具，可以帮助开发者快速从预定义的模板创建项目结构，避免重复搭建项目框架的繁琐工作。

安装Boilr

# 使用go install安装
go install github.com/tmrts/boilr/cmd/boilr@latest

# 或者直接下载二进制文件
# 从GitHub releases页面下载对应平台的二进制文件
# https://github.com/tmrts/boilr/releases

基本使用

1. 初始化Boilr

boilr init

这会创建~/.boilr目录用于存储模板。

2. 下载模板

Boilr支持从GitHub等地方下载模板：

# 下载官方示例模板
boilr template download github.com/tmrts/boilr-templates/golang-cli my-golang-cli

# 或者下载其他模板
boilr template download github.com/author/template-repo template-name

3. 列出可用模板

boilr template list

4. 使用模板创建项目

boilr template use my-golang-cli my-new-project

执行后会提示输入模板变量值，然后生成项目。

创建自定义模板

1. 创建模板目录结构

my-template/
├── template
│   ├── main.go
│   ├── go.mod
│   └── ...
└── metadata.yml

2. 编写metadata.yml

variables:
  - name: "ProjectName"
    description: "What is your project name?"
    type: "string"
    default: "my-project"
    
  - name: "GoVersion"
    description: "Which Go version to use?"
    type: "string"
    default: "1.21"

3. 在模板文件中使用变量

在模板文件中使用{{.VariableName}}语法：

// main.go
package main

import "fmt"

func main() {
    fmt.Println("Welcome to {{.ProjectName}}!")
}

4. 保存模板

boilr template save ./my-template my-golang-template

高级用法

条件语句

{{if eq .UseLogging "yes"}}
import "log"
{{end}}

循环语句

{{range .Dependencies}}
import "{{.}}"
{{end}}

预定义函数

Boilr提供了一些有用的函数：

• lower - 转换为小写
• upper - 转换为大写
• title - 首字母大写
• trim - 去除空格

package {{lower .ProjectName}}

实际示例

1. 创建一个CLI项目模板

metadata.yml:

variables:
  - name: "ProjectName"
    description: "Project name"
    type: "string"
    default: "my-cli"
    
  - name: "UseCobra"
    description: "Use Cobra CLI library? (yes/no)"
    type: "string"
    default: "yes"

main.go.template:

package main

{{if eq .UseCobra "yes"}}
import (
    "github.com/spf13/cobra"
)

func main() {
    cmd := &cobra.Command{
        Use:   "{{.ProjectName}}",
        Short: "A brief description of your application",
    }
    
    if err := cmd.Execute(); err != nil {
        panic(err)
    }
}
{{else}}
import "fmt"

func main() {
    fmt.Println("Hello from {{.ProjectName}}!")
}
{{end}}

2. 使用模板

boilr template use my-cli-template new-cli-project
# 回答提示问题后生成项目

优点

1. 节省时间 - 避免重复搭建项目结构
2. 一致性 - 团队使用相同模板保证项目结构一致
3. 灵活性 - 支持条件逻辑和变量替换
4. 易于分享 - 模板可以轻松共享给团队成员

Boilr是Golang项目中提高开发效率的实用工具，特别适合需要频繁创建新项目或维护多个相似项目结构的团队。