理解 CRLF,LF

CRLF, LF 是用來表示文本換行的方式。CR(Carriage Return) 代表回車,對應字符 '\r';LF(Line Feed) 代表換行,對應字符 '\n'。由于歷史原因,不同的操作系統文本使用的換行符各不相同。主流的操作系統一般使用CRLF或者LF作為其文本的換行符。其中,Windows 系統使用的是 CRLF, Unix系統(包括Linux, MacOS近些年的版本) 使用的是LF。

系統間的這個差異給跨平臺協作開發和跨平臺運行帶來很多不方便的地方。最近寫的代碼就遇到了這個問題。下面是一段按行讀取配置文件的 Golang 代碼,在讀取一行字符之后,去掉開頭結尾的換行符與空格。我是這樣寫的:

fun InterpretQueryLine(data []byte) {
    str_line := strings.Trim(string(data), " \n")
    // ...
}

本來在自己的 Ubuntu 系統上跑的很好,覺得沒bug就提交了。然而,同事使用的是Windows系統,他編譯之后怎么跑都不正常。由于我對 Golang 不熟悉,調試了很久才發現是換行符的問題。在Windows系統上換行符是CRLF, \r\n兩個字符,只刪除\n是不夠的。所以在讀取文件的時候一定要小心跨平臺。

除了上面的問題,我們平常受到換行符問題的困擾更多來自協作開發工具,比如Git。有時候我們只改了源碼中的一行,但提交的時候發現整個文件都被修改了。有時候拉取最新的分支,明明改動不大,但是在與本地合并的時候整個文件都是沖突。這些問題不會導致嚴重的錯誤,但是會給開發帶來非常大的不方便。

下面介紹兩個 Git 中換行符相關的處理方式:

這里先指定兩個非官方的概念,方便后面解釋與描述:(重要,否則后面看不懂)

  1. 標準化 指在提交代碼到git數據庫(本地庫) 中將文本文件中的換行符CRLF轉為LF的過程
  2. 轉換 指在檢出Git數據庫代碼過程中將文本文件中的換行符LF轉換為CRLF的過程

core.autocrlf & core.safecrlf

Git 提供了一個名為 core.autocrlf 的配置,可以自動完成標準化與轉換。它的設置方式如下:

git config --global core.autocrlf  [true | input | false]  # 全局設置
git config --local core.autocrlf  [true | input | false] # 針對本項目設置
  • true 自動完成標準化與轉換
  • input 只做標準化操作,不做轉換操作
  • false 提交與檢出的代碼都保持文件原有的換行符不變
  1. CRLF 與 LF 混合的文本文件不受此配置控制。
  2. Git 安裝后默認為 false

所以,一種規范換行符的方式是這樣的:
使用 Windows 系統的開發者設置:

git config --global core.aurocrlf true

使用 Linux/MacOS 的開發者設置:

git config --global core.autocrlf input

由于沒有一個絕對有效的算法來判斷一個文件是否為文本,所以Git 提供了一項禁止/警告不可逆轉換的配置來防止錯誤的標準化與轉換。它主要是影響到多種換行符混合的文件,我們可以手動將其轉換為同一種換行符:

git config --global core.safecrlf [true | false | warn]
  • true 禁止提交混合換行符的文本文件(git add 的時候會被攔截,提示異常)
  • warn 提交混合換行符的文本文件的時候發出警告,但是不會阻止 git add 操作
  • false 不禁止提交混合換行符的文本文件(默認配置)

.gitattributes 文件

core.autocrlf 的配置依賴于每一位參與項目的開發機器上的配置,這很難確保每個人都能正確配置。于是在規范項目中的換行符方面,還有一套添加配置文件的方案。在項目的根目錄下可以添加一個.gitattributes 文件。它的優先級高于core.autocrlf的設置,可以覆蓋core.autocrlf的。它類似于 .gitignore 文件,隨提交修改生效,一個項目中可以維持一份相同的配置。所以,它能夠避免每個開發人員配置不同的問題。

.gitattributes文件的功能不只有配置換行符,所以它的配置相對復雜一下。詳細的說明文檔可以參考 地址。這里只針對換行符的配置做一下簡單的介紹:

每行基本形式:

filter attr1 attr2 ....

filter 代表匹配文件的通配符,在它后面跟著相應的屬性,用空格間隔。

filter 的選項比較簡單,常見的:

* 匹配所有文件
*.txt  匹配文件名以txt結尾的文件

attr的選擇比較多,其中與換行符相關的屬性只有幾條:

  • text
    • text 自動完成標準化與轉換
    • -text 不執行標準化與轉換
    • text=auto 根據 Git 決定是否需要執行標準化與轉化
    • 不設置 使用core.autocrlf配置決定是否執行標準化與轉換
  • eol
    • eol=lf 強制完成標準化,不執行轉換(相當于指定轉換為LF格式)
    • eol=crlf 強制完成標準化,指定轉換為CRLF格式
  • binary
    • binary 二進制文件不參與標準化與轉換
    • 不設置 由 Git 決定是否為二進制文件

text 設置的時候,轉換自動轉換到對應平臺的換行符
行號高的設置會覆蓋行號低的設置

這里給出一個簡單的例子來說明一下:

*         text=auto
# These files are text and should be normalized (convert crlf => lf)
*.cs      text
*.xaml    text
*.csproj  text
*.sln     text
*.tt      text
*.ps1     text
*.cmd     text
*.msbuild text
*.md      text

# Images should be treated as binary
# (binary is a macro for -text -diff)
*.png     binary
*.jepg    binary

*.sdf     binary

除了下面匹配到的文件,剩下的依賴Git 決定是否參與標準化與轉換。上面一段是參與標準化與轉換的文件;下面一段是不參與標準化與轉換的文件;

其實,在文件里只有下面這行配置的時候,就相當于根據操作系統自動填入 core.autocrlf 的設置。

* text=auto

所以,這里推薦使用.gitattributes來規范項目中換行符。簡單,方便,靈活。

參考文章:

我的博客即將搬運同步至騰訊云+社區,邀請大家一同入駐:https://cloud.tencent.com/developer/support-plan?invite_code=3ld8ip2y3rsw8

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,488評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,034評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,327評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,554評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,337評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,883評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,975評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,114評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,625評論 1 332
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,555評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,737評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,244評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,973評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,362評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,615評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,343評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,699評論 2 370

推薦閱讀更多精彩內容