Windows下在IntelliJ IDEA 使用 Git 拉取、提交脚本出现换行符问题

背景

在 Windows 系统下使用 IntelliJ IDEA 进行 Git 操作（如拉取和提交脚本）时，经常会遇到换行符问题。这主要是因为不同操作系统对换行符的处理方式不同：Windows 使用 CRLF（回车符 + 换行符，即 \r\n）作为换行符，而 Linux 和 macOS 使用 LF（换行符，即 \n）。当在不同系统间协作开发或者切换工作环境时，就可能因为换行符的不一致导致代码文件出现格式问题，甚至影响代码的正常运行。

问题

拉取代码时

当从远程仓库拉取代码到 Windows 本地时，原本在 Linux 或 macOS 系统下使用 LF 换行符的文件，可能会被自动转换为 CRLF 换行符。这可能导致代码文件的格式发生变化，在 IntelliJ IDEA 中打开文件时，会看到一些不必要的修改标记，甚至可能影响代码的编译和运行。

提交代码时

当在 Windows 系统下使用 IntelliJ IDEA 提交代码到远程仓库时，如果本地文件使用的是 CRLF 换行符，而远程仓库期望的是 LF 换行符，那么提交的代码可能会出现换行符不一致的问题。其他使用 Linux 或 macOS 系统的开发者在拉取代码时，可能会看到很多不必要的换行符修改，增加了代码审查的难度。

问题原因

Git 为了在不同操作系统之间保持代码的一致性，提供了一个自动转换换行符的功能。默认情况下，Git 在 Windows 系统上会将 LF 转换为 CRLF，在 Linux 和 macOS 系统上会将 CRLF 转换为 LF。然而，这种自动转换有时会导致不必要的问题，特别是在团队协作开发中，不同开发者使用的操作系统和开发工具可能不同。

解决方案

1.全局配置 Git 的换行符处理策略

可以通过以下命令来配置 Git 的全局换行符处理策略：

# 设置在检出代码时将 LF 转换为 CRLF，在提交代码时将 CRLF 转换为 LF
git config --global core.autocrlf true

# 设置在检出代码时不进行换行符转换，保持原样
git config --global core.autocrlf input

# 禁用自动换行符转换
git config --global core.autocrlf false

• core.autocrlf true：这是 Windows 系统上的默认配置，适合大多数情况。它会在检出代码时将 LF 转换为 CRLF，在提交代码时将 CRLF 转换为 LF，确保本地文件使用 CRLF 换行符，而远程仓库使用 LF 换行符。
• core.autocrlf input：适合在 Linux 或 macOS 系统上使用，或者在 Windows 系统上希望保持代码文件的原始换行符。它会在提交代码时将 CRLF 转换为 LF，但在检出代码时不进行转换。
• core.autocrlf false：禁用自动换行符转换，适合在所有系统上都使用相同的换行符，或者在团队中已经统一了换行符标准的情况。

2.在 IntelliJ IDEA 中配置换行符

可以在 IntelliJ IDEA 中设置文件的换行符，确保所有文件使用一致的换行符。具体步骤如下：

1. 打开 IntelliJ IDEA，点击 File -> Settings（Windows/Linux）或 IntelliJ IDEA -> Preferences（macOS）。
2. 在设置窗口中，选择 Editor -> Code Style。
3. 在右侧的 Line separator 下拉框中，选择你希望使用的换行符，如 LF (\n) 或 CRLF (\r\n)。
4. 点击 Apply 和 OK 保存设置。

3.使用 .gitattributes 文件

可以在项目根目录下创建一个 .gitattributes 文件，来指定不同类型文件的换行符处理策略。示例如下：

# 对所有文本文件使用 LF 换行符
* text eol=lf

# 对 .bat 文件使用 CRLF 换行符
*.bat text eol=crlf

• * text eol=lf：表示所有文本文件在提交时使用 LF 换行符。
• *.bat text eol=crlf：表示 .bat 文件在提交时使用 CRLF 换行符。

将 .gitattributes 文件添加到 Git 仓库中，并提交到远程仓库，这样所有开发者在拉取代码时都会遵循相同的换行符处理策略。