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 中換行符相關的處理方式:
這里先指定兩個非官方的概念,方便后面解釋與描述:(重要,否則后面看不懂)
- 標準化 指在提交代碼到git數據庫(本地庫) 中將文本文件中的換行符CRLF轉為LF的過程
- 轉換 指在檢出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 提交與檢出的代碼都保持文件原有的換行符不變
- CRLF 與 LF 混合的文本文件不受此配置控制。
- 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