ios开发学习 - 第二课iOS项目文件夹结构

Posted 2020-09-24 zhchoutai

文件夹结构

AppDelegate

Models

Macro

General

Helpers

Vendors

Sections

Resources

 

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

 

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中去实现页面效果和功能，初看起来可能会快一点，但仅仅要有点复杂度的项目。这样的做法到后来仅仅会吃尽苦头。代码会变的越来越难维护。

所曾经期一定要做好充足的准备工作。