标准IOS项目代码目录结构 ios项目架构图

转载

mob64ca13ff28f1 2023-12-18 21:48:43

文章标签 标准IOS项目代码目录结构 #define 宏定义头文件 文章分类 iOS 移动开发

说下结构，我在创建项目之后，把所有的功能都分文件夹，而且在项目里建立对应的实体文件夹，看起来整洁，找文件也方便：
一、.AppDefine文件夹写了程序里的常用到的一些宏定义，分为6个.h文件：
1.Singleton.h：这个就是写了一个单例的模板，快速生成一个单例。
2.AppConfig.h：把程序的一些字典定义在里面，比如用到的第三方的Key，程序的字体、颜色，这些啥的，比如我程序里的Nav的title，我在这里定义了字体大小，颜色，如果要更改的时候，在这里更改一下，程序里所有的界面都改过来了，不用一个页面一个页面的去改。这个文件主要看自己程序是怎么定义的，一般把通用的设置写在这里。
3.InLineDefine：一些常用的内联函数定义，我用的内联函数很少。只是先定义好，后面可能有用。
4.MacroDefine.h：这个文件里定义的都是通用的宏定义，所有程序都通用，新建项目的时候，直接拖过去就可复用。我主要定义一些编译设置、一些方法简写。为了避免与其它的宏定义冲突，全部以小写m开头。
5.NetworkAPI.h：把所有的网络请求的接口全部定义在这里，统一管理，方便清晰。还定义了一些网络请求状态码
6.UmengConfig.h：友盟的配置文件。

二、AppEngine文件夹写了项目里比较核心的一些文件。这个项目用的是侧边栏式，所以里面主要的就是侧边栏的配置
三、LeftViewController、RightViewControllers文件夹对应的就是侧边栏的左、右相应的功能
四、NotificationCenter文件夹写了项目的活动、公告、应急这些处理的类
五、SupportingFiles里为原来默认的一些配置文件
六、Images为程序的资源文件，为方便查找，都是按功能块放入对应的文件夹里。

在项目里，我给每个ViewController写了一个Model（or service），把所有的网格请求、数据都放在这个Model里，ViewController需要数据的时候，直接去Model里去取，要更改数据，也直接让Model更改。这样做，我觉得有两个好处：首先，减少ViewController的压力，降低它的复杂度。其它，从结构上也更清晰一些。这样后面需求变更的时候也更容易一些，不至于ViewController里一坨一坨的。

最后一点吧，把在很多类都要用到的类的头文件，都放到.pch里去，这样在整个项目中都不用再引头文件了。我把所有的到处要用的第三方库文件的头文件、QuartzCore、分类文件都引入到里面。这样可以减少类里的头文件引用。
另外，我把写的所有分类都放到CategoryUtils.h这个头文件里，然后在.pch里引入这一个头文件，这样，在所有的地方都可以直接使用分类了。

犹如：

Appconfig.h：定义了项目里一些常用的常量，比如常用的字体、颜色、常量等等
MacroDefine.h：定义一通用的一些宏定义，所有项目通用，以m开头
NetworkAPI.h：定义项目里的网络接口

TWModel.h：模型的引入头文件，方便引用
TWTableDataSource.h：定义TableView的通用DataSource，以减轻使用UITableView的VC复杂度
TWTableDelegate.h：定义TableView的通用Delegate，以减轻使用UITableView的VC复杂度
TWTableModel.h：TableView的通用数据模型，对TableView的数据做简单的处理
TWNetworkRequest.h：对MKNetworkEngine的一层封装，简化网络请求
TWKit.h：UI的引入头文件，方便引用
TWButton.h：定制Button的样式，如形状，字体大小等等
TWCell.h：定制Cell的几个通用方法，配合TWTableDataSorce和TWTableDelegate使用
TWLable：定义Label，如背景为透明，字体大小等
TWTextField：定制TextField，如圆角，字体大小，背景色等
TWTextView：同上
TWViewController.h：定制ViewController，如显示加载页面等
TWBarButtonItem.h：定制BarButtonItem按钮，如导航栏按钮，在iOS7和之前显示是不一样的，这里把它设置为一样的，使样式统一，体验一致

2. iOS项目的目录结构和开发流程

目录结构

AppDelegate

Models

Macro

General

Helpers

Vendors

Sections

Resources

一个合理的目录结构首先应该是清晰的，让人一眼看上去就能大概了解目录的职责，且容易应对新的变化。

AppDelegate

这个目录下放的是AppDelegate.h(.m)文件，是整个应用的入口文件，所以单独拿出来。

Models

这个目录下放一些与数据相关的Model文件，里面大概是这样：

Models

