编写高质量的iOS代码(五)

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

  • 起名时应遵从标准的Objective-C命名规范,这样创建出来的接口更容易为开发者所理解。

🌰:

NSString *text = @"The quick brown fox jumped over the lazy dog";
NSString *newText = [NSString stringByReplacingOccurrencesOfString:@"fox" with String:@"cat"];

虽然只是一个简单的表达式,但是OC中却用一整句话来表达,这样做会让方法更明确、易读。并且方法与变量名使用了“驼峰式大小写命名法”(camel casing)。类名也用驼峰命名法,不过首字母要大写,通常还有两三个前缀字母。
当然这只是一种习惯,不是硬性要求,也可以按照自己的风格来命名,不过用驼峰命名法更容易被其他Objective-C开发者所接受。

  • 方法名要言简意赅,从左至右读起来要像个日常用语中的句子才好。

不要吝于使用长方法名,把方法名起得稍微长一点,可以保证能准确的传达出所执行的任务。当然,方法名也不能长的过分。
NSString这个类就展示了一套良好的命名习惯,列举出几个方法:

  • + string
    工厂方法(factory method),用于创建新的字符串。方法名就清晰的描述了返回值的类型。
  • + stringWithString
    工厂方法,根据某个字符串创建出与之内容相同的新字符串(感觉和copy一样)。方法名第一个单词也指明了返回类型。
  • + localizedStringWithFormat:
    工厂方法,根据特定格式创建出新的“本地化字符串”(locallized string)。返回值类型是第二个单词(string),因为前面还有个修饰语(localized)用来描述其逻辑含义。
  • - lowercaseString
    把字符串的大写字母转为小写。这个方法不会修改字符串本身,而是创建一个新的字符串,返回值类型是第二个单词(string),前面是定语(lowercase)。
  • - intValue
    将字符串解析为int型。返回值是int。通常不会简写返回值的类型,比如string不简写为str,但是由于"Integer"的简写"int"本身就是类型名称,所以这么做就合理了。只有一个词的名字通常用来表示属性,所以后面加上了"Value"。
  • - length
    获取字符串长度。这个方法只有一个词,实际上length也是NSString的一个属性。
  • - lengthOfBytesUsingEncoding:
    若字符串是以给定的编码格式(ASCII、UTF8、UTF16等)来编码的,则返回其字符数组的长度。这个方法和上面的"length"类似,但是这个方法需要一个参数,所以紧跟着描述类型的名词(encoding)。
  • - getCharacters:range:
    获取字符串中给定范围内的字符。其他语言里的获取方法也许会以get开头,但是Objective-C中一般不这么做,但是此处是个例外。原因在于,调用方法时要在其首个参数中传入数组,而该方法所获取的字符正是要放到这个数组里面。
  • - hasPrefix:
    判断本字符串是否以另一个字符串开头。因为返回值是Boolean类型,所以为了读起来像个句子,这种方法的名称中通常包括has(“是否有”)一词。
  • - isEqualToString:
    判断两字符串是否相等。返回值是Boolean,为了便于述说,方法名用is开头。

给方法命名时的注意事项可以总结成下面几条规则:

  • 如果方法的返回值是新创建的,那么方法名的首个词应该是返回值的类型,除非前面还有修饰语,例如上面的localizedString。需要注意,属性的存取方法不遵循这种命名方式,因为一般认为这些方法不会创建新的对象。

  • 应该把表示参数类型的名词放在签署前面。

  • 如果方法要在当前对象上执行操作,那么就应该包含动词;若执行操作时还需要参数,则应该在动词后面加上一个或多个名词。

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

  • Boolean属性应加is前缀。如果某方法返回非属性的Boolean值,那么应该根据其功能,选用has或is当前缀。

  • 将get整个前缀留给那些借由“输出参数”来保存返回值的方法,比如说,把返回值填充到“C语言数组”里的那种方法就可以使用整个次做前缀。

  • 给方法起名时的第一要务就是确保其风格与你自己的代码所要继承的框架相符。

  • 最重要的一点就是,命名方式要协调一致。如果要从其他框架中集成子类,那么务必遵循其命名惯例。

