iOS项目架构文档

  设计的项目架构主要引用MVVM+MVC架构,并以功能模块分级。以下为目录结构。

  初级目录:

  

  我们只需要关注SGZH文件夹下的目录,其他为Xcode管理的目录。可以看到此目录为项目初级目录,我们开发过程只需对初级目录内的文件进行操作,其主要划分为3大块:

  AppDelegate: AppDelegate是程序入口,程序启动和显示逻辑都定义在内部,主要可以让开发人员快速找到代理文件并了解程序从启动到显示过程,也可以快速进行一些初始化测试。

  Resource: 此目录主要存放一些项目资源文件,如项目切图、音频、视频、coreData数据等。

  Class: 存放我们编写的代码文件。

  SupportingFile: 项目配置文件。

  Info.plist、main.m、pch文件。

 二级目录:

  Resource目录下: 相对较小的切图放在Assets内部,并以功能模块划分文件夹。如果较大的图,如启动页,引导页,可以在该目录下新建对应的功能模块文件夹存放。其他音频视频文件可以建立对应名字的文件夹存放。

  Class目录下:

  

  Category: 项目分类文件。

  Macro: 项目全局头文件、全局宏和常量

  

  Other: 其他一些配置文件,如网络请求API

  Main: 项目主要文件,全局共用文件以及一些基类

  

  Tool: 项目工具类,如网络请求工具,缓存工具,app管理工具等 Vendor: 存放项目需要手动引入的第三方库。

  

  Sections: 项目功能模块分组。

  

  可按底部tabbar对应选项卡划分,若有登录、新特性等比较大的功能,也可划分为一个模块。 若果模块内的子模块功能比较多,也可在其内部划分一个子模块。 每个模块内部都分4个文件夹,分别存放对应的Controller、Model、View、ViewModel。 据我了解,大部分企业iOS项目都会选取类似这种架构模式。个人觉得此架构较为清晰,可读性好,并且每个模块文件夹相对独立,开发人员相对专注开发自己的模块。

  以上为本人从事iOS开发以来总结的一些项目架构经验,如有不足或者可改进之处可提出修改。

时间: 2024-08-24 08:43:38

iOS项目架构文档的相关文章

开发人员,请不要抱怨项目没有文档

每当我们切入一个新项目时,我们发现项目中的文档总是少的可怜,而且里面的设计与当前的系统设计严重不符,有些甚至在架构上出现了严重的偏离.于是我们问待交接人,为什么项目中只有这么点文档,而且文档的内容也不准确?他们振振有词的告诉我们:这个项目的开发周期非常紧张,而且需求经常发生变化,他们根本没有时间去维护文档,里面的那份文档,是很久之前加班补的.要想看详细的设计,就去看代码吧,代码就是最好的文档. 听到这里,有些人也许会以为项目中的代码写的多么的酷,每个类都是按照教科书中的格式体去注解的.但当我们看

3g上网卡的驱动程序的自动更新web端架构文档

几年前写的. 看是否有人用得上吧 1   简介 本文档详细描述了基于ASP.NET平台和IIS服务的T-Mobile自动更新系统的实现框架. 本文档主要从技术架构和业务架构两个方面来着手来描述T-Mobile自动更新系统的架构,以使相关人员快速了解产品的架构. 1.1   目的 本文档将从架构方面对T-Mobile自动更新系统进行综合概述,其中会使用用例视图.逻辑视图.部署视图.实施视图等多种不同的架构视图来描述系统的各个方面. 这些描述用于记录并表述已对系统的架构方面做出的重要决策,同时确定系

3g自己主动更新网卡驱动web完架构文档

几年前写. 看它是否是用得上 1  简单介绍 本文档具体描写叙述了基于ASP.NET平台和IIS服务的T-Mobile自己主动更新系统的实现框架. 本文档主要从技术架构和业务架构两个方面来着手来描写叙述T-Mobile自己主动更新系统的架构,以使相关人员高速了解产品的架构. 1.1  目的 本文档将从架构方面对T-Mobile自己主动更新系统进行综合概述.当中会使用用例视图.逻辑视图.部署视图.实施视图等多种不同的架构视图来描写叙述系统的各个方面. 这些描写叙述用于记录并表述已对系统的架构方面做

nginx-tomcat-memcached架构文档说明(转)

800x600 Normal 0 7.8 磅 0 2 false false false EN-US ZH-CN X-NONE MicrosoftInternetExplorer4 st1\:*{behavior:url(#ieooui) } /* Style Definitions */ table.MsoNormalTable {mso-style-name:普通表格; mso-tstyle-rowband-size:0; mso-tstyle-colband-size:0; mso-sty

我的项目需求分析文档模版

1. 项目概况 1.1. 背景 写项目的来龙去脉 1.2. 项目愿景 写该项目达到的目的. 例如 建设该项目是为了提高本区域的地质灾害预警预报的及时性. 1.3. 项目干系人 和该项目相关的人员和其负责的内容 在这里要找到主要干系人,也就是说能对系统功能拍板的人. 1.4. 运行环境 项目的运行环境,包括硬件环境和软件环境 1.5. 条件与限制 硬件条件限制.例如只能购买一台服务器,网络条件限制,只能走政务内网或局域网.或者已经指定了数据库和开发平台,开发语言等.还有工期等. 2. 数据需求 2

.NET项目工程生成一份项目帮助文档chm--Sandcastle工具

.NET项目工程生成一份项目帮助文档chm--Sandcastle工具

架构文档类别

我们在做架构设计文档一般分为两个层面: #1 技术架构设计. 从技术的解决上来讨论,着重点是讨论采用什么样的技术,如何分层,采用了那些好的技术特性.采用这些技术特性会为我们的工作带来哪些好处.为什么要这么做. #2 体系结构设计. 从业务需求的角度来出发,理清物理结构图和逻辑结构图. 划分每个子模块,为什么要这么划分,以及各个只模块之间的交互关系,每个子模块具有哪些接口. 这个是要求对需求的把握十分到位,是用设计对需求的映射,重点是要理清整个系统的脉络. 架构文档类别

xml和xsd架构文档相关知识

1.使用架构(XSD)验证XML文件 2.使用自动生成工具: 工具目录:C:\Program Files (x86)\Microsoft SDKs\Windows\v8.0A\bin\NETFX 4.0 Tools 工具名称:xsd.exe 使用帮助:生成xml架构文档xsd-->拷贝xml文件到工具目录下,打开命令工具,进入该目录,执行命令:xsd myFile.xml 生成xsd架构文档相关类-->执行命令:xsd /c/language:CS XSDSchemaFile.xsd 更多详细

IOS项目架构分享

1.项目分层:通过过往的一些项目经验,我们在IOS项目架构时候可以对项目进行如下图层: OpenSourceSDK,顾名思义,就是我们引入的一些第三方的开源工具,比如github上开源项目 MySDK 就是我们自己封装的一些SDK.可以在各个项目中能用的 需要重点介绍的就是我们的MVP结构,请接着往下看 -------------------------------------------------------------------------------------------------