Java异常 #Number of lines annotated by Git is not equal to number of lines in the file, check file …

1. 异常现象

在项目中某个 java 文件左边栏右键查看代码版本履历（Annotate）时无法显示，IDEA 提示：Number of lines annotated by Git is not equal to number of lines in the file, check file encoding and line separators.

 

2. 异常原因

这个问题涉及到不同操作系统下文本文件的换行符差异引起的。在不同操作系统中，文本文件的换行符可能是不同的：Windows使用CRLF（Carriage Return + Line Feed），而Unix和Mac使用LF（Line Feed）。

 

3. 排查分析

1）为什么会出现无法查看代码的版本管理？

1. 由于项目部分代码是在 Mac 电脑开发并 git 提交的等等历史原因，导致在 Windows 系统上打开项目文件看不到版本管理（Annotate），即后面的人可能无法查看到代码的历史提效记录。
2. Unix/Mac 系统下的文件在 Windows 里打开时，Windows 上的编辑器会悄悄把行尾的换行（LF）字符转换成回车和换行（即 \r\n），但编辑器仍会显示原有的 line separator。比如 Windows 环境下，IDEA 打开 Mac 提交的 CRLF 文件时，内容仍然是换行的，但无法查看版本管理。在 Windows 下进行 git 提交后，你的提交会做为初始提交记录。

2）什么是 CRLF、CR、LF？

如果把这三种方式的功能统称为换行的话，那 CRLF、CR、LF 分别就是各种不同操作系统在处理行尾结束符采取的不同处理方法。
具体可以看下表：

换行方式	对应简写	对应平台	含义说明
CRLF	Carriage Return Line Feed	Windows	回车换行（即\r\n），Windows使用回车（CR）换行（LF）两个字符表示行尾
CR	Carriage Return	Mac	回车（即\r），仅使用回车（CR）表示行尾
LF	Line Feed	Mac/Linux	换行（即\n），仅使用换行（LF）表示行尾

 

4. 解决方案

方法1：更改当前文件的换行符格式

在IDEA中，你可以手动更改文件的换行符格式。在打开的文件编辑器中，右下角有一个显示换行符的状态。点击这个状态可以切换换行符格式。你可以尝试切换为Windows格式（CRLF）或者Unix格式（LF），看看是否解决了问题。

注意：此方法不足的是，因为只是修改当前文件的换行符格式，所以当提交到 Git 后，你的这次提交会作为版本管理履历的首次提交记录。

方法2：重新提交文件

如果只是部分文件出现了问题，你可以考虑在 Mac 环境中重新打开并保存这些文件，然后重新提交到版本控制系统。这会确保文件的换行符格式与 Mac 环境兼容。
注意：此方法不足的是，可能需要找相关同事，比较麻烦。

方法3：配置Git属性

如果你使用的是 Git 版本控制系统，你可以在项目的根目录下添加一个名为 .gitattributes 的文件，并在其中指定文件的换行符格式。例如：

* text=auto

这会告诉 Git 根据不同操作系统自动处理换行符格式。

方法4：配置IDEA处理换行符

在IDEA中，你可以尝试调整一些设置来处理换行符问题。在IDEA的设置中搜索 “Line Separator” 或 “换行符”，为新文件配置行分隔符。

1. 按 Ctrl+Alt+S 打开 IDE 设置，并选择 编辑器（Editor） -> 代码风格（Code Style）
2. 选择要修改的代码样式方案：【Scheme】默认为 IDE 级别适用换行符。也可配置项目（Project）级别
3. 从**行分隔符（line separator）**列表中，选择要应用的行分隔符样式
4. 确认OK，应用并关闭对话框
   

方法5：考虑使用统一的换行符格式

为了避免类似的问题，项目中最好使用统一的换行符格式。可以在团队中协商使用哪种换行符格式，并在版本控制系统中进行相应的设置，以便在不同操作系统之间共享代码时不会出现问题。这是需要在项目开始就要执行的代码规范。

方法6：重写历史记录

如果换行符格式的问题已经在版本控制历史中产生，你可能需要考虑使用版本控制系统的工具（如Git的 git filter-branch 或 git rebase）来重新写入历史记录，以统一换行符格式。
注意： 成本和风险都比较大，不推荐这么干。在操作历史修复记录时，务必小心谨慎，并在备份的环境中进行测试。

 

5. 参考资料

https://www.jetbrains.com/help/idea/configuring-line-endings-and-line-separators.html