golang第三方庫之go-homedir

go-homedir是一個(gè)用于獲取用戶主目錄的微型第三方庫授舟,代碼不超過200行。源碼地址:go-homedir

為什么不用os/user庫浩村?

golang標(biāo)準(zhǔn)庫包含的os/user庫可以獲取用戶的主目錄盒至,代碼如下:

package main

import (
    "fmt"
    "os/user"
)

func main() {
    u, _ := user.Current()
    fmt.Println(u.HomeDir)
}

github上的解釋如下:The built-in os/user package requires cgo on Darwin systems. This means that any Go code that uses that package cannot cross compile. But 99% of the time the use for os/user is just to retrieve the home directory, which we can do for the current user without cgo. This library does that, enabling cross-compilation.
Darwin操作系統(tǒng)上使用os/user包需要開啟cgo硕旗,開啟cgo意味著不能交叉編譯缺谴。該庫既可以獲取用戶的主目錄但惶,也可以交叉編譯。

接口介紹

go-homedir的接口有4個(gè):

名字 變量類型 作用
DisableCache bool false - 第一次獲取主目錄后修改主目錄湿蛔,Dir(),Expand()獲取的仍是初始值膀曾;
true - 禁用緩存,實(shí)時(shí)獲取主目錄阳啥,比較耗時(shí)添谊;
Dir func Dir() (string, error) 獲取用戶主目錄
Expand func Expand(path string) (string, error) path的第一個(gè)字符是~時(shí),替換成主目錄察迟,否則返回原目錄或者error
Reset func Reset() 清空緩存的用戶主目錄斩狱,再次獲取可以獲取當(dāng)前的主目錄

源碼分析

Dir

  • DisableCache置為false時(shí)耳高,第一次執(zhí)行Dir函數(shù),獲取當(dāng)前主目錄喊废,后續(xù)獲取的都是緩存值(homedirCache)祝高,這樣可以節(jié)省時(shí)間栗弟;當(dāng)主目錄修改后污筷,此時(shí)獲得的結(jié)果有誤;調(diào)用Reset函數(shù)后乍赫,清空緩存瓣蛀,可以獲取當(dāng)前主目錄。因此雷厂,修改主目錄后需要調(diào)用一次Reset函數(shù)惋增,以保證獲取主目錄的正確性;
  • DisableCache置為true時(shí)改鲫,每次獲取的都是當(dāng)前的主目錄诈皿,比較耗時(shí),此時(shí)調(diào)用Reset函數(shù)無意義
var cacheLock sync.RWMutex // 讀寫鎖
func Dir() (string, error) {
    if !DisableCache {  // DisableCache為true時(shí)像棘,跳過該分支稽亏,獲取當(dāng)前主目錄
        cacheLock.RLock() // 讀加鎖,禁止其它線程寫入缕题,可讀
        cached := homedirCache
        cacheLock.RUnlock()
        if cached != "" { // 第一次或者Reset后第一次cached為空截歉,跳過該分支
            return cached, nil 
        }
    }

    cacheLock.Lock() // 加鎖,禁止其它線程讀寫
    defer cacheLock.Unlock()

    var result string
    var err error
    if runtime.GOOS == "windows" {
        result, err = dirWindows() // 獲取Windows系統(tǒng)主目錄
    } else {
        result, err = dirUnix() // 獲取Unix-like系統(tǒng)主目錄
    }

    if err != nil {
        return "", err
    }
    homedirCache = result // 獲取的主目錄存入緩存烟零,DisableCache為false后瘪松,再次獲取主目錄直接從緩存讀取
    return result, nil
}

Expand函數(shù)調(diào)用DIr函數(shù),工作原理類似Dir锨阿,需要與DisableCache和Reset配合工作宵睦;

func Expand(path string) (string, error) {
    if len(path) == 0 {
        return path, nil
    }

    if path[0] != '~' {
        return path, nil //
    }

    if len(path) > 1 && path[1] != '/' && path[1] != '\\' {
        return "", errors.New("cannot expand user-specific home dir")
    }

    dir, err := Dir()
    if err != nil {
        return "", err
    }

    return filepath.Join(dir, path[1:]), nil
}

Reset主要負(fù)責(zé)清空緩存homedirCache

func Reset() {
    cacheLock.Lock()
    defer cacheLock.Unlock()
    homedirCache = ""
}
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市墅诡,隨后出現(xiàn)的幾起案子壳嚎,更是在濱河造成了極大的恐慌,老刑警劉巖书斜,帶你破解...
    沈念sama閱讀 219,539評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件诬辈,死亡現(xiàn)場離奇詭異,居然都是意外死亡荐吉,警方通過查閱死者的電腦和手機(jī)焙糟,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,594評(píng)論 3 396
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來样屠,“玉大人穿撮,你說我怎么就攤上這事缺脉。” “怎么了悦穿?”我有些...
    開封第一講書人閱讀 165,871評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵攻礼,是天一觀的道長。 經(jīng)常有香客問我栗柒,道長礁扮,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,963評(píng)論 1 295
  • 正文 為了忘掉前任瞬沦,我火速辦了婚禮太伊,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘逛钻。我一直安慰自己僚焦,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,984評(píng)論 6 393
  • 文/花漫 我一把揭開白布曙痘。 她就那樣靜靜地躺著芳悲,像睡著了一般。 火紅的嫁衣襯著肌膚如雪边坤。 梳的紋絲不亂的頭發(fā)上名扛,一...
    開封第一講書人閱讀 51,763評(píng)論 1 307
  • 那天,我揣著相機(jī)與錄音惩嘉,去河邊找鬼罢洲。 笑死,一個(gè)胖子當(dāng)著我的面吹牛文黎,可吹牛的內(nèi)容都是我干的惹苗。 我是一名探鬼主播,決...
    沈念sama閱讀 40,468評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼耸峭,長吁一口氣:“原來是場噩夢(mèng)啊……” “哼桩蓉!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起劳闹,我...
    開封第一講書人閱讀 39,357評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤院究,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后本涕,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體业汰,經(jīng)...
    沈念sama閱讀 45,850評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,002評(píng)論 3 338
  • 正文 我和宋清朗相戀三年菩颖,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了样漆。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,144評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡晦闰,死狀恐怖放祟,靈堂內(nèi)的尸體忽然破棺而出鳍怨,到底是詐尸還是另有隱情,我是刑警寧澤跪妥,帶...
    沈念sama閱讀 35,823評(píng)論 5 346
  • 正文 年R本政府宣布鞋喇,位于F島的核電站,受9級(jí)特大地震影響眉撵,放射性物質(zhì)發(fā)生泄漏侦香。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,483評(píng)論 3 331
  • 文/蒙蒙 一执桌、第九天 我趴在偏房一處隱蔽的房頂上張望鄙皇。 院中可真熱鬧,春花似錦仰挣、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,026評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至洲愤,卻和暖如春颓芭,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背柬赐。 一陣腳步聲響...
    開封第一講書人閱讀 33,150評(píng)論 1 272
  • 我被黑心中介騙來泰國打工亡问, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人肛宋。 一個(gè)月前我還...
    沈念sama閱讀 48,415評(píng)論 3 373
  • 正文 我出身青樓州藕,卻偏偏與公主長得像,于是被迫代替她去往敵國和親酝陈。 傳聞我的和親對(duì)象是個(gè)殘疾皇子床玻,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,092評(píng)論 2 355