golang sync.once的应用

sync.once是被用于全局执行单次函数的场景，用法比较简单。
我们用到它主要是为了单元测试的执行，因为有些单元测试的函数需要和db交互，还有log的初始化，config配置文件的初始化，等等，这些其实都只需要执行一次就够了，对于单元测试来说，如何知道这些是否执行过呢，那就用sync.once，这样我就不需要关心这些是否重复执行，只要在每个用例的最前面执行sync.once的方法就行了。

sync.once使用起来比较简单，直接上示例：

var InitOnce sync.Once

func DbInitOnce() {
    connect_str := config.Gconfig.DB.UserName + ":" + config.Gconfig.DB.Password + "@tcp(" +
        config.Gconfig.DB.IP + ":" + config.Gconfig.DB.Port + ")/" + config.Gconfig.DB.Name
    Gdb.Db, _ = sqlx.Open("mysql", connect_str)

    _ = Gdb.Db.Ping()

    Gdb.Db.SetMaxOpenConns(config.Gconfig.DB.MaxConn)
    Gdb.Db.SetMaxIdleConns(200)
    Gdb.Db.SetConnMaxLifetime(time.Second * 300)
}

var loggerOnce sync.Once
var configOnce sync.Once

func loggerInit() {
    logger.New(config.Gconfig.Log.LogFileName)
    logger.SetDefaultLogger(config.Gconfig.Log.LogFileName).SetLevel(config.Gconfig.Log.LogLevel)
}

func configInit() {
    config.ReadConfigFileForTest(&config.Gconfig, "../config.cfg")
}

func TestInsertIndex(t *testing.T) {  //单元测试用例
    configOnce.Do(configInit)
    loggerOnce.Do(loggerInit)
    db.InitOnce.Do(db.DbInitOnce)  //第一段代码
    Db2.Db = db.Gdb.Db

    convey.Convey("测试插入汇率", t, func() {
        convey.Convey("插入无报错", func() {
            var testEntity = IndexDetail{
                Currency: "USD",
                Date:     "2018-03-22",
                Index:    0.8058,
            }
            err := Db2.insertIndex(testEntity)
            convey.So(err, convey.ShouldBeNil)
        })
    })
}

光会用是不够的，再来看下sync.once的实现原理
源码：

// Once is an object that will perform exactly one action.
type Once struct {
    m    Mutex
    done uint32
}

.
.
.

func (o *Once) Do(f func()) {
    if atomic.LoadUint32(&o.done) == 1 {
        return
    }

    o.m.Lock()
    defer o.m.Unlock()
    if o.done == 0 {
        defer atomic.StoreUint32(&o.done, 1)
        f()
    }
}

源码也比较好理解，一把锁，一个flag进行标识。
先判断flag，如果已经为1，则直接返回。如果是0，则先加锁，然后把flag置为1，然后执行函数对象，最后解锁。

golang sync.once的应用

猜你喜欢