iOS代码规范制定

379 阅读3分钟

首先苹果有一套CodingGuidelines(developer.apple.com/library/arc…),在符合官方规范的情况下还做以下代码规范:

ViewController里面的代码布局:

所有的属性都使用getter和setter

不要在viewDidLoad里面初始化你的view然后再add,这样代码就很难看。在viewDidload里面只做addSubview和view布局的事情,在viewDidAppear里面做Notification的监听之类的事情。至于属性的初始化,则交给getter去做。

比如这样:

#pragma mark - life cycle

  • (void)viewDidLoad{

    [super viewDidLoad];

    self.view.backgroundColor = [UIColor whiteColor];

    [self.view addSubview:self.firstTableView];

    [self.view addSubview:self.secondTableView];

    [self.firstTableView mas_makeConstraints:^(MASConstraintMaker *make) {

      make.bottom.equalTo(self.mapView.mas_bottom).offset(-7);
      make.size.mas_equalTo(CGSizeMake(40, 40));
      make.right.mas_equalTo(-15);
    

    }];

    [self.secondTableView mas_makeConstraints:^(MASConstraintMaker *make) {

      make.top.equalTo(self.mapView.mas_bottom).offset(11);
      make.size.mas_equalTo(CGSizeMake(self.width-40, 76));
       make.centerX.equalTo(self.scrollView);
    

    }];

    ......

}

这样即便在属性非常多的情况下,还是能够保持代码整齐,view的初始化都交给getter去做了。总之就是尽量不要出现以下的情况:

  • (void)viewDidLoad { [super viewDidLoad];

    self.textLabel = [[UILabel alloc] init];

    self.textLabel.textColor = [UIColor blackColor];

    self.textLabel ... ...

    self.textLabel ... ...

    self.textLabel ... ...

    [self.view addSubview:self.textLabel]; }

这种做法就不够干净,都扔到getter里面去就好了。关于这个做法,在唐巧的技术博客里面有一篇文章和我所提倡的做法不同,这个我会放在后面详细论述。

getter和setter全部都放在最后

因为一个ViewController很有可能会有非常多的view,就像上面给出的代码样例一样,如果getter和setter写在前面,就会把主要逻辑扯到后面去,其他人看的时候就要先划过一长串getter和setter,这样不太好。然后要求业务工程师写代码的时候按照顺序来分配代码块的位置,先是life cycle,然后是Delegate方法实现,然后是event response,然后才是getters and setters。这样后来者阅读代码时就能省力很多。

每一个delegate都把对应的protocol名字带上,delegate方法不要到处乱写,写到一块区域里面去

比如UITableViewDelegate的方法集就老老实实写上#pragma mark - UITableViewDelegate。这样有个好处就是,当其他人阅读一个他并不熟悉的Delegate实现方法时,他只要按住command然后去点这个protocol名字,Xcode就能够立刻跳转到对应这个Delegate的protocol定义的那部分代码去,就省得他到处找了。

event response专门开一个代码区域

所有button、gestureRecognizer的响应事件都放在这个区域里面,不要到处乱放。

关于private methods,正常情况下ViewController里面不应该写

不是delegate方法的,不是event response方法的,不是life cycle方法的,就是private method了。对的,正常情况下ViewController里面一般是不会存在private methods的,这个private methods一般是用于日期换算、图片裁剪啥的这种小功能。这种小功能要么把它写成一个category,要么把他做成一个模块,哪怕这个模块只有一个函数也行。

ViewController基本上是大部分业务的载体,本身代码已经相当复杂,所以跟业务关联不大的东西能不放在ViewController里面就不要放。另外一点,这个private method的功能这时候只是你用得到,但是将来说不定别的地方也会用到,一开始就独立出来,有利于将来的代码复用。

为什么要这样要求?

目前大部分项目并没有做好代码规范,代码布局乱得一塌糊涂,这里一个delegate那里一个getter,然后ViewController的代码一般都死长死长的,看了就让人头疼。

在这里定义好这个规范,就能使得ViewController条理清晰,接手的小伙很能够区分哪些放在ViewController里面比较合适,哪些不合适。另外,也可以提高代码的可维护性和可读性。