自定义控件初始化代码中的坑

初始化代码应该是IOS开发者最先接触到的代码了。很容易、很简单是不，我也是这样觉得的。直到我使用了github上一个有1000多人star的开源控件，遇到了一个不可思议的BUG时，才发现踩进这个坑的应该不只是初学者！一般开发者最容易写出下面的初始化代码。

@interface YDTestView : UIView
-(id)initWithFrame:(CGRect)frame;
@end

@implementation YDTestView

-(id)init
{
  if(self = [super init]){
    NSLog(@"%@", NSStringFromSelector(_cmd));
    [self initialize];
  }
  return self;
}

-(id)initWithFrame:(CGRect)frame
{
  if(self = [super initWithFrame:frame]){
    NSLog(@"%@", NSStringFromSelector(_cmd));
    [self initialize];
  }
  return self;
}
@end

@implementation ViewController

-(void)viewDidLoad{
  [super viewDidLoad];

  YDTestView* view = [[YDTestView alloc] init];
  [view setFrame:CGRectMake(xx, xx, xx, xx)];
  [self.view addSubview:view];
}

@end

这里看上去一点问题没有实际运行也没有什么问题，打印的LOG日志如下： init调用日志

如果你对LOG打印有疑问的话，请实际运行并思考下为什么initWithFrame接口会被调用到。

要说的坑

上面的初始化代码的坑就是出现在[self initalize]这句代码里。它负责整个控件的初始化工作，开发者会将所有的与初始化相关的动作都放置在这里。那么将kvo中的addObserver放置在initalize接口，removerObserver放置在dealloc接口中是最正常不过的选择了，如此坑就出现了。

-(void)initialize
{
  ...
  [self addObserver:self forKeyPath:BorderStyleKeyPath options:NSKeyValueObservingOptionNew context:nil];
}

-(void)dealloc
{
  ...
  [self removeObserver:self forKeyPath:BorderStyleKeyPath];
}

运行测试应用，当前页面退出时，应用崩溃了，报了下图中的异常： addObser导致的崩溃Log

但我们明明在delloc里释放了这些观察对象的。这就要和上面的两个init方法联系到一块来说了。开发者初始化时直接调用了init接口而没有使用initWithFrame接口，但init接口会默认调用一次initWithFrame接口。也就是说初始化initialize接口在一次初始化过程被调用了两次，那么addObserver接口同样被调用了两次，但仅仅释放了一次，那么出现上面的崩溃就容易理解了。

如何避免

理解了错误产生的原因，那么怎样避免就显而易见了。这里给出这样的建议，在自定义的控件的初始化代码中，如果实现了initWithFrame接口，就不要再重写init接口实现了，或者将addObserver调用放置到初始化过程之外的代码中。

后记

可能是没有清晰的表达我的想法，评论中有同学在纠结initialize这个接口。这里说明下，这个接口只是用来表达init与initWithFrame两个接口的共有部分代码，它可以叫做任何你希望的名字。这个BUG出现的原因是使用者调用init接口间接导致了addObserver被调用了两次，但在控件销毁时只removeObserver一次。