iOS代码编写规范

一、命名规则

1、总则

简洁

简单明了，尽量使用全拼

应该： setBackgroundColor
不应该：setBkgdColor

当然，我们也会有一些常用的缩略词，比如 info 代表 Information等（持续补充）

一致性

作用相同，或者在表达同一件事时，统一命名。
比如位置存储信息 location，不要再出来place表示位置的情况。

2、命名方法

遵守驼峰命名法，类名首字母大写，方法名和属性首字母小写（首字母为缩略词，如ZJB时亦使用小写，ZJBTableviewModel定义时使用z j bTableViewModel）

1、类名规范 (Class)

类名必须使用名词，如果一个类名内含多个单词，那么各个单词第一个字母大写，后续字母小写，起伏呈驼峰状。给类名命名时，必须保证准确、简洁且容易理解。尽量使用完整单词，避免使用缩写词（除了大家公认的）；

要求：

选择有意义的名字，能快速地传达该类的用途。类名需要加前缀，前缀一般为：“工程关键词”+“项目关键词”，我们现在工程中目前可暂不使用“工程关键词”，但新建的都要遵循新标准，如
```
ZJBBusListViewController
ZJBBusOrederDetailsViewController
//我们原来的类名可不加上“工程关键词”
BusListViewController  
BusOrederDetailsViewController
```
除VC和View外，自己封装的公共的基础组件统一加上ZJB前缀，区分第三方，如
```
ZJBThirdAppService
ZJBEmptyView
```
当要区别委托类时，需细分是delegate还是protocol，在委托类的后面加上“Delegate”或“Protocol”。如：SceneryQueryBLLDelegate；
实体类区分Request和Response。如：RequestGetSceneryList、ResponseGetSceneryList；

2、方法名规范（Method）

方法名应该以小写字母开头，并混合驼峰格式。每个具名参数也应该以小写字母开头方法名应尽量读起来就像句子，这表示你应该选择与方法名连在一起读起来通顺的参数名。第二个及以后参数不要"and"

- (CGPoint)convertPoint:(CGPoint)point fromView:(nullable UIView *)view;
- (void)replaceCharactersInRange:(NSRange)range withString:(NSString *)str;
//正确: 
- (instancetype)initWithWidth:(float)width height:(float)height;
//不好: 
- (id)initWithWidth:(float)width andHeight:(float)height;

3、变量名规范

变量必须起有意义的名字，使其他组员可以很容易读懂变量所代表的意义。第一个单词为类型首字母且小写，其他单词首字母大写。自定义类型可随意命名前缀；

类型	前缀	举例
int	i	iNumber
float	f	fHeight
BOOL	b	bNearBy
NSUInteger	i	iTicketCount
NSString	s	sCityName
NSMutaArray/NSArray	arr	arrData
NSMutaDictionary/NSDictionary	dic	dicData
short	sht	shtNumber
Long/long	lng	lngNumber
Double/double	dbl	dblNumber

4、控件名规范

控件命名前缀或者后缀增加通用符号，优点是易识别,未包含的控件使用全称或自定义，通俗易懂。

类型	前缀/后缀	举例
UILabel	lbl*	lblName
UIButton	btn*	btnTip
UITextField	txf*	txfName
UIImage	img*	imgHead
UIImageView	Imgv*	imgvHead
UIView	*View	headView
UIViewController	*VC	homeVC
UIScrollView	*ScrollView	bannerScrollView
UITableView	*TableView	mainTableView
UITableViewCell	cell*	cellHybridTest
UITextView	*TextView	userWriteTextView
UIWebView	*WebView	customWebView
NSLayoutConstraint	*Constraint	sliderViewLeadingConstraint
UIMapView	*MapView	busStationMapView

5、枚举名规范（Enum）

枚举名同类名规则，加前缀，前缀一般为：“工程关键词”+“项目关键词”，大驼峰命名；枚举值，大驼峰命名

