團(tuán)隊(duì)開發(fā)中，期望 Code Review 來約束的是代碼結(jié)構(gòu)和潛在邏輯問題，這時(shí)代碼規(guī)范這種『細(xì)節(jié)』就給 review 過程帶來不小的噪音。
特別是團(tuán)隊(duì)目前的情況：歷史負(fù)擔(dān)較重，大量經(jīng)幾手的舊代碼風(fēng)格不一致，團(tuán)隊(duì)成員新組建，對(duì)代碼規(guī)范、好的范式還沒達(dá)成默契。新寫代碼的規(guī)范尚在磨合中，遑論手動(dòng)改寫大量的舊代碼。
這是重要不緊急的問題，最近項(xiàng)目略有空閑，是對(duì)這類問題下手的好時(shí)機(jī)；）
目標(biāo)
- 提升代碼可讀性，打破『破窗效應(yīng)』
- 用工具約束代碼規(guī)范，盡可能不影響原有開發(fā)流程的同時(shí)，盡可能減少 code review 中代碼規(guī)范方面的噪音，讓開發(fā)精力放在該放的地方
- Reformat 歷史代碼，一勞永逸的解決這個(gè)問題
破窗效應(yīng)
『如果那些窗不被修理好，可能將會(huì)有破壞者破壞更多的窗戶。...又或想像一條人行道有些許紙屑，如果無人清理，不久后就會(huì)有更多垃圾，最終人們會(huì)視為理所當(dāng)然地將垃圾順手丟棄在地上?！?br> ——維基百科
一些調(diào)研
本以為不會(huì)太復(fù)雜，實(shí)際執(zhí)行起來發(fā)現(xiàn)問題也不少：
- 拜蘋果的封閉和垃圾的 Xcode 所致，舊插件不可用 ClangFormat-Xcode 、BBUncrustifyPlugin-Xcode ，Xcode8 插件又未成火候，均不好用
-
XcodeClangFormat for Xcode8 調(diào)試
.clang-format并不方便 - SwiftLint 評(píng)價(jià)很高，可惜目前項(xiàng)目 7w lines ObjC，Swift 在下半年計(jì)劃里
看了一圈，最終決定選擇 square 家的方案：https://github.com/square/spacecommander
spacecommander = clang-format + ObjC 定制規(guī)范 + git 工作流
spacecommander 在 clang-format 基礎(chǔ)上加入幾條定制規(guī)范，解決了 block 縮進(jìn)問題，對(duì) ObjC 更友好。內(nèi)置腳本，很方便的添加 git pre-commit hook，format 代碼也算方便，不影響原有工作流。源代碼很少，一些 shell 和 python，很容易看懂。
這些跟團(tuán)隊(duì)需要很契合，項(xiàng)目有些老，有些小問題，縫縫補(bǔ)補(bǔ)能用就好。
如何執(zhí)行
- Fork https://github.com/square/spacecommander 項(xiàng)目（方便后續(xù)定制），clone 到本地
- cd 到需要格式化的項(xiàng)目根目錄，執(zhí)行
/path/to/spacecommander/setup-repo.sh。這時(shí)你會(huì)看到項(xiàng)目目錄下創(chuàng)建了一個(gè)軟鏈接.clang-format（并加入到.gitignore) 同時(shí)創(chuàng)建.git/hooks/pre-commit，commit 時(shí)起效果的秘密就在這里 - 隨意修改項(xiàng)目中的一個(gè) .m 文件，stage file，commit，你會(huì)得到這樣的提示：
git -c diff.mnemonicprefix=false -c core.quotepath=false -c credential.helper=sourcetree commit -q -F /var/folders/7w/5_0xvl794n960s_wsr3h68340000gn/T/SourceTreeTemp.GSJLdQ
?? Format and stage individual files:
"/Users/zengming/ming-dev/gg-projects/spacecommander"/format-objc-file.sh 'ios-common/GGLib/GGBase/GGModels/GGHotelAPIModel.m' && git add 'ios-common/GGLib/GGBase/GGModels/GGHotelAPIModel.m';
?? Format and stage all affected files:
"/Users/zengming/ming-dev/gg-projects/spacecommander"/format-objc-files.sh -s
?? There were formatting issues with this commit, run the?? above?? command to fix.
?? Commit anyway and skip this check by running git commit --no-verify
Completed with errors, see above
- 新修改的 GGHotelAPIModel.m 文件代碼規(guī)范檢查不通過，所以 commit 失敗。解決起來也很容易，按上面的提示在終端輸入
"/Users/zengming/ming-dev/gg-projects/spacecommander"/format-objc-files.sh -s，再 commit，搞定！
spacecommander 的原理是定制好 .clang-format，執(zhí)行 commit 前運(yùn)行 format-objc-file-dry-run 檢查當(dāng)前要提交的文件，如果不符合規(guī)范，則提示修改。（默認(rèn)只檢查已修改并 Stage 的文件）
如果要格式化項(xiàng)目所有文件，可以嘗試在項(xiàng)目中運(yùn)行 /path/to/spacecommander/format-objc-files-in-repo
一些細(xì)節(jié)問題
Block 格式化不符合預(yù)期？
參見這里：https://bugs.llvm.org//show_bug.cgi?id=23585
clang-format: Support nested block formatting with ColumnLimit=0.
改到可用，這點(diǎn)還不大符合我的預(yù)期。誰有更好的方法嗎？
// 格式化后的效果
[UIAlertView bk_showAlertViewWithTitle:@"溫馨提示"
message:push.alert
cancelButtonTitle:@"忽略"
otherButtonTitles:@[ @"查看" ]
handler:^(UIAlertView *alertView, NSInteger buttonIndex) {
if (buttonIndex == 0) {
return;
}
...
}];
// 我期望的效果
[UIAlertView bk_showAlertViewWithTitle:@"溫馨提示"
message:push.alert
cancelButtonTitle:@"忽略"
otherButtonTitles:@[ @"查看" ]
handler:^(UIAlertView *alertView, NSInteger buttonIndex)
{
if (buttonIndex == 0) {
return;
}
...
}];
直接使用 .clang-format ?
最開始我也是直接配 .clang-format，總有些配置不合預(yù)期，改起來調(diào)試也不是那么方便。spacecommander 的基礎(chǔ)配置是一個(gè)能看的配置，推薦在它的基礎(chǔ)上改，何況 git hook 都寫好了何必自己折騰。
.clang-format 全部配置細(xì)節(jié)參見這里：https://clang.llvm.org/docs/ClangFormatStyleOptions.html
spacecommander 的一些小問題
- spacecommander 一些配置是挺老的，自帶的 clang-format 是 v3.8（官方最新是 v5），這點(diǎn)沒碰到問題，略過
- 如果你運(yùn)行
format-objc-files.sh -s時(shí) python 報(bào)錯(cuò)，這是因?yàn)?spacecommander 定制的規(guī)則 py 使用的是 python2, 切到 python2 下運(yùn)行即可 - spacecommander 其中一個(gè)定制
MacroSemicolonAppender.py格式化時(shí)會(huì)把我的文件改錯(cuò)（錯(cuò)加分號(hào)），我沒細(xì)究，禁掉即可（禁掉方式參見我的 fork）
總結(jié)
- 代碼規(guī)范其實(shí)是很重要的事，看整齊的代碼給大家好的心情，這非常重要
- 代碼規(guī)范這種重要卻又瑣碎的臟活累活還是交個(gè)自動(dòng)化工具來解決，讓團(tuán)隊(duì)精力集中在其它重要的事情上
- 格式化配置細(xì)節(jié)還有有些問題，關(guān)系不大，不怕工具不好，先有，再慢慢改進(jìn)
- 這只是代碼規(guī)范，跟代碼邏輯，架構(gòu)沒半毛錢關(guān)系
- 代碼整齊了，看著真舒服不少??