🌰:从UIView类中继承自定义的子类,那么类名末尾的词必须是View。同理,创建自己定义的delegate protocol,则其名称中应该包含委托发起方的名称,后面再跟上Delegate一词。


为私有方法名加前缀

  • 这样的做法可以很容易地将其同公共方法区分开。

编写类的实现代码的时候,经常会写一些只有在内部才使用的方法。在私有方法前加前缀可以更好的调试。还有一个原因就是这么做便于修改方法名或方法签名。不同于私有方法,类的公共API一般是不能够随意改动的。而私有方法有了前缀,就可以很容易的看出哪些可以随意修改,哪些不能。

  • 不要单用一个下划线做私有方法的前缀,因为这种做法是预留给苹果公司用的。

具体用什么前缀根据自己的喜好来定,但是其中最好包含下划线和字母p(private)。


理解Objective-C错误模型

  • 只有在发生了可使整个应用程序崩溃的严重错误时,才应使用异常。

首先要注意,“自动引用计数”(ARC)在默认的情况下不是“异常安全的”(exception safe)。具体点,如果抛出异常,本应该在作用域末尾释放的对象现在却不会自动释放了。
OC语言现在采用的办法就是:只在极其罕见的情况下抛出异常,异常抛出之后,无需考虑恢复问题,而且app此时也应该退出。

  • 在错误不那么严重的情况下,可以指派“委托方法”(delegate method)来处理错误,也可以把错误信息放在NSError对象里,经由“输出参数”返回给调用者。

NSError的用法更灵活,因为我们可以通过它来将错误信息报出来,NSError里封装了三条信息:

  • Error domain(错误范围,类型为字符串)
    🌰,“处理URL的子系统”(URL-handling subsystem)在从URL中解析或取得数据时出错,就会只用NSURLErrorDomain来表示错误范围。
  • Error code(错误码,类型为整数)
    通常都是用枚举来定义,常见的就是HTTP请求的错误码。
  • User info(用户信息,类型为字典)
    错误的额外信息,其中有可能包含一段“本地化描述”(localized description),也有可能包含的是另外一个错误,经由此种信息,可以把相关的错误串成一条“错误链”(chain of errors)。

而NSError一种最常见的用法就是写在delegate method中。

 - (void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)error;

另一种常见的用法就是最为“输出参数”返回给调用者。

 - (BOOL)doSomething:(NSError **)error;

理解NSCopying协议

  • 若想令自己所写的对象具有拷贝功能,则需要实现NSCopying协议。

同时要实现NSCopying中唯一的一个方法:

 - (id)copyWithZone:(NSZone *)zone

之所以存在NSZone是因为,在之前的开发中,会将内存分成不同的“区”(zone),但是对象只会创建在这个区里(allocWithZone)。但是现在不用了,每个程序只有一个区:“默认区”(default zone),也就是说,上面方法中的参数可以不用担心。

  • 如果自定义的对象分为可变版本和不可变版本,那么就要同时实现NSCopying与NSMutableCopying协议。
 - [NSMutableArray copy] => NSArray
 - [NSArray mutableCopy] => NSMutableArray
  • 复制对象时需决定采用浅拷贝还是深拷贝,一般情况下应该尽量执行浅拷贝。


    浅拷贝与深拷贝对比图。浅拷贝之后的内容与原始内容均指向相同对象。而深拷贝之后的内容所指的对象是原始内容中相关对象的一份拷贝。
  • 如果你所写的对象需要深拷贝,那么可考虑新增一个专门执行深拷贝的方法。

因为没有专门定义深拷贝的协议,所以具体执行的方式是每个类自己来确定的。在绝大多数的情况下,NSCopying执行的都是浅拷贝,除非该类的文档中说明了它是用深拷贝的,否则就寻找能够执行深拷贝的相关方法,或者自己编写方法来做。

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

推荐阅读更多精彩内容