typedef NS_ENUM(NSInteger, ZJBBusRequestStatusType) {
    ZJBBusRequestStatusType_Default = 0,//默认状态未请求
    ZJBBusRequestStatusType_Executing,//请求进行中
    ZJBBusRequestStatusType_Success,//请求成功
    ZJBBusRequestStatusType_Fail,//请求失败
    ZJBBusRequestStatusType_Cancel//请求取消
};

多用枚举控制多态，减少bool值等去判断的情况，增加可读性

6、常量名规范

以const修饰一个常量，一般是写在.h文件中，然后将.h的头文件加入预编译pch文件中；私有的写在.m文件中。以小写字母k开头，后面单词遵循"驼峰原则"命名。例如:

static const NSTimeInterval kTimeDuration = 0.5;
static const float kMaxHeight = 100.f;
static NSString * const kAppName = @"巴士管家";

定义常量时：多用类型常量，少用#define预处理指令；宏定义没有类型，有被重复定义风险，影响工程编译速度。

//建议用
static NSString * const kConst = @"Hello"；
static const CGFloat kWidth = 10.0;
//代替
#define kConst @"Hello"
#define kWidth 10.0

当定义对外公开的常量的时候，我们一般使用如下定义

//Test.h
extern NSString * const kClassNameconst;
//Test.m
NSString * const kClassNameconst = @"hello";

7、通知名规范

用类名做前缀，Notification做后缀；如：

UIApplicationDidEnterBackgroundNotification
UIApplicationWillEnterBackgroundNotification

8、块名规范（Block）

模块关键词 + 功能名词 + "Block"；例：

typedef void (^CityListRequestBlock)(TCTNetworkError * _Nullable error);
typedef void (^CityListSearchResultBlock)(NSMutableArray *cityList);

9、图片命名规范

基本要求：
- 文件名必须全小写
- 采用下划线命名法
- 采用单词全拼，或者大家公认无岐义的缩写(比如：nav，bg，btn等)
基本规范："模块_类别_功能_状态.png"

对于静态的模块功能页面，按照 "模块_类别_功能_状态.png" 这样的规则命名。如“bus_icon_info.png”
- 模块：即项目或公共模块名
- 类别：参照3的 基本名词命名
- 功能：即按钮作用
- 状态：如按钮会有select等状态，无状态可省略

基本名词命名：

