lang.cn.md

layout	default
title	扩展 Go 语言自身

扩展 Go 语言自身

• TOC {:toc}

App

import "github.com/v2pro/plz"

plz.RunApp(func() int {
	// os.Exit(0)
	return 0
})

把main函数包装起来。返回值就是进程的exit code。提供以下两个 SPI

AfterPanic

import "github.com/v2pro/plz/lang/app"

app.AfterPanic = append(app.AfterPanic, func(recovered interface{}, kv []interface{}) int {
	fmt.Println("panic", recovered)
	return 2
})

在main函数panic的时候被回调。可以在这里做一些打日志，上报指标的事情。

BeforeFinish

import "github.com/v2pro/plz/lang/app"

app.BeforeFinish = append(app.BeforeFinish, func(kv []interface{}) {
	ioutil.WriteFile("/tmp/hello", []byte("world"), os.ModeAppend|0666)
})

在退出之前回调。一般用于处理一些日志刷盘的事情。如果有panic，会先调用 AfterPanic 再调用 BeforeFinish。

Routine

import "github.com/v2pro/plz"

plz.Go(func() {
	fmt.Println("hello from one off goroutine")
	panic("should not crash the whole program")
})

通过 plz.Go 调用比直接 go 可以自动实现 panic 的捕捉。

import "github.com/v2pro/plz"

plz.GoLongRunning(func() {
	timer := time.NewTimer(time.Second).C
	for {
		select {
		case <-timer:
			fmt.Println("hello from running goroutine")
			return
		}
	}
})

对于常驻的后台goroutine，我们往往需要保证它不要挂掉。简单的panic recover会导致goroutine退出。使用 plz.GoLongRunning 启动的goroutine可以在异常之后自动重启。

包装goroutine的生命周期，除了给一些默认的行为之外，更多是为了把一些 SPI 暴露出去，从而使得其他的库能够进行一些扩展（比如限制同时并发数，实现goroutine local storage）。

BeforeStart

import "github.com/v2pro/plz/lang/routine"

routine.BeforeStart = append(routine.BeforeStart, func(kv []interface{}) error {
	return errors.New("can not start more goroutine")
})

在goroutine被启动之前调用。如果返回错误，则goroutine不会被启动。错误会作为 plz.Go 或者 plz.GoLongRunning 的返回值返回。调用者在goroutine外部。

AfterStart

import "github.com/v2pro/plz/lang/routine"

routine.AfterStart = append(routine.AfterStart, func(kv []interface{}) {
	fmt.Println("started")
})

在goroutine启动之后被调用。与BeforeStart不同，调用者在goroutine内部。

AfterPanic

import "github.com/v2pro/plz/lang/routine"

routine.AfterPanic = append(routine.AfterPanic, func(recovered interface{}, kv []interface{}) {
	fmt.Println("panic", recovered)
})

在任何goroutine panic之后被调用。如果是GoLongRunning，则可能一个goroutine多次调用AfterPanic。调用者在goroutine内部。

BeforeFinish

import "github.com/v2pro/plz/lang/routine"

routine.BeforeFinish = append(routine.BeforeFinish, func(kv []interface{}) {
	fmt.Println("finished")
})

在goroutine退出之前被调用。每个goroutine仅调用一次。调用者在goroutine内部。如果有panic，会先调用 AfterPanic 再调用 BeforeFinish。

Tagging

通过 struct 自身定义 tag

type Order struct {
	OrderId   int `json:"order_id"`
	ProductId int `json:"product_id"`
}

这种写法是go原生支持的写法。缺点是

• 都在一个字符串上，写得比较长
• 无法支持不同上下文，提供不同的tags。比如一个字段是requird，取决于输入的来源方。
• 不支持string之外的数据类型
• 只能定义在 field 上，无法定义在 struct 自身，或者非 struct 的类型

扩展的 github.com/v2pro/plz/tagging 就是为了扩展打tag的能力。给任意的 go 类型都可以打 tag。

通过 struct method 定义 tag

import "github.com/v2pro/plz/tagging"

type Order struct {
	OrderId   int `json:"order_id"`
	ProductId int `json:"product_id"`
}

func (order *Order) DefineTags() tagging.Tags {
	return tagging.D(
		tagging.S("comment", "some more info about the struct itself"),
		tagging.F(&order.OrderId, "validation", "required", "tag_is_not_only_string", 100),
		tagging.F(&order.ProductId, "validation", "required"),
	)
}

通过 tagging.Define 定义 tag

import "github.com/v2pro/plz/tagging"

type Product struct {
	ProductId int `json:"product_id"`
}

tagging.Define(func(p *Product) tagging.Tags {
	return tagging.D(
		tagging.S("comment", "some more info about the struct itself"),
		tagging.F(&p.ProductId, "validation", "required", "tag_is_not_only_string", 100),
	)
})