接口和API设计

1、用前缀避免命名空间冲突,

其中前缀一般为三个大写字母。不仅仅是类名,应用程序中的所有名称都应加前缀,包括分类、C函数、全局变量。

2、提供“全能初始化方法”,

所有对象都要初始化,对外提供多个初始化方法,但所有初始化方法都会调用全能初始化方法。

如果子类的全能初始化方法与超类方法的名称不同,那么总应覆写超类的全能初始化方法,

有时候可能需要编写多个全能初始化方法,比如某对象实例有两种完全不同的创建方式,必须分开处理,那么就会有这种情况。

在类中提供一个全能初始化方法,并于文档里指明,其他初始化方法均应调用此方法,若全能初始化方法与超类不同,则需覆盖超类中对应的方法,如果超类的初始化方法不适用于子类,那么应该复写这个超类方法,并在其中抛出异常。

3、实现description方法,

打印object对象时候,object对象会受到description消息,该方法所返回的描述信息将取代“格式化字符串”。为了更明确展示对象信息,一般重写description方法,并在里面输出累的名字、指针地址,然后根据需要打印属性信息等

如果想在调试时候打印出详细信息,则应事先debugDescription方法

4、尽量使用不可变对象

设计类的时候,应充分利用属性来封装数据,对不需要改的属性可以设为只读。只有在必要的时候,才将属性对外公布。在公共接口中声明的属性在内部可以重新声明,前提是需要修改属性的特征,例如将readonly改为readwrite

开发者最好不要从底层直接修改对象中的数据

5、使用清晰而协调的命名方式

(1)方法命名:OC的方法命名虽然繁琐,但是可读性高

如果方法的返回值是新建,那么方法名的首个词应是返回值的类型,除非前面还有修饰语

应该把参数类型的名词放在参数面前

如果方法要在当前对象上操作,那么就应该包含动词

不要使用str这样的简称,应该用string这样的全称

bool属性应加is前缀

(2)类和协议的命名

起名遵守OC命名规范,方法名言简意赅,方法名里不要使用缩略后的类型名称,给方法起名时第一要务就是确保其风格与你自己的代码或所需要集成的框架相符合。

(3)为私有方法名钱加前缀

为私有方法加前缀,就很容易把私有方法和公有方法区分开,还可以便于修改方法名或方法签名,有了前缀就很容易看出来哪些方法可以随意修改,哪些方法不应轻易改动

前缀不要以“_”,因为这是给苹果公司自已用的

6、OC的错误类型

OC中的错误类型只有在极其严重的时候使用,一般情况是用NSErrors,经由方法的”输出参数返回给调用者“传递给方法的参数是个指针,而该指针本身又指向另外一个指针,那个指针指向NSError对象,,所以可以直接把错误信息塞到NSError里面。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容