|- BaseModel.h

|- BaseModel.m

|- CollectionModel.h

|- CollectionModel.m

...

Macro

这个目录下放了整个应用会用到的宏定义，里面大概是这样：

Macro

|- AppMacro.h

|- NotificationMacro.h

|- VendorMacro.h

|- UtilsMacro.h

AppMacro.h 里放app相关的宏定义，如:

// 表情相关

#define EMOTION_CACHE_PATH @"cachedemotions"

#define EMOTION_RECENT_USED @"recentusedemotions"

#define EMOTION_CATEGORIES @"categoryemotions"

#define EMOTION_TOPICS @"emotiontopics"

// 收藏相关

#define COLLECT_CACHE_PATH @"collected"

// 配图相关

#define WATERFALL_ITEM_HEIGHT_MAX 300

#define WATERFALL_ITEM_WIDTH 146

NotificationMacro.h 里放的是通知相关的宏定义。

UtilsMacro.h 里放的是一些方便使用的宏定义，如：

#define UIColorFromRGB(r,g,b) [UIColor \

colorWithRed:r/255.0 \

green:g/255.0 \

blue:b/255.0 alpha:1]

#define NSStringFromInt(intValue) [NSString stringWithFormat:@"%d",intValue]

VendorMacro.h 里放一些第三方常量，如：

#define UMENG_KEY @"xxxxx"

#define UMENG_CHANNEL_ID @"xxx"

如果有新的类型的宏定义，可以再新建一个相关的Macro.h。

General

这个目录放会被重用的Views/Classes和Categories。里面大概是这样：

General

|- Views

|- TPKScollView

|- TPKPullToRefresh

...

|- Classes

|- TPKBaseViewController

|- TPKHorizontalView

...

| - Categories

|- UIViewController+Sizzle

|- UIImageView+Downloader

...

这里的TPK是项目的首字母缩写。

Helpers

这个目录放一些助手类，文件名与功能挂钩。里面大概是这样：

Helpers

|- TPKShareHelper

|- TPDBHelper

|- TPKEmotionHelper

...

助手类的主要作用是帮助Controller瘦身，也可以提供一定程度的复用。

Vendors

这个目录放第三方的类库/SDK，如UMeng、WeiboSDK、WeixinSDK等等。

Sections

这个目录下面的文件对应的是app的具体单元，如导航、瀑布流等等。里面大概是这样：

Sections

|- Menu

|- Setting

|- Collection

...

Resources

这个目录下放的是app会用到的一些资源，主要是图片。

Cocoapods

业务无关的类库可以通过 Cocoapods 来方便地管理，如SDWebImage, Reachability等等。还有一些是多个应用都会用到的基础模块，比如HBAPI、HBSNS 、HBFoundation（HB为公司名首字母）等等，可以建一个私有的git repo，然后加到podfile中，这样如果HBAPI有更新，只需要pod update一下就行了。

顺便说一下HBFoundation，这个git仓库中可以放一些自己写的所有应用基本上都会用到的小模块。如很多app都会有隔一段时间跳出一个求好评的alertView，就可以写一个HBRating类，这样需要使用该功能的app只需加上一句：[HBRating checkIfShouldPopupWithAppID:(NSInteger)appID]就行了。又比如app都有接受push notification的需求，可以写一个HBAPNS类，等等。

开发流程

在拿到设计图后，就可以针对设计图抽离出可复用的Classes/Views/Helpers，考虑一下某个效果的具体实现，使用合适的设计模式来避免大量的if/else嵌套，等等。不要一下子就钻到Sections中去实现页面效果和功能，初看起来可能会快一点，但只要有点复杂度的项目，这种做法到后来只会吃尽苦头，代码会变的越来越难维护。所以前期一定要做好充足的准备工作。

http://www.cocoachina.com/industry/20140225/7879.html

3. 最后看几个开源项目

BeeFramework:https://github.com/gavinkwoe/BeeFramework

ECMobile 是基于自主知识产权框架 BeeFramework 进行研发的跨平台电子商务移动客户端产品:https://github.com/GeekZooStudio/ECMobile_Universal

NUI:https://github.com/tombenner/nui

NUI is a drop-in UI kit for iOS that lets you style UI elements using a stylesheet, similar to CSS. It lets you style an entire app in minutes.

Pixate:http://www.pixate.com/

Maxonry:https://github.com/Masonry/Masonry

Harness the power of AutoLayout NSLayoutConstraints with a simplified, chainable and expressive syntax. Supports iOS and OSX Auto Layout,响应式布局。

IOS samples:https://github.com/shu223/iOS8-Sampler

https://github.com/wjkhappy14/MHVideoPhotoGallery