一、规范
1) git 提交规范
# 提交管理
Type(scope) : # module name # subject
例如:
fix: # 租赁合同 # 修改xxx
Type 必须填写
* feat: 新功能
* fix:修复bug
* Docs:文档改变
* Refactor: 某个已有功能重构
* Perf: 性能优化
* Test: 增加测试
* build:改变build工具
* revert:撤销上一次commit
* merge:合并代码
subject:commit 简单的说明,必须填写
适当使用git merge / git rebase
2) 代码规范
# 1、命名规范
类名、协议名、变量名、方法名、常量命令、宏定义命名、通知名
尽量使用 用前缀避免命名空间冲突
# 2、mark 标记类型
#pragma mark - lifeCycle
#pragma mark - public
#pragma mark - request
#pragma mark - delegate
#pragma mark - privates
#pragma mark - lazy
# 3、数据源显示UI
比如自定义cell、view
在需要加载数据,显示UI的时候,统一用一个方法传递数据源,这个方法可以统一用 Protocol 来处理,特殊的单独处理
- (void)showData:(id)data;
# 4、变量的访问
对象内部尽量直接访问实例变量,因为速度较快;
编译器所生成的代码会直接访问保存对象实例变量的那块内存
不会调用“set方法”,绕过了属性所定义的内存管理语义
一般写入实例变量,通过set 方法
# 5、注释
供外部使用的,请使用文档注释
# 6、多用类型常量,少使用宏定义
宏定义增加编译时间
没有类型检查,编译通常不会报错,所以错误异常很难定位
# 7、头文件导入
尽量使用向前声明的方法 @class xxx
降低耦合、减少编译时间
尽量在extension 里面 设置private属性,在.h文件中,设置public属性
# 8、资源图片
改好英文名字之后才放入到工程里面(不能直接去工程里面改名字,因为图片的名字没有改变)
# 9、说明文件
为了提高效率,人员之间的对接,应该有一个说明文档,可以通过网页查看,记录相关的事宜
1、规范文档
2、第三方库的功能类型以及的使用的事例(防止同一个功能,存在很多版本)
3、多搞交流会,提高技术
注意
- 改动别人模块的代码,一定要 模块负责人 代码review一下
二、六大原则
中心思想: 高内聚 低耦合
1. 单一职责原则
一个类或者一个方法只负责一项职责,尽量做到类的只有一个行为原因引起变化
2. 里氏替换原则
子类可以扩展父类的功能,但不能改变原有父类的功能;
父类出现的地方,子类都可以出现,并且将父类对象替换子类对象的时候,程序不会抛出任何异常或错误
因此:尽量不要重载或者重写父类的方法(抽象方法除外),因为这样会改变父类的原有的行为
3. 依赖倒置原则
面向接口编程,高层模块不应该依赖低层模块(原子操作的模块),两者都应该依赖于抽象。
接口(也可以是抽象类)就是一种抽象,只要不修改接口声明,大家可以放心大胆调用,至于接口的内部实现则无需关心,可以随便重构。
这里,接口就是抽象,而接口的实现就是细节
4. 接口隔离
客户端不应该依赖它不需要的接口,一个类对另一个类的依赖应该建立在最小的接口上
5. 迪米特原则
最少知道原则,尽量降低类与类之间的耦合;
如果两个类不必彼此直接通信,那么这两个类就不应当发生直接的相互作用。
如果其中的一个类需要调用另一个类的某一个方法的话,可以通过第三者转发这个调用。
6. 开闭原则
对扩展开放,对修改关闭;是指设计的时候,尽量让设计的类做好后就不再修改,如果有新的需求,通过新加类的方式来满足,而不去修改现有的类(代码)
注意
- 继承不要滥用
三、架构
1) 业务模块
首页 、客户、消息、 我的
细分:
委托、租赁合同、营销工具、后台管理、IM、ReactNative、Q聊、实勘、拓房、钥匙管理、跟进、个人中心、
扫码登录
2) 功能模块
细分:
- 营销工具【分享、电话、短信】
- 路由:
- 网络框架
- 下载功能
- 异常防护
- 埋点
- Js交互、RN与原生交互
- 性能监听
- 播放视频、浏览图片、语音
- 上传视频、图片
- 工具类:
- Q聊
- 推送
- 二维码功能
3) base 模块
公共UI组件类
弹框类组件:alertView、sheetView、toastview、popoverView
分段类组件: segmentView、flitterView、MenuView
搜索框组件:
时间选择器:
分类:
foundation框架类: NSString、NSDate、NSDictionary、NSArray…
UIKit框架类:UIView、UIButton、UITextField…
4) 架构
1. 架构图
2. 私有pod 库
- 利用pod 私有库封装base 层