本文主要介绍每当开启一个新项目的第一步:从项目的搭建到给团队分发模块开始开发的过程。现在虚拟一个即将要开始的项目叫:NewStart(新起点),通过这个项目你能看到整个项目的目录结构。
主要的框架设计如下 :
建议先下载已经完成的代码,其实可以直接看代码的,可以不用看这篇文章,这里说的不全,其中也有很多的废话,我的表述也有些问题。毕竟一行代码胜过千言万语。下载代码下来之后,在运行之前记得 pod install 一下。由于代码有更新,所以本文介绍主要是在git的第二个节点做介绍的:项目第一次提交,主要完成了项目的搭建到分发。
接下来、将会按照步骤依次做介绍。
一、git准备
刚开始工作那会一直使用svn来做代码管理,自17年初开始使用git、这次使用 github 来做介绍。一般情况公司都会有自己的 git 服务器。具体的步骤:
1、首先需要有一个项目组 (group),一般是以公司为单位。比如 XXXX 公司的项目,都应该在一个组中。即使这个公司只有一个项目,也应该是单独的一个组。
2、在指定的项目组中创建一个项目,一个空的没有任何分支的 git 项目已经完成。
3、通过第2步创建的 git 项目,可以直接在网页把 README.md 文件也创建了。
4、将项目 clone 到本地,然后添加一个忽略文件 (.gitignore)
以上是在工作中的 git 的常规步骤,现在使用 github 的流程走一遍,流程是一致的,唯一的区别是一个 group ,一个叫 team,其实都是一样的。
在自己的账号中创建一个 team:
这是 team 创建成功的样子。
开始创建项目 :
这是项目创建成功的样子:
现在为止,一个 git 远程仓库就准备好了,我们直接 clone 到本地,最终是这样子的:
到现在为止,一个 git 的全部准备工作就全部完成了。其实这个过程是很简单的,可以说不需要时间就能完成。
二、创建项目
在Xcode中创建完项目后是这样子的:
首当其冲的将项目的系统最低支持版本也改一下:
到现在为止,一个简单的项目就算是结束了,现在就可以提交远程给同事们开始开发了么?那肯定是不可以的,还差得很远,现在只是有一个项目,还需要将一个简单的框架搭建好才能给出去,否则其他同事是会很乱的。至少还需要把一下3点
完成 :
1、项目的整体结构以及常用的基类
2、 第三方
3、 网络框架
这三点可以不是最终版本,但是一定要有,毕竟团队合作开发肯定得有一个方向,否则不同的人肯定会弄出自己的一套,这样是不行的。下面根据以上3点分别做介绍。
1、项目的整体结构以及常用的基类
目录小改动
添加 SupportingFiles 目录
在新版本的 Xcode 中没有 SupportingFiles 了,但是习惯了这个文件,我们可以自己搞一个。主要是习惯了将 Assets.xcassets, Info.plist 与 main.m 这三个文件放到这个目录下。
这里需要注意的是,要在文件中将 project.pbxproj 文件中的 INFOPLIST_FILE 的值改一下,因为改了 Info.plist 文件的路径。
添加 AppDelegate 目录
将 AppDelegate 的两个 .h 与 .m文件单独放到这个文件夹中。
现在的样子是这样的:
在 Xcode 中,目录合起来是这个样子的:
这样看起来还是比较简单明了清楚的,我感觉,其实到现在为止,只是做了一个小小的调整而已,还没有真正的搭建项目的结构。
添加 General 目录
这个目录是一个核心的目录,所有的代码都将会在这里。这个目录中也有这些的目录:Libs(用到的非 pod 管理的第三方库),Category (分类),Modules (项目的所有模块),Macro(基本的配置,比如网络,基类)。如:
其实在上面的目录中的 Libs 与 Category 是可以允许为空文件的,具体可以在开发的过程中用到了再添加。但是Modules与Macro 尽量一次性弄好。
Macro目录完善
在这个目录中,一般存放的是固定的,以后即使要改的话,改动也不会太大的东西,或者即使要改也是全局性修改的那种。最终结果如下:
其实,穿过图片就能知道这里面写的都是一些再基础不过的基本配置。换句话来说,几乎所有的项目都能通用,即使改动也不会太大。
Modules目录完善
这个目录中,就是项目的核心需求了。具体要怎么去搭建目录,那就要看项目的实际结构了。
比如这样的:
2、 第三方
是这样的 :
或者是直接将别人的代码直接拖入项目中,是这样的:
3、 网络框架
网络框架,为什么一定要先提前弄好?
反正在我刚开始敲代码那会儿,我们的新项目是没有的,然后团队中的每个人各领风骚,本来一个项目的网络请求都应该是一个套路的,否则最后会很乱的。
同事们在使用的时候,直接在这里来添加自己的接口即可:
通过自己的模块/功能自行创建分类,这样项目不会至于会乱。
到现在为止,一个简单的项目搭建就算完成了,可以直接将自己本地的代码提交到远程,告知团队开始进行开发了。记得创建一个 develop 分支。
直接在这里下载 代码代码代码,下载代码下来之后,在运行之前记得 pod install 一下。由于代码有更新,所以本文介绍主要是在git的第二个节点做介绍的:项目第一次提交,主要完成了项目的搭建到分发.