iOS新建项目文件管理规范

Posted 2020-07-05 NSSong

当我们进入到新的公司的第一天，看到以前老员工编写的代码，找个东西累死人咧，那个抓耳挠腮的啊，一般情况下都有想揍人的赶脚。 哈哈，不忙，先想一下自己的代码！想一下自己写的代码怎么才能新来的人一眼就能看懂，想找什么，在几秒之内就能找到?这个就要在前期创建项目的时候留神 了， 要保证项目的易读性、易维护性以及易扩展性等。

在我看来，作为一个项目开发的领头人，你可以从两个方面着手：

• 项目的架构

• 代码的规范

今 天就先介绍我在做新项目的时候项目架构(代码规范我会在下一篇文章以总结的形式罗列出来)，搞理论这个我不擅长，只好整个例子说一说。考虑到很多人在刚学 OC的时候都用“新浪微博”来练手，所以这里就拿新浪微博的iPhone客户端来说事，也正好对比一下，这样更能看出问题所在。(其实，目前市场上基本所 有的应用都适用，本文说的就是一个思想，不论平台，不论语言，只要能理解，就可以应用到实际的应用开发中。)

为了为项目代码创建一个易读性、易维护性、易扩展性都相当不错的代码模板，现在要求项目代码的搭建者按照如下的步骤进行：

1、所有新建项目最好是「Single View Application」：

2、填好各个项目，这里注意，项目名称最好使用英文:

3、项目创建好之后，第一件事就是修改最低部署系统的Target版本:

4、接下来就是源文件管理，我们看左侧的导航区域:

• 非代码源文件全部移动到「Supporting Files」中；

• 选 中Appdelegate和ViewController的.h和.m，右键「Show In Finder」，然后把Appdelegate和ViewController的.h和.m移到废纸篓，回到Xcode，删除红色的刚才我们删除的文件 (也可以直接在Xcode中右键->delete->movetotrash, 但是有时候会删除地不干净)。

5、 导入我们已经准备好的项目结构文件(就是项目结构的文件夹和文件的集合在这下载查看)到与项目名称相同的目录之下，如图:

结果是这样的:

6、 其中文件夹`QLClasses`中是该项目中的所有源代码，`QLResources`中存放的是所有的非代码资源文件，下面就这两个文件夹的结构就新浪微博目前的结构进行详细的说明。整体的框架图如下(这才是重点):

• 需 要注意的是图片的处理，在`QLResources`中有个`QLImages`文件夹,这个文件夹是供特殊的图片文件而设立的，你不能把所有的图片都塞 到这里，这个不科学。最好还是放在Assets.xcassets中，那么到底是哪些图片呢?在有些项目中，大量使用了全屏的背景图片，这样的图片我们一 定不能使用[UIImage imageNamed:@"imageName"]的方式加载，因为这个方法会把图片直接缓存到内存中，试想一下，如果很多张图片都塞进内存是什么情况？ 那就只能使用[UIImage imageWithContentsOfFile:@"imagePath"]的方式，但是我们知道Assets.xcassets中的图片在生成ipa 后会被打包成一个压缩文件，以减少内存的占用，这个`imagePath`从哪里来呢，所以问题就解决了。把这些图片放到这个文件夹下面，加载的时候直接 用NSBundle解决path的问题，ok！

• 项目中肯定会遇到多个界面使用同一个数据模型的问题，最好还是在`QLMain`文件夹中创建两个文件夹`QLCommonModel`和`QLCommonView`两个文件夹，以便统一管理。

• 在Xcode左侧导航中看到的结构中的每一个文件夹(除却Supporting Files)，必须映射到Finder中的文件夹中，这样在不打开项目的情况下，我们就可以迅速的定位出以前写过的工具类的位置，也方便在Finder中查看当前项目的结构。