bg (backgrond）	背景
nav（navbar）	导航栏
tab（tabbar）	标签栏
btn（button）	按钮
img（image）	图片
icon	图标
line	线条
logo	标识
bar	进度条
arrow	箭头

不限于此，只是列出一些常用的，只要认可的都行。

状态常用命名：

selected 选中

disabled 无法点击

highlight 点击时高亮

default 默认

normal 一般

pressed 按下

slide 滑动

不限于此，只是列出一些常用的，只要认可的都行。

selected	选中
disabled	无法点击
highlight	点击时高亮
default	默认
normal	一般
pressed	按下
slide	滑动

二、代码格式化

1、代码结构

代码中vc或者View遵循这样的代码结构，方便阅读。

#pragma mark - life cycle

#pragma mark - private methods

#pragma mark - delegate

#pragma mark - event response

#pragma mark - getters and setters

建议多使用“#pragma mark”，方便阅读代码，5个部分顺序可以变化，但是除了上述5个带“-”分割线以外，其他不要带，不然造成过多的分割线，只需要这5个部分的分割线即可。明确用唯一的分割来区分开5个部分！

2、语法糖

应该使用可读性更好的语法糖来构造 NSArray ， NSDictionary 等数据结构，避免使用冗长的 alloc,init 方法。

NSArray *animals = @[@"dog", @"pig", @"you"];
Dictionary *dict = @{@"animal":@"tiger", @"phone":@"iPhone 6"};

NSString *dog = animals[0];
NSString *iphone = dict[@"phone"];

3、方法声明和调用

声明

-或者+和返回类型之间须使用一个空格，括号要同行并有一个空格。方法应该像这样：

- (void)doSomethingWithString:(NSString *)theString {
  ...
}

如果函数名字太长，参数过多，则可以换行并用冒号对齐，像这样：

- (void)doSomethingWith:(GTMFoo *)theFoo
                   rect:(NSRect)theRect
               interval:(float)theInterval {
  ...
}

注：比较特殊且少见的情况，当第一个关键字比其它的短时,要保证下一行至少有4个空格的缩进，对齐关键字，像这样：

- (void)shortWord:(NSString *)sShortWord
    longKeyword:(NSString *)sTheRect
    evenLongerKeyword:(float)fTheInterval {
  ...
}

调用

参数较少且代码较短的可以放在一行，如：

[myObject doFooWith:arg1 name:arg2 error:arg3];

参数较多，代码较长的换行，冒号对其，如：

[myObject doFooWith:arg1
               name:arg2
              error:arg3];

4、对象初始化

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

5、conditions（条件语句）

条件语句要格外注意空格和括号等写法，便于阅读

//正确
if (condition) {
    // Do something
} else {
    // Do something else
}

if (!error) {
    return success;
}

//不正确
if (!error)
    return success;

if (!error) return success;

switch

switch (condition) {
        case 0:
        {
            ...
        }
            break;
        case 1:
        {
            ....
        }
            break;
        default:
        {
            ...
        }
            break;
    }

6、category（分类）

建议使用类别来简明地划分功能，并且应该通过命名来描述该功能。命名要明确体现其功能，不要搞通用。

//建议
@interface UIButton (SettingStyle)
@interface NSNumber (ChineseNumber)

//不建议
@interface UIAlertController (Custom)
@interface NSDate (Utility)

category中的方法名建议带有标识前缀，比如zjb_XXX method，防止无意中覆盖同名方法，可能是系统方法。

//建议
@interface UIButton (SettingStyle)
- (void)zjb_setButtonBackGroundImage:(UIImage *)image;
@end
  
//不建议
@interface UIButton (SettingStyle)
- (void)setButtonBackGroundImage:(UIImage *)image;
@end

7、CGRect

在访问CGRect的x、y、宽度或高度时，代码必须使用CGGeometry函数，而不是直接访问struct成员。从苹果的CGGeometry参考:

All functions described in this reference that take CGRect data structures as inputs implicitly standardize those rectangles before calculating their results. For this reason, your applications should avoid directly reading and writing the data stored in the CGRect data structure. Instead, use the functions described here to manipulate rectangles and to retrieve their characteristics.

//正确
CGRect frame = self.view.frame;

CGFloat x = CGRectGetMinX(frame);
CGFloat y = CGRectGetMinY(frame);
CGFloat width = CGRectGetWidth(frame);
CGFloat height = CGRectGetHeight(frame);

//不建议
CGRect frame = self.view.frame;

CGFloat x = frame.origin.x;
CGFloat y = frame.origin.y;
CGFloat width = frame.size.width;
CGFloat height = frame.size.height;

8、单例模式

写单例的时候可能出现别人init了这个类，创建一个新的对象，要保证永远都只为单例对象分配一次内存空间，写法如下：

#import "Singleton.h"

static Singleton* _instance = nil;

@implementation Singleton
+(instancetype)shareInstance
{
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
       _instance = [[super allocWithZone:NULL] init];
    });
    return _instance;
}

+(id)allocWithZone:(struct _NSZone *)zone
{
    return [Singleton shareInstance];
}

-(id)copyWithZone:(struct _NSZone *)zone
{
    return [Singleton shareInstance];
}
@end

三、重要原则

1、私有变量和属性

私有变量和属性都定义到.m文件中，包括从xib中拖拉的控件。.h文件中只能有对外提供的参数和api的定义

2、Public API 要尽量简洁

公有接口要设计的简洁，满足核心的功能需求就可以了。不要设计很少会被用到，但是参数极其复杂的 API 。如果要定义复杂的方法，使用类别或者类扩展。