跨平台代码换行符的问题处理

主题封面

背景概述

通常,我们使用git做源码版本控制,在windows平台开发源码并进行单元测试,然后打包部署到linux平台进行集成测试或系统测试。

除源码之外,我们会为部署写一些自动化的脚本,方便服务的启动和关闭。由于脚本文件是直接打包并上传到linux平台的,而windows平台和linux平台的换行符不同,这就导致了脚本在linux平台上执行错误。

相关操作

如上图所示,在默认的情况下,git远程仓库(Linux)的代码换行符是LF(linux平台换行符),通过git clone或git pull将代码拉到本地(windows平台),git会自动将换行符替换成CRLF。本地代码通过git push推送到远程仓库,git又会自动替换成linux换行符。
另外,IDEA新建文件,默认也是使用平台的换行符,即windows平台使用CRLF。

在测试阶段,需要频繁的更新文件,脚本也不便单独部署,手动解决换行符的问题(IDEA上可以做)比较低效。

本文就这个问题给出解决方案。

方案一:别给我改

问题出现的原因,是因为git和IDEA考虑了平台换行符的兼容性,其实以LF换行的文件,在windows也可以良好的识别。所以我们可以修改git和idea的行为,不让它更改换行符。

git有两个配置项,与换行符相关:

core.autocrlf
    - true    提交时转换为LF,检出时转换为CRLF(默认行为)。
    - false   提交检出均不转换。
    - input   提交时转换为LF,检出时不转换

core.safecrlf
    - true    拒绝提交包含混合换行符的文件
    - false   允许提交包含混合换行符的文件
    - warn    提交包含混合换行符的文件时,给出警告

因为我们只是想确保本地的代码也使用LF换行符,并不打算改变远程仓库的换行符,所以建议设置如下:

core.autocrlf=input
core.safecrlf=true

IDEA上也可以设置,新建的文件使用的换行符:

idea的设置

这些设置并不能改变已有文件的换行符,最直接的方式是把本地仓库删除掉,重新从远程仓库拉代码。

但是这个方案存在着一定的难度和隐患。说难,是因为需要在团队内部进行宣贯,确保每个人都按照这样做了;说隐患,是新员工未必能及时遵守这个规定,或者在重新安装软件的时候,又恢复到了默认的设置。

不过,这并不算什么大事情,只是有点麻烦。

方案二:让脚本改

之所以要修改换行符,是因为我们要部署到linux平台上去用,那么可以让打包脚本统一修改文件的换行符。

借助于dos2unix工具,脚本可以直接调用命令,将要修改的文件路径作为参数。要递归修改某个目录,也可以通过shell脚本来实现。

首先,从链接下载工具,放置到合适的目录。

通过类似于下面的命令,实现递归修改文件:

find D:/projects/release_dir -type f ! -name "*.jar" | xargs dos2unix.exe

# find:搜索文件系统
# -type f:限定文件
# !:逻辑非
# -name:匹配文件名

这个方案直接面对问题进行处理,不和平台之间换行符转换的问题进行纠缠,也不必要求同事进行各种设置。只一条:通过打包脚本来打包。

而一般情况下,我们都乐于使用打包脚本来自动打包,所以这一条也没有给开发人员添加任何负担。

总结

我更推荐使用第二种方案,它显得轻量小巧,不和其他问题纠缠夹杂,干净利索。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,100评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,308评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,718评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,275评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,376评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,454评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,464评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,248评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,686评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,974评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,150评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,817评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,484评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,140评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,374评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,012评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,041评论 2 351

推荐阅读更多精彩内容