开源项目 `littleboss` 使用教程

1. 项目的目录结构及介绍

littleboss/
├── README.md
├── example
│   └── main.go
├── go.mod
├── go.sum
└── littleboss.go

• README.md: 项目说明文件，包含项目的基本介绍和使用方法。
• example/main.go: 示例文件，展示了如何使用 littleboss 包来管理服务。
• go.mod: Go 模块文件，定义了项目的依赖关系。
• go.sum: Go 模块的校验文件，确保依赖的完整性和安全性。
• littleboss.go: 项目的主要代码文件，包含了 littleboss 包的实现。

2. 项目的启动文件介绍

example/main.go 是项目的启动文件，展示了如何使用 littleboss 包来管理服务。以下是该文件的主要内容：

package main

import (
	"context"
	"fmt"
	"log"
	"net/http"
	"os"
	"time"

	"github.com/crawshaw/littleboss"
)

func main() {
	lb := littleboss.New("example-service")

	lb.Run(func(ctx context.Context) {
		srv := &http.Server{
			Addr:    ":8080",
			Handler: http.HandlerFunc(handler),
		}

		go func() {
			<-ctx.Done()
			shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
			defer cancel()
			srv.Shutdown(shutdownCtx)
		}()

		if err := srv.ListenAndServe(); err != http.ErrServerClosed {
			log.Fatalf("http.ListenAndServe: %v", err)
		}
	})
}

func handler(w http.ResponseWriter, r *http.Request) {
	fmt.Fprintf(w, "Hello, world!\n")
}

• littleboss.New("example-service"): 创建一个新的 littleboss 实例，并指定服务名称为 example-service。
• lb.Run(func(ctx context.Context) { ... }): 启动服务，并在上下文中运行提供的函数。
• srv.ListenAndServe(): 启动 HTTP 服务器，监听端口 8080。
• srv.Shutdown(shutdownCtx): 在接收到关闭信号时，优雅地关闭服务器。

3. 项目的配置文件介绍

littleboss 项目本身没有独立的配置文件，其配置主要通过命令行参数和环境变量进行。以下是一些常见的配置方式：

命令行参数

$ ./example-service -help
Usage of ./example-service:
  -debug
    	enable debug logging
  -port int
    	port to listen on (default 8080)

• -debug: 启用调试日志。
• -port: 指定服务器监听的端口，默认为 8080。

环境变量

$ export EXAMPLE_SERVICE_DEBUG=true
$ export EXAMPLE_SERVICE_PORT=8081
$ ./example-service

• EXAMPLE_SERVICE_DEBUG: 启用调试日志。
• EXAMPLE_SERVICE_PORT: 指定服务器监听的端口。

通过这些配置方式，可以灵活地调整 littleboss 服务的运行参数。