三、接口与API设计

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

1, 选择自己的公司,应用程序或者二者皆有关联之名称作为类名的前缀,并在所有代码中均使用这一前缀。

2, 如果自己所开发的程序库中用到了第三方库,则应为其中的名称加上前缀。


整个项目添加前缀

三、接口与API设计_第1张图片

16,提供'全能初始化方法'

1,在类中提供一个全能的初始化方法,并在文档中说明,其他初始化方法均应调用此方法

2,若全能初始化方法与超类不同,则需要覆写超类中的对应方法

3,如果超类的初始化方法不适用子类,那么应该覆写这个超类方法,并在其中抛出异常

OC中需要在调用  [super init] 后设置本类的初始化属性

Swift中需要在首先设置本类的初始化属性后,再调用父类的初始化方法

17,实现descrition方法

1, 实现descriton方法,并返回一个有意义的字符串,用以描述该实例

2, 若想在调试时打印更详尽的描述信息,则应该实现 debugDescription方法

#import

static char*constPROPERTIESLIST ="PROPERTIESLIST";

- (NSString*)description

{

NSArray* arrPropertys = objc_getAssociatedObject(self, PROPERTIESLIST);

if(!arrPropertys) {

arrPropertys = [self filterPropertys];

}

NSArray*arrValue = [self propertyValues:arrPropertys];

NSMutableString*reuslt = [NSMutableString new];

[reuslt appendString:[super description]];

[reuslt appendString:@"\n"];

for(inti =0; i < arrPropertys.count; i++) {

NSString*strProperty = arrPropertys[i];

id property = arrValue[i];

[reuslt appendFormat:@"%@ ----> %@\n", strProperty, property];

}

return reuslt;

}

- (NSArray*)propertyValues:(NSArray*)arrPropertys {

NSMutableArray*values = [NSMutableArray array];

for(NSString*columnName in arrPropertys) {

id value = [self valueForKey:columnName];

if(value !=nil) {

[values addObject:value];

}else{

[values addObject:[NSNullnull]];

}

}

return values;

}

- (NSArray*)filterPropertys

{

NSMutableArray*props = [NSMutableArray array];

unsignedintoutCount, i;

objc_property_t*properties =class_copyPropertyList([self class], &outCount);

for(i =0; i

{

const char* char_f =property_getName(properties[i]);

NSString*propertyName = [NSString stringWithUTF8String:char_f];

[props addObject:propertyName];

}

objc_setAssociatedObject(self,PROPERTIESLIST, props,OBJC_ASSOCIATION_RETAIN_NONATOMIC);

free(properties);

returnprops;

}

- (void)dealloc

{

//NSLog(@"%@已销毁", [self class]);

}

18,尽量使用不可变对象

1,尽量创建不可变的对象

2,若某属性仅可于对象内部修改,则可在  分类中将其由 readonly 属性扩展为 readwrite属性

3,不要把可变的collection作为属性公开,而应提供相关的方法,以此修改对象的可变collection

在.h 中声明

@property(nonatomic,strong,readonly )NSArray* arrTest;

-(void)setArrTest:(NSArray*)arrTest;

在.m 分类中

@property(nonatomic,strong,readwrite) NSArray* arrTest;

-(void)setArrTest:(NSArray*)arrTest{

_arrTest= arrTest;

}

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

1,起名时,应遵从标准的oc命名规范,这样创建出来的接口更容易为其他开发者所理解

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

3,方法名里不要使用缩略后的类型名称

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

20,为私有方法加前缀

1,给私有方法的名称加上前缀,这样可以很容易的和共同公共方法区分开

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

例如:p_

21, 理解oc 的错误模型

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

2,在错误不那么严重的情况下,可以指派 ‘委托方法’来出来错误,可可以把错误信息放进NSError对象里,经由‘输出参数’返回给调用者

22,理解NSCopying协议

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

2, 如果自定义的对象分为可变版本与不可变版本,那么就要同事实现NSCopying 和 NSMutableCopying协议

3, 赋值对象时需要采用浅拷贝 还是深拷贝,一般情况下应尽量使用浅拷贝

4, 如果你所写的对象需要支持深拷贝,那么可考虑新增一个专门执行深拷贝的方法

你可能感兴趣的:(三、接口与API设计)