iOS项目重构周记（一）

2015-07-05 本文已影响4924人 Levi_

最近开始做公司的iOS项目重构，现准备每周做一次汇总，把重构过程中遇到的问题和解决方案记录下来，做一个记录和分享。

1.文件目录结构

我们在Xcode中使用“new group”创建一个新的目录时，对应的文件系统中并不会相应的创建一个实体文件夹，只是在Xcode中创建一个便于管理的虚拟文件夹。这样就导致添加的所有文件最终都放在文件系统的同一目录下，这里面可能会包含.h文件、.m文件、nib文件，图片等等一系列的资源文件。当项目最终变的比较庞大时，众多的文件将变的极难管理。而且，当我们使用SVN或Git来做版本控制时，一旦产生工程文件冲突，重新添加文件也很难定位，并且容易遗漏文件。

所以我们应该使用实体文件夹来构建项目中的Group，另外当项目比较庞大时，Group的划分也是需要斟酌的一项。好的结构划分能够帮助我们快速定位代码，有助于理解整个项目的架构和逻辑。所以我建议基于以下几条来区分目录结构。

公共部分和各功能模块的区分
公共部分和各功能模块应该区分开来，公共模块一般包含公共模型、方法、视图、第三方库。我们写的任何可被其他功能模块调用的组件都应该包含到公共目录下。
资源类型的区分
所有的图片、数据库文件、bundle、plist等等资源文件都应该统一包含到资源目录下。
MVC的区分
各功能模块都可按MVC来区分，视图模型控制器的区分可以帮助自己和他人更快的定位代码。

另外说一下添加文件夹到工程中时，“Create groups”和“Create folder references”的区别。

img
Create group类似于我们“new group”时创建的组，其中包含的文件会自动添加到Compile Sources中，Create folder references只会引用文件夹，文件夹里面的东西都会直接拷贝到bundle包，不参与编译。

2.注释

注释也是重构中的一部分，好的注释能够极大程度上帮助自己和他人理解代码。我相信对注释负责的人，也从侧面证明是一个靠谱的人。只是这里要注意注释的格式。

这里推荐一个喵神写的自动注释工具:VVDocumentor
这是一个Xcode插件，只需要在要写文档的代码上面连打三个斜杠，就能自动提取参数等生成规范的Javadoc格式文档注释，下载编译一下，然后重启Xcode就可以使用了。

img
使用这种方式的注释，只要按住option键+鼠标左键，是可以在调用时直接查看注释内容的:

img

3.手写代码 or Xib？

关于这个问题相信很多同学都有困惑，国内iOS界的大神唐巧和喵神对这个问题也都有自己的见解，大家可以移步到他们的博客看看：
唐巧：http://blog.devtang.com/blog/2015/03/22/ios-dev-controversy-2/
喵神：http://onevcat.com/2013/12/code-vs-xib-vs-storyboard/
借用唐巧的几句话：

对于复杂的、动态生成的界面，建议使用手工编写界面。
对于需要统一风格的按钮或UI控件，建议使用手工用代码来构造。方便之后的修改和复用。
对于需要有继承或组合关系的 UIView 类或 UIViewController 类，建议用代码手工编写界面。
对于那些简单的、静态的、非核心功能界面，可以考虑使用 xib 或 storyboard 来完成。

4.多用类型常量，少用#define

一个庞大的项目中，常常使用了大量的宏定义。宏定义的初衷之一是提高了程序的可读性，同时也方便进行修改。可是过度的宏定义往往违背了它的初衷。

例如

#define ANIMATION_DURATION 0.3

我们并不能很直观的理解它其中的时间含义，而

static const NSTimeInterval kAnimationDuration = 0.3;

就很好的描述了常量的含义。

此外，为什么要加一个static和const来同时命名？因为static意味着该变量仅在定义此变量的编译单元中可见。编译器每收到一个编译单元，就会相应的输出一份目标文件(object file即.o文件)。假如我们不声明static，编译器就会为它创建一个“外部符号”。此时如果另一个编译单元也声明了一个同名变量，那么编译器就会抛出一条错误消息。事实上，如果同时用static和const命名，编译器根本不会创建符号，而是会像#define预处理指令一样，把所有遇到的变量都替换为常值。不过还是有一点区别的，用这种方式定义的常量是带有类型信息的。

