关于iOS代码风格管理的两三事

代码风格的两三事儿

前一阵一直在做单元测试相关的内容,想来终于把自动化测试的一整套方案弄的差不多了,于是在想还有没有其他可以提升代码质量的事儿可做。

记得去年在某度的时候,每次苦逼地搬完砖提交代码的时候,都会有一个代码风格校验的审查,如果没有通过规则的话是提交不上去的,并且还会给出相应的警告。比如下面代码

@property(nonatomic,strong)MGJAwesomeCommand *awesomeCMD;
if(sth.){xxx;return;}

// Unrelated comment
void someFunction() {
    doWork(); // Does something
    doMoreWork(); // Does something else
}

那么对于追求More Free[和吴悠无关🐦] 的程序员这个有意义么?

其实我认为是有意义的,第一、由于现在我们都是团队作战,如果团队内部可以做到代码风格统一, 采用同一个代码规范,让不同人写出来的程序可读性基本一致或者接近,这样对于新人来说, 做过一个模块后,在接触别人代码,别的模块代码的时候,无论开发还是维护都会更快上手, 他的精力可以更多放在其他方面。同时, 好的代码规范,编程习惯也可以减少bug的产生,减少开发人员和测试人员的的时间成本;第二 、工具化程度是衡量一个公司技术水准很重要的一个考量.例如跑Unit Test,代码风格检测,持续化集成都自动化的时候,这些东西都是可以极大的节省时间精力的东西。

那么如何来做到这些,使团队内部代码风格趋于统一呢?有下面几种方案。

1.使用插件

比如ClangFormat-Xcode一款格式化代码工具,能够让开发者使用 Clang 将代码格式化为 LLVM、Google、Chromium、Mozilla 或 WebKit 等格式。操作类似下面这样

2.定制模版

团队内部可以设置类的代码组织结构, 例如ViewController类可以按照以下顺序来组织代码结构:

#pragma mark - def
#pragma mark - override
#pragma mark - api
#pragma mark - model event 
#pragma mark - view event
#pragma mark - private
#pragma mark - getter / setter

那么如何制定一个模版呢,从头制作一个模板类有些坑。 我们采用简单的办法, 先拷贝一个模板类, 然后修改成自己需要的样子。
这里推荐一个简单的模板类的模板. 先下载下来, 再修改成你需要的样子, 最后拷贝到Xcode的文件模板文件夹里

/Applications/Xcode.app/Contents/Developer/Library/Xcode/Templates/File Templates/Folder

这样就可以使用了。

(这里顺便安利下之前写的一个单元测试的模版通过Alcatraz搜索Kiwi-Template进行安装)

3.最佳推荐

以上两种方法操作起来都稍微有点麻烦或是不是太方便,比如使用插件的话每次只能一个文件一个文件的去修改,而且只能装在Xcode上;使用定制模版的话每次需要从模版中创建,似乎有点别扭,并且也只能用在Xcode上。而且两种方法也起不到通知程序员代码风格矫正的作用,那么有没有一种既简单又不限制IDE而且还能通知程序员代码风格不符的方法呢?

这里羞羞地推荐一下自己写的一个工具。具体的使用方法如下:

这里以最近正在写的Command为例,首先打开工程目录,例如我的目录是下面这样


然后打开终端执行命令

curl -o format-check -ssl https://github.com/Bupterambition/objc-format-check/blob/master/format-check?raw=true

下载完毕后执行

bash format-check

这样就全部搞定了。那么上面操作具体做了什么呢,其实很简单。

首先format-check会clone下来一个工具(这里参考了Space Commander)放在.format-check目录,然后执行我们的工具。工具主要干了两件事。

.clang-format

在当前目录下添加了.clang-format文件,这个文件主要是做什么的呢?
其主要是设定了代码的一些风格.

Language:        Cpp
AccessModifierOffset: -1
ConstructorInitializerIndentWidth: 4
SortIncludes: false

AlignAfterOpenBracket: true
AlignEscapedNewlinesLeft: true
AlignOperands: false
AlignTrailingComments: true

AllowAllParametersOfDeclarationOnNextLine: false
AllowShortBlocksOnASingleLine: true
AllowShortCaseLabelsOnASingleLine: false
AllowShortFunctionsOnASingleLine: true
AllowShortIfStatementsOnASingleLine: false
AllowShortLoopsOnASingleLine: false

AlwaysBreakAfterDefinitionReturnType: false
AlwaysBreakTemplateDeclarations: false
AlwaysBreakBeforeMultilineStrings: false

BreakBeforeBinaryOperators: None
BreakBeforeTernaryOperators: false
BreakConstructorInitializersBeforeComma: false

什么意思呢,比如将

AllowShortFunctionsOnASingleLine:false

那么这样风格的代码

int f() { return 0; }

将是不允许的,
需要改成这样的才能通过规则

int f() {
    return 0;
}

那么具体效果是什么样呢,如果你commit的代码中有上述风格的代码,那么提交的时候将会这样

根据提示你可以选择一键修正所有要commit的脚本或是使用git commit --no-verify来忽略。

Git Hook

另一个是在/AwesomeCommand/.git/hook/中添加了一个pre-commit的脚本,那么这个pre-commit是干什么的呢,很简单,这个东西就是在你每次要commit代码之前,git都会去找有没有这个文件。如果有这个文件,那么就去文件里执行一些特定的shell脚本,比如我们的pre-commit是去/.format-check/目录下执行format-objc-hook脚本

如果您使用后觉得这个工具不好用的话可以在您的工程目录下执行下面命令进行删除

curl -ssl https://raw.githubusercontent.com/Bupterambition/objc-format-check/master/uninstall.sh|bash

至此,我们就完成了一个代码风格审查工具的部署,如果团队想要制定代码风格的话只需要修改和.git同目录下的.clang-format文件就好,具体的规则可以参考这个,每种样式点击一下会弹出相应的实例代码。[不过要记得.gitignore中需要把.clang-fotmat去掉,这样只需要由一个人制定好了规则每个人pull一下就OK了]。同时只需要把刚刚download下来的format-check文件放到相应的组件文件夹下执行一边就可以完成全部组件的代码风格部署。

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

推荐阅读更多精彩内容