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

系統(tǒng)間的這個(gè)差異給跨平臺(tái)協(xié)作開發(fā)和跨平臺(tái)運(yùn)行帶來(lái)很多不方便的地方。最近寫的代碼就遇到了這個(gè)問(wèn)題。下面是一段按行讀取配置文件的 Golang 代碼，在讀取一行字符之后，去掉開頭結(jié)尾的換行符與空格。我是這樣寫的：

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

本來(lái)在自己的 Ubuntu 系統(tǒng)上跑的很好，覺(jué)得沒(méi)bug就提交了。然而，同事使用的是Windows系統(tǒng)，他編譯之后怎么跑都不正常。由于我對(duì) Golang 不熟悉，調(diào)試了很久才發(fā)現(xiàn)是換行符的問(wèn)題。在Windows系統(tǒng)上換行符是CRLF, \r\n兩個(gè)字符，只刪除\n是不夠的。所以在讀取文件的時(shí)候一定要小心跨平臺(tái)。

除了上面的問(wèn)題，我們平常受到換行符問(wèn)題的困擾更多來(lái)自協(xié)作開發(fā)工具，比如Git。有時(shí)候我們只改了源碼中的一行，但提交的時(shí)候發(fā)現(xiàn)整個(gè)文件都被修改了。有時(shí)候拉取最新的分支，明明改動(dòng)不大，但是在與本地合并的時(shí)候整個(gè)文件都是沖突。這些問(wèn)題不會(huì)導(dǎo)致嚴(yán)重的錯(cuò)誤，但是會(huì)給開發(fā)帶來(lái)非常大的不方便。

下面介紹兩個(gè) Git 中換行符相關(guān)的處理方式：

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

1. 標(biāo)準(zhǔn)化 指在提交代碼到git數(shù)據(jù)庫(kù)(本地庫(kù)) 中將文本文件中的換行符CRLF轉(zhuǎn)為L(zhǎng)F的過(guò)程
2. 轉(zhuǎn)換 指在檢出Git數(shù)據(jù)庫(kù)代碼過(guò)程中將文本文件中的換行符LF轉(zhuǎn)換為CRLF的過(guò)程

core.autocrlf & core.safecrlf

Git 提供了一個(gè)名為 core.autocrlf 的配置，可以自動(dòng)完成標(biāo)準(zhǔn)化與轉(zhuǎn)換。它的設(shè)置方式如下：

git config --global core.autocrlf  [true | input | false]  # 全局設(shè)置
git config --local core.autocrlf  [true | input | false] # 針對(duì)本項(xiàng)目設(shè)置

• true 自動(dòng)完成標(biāo)準(zhǔn)化與轉(zhuǎn)換
• input 只做標(biāo)準(zhǔn)化操作，不做轉(zhuǎn)換操作
• false 提交與檢出的代碼都保持文件原有的換行符不變

1. CRLF 與 LF 混合的文本文件不受此配置控制。
2. Git 安裝后默認(rèn)為 false

所以，一種規(guī)范換行符的方式是這樣的：
使用 Windows 系統(tǒng)的開發(fā)者設(shè)置：

git config --global core.aurocrlf true

使用 Linux/MacOS 的開發(fā)者設(shè)置：

git config --global core.autocrlf input

由于沒(méi)有一個(gè)絕對(duì)有效的算法來(lái)判斷一個(gè)文件是否為文本，所以Git 提供了一項(xiàng)禁止/警告不可逆轉(zhuǎn)換的配置來(lái)防止錯(cuò)誤的標(biāo)準(zhǔn)化與轉(zhuǎn)換。它主要是影響到多種換行符混合的文件，我們可以手動(dòng)將其轉(zhuǎn)換為同一種換行符：

git config --global core.safecrlf [true | false | warn]

• true 禁止提交混合換行符的文本文件(git add 的時(shí)候會(huì)被攔截，提示異常)
• warn 提交混合換行符的文本文件的時(shí)候發(fā)出警告，但是不會(huì)阻止 git add 操作
• false 不禁止提交混合換行符的文本文件（默認(rèn)配置）

.gitattributes 文件

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

.gitattributes文件的功能不只有配置換行符，所以它的配置相對(duì)復(fù)雜一下。詳細(xì)的說(shuō)明文檔可以參考 地址。這里只針對(duì)換行符的配置做一下簡(jiǎn)單的介紹：

每行基本形式：

filter attr1 attr2 ....

filter 代表匹配文件的通配符，在它后面跟著相應(yīng)的屬性，用空格間隔。

filter 的選項(xiàng)比較簡(jiǎn)單，常見的：

* 匹配所有文件
*.txt  匹配文件名以txt結(jié)尾的文件

attr的選擇比較多，其中與換行符相關(guān)的屬性只有幾條：

• text
  • text 自動(dòng)完成標(biāo)準(zhǔn)化與轉(zhuǎn)換
  • -text 不執(zhí)行標(biāo)準(zhǔn)化與轉(zhuǎn)換
  • text=auto 根據(jù) Git 決定是否需要執(zhí)行標(biāo)準(zhǔn)化與轉(zhuǎn)化
  • 不設(shè)置 使用core.autocrlf配置決定是否執(zhí)行標(biāo)準(zhǔn)化與轉(zhuǎn)換
• eol
  • eol=lf 強(qiáng)制完成標(biāo)準(zhǔn)化，不執(zhí)行轉(zhuǎn)換（相當(dāng)于指定轉(zhuǎn)換為L(zhǎng)F格式）
  • eol=crlf 強(qiáng)制完成標(biāo)準(zhǔn)化，指定轉(zhuǎn)換為CRLF格式
• binary
  • binary 二進(jìn)制文件不參與標(biāo)準(zhǔn)化與轉(zhuǎn)換
  • 不設(shè)置 由 Git 決定是否為二進(jìn)制文件

text 設(shè)置的時(shí)候，轉(zhuǎn)換自動(dòng)轉(zhuǎn)換到對(duì)應(yīng)平臺(tái)的換行符
行號(hào)高的設(shè)置會(huì)覆蓋行號(hào)低的設(shè)置

這里給出一個(gè)簡(jiǎn)單的例子來(lái)說(shuō)明一下：

*         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 決定是否參與標(biāo)準(zhǔn)化與轉(zhuǎn)換。上面一段是參與標(biāo)準(zhǔn)化與轉(zhuǎn)換的文件；下面一段是不參與標(biāo)準(zhǔn)化與轉(zhuǎn)換的文件；

其實(shí)，在文件里只有下面這行配置的時(shí)候，就相當(dāng)于根據(jù)操作系統(tǒng)自動(dòng)填入 core.autocrlf 的設(shè)置。

* text=auto

所以，這里推薦使用.gitattributes來(lái)規(guī)范項(xiàng)目中換行符。簡(jiǎn)單，方便，靈活。

參考文章：

• [1] Mind the End of Your Line
• [2] gitattributes(5) Manual Page

我的博客即將搬運(yùn)同步至騰訊云+社區(qū)，邀請(qǐng)大家一同入駐：https://cloud.tencent.com/developer/support-plan?invite_code=3ld8ip2y3rsw8