不管是#define还是static const都不应该在头文件里声明，因为常量名称很有可能互相冲突，如果一定要这么做的话，要加上前缀，表明它输入哪个类。

再延伸的说一下extern：
extern常用于NSNotification中等，供外部使用，extern常量放在“全局符号表”中，以便可以在定义该常量的编译单元之外使用。这也是不用使用#import引入其所在头文件的原因，需注意，此类常量必须要定义，而且只能定义一次。

5.Reveal

对于庞大的项目，纯代码构建的UI，使用Reveal来调试界面的用处还是很大的。可以帮助我们更直观的了解代码，快速定位UI细节。颜色，位置，大小，间距，和View之间的相对关系都可以一目了然。Reveal甚至比Xcode自带的Interface Builder做的还要好。对于越狱的设备，Reveal还可以用来分析其他应用程序的UI，实在是不可多得的利器。

img

Reveal加载的三个方法

加载方法1

下载Reveal之后打开，在菜单中的Help中可以找到集成到Xcode项目的方法，这里不再赘述。

加载方法2

此方法可以在不改变工程设置的前提下加载Reveal
打开终端，输入

vim ~/.lldbinit

LLDB每次启动的时候都会加载这个文件。输入：

command alias reveal_load_sim expr (void*)dlopen("/Applications/Reveal.app/Contents/SharedSupport/iOS-Libraries/libReveal.dylib", 0x2);

command alias reveal_load_dev expr (void*)dlopen([(NSString*)[(NSBundle*)[NSBundle mainBundle] pathForResource:@"libReveal" ofType:@"dylib"] cStringUsingEncoding:0x4], 0x2);

command alias reveal_start expr (void)[(NSNotificationCenter*)[NSNotificationCenter defaultCenter] postNotificationName:@"IBARevealRequestStart" object:nil];

command alias reveal_stop expr (void)[(NSNotificationCenter*)[NSNotificationCenter defaultCenter] postNotificationName:@"IBARevealRequestStop" object:nil];

然后输入control+c，w q enter退出终端。
上述文件创建了4个命令：

reveal_load_sim,reveal_load_dev, reveal_start 和 reveal_stop

reveal_load_sim 这个只在iOS模拟器上有效。它从Reveal的应用程序bundle中找到并加载libReveal.dylib（请确保你把Reveal安装到了系统的Application文件夹，如果你换地方了，你修改上述的文件）。
reveal_load_dev 这个命令在iOS设备和模拟器上都有效。不过，它需要你在Build Phase中的的Copy Bundle Resources中加上libReveal.dylib，请确保没有放到Link Binary With Libraries这个地方。
reveal_start 这个命令发出一个通知启动Reveal Server。
reveal_stop 这个命令发出一个通知停止Reveal Server。

如果在模拟器下调试，只需要在- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions方法中加入一个断点并且如图所示编辑：

img
编译运行即可。

在真机下，需在工程中导入Reveal的动态库，打开Reveal，点击Help-Show Library in Finder，将libReveal.dylib文件拖动到目标Xcode工程中，Xcode默认情况下错误地将libReveal.dylib设置到了”Link Binary With Libraries”下，我们需要进行一下调整，将其中”Link Binary With Libraries”中删除，然后将其添加到“Copy Bundle Resources”下面。

img
之后用Reveal连接真机的方式和连接模拟器的方式类似，我们只需要把模拟器调试下的断点Action的内容从reveal_load_sim改成reveal_load_dev即可。

加载方法3

对于越狱的机器，可以用Reveal来”调试“其它应用界面，什么时候会有这种奇怪的需求呢？——当我们想学习别人是如何实现界面效果的时候。iOS设备的目录/Library/MobileSubstrate/DynamicLibraries下存放着所有在系统启动时就需要加载的动态链接库，所以我们只需要将Reveal的动态链接库上传到该目录即可。

对于越狱的设备，我们可以在安装OpenSSH之后，用scp来上传该文件。具体步骤如下：
1.将libReveal.dylib 上传到/Library/MobileSubstrate/DynamicLibraries
2.如果libReveal.dylib没有执行权限，用chmod +x libReveal.dylib命令，给其增加执行权限
3.执行killall SpringBoard重启桌面

另外需要注意的是，使用Reveal真机测试时手机和电脑应处于同一网络下。