聊聊iOS工程目录结构

关于工程目录结构和代码管理,每个开发者可能都有自己的理念和习惯,但是都应该以简单、清晰、容易查找为原则。比较混乱的结构,会让新同事甚至自己在开发的过程当中都会绊手绊脚。这里就举个反栗子,直接贴一下我们公司项目两年多前1.0版本的工程结构。当初刚刚看到这个工程,我是直接晕了过去,想走的心都有了。。。这里就不说这样的结构有什么问题,相信哪位同事现在也应该不会搞出这样的东东来。

那些年震惊过的工程目录结构

我开始参与这个项目之后,1.1版本第一件做的事就是对工程目录结构进行了调整。不过经过两年40多个版本的迭代开发,项目结构很多代码文件又开始有点混乱的感觉,一些文件的查找很不方便。这次趁着项目重构的机会,又对工程的目录结构进行一下调整。下面是新工程目录结构的导图。

新的工程目录结构导图

主要有三大部分,Core存放我们的代码,也是文章主要说明的部分。Resource存放资源,例如图片、音效、文件等等,至于图片现在很多基本都用assets来管理了;SupporrtingFiles存放pch、main.m等等,一般我们也不能把文件放到这个位置。因为这个分组的点击次数是最少的,所以放到最下面。

Core的分组主要分为AppDelegate、Modules、NetWork/Requests、Services、General、Macro、Vendors等六个大模块。

AppDelegate

这里只放AppDelegate的h和m文件,也可以放入其他跟AppDelegate有关的文件,比如我们写了一个AppDelegate+Router的Category文件,用来处理rootViewController的变化,这个也应该放到这个分组来比较清晰,而不是放到General的Category。

Modules

Modules放应用的业务逻辑代码,比如微信可以分‘微信’、‘通讯录’、‘发现’、‘我’等四个主模块,然后‘我’里面还可以分收藏、钱包、表情等等模块。总而言之,Modules就是放App主要业务逻辑和功能代码的地方。

Network/Request

Network这一模块,又可以命名为Request,主要放我们的网络请求方法。每个Path包含的请求写一个类。这一块当然大家可以根据的自己的项目来定,因为我们后台的api,同一个Path下面的方法,有可能被Modules里面不同的模块调用,所以,我这里把网络请求方法独立出来了。

Services

服务模块,这一模块,主要提供应用的基础服务,比如说Apns推送管理,数据库,本地推送等等,这一类的封装之后的功能模块。

General

General用来放通用性的代码,CustomUI指我们写的UI控件;Category指我们写的Category文件了;Base指基类,如baseModel,baseViewController等等;Utils指工具类。
这里要强调是General必须是不涉及Modules里面逻辑的代码。举个栗子,我们编写的一个ChartView,用来显示各类投资收益占比的饼图,它已经包含了投资收益的计算逻辑(最好这类逻辑也不好写入控件),这个时候,这个ChartView已经不适合其他地方去使用,所以它更适合放到Modules对应模块的View分组去。

Macros

Macros模块宏定义的文件,我个人习惯定义不同的宏文件,比如说ConfigMacrof主要包含跟App配置相关的宏,UtilMacro包含工具类的宏等等。一些pch包含的定义性文件也可以放到这里来,比如说CommonEnum主要保存一些常用的枚举定义,我也会把它放到Macros这个模块来。

Vendors

所有的第三方类库都放到Vendors里面。

最后提一下Assets,我个人在使用的Assets的时候,一般是根据Modules里面的功能模块也分组存放图片的。大部分的图片资源也是用在这些Modules,这样就很方便我们在开发的时候查找图片,已经后续修改对应的模块,也容易替换资源。

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

推荐阅读更多精彩内容