OC 语法

2020-08-25 本文已影响0人 A_rcher34

下划线和self.的区别

1.通过self. 访问，包含了set和get方法。
通过下划线是获取自己的实例变量，不包含set和get的方法。

2.self.是对属性的访问，而下划线是对局部变量的访问。在使用self.时是调用一个getter方法。会使引用计数加一，而下划线不会使用引用计数器加一的。
所有被声明为属性的成员，在iOS5之前需要使用编译指令@synthesize 来告诉编译器帮助生成属性的getter和setter方法，之后这个指令可以不用人为的指定了，默认情况下编译器会帮助我们生成。编译器在生成getter，setter方法时首先查找当前的类中用户是否定义了属性的getter，setter方法，如果有，则编译器会跳过，不会再生成，使用用户定义的方法。

总结:
使用self.是更好的选择，因为这样可以兼容懒加载，同时也避免了使用下滑线的时候忽略了self这个指针，后者容易在Block中造成循环引用。也因为，使用 _是获取不到父类的属性的，它只是对局部变量的访问。self方法实际上是用了get和set方法间接调用，下划线方法是直接对变量操作。

参考文献：
OC中下划线和self.的区别

const和#define的区别

define

#define语法称之为预处理命令。#define声明主要用于将常量（或字符串）赋予有意义的名字，比如当你在编写一个日历程序时，可以定义:

#define MONTHS_PER_YEAR 12

Tips:
1.通常情况下，习惯将预处理的常量名全大写，单词之间用下划线隔开
（与正常变量区分）。
2.如果是定义常量，若这个常量的适用范围局限于.m，那么习惯性在常量名前
加k，若常量在类之外可见，则通常以类名为前缀。

预处理代码起的作用实际上相当于在编译之前！！！
预处理代码起的作用实际上相当于在编译之前！！！
预处理代码起的作用实际上相当于在编译之前！！！
重要事情说三遍。也就是说宏使用过多会增加编译时间

而一个常量在栈中开辟空间是很高效的。

使用宏有以下好处：

1.增强代码可读性
2.方便全局使用和修改一些方法和参数
3.增强复用性

const常量

const 如果是声明常量，仅仅是想要在.m文件中使用，那么一定要同时使用static 和const来声明，若不加系统在编译时会自动为它加一个extern （外部符号），此时，若另一个编译单元出现了同名变量就会报错，并且很难查找错误。

只能在警告区找到

但无法确认错误位置

这是OC程序员最不愿意看到的错误。。。也是很难查找的错误，跟修改已经创建的类的文件名的错误差不多。

总结：

多用类型常量，少用#define预处理指令（出自《Effective Objective-C》第四条原则）
苹果的API中，大多数字符串，也是用以下这种方式（如以Key，style，Type结尾的一些参数）

// Constants.h
FOUNDATION_EXPORT NSString *const MyFirstConstant;
FOUNDATION_EXPORT NSString *const MySecondConstant;

// Constants.m
NSString *const MyFirstConstant = @"FirstConstant";
NSString *const MySecondConstant = @"SecondConstant";

或者

extern NSString * const PPRememberMusicList;
extern NSString * const PPLoadMusicAtListLoad;
extern NSString * const PPAfterPlayingMusic;
extern NSString * const PPGotoStartupAfterPlaying;

NSString * const PPRememberMusicList = @"Remember Music List";
NSString * const PPLoadMusicAtListLoad = @"Load music when loading list";
NSString * const PPAfterPlayingMusic = @"After playing music";
NSString * const PPGotoStartupAfterPlaying = @"Go to startup pos. after playing";

参考文献：
Define与Const的使用

switch case

OC中的switch case语句，在每个case后都要加break。不然会将该case下面的case也全部执行，直到遇到break。
Swift的case，只要有内容，就可以省略break。

在 OC 中的 switch

格式: switch(需要匹配的值) case 匹配的值: 需要执行的语句 break;
可以穿透
可以不写default
default位置可以随便放
在case中定义变量需要加大括号, 否则作用域混乱（仔细了解了一下在C或者C++中，只要是在任何一对花括号 “{ }”中定义的对象，那么该对象的作用域就局限在这对花括号里面，上面的代码的错误就出现在这儿了。）
不能判断对象类型, 只能判断基本类型中的整数

在 Swift 中的 Switch

OC必须是整数, 在 Swift 中可以是对象的类型也可以是 double类型
不可以穿透
可以不写break
不能不写default
default位置只能在最后
在case中定义变量不用加大括号

@interface

.h中的@interface
供其他的class调用。是public

.m中的@interface
也可以叫做class extension。是.h中@interface的补充。但是对其他class是不开放的。是private

总结：一般把public的方法和变量放到.h中。将private的变量放到.m中。而private的方法在.m中可以不声明，直接使用。

Copy

当我们使用自定义对象的 copy 方法时会报错,例如我们自定了一个 Person 类并实例化一个对象,并调用其 copy 方法：

Person *p = [[Person alloc] init];
p.name = @"小明";
Person *p1 = [p copy];

当执行到 [p copy] 时，将会报错，错误如下：

-[Person copyWithZone:]: unrecognized selector sent to instance 0x100612d20

原因是没有实现 copyWithZone 方法，是因为在 copy 方法中调用了 copyWithZone 方法，所以必须实现 copyWithZone 方法才能够使用 copy 方法。
要实现 copyWithZone 方法，我们首先需要在 Person.h 文件中让 Person 类遵循 NSCopying 协议

@interface Person : NSObject  <NSCopying>

然后在 Person.m 文件中实现 copyWithZone 方法：

- (id)copyWithZone:(NSZone *)zone{
    // 如果不实现下面的代码将会变成浅拷贝
    Person *copy = [[[self class]allocWithZone:zone]init];
    copy.name = self.name;
    return copy;
}

实现后运行以下代码：

Person *p = [[Person alloc] init];
p.name = @"小明";
Person *p1 = [p copy];

NSLog(@"%p,%p,%@,%@",p,p1,p.name,p1.name);

打印的结果是

0x1006562b0,0x10065a490,小明,小明

可以看出通过以上代码调用 copy 方法拷贝是深拷贝。

参考文献：
https://juejin.im/post/6844903648380583950

书写规范

nil的判断

// 正确示例
if (objc) {
}

// 错误示例
if (nil == objc) {
}

编码规范

所有的方法之间空一行。
所有的代码块之间空一行，删除多余的注释。
所有自定义的方法需要给出注释。
尽量使用懒加载，在控制器分类时有提及和要求，其它自定义类按照控制器格式分类，没有的分类不写即可。
代码后的’{‘不需要独占一行，包括方法之后，if，switch等。
必须要统一的要求，属性的定义请按照下图property之后，空一格，括号之后空一格，写上类名，空一格之后跟上*和属性名。

@property (nonatomic, strong) UITableView *tableView;///< 注释
@property (nonatomic, strong) DeliveryModel *delivery;///< 注释
@property (nonatomic, strong) DeliveryLookAdapter *lookAdapter;///< 注释
@property (nonatomic, strong) DeliveryLookAPIManager *lookManager;///< 注释

遵循一般代码规范，多模仿苹果API。
删除不用的代码。
如果有方法一直不会用到，请删除（除工具类）。
没有执行任何业务逻辑的方法，请删除或给予注释，删除多余的资。源或文件，添加必要的注释。
比较大的代码块需要给出注释。

结构

life cycle
自定义方法
event response
Delegate方法实现
getter和setter全部放到最后

在函数分组和protocol/delegate实现中使用#pragma mark -来分类方法，要遵循以下一般结构：

#pragma mark - Lifecycle
- (instancetype)init {}
- (void)dealloc {}
- (void)viewDidLoad {}
- (void)viewWillAppear:(BOOL)animated {}
- (void)didReceiveMemoryWarning {}

#pragma mark - Custom Accessors 自定义方法
- (void)setCustomProperty:(id)value {}
- (id)customProperty {}

#pragma mark - IBActions/Event Response
- (IBAction)submitData:(id)sender {}
- (void)someButtonDidPressed:(UIButton*)button

#pragma mark - Protocol conformance
#pragma mark - UITextFieldDelegate
#pragma mark - UITableViewDataSource
#pragma mark - UITableViewDelegate

#pragma mark - Public
- (void)publicMethod {}

#pragma mark - Private
- (void)privateMethod {}

#pragma mark - NSCopying
- (id)copyWithZone:(NSZone *)zone {}

#pragma mark - NSObject
- (NSString *)description {}

空格

缩进使用4个空格，确保在Xcode偏好设置来设置。(raywenderlich.com使用2个空格)
方法大括号和其他大括号(if/else/switch/while 等.)总是在同一行语句打开但在新行中关闭。

// 正确写法
if (user.isHappy) {
    //Do something
} else {
    //Do something else
}

// 错误写法
if (user.isHappy)
{
  //Do something
}
else {
  //Do something else
}

下划线

在初始化方法里，应该使用_variableName来避免getter/setter潜在的副作用。
其他位置使用实例变量时，都应该使用self.来访问和改变。
局部变量不应该包含下划线。

属性特性

所有属性特性应该显式地列出来，有助于阅读代码。
NSString应该使用copy 而不是 strong的属性特性。
为什么？即使你声明一个NSString的属性，有人可能传入一个NSMutableString的实例，然后在你没有注意的情况下修改它。

// 正确写法
@property (nonatomic,copy) NSString *tutorialName;

// 错误写法
@property (nonatomic,strong) NSString *tutorialName;

字面值

NSString, NSDictionary, NSArray, 和 NSNumber的字面值应该在创建这些类的不可变实例时被使用。请特别注意nil值不能传入NSArray和NSDictionary字面值，因为这样会导致crash。
应该：

NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"];
NSDictionary *productManagers = @{@"iPhone": @"Kate", @"iPad": @"Kamal", @"Mobile Web": @"Bill"};
NSNumber *shouldUseLiterals = @YES;
NSNumber *buildingStreetNumber = @10018;

不应该：

NSArray *names = [NSArray arrayWithObjects:@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul", nil];
NSDictionary *productManagers = [NSDictionary dictionaryWithObjectsAndKeys: @"Kate", @"iPhone", @"Kamal", @"iPad", @"Bill", @"Mobile Web", nil];
NSNumber *shouldUseLiterals = [NSNumber numberWithBool:YES];
NSNumber *buildingStreetNumber = [NSNumber numberWithInteger:10018];

点符号语法

点语法是一种很方便封装访问方法调用的方式。当你使用点语法时，通过使用getter或setter方法，属性仍然被访问或修改。
点语法的使用必须满足两个条件：1是属性；2是有对应的getter和setter方法

一般情况下，满足条件的属性用点语法。而方法则使用中括号。

变量

变量尽量以描述性的方式来命名。单个字符的变量命名应该尽量避免，除了在for()循环。
星号表示变量是指针。例如， NSString *text 既不是 NSString* text 也不是 NSString * text，除了一些特殊情况下常量。
私有变量应该尽可能代替实例变量的使用。尽管使用实例变量是一种有效的方式，但更偏向于使用属性来保持代码一致性。

通过使用'back'属性(_variable，变量名前面有下划线)直接访问实例变量应该尽量避免，除了在初始化方法(init, initWithCoder:, 等…)，dealloc 方法和自定义的setters和getters。

// 正确写法
@interface RWTTutorial : NSObject
@property (nonatomic, copy) NSString *tutorialName;
@end

// 错误写法
@interface RWTTutorial : NSObject {
  NSString *tutorialName;
}

常量

常量是容易重复被使用和无需通过查找和代替就能快速修改值。常量应该使用static来声明而不是使用#define，除非显式地使用宏。

// 正确写法
static NSString * const RWTAboutViewControllerCompanyName = @"RayWenderlich.com";
static CGFloat const RWTImageThumbnailHeight = 50.0;

// 错误写法
#define CompanyName @"RayWenderlich.com"
#define thumbnailHeight 2

枚举类型

当使用``enum时，推荐使用新的固定基本类型规格，因为它有更强的类型检查和代码补全。现在SDK有一个宏NS_ENUM()```来帮助和鼓励你使用固定的基本类型。

typedef NS_ENUM(NSInteger, RWTLeftMenuTopItemType) {
  RWTLeftMenuTopItemMain,
  RWTLeftMenuTopItemShows,
  RWTLeftMenuTopItemSchedule
};

你也可以显式地赋值(展示旧的k-style常量定义)：

typedef NS_ENUM(NSInteger, RWTGlobalConstants) {
  RWTPinSizeMin = 1,
  RWTPinSizeMax = 5,
  RWTPinCountMin = 100,
  RWTPinCountMax = 500,
};

旧的k-style常量定义应该避免除非编写Core Foundation C的代码。

// 错误写法
enum GlobalConstants {
  kMaxPinSize = 5,
  kMaxPinCount = 500,
};

case 语句

大括号在case语句中并不是必须的，除非编译器强制要求。当一个case语句包含多行代码时，大括号应该加上。

有很多次，当相同代码被多个cases使用时，一个fall-through应该被使用。一个fall-through就是在case最后移除'break'语句，这样就能够允许执行流程跳转到下一个case值。为了代码更加清晰，一个fall-through需要注释一下。

switch (condition) {
  case 1:
    // ** fall-through! **
  case 2:
    // code executed for values 1 and 2
    break;
  default: 
    // ...
    break;
}

当在switch使用枚举类型时，'default'是不需要的。例如：

RWTLeftMenuTopItemType menuType = RWTLeftMenuTopItemMain;

switch (menuType) {
  case RWTLeftMenuTopItemMain:
    // ...
    break;
  case RWTLeftMenuTopItemShows:
    // ...
    break;
  case RWTLeftMenuTopItemSchedule:
    // ...
    break;
}

私有属性

私有属性应该在类的实现文件中的类扩展(匿名分类)中声明，命名分类(比如RWTPrivate或private)应该从不使用除非是扩展其他类。匿名分类应该通过使用<headerfile>+Private.h文件的命名规则暴露给测试。

@interface RWTDetailViewController ()

@property (nonatomic, strong) GADBannerView *googleAdView;
@property (nonatomic, strong) ADBannerView *iAdView;
@property (nonatomic, strong) UIWebView *adXWebView;

@end

布尔值

Objective-C使用YES和NO。因为true和false应该只在CoreFoundation，C或C++代码使用。既然nil解析成NO，所以没有必要在条件语句比较。不要拿某样东西直接与YES比较，因为YES被定义为1和一个BOOL能被设置为8位。

这是为了在不同文件保持一致性和在视觉上更加简洁而考虑。

应该：

if (someObject) {}
if (![anotherObject boolValue]) {}

不应该：

if (someObject == nil) {}
if ([anotherObject boolValue] == NO) {}
if (isAwesome == YES) {} // Never do this.
if (isAwesome == true) {} // Never do this.

如果BOOL属性的名字是一个形容词，属性就能忽略"is"前缀，但要指定get访问器的惯用名称。例如：

@property (assign, getter=isEditable) BOOL editable;

返回布尔值时，要返回YES或NO。不能返回逻辑运算的数

// 正确写法
- (BOOL)isBold {
  return ([self fontTraits] & NSFontBoldTrait) ? YES : NO;
}
// 正确，逻辑操作符可以直接转化为BOOL
- (BOOL)isValid {
  return [self stringValue] != nil;
}

// 错误写法
// 不要将其它类型转化为BOOL返回。因为在这种情况下，BOOL变量只会取值的最后一个字节来赋值，这样很可能会取到0（NO）。但是，一些逻辑操作符比如`&&`,`||`,`!`的返回是可以直接赋给BOOL的
- (BOOL)isBold {
  return [self fontTraits] & NSFontBoldTrait;
}
- (BOOL)isValid {
  return [self stringValue];
}

条件语句

条件语句主体为了防止出错应该使用大括号包围，即使条件语句主体能够不用大括号编写(如，只用一行代码)。这些错误包括添加第二行代码和期望它成为if语句；还有，even more dangerous defect可能发生在if语句里面一行代码被注释了，然后下一行代码不知不觉地成为if语句的一部分。除此之外，这种风格与其他条件语句的风格保持一致，所以更加容易阅读。

应该：

if (!error) {
  return success;
}

不应该：

if (!error)
  return success;

或：

if (!error) return success;

三元操作符

当需要提高代码的清晰性和简洁性时，三元操作符?:才会使用。单个条件求值常常需要它。多个条件求值时，如果使用if语句或重构成实例变量时，代码会更加易读。一般来说，最好使用三元操作符是在根据条件来赋值的情况下。

Non-boolean的变量与某东西比较，加上括号()会提高可读性。如果被比较的变量是boolean类型，那么就不需要括号。

应该：

NSInteger value = 5;
result = (value != 0) ? x : y;

BOOL isHorizontal = YES;
result = isHorizontal ? x : y;

不应该

result = a > b ? x = c > d ? c : d : y;

Init方法

Init方法应该遵循Apple生成代码模板的命名规则。返回类型应该使用instancetype而不是id

- (instancetype)init {
  self = [super init];
  if (self) {
    // ...
  }
  return self;
}

不要使用new语法。
尽管很多时候能用new代替alloc init方法，但这可能会导致调试内存时出现不可预料的问题。Cocoa的规范就是使用alloc init方法，使用new会让一些读者困惑。

类构造方法

当类构造方法被使用时，它应该返回类型是instancetype而不是id。这样确保编译器正确地推断结果类型。

@interface Airplane
+ (instancetype)airplaneWithType:(RWTAirplaneType)type;
@end

方法

在方法签名中，应该在方法类型(-/+ 符号)之后有一个空格。在方法各个段之间应该也有一个空格(符合Apple的风格)。在参数之前应该包含一个具有描述性的关键字来描述参数。
多个参数的话务必说明参数的作用
不要用and来连接两个参数，通常and用来表示方法执行了两个相对独立的操作（从设计上来说，这时候应该拆分成两个独立的方法）：用with。

如果一个函数有特别多的参数或者名称很长，应该将其按照:来对齐分行显示：

-(id)initWithModel:(IPCModle)model
       ConnectType:(IPCConnectType)connectType
        Resolution:(IPCResolution)resolution
          AuthName:(NSString *)authName
          Password:(NSString *)password
               MAC:(NSString *)mac
              AzIp:(NSString *)az_ip 
             AzDns:(NSString *)az_dns  
             Token:(NSString *)token  
             Email:(NSString *)email 
          Delegate:(id<IPCConnectHandlerDelegate>)delegate;

函数调用时，和书写格式一样。可以按照函数的长短来选择写在一行或者分成多行。分多行写时，要按照:对齐各个参数。

语法糖

应该使用可读性更好的语法糖来构造NSArray，NSDictionary等数据结构，避免使用冗长的alloc,init方法。
如果构造代码写在一行，需要在括号两端留有一个空格，使得被构造的元素于与构造语法区分开来：

//正确，在语法糖的"[]"或者"{}"两端留有空格
NSArray *array = @[ [foo description], @"Another String", [bar description] ];
NSDictionary *dict = @{ NSForegroundColorAttributeName : [NSColor redColor] };

//不正确，不留有空格降低了可读性
NSArray* array = @[[foo description], [bar description]];
NSDictionary* dict = @{NSForegroundColorAttributeName: [NSColor redColor]};

命名规范

清晰命名应该尽可能的清晰和简洁，但在Objective-C中，清晰比简洁更重要。由于Xcode强大的自动补全功能，我们不必担心名称过长的问题。

黄金路径

当使用条件语句编码时，不要嵌套太多if语句，多个返回语句也是OK。
应该：

- (void)someMethod {
  if (![someOther boolValue]) {
    return;
  }

  //Do something important
}

不应该：

- (void)someMethod {
  if ([someOther boolValue]) {
    //Do something important
  }
}

错误处理

当方法通过引用来返回一个错误参数，判断返回值而不是错误变量。
应该：

NSError *error;
if (![self trySomethingWithError:&error]) {
  // Handle Error
}

不应该：

NSError *error;
[self trySomethingWithError:&error];
if (error) {
  // Handle Error
}

在成功的情况下，有些Apple的APIs记录垃圾值(garbage values)到错误参数(如果non-NULL)，那么判断错误值会导致false负值和crash。

单例模式

单例对象应该使用线程安全模式来创建共享实例。

+ (instancetype)sharedInstance {
  static id sharedInstance = nil;

  static dispatch_once_t onceToken;
  dispatch_once(&onceToken, ^{
    sharedInstance = [[self alloc] init];
  });

  return sharedInstance;
}

换行符

换行符是一个很重要的主题，因为它的风格指南主要为了打印和网上的可读性。

self.productsRequest = [[SKProductsRequest alloc] initWithProductIdentifiers:productIdentifiers];

一行很长的代码应该分成两行代码，下一行用两个空格隔开。

self.productsRequest = [[SKProductsRequest alloc] 
  initWithProductIdentifiers:productIdentifiers];

参考文献：
https://www.jianshu.com/p/cb0269b88d8a
https://juejin.im/post/6844903524887691277

OC 语法

下划线和self.的区别

const和#define的区别

define

const常量

switch case

@interface

Copy

书写规范

nil的判断

编码规范

结构

空格

下划线

属性特性

字面值

点符号语法

变量

常量

枚举类型

case 语句

私有属性

布尔值

条件语句

三元操作符

Init方法

类构造方法

方法

语法糖

命名规范

黄金路径

错误处理

单例模式

换行符

猜你喜欢

热点阅读