关于工程目录结构和代码管理,每个开发者可能都有自己的理念和习惯,但是都应该以简单、清晰、容易查找为原则。比较混乱的结构,会让新同事甚至自己在开发的过程当中都会绊手绊脚。这里就举个反栗子,直接贴一下我们公司项目两年多前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,这样就很方便我们在开发的时候查找图片,已经后续修改对应的模块,也容易替换资源。