在使用NSTimer,如果使用不得当特别会引起循环引用,造成内存泄露。下面我提出几种解决NSTimer的几种循环引用
产生原因
当你在ViewController(简称VC)中使用timer属性,由于VC强引用timer,timer的target又是VC造成循环引用。当你在VC的dealloc方法中销毁timer,发现VC被pop,VC的dealloc方法没走,VC在等timer释放才走dealloc,timer释放在dealloc中,所以引起循环引用。
解决方案
- 在ViewController执行dealloc前释放timer
- 对定时器NSTimer封装
- 苹果系统API可以解决(iOS10以上)
- 使用block进行解决
- 使用NSProxy进行解决
在ViewController执行dealloc前释放timer
可以在viewWillAppear中创建timer,可以在viewWillDisappear中销毁timer
对定时器NSTimer封装
代码如下
//PFTimer.h文件
#import <Foundation/Foundation.h>
@interface PFTimer : NSObject
//开启定时器
- (void)startTimer;
//暂停定时器
- (void)stopTimer;
@end
//PFTimer.m文件
#import "PFTimer.h"
@implementation PFTimer {
NSTimer *_timer;
}
- (void)stopTimer{
if (_timer == nil) {
return;
}
[_timer invalidate];
_timer = nil;
}
- (void)startTimer{
_timer = [NSTimer scheduledTimerWithTimeInterval:1.0 target:self selector:@selector(work) userInfo:nil repeats:YES];
}
- (void)work{
NSLog(@"正在计时中。。。。。。");
}
- (void)dealloc{
NSLog(@"%s",__func__);
[_timer invalidate];
_timer = nil;
}
@end
//VC.m
#import "ViewController1.h"
#import "PFTimer.h"
@interface ViewController1 ()
@property (nonatomic, strong) PFTimer *timer;
@end
@implementation ViewController1
- (void)viewWillDisappear:(BOOL)animated {
[super viewWillDisappear:animated];
}
- (void)viewDidLoad {
[super viewDidLoad];
self.title = @"VC1";
self.view.backgroundColor = [UIColor whiteColor];
//自定义timer
PFTimer *timer = [[PFTimer alloc] init];
self.timer = timer;
[timer startTimer];
}
- (void)dealloc {
[self.timer stopTimer];
NSLog(@"%s",__func__);
}
// 运行结果
-[ViewController1 dealloc]
-[PFTimer dealloc]
这个方式主要就是让PFTimer强引用NSTimer,NSTimer强引用PFTimer,避免让NSTimer强引用ViewController,这样就不会引起循环引用,然后在dealloc方法中执行NSTimer的销毁,相对的PFTimer也会进行销毁了。
苹果系统API可以解决(iOS10以上)
在iOS 10.0以后,苹果官方新增了关于NSTimer的三个API:
+ (NSTimer *)timerWithTimeInterval:(NSTimeInterval)interval repeats:
(BOOL)repeats block:(void (^)(NSTimer *timer))block
API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0));
+ (NSTimer *)scheduledTimerWithTimeInterval:(NSTimeInterval)interval repeats:
(BOOL)repeats block:(void (^)(NSTimer *timer))block
API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0));
- (instancetype)initWithFireDate:(NSDate *)date interval:
(NSTimeInterval)interval repeats:(BOOL)repeats block:(void (^)(NSTimer *timer))block
API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0));
这三个方法都有一个Block的回调方法。关于block参数,官方文档有说明:
the timer itself is passed as the parameter to this block when executed
to aid in avoiding cyclical references。
翻译过来就是说,定时器在执行时,将自身作为参数传递给block,来帮助避免循环引用。使用很简单,但是要注意两点:1.避免block的循环引用,使用__weak和__strong来避免,2.在持用NSTimer对象的类的方法中-(void)dealloc调用NSTimer 的- (void)invalidate方法;
使用block进行解决
通过创建一个NSTimer的category名字为PFSafeTimer,在NSTimer+PFSafeTimer.h代码如下:
//NSTimer+PFSafeTimer.h
@interface NSTimer (PFSafeTimer)
+ (NSTimer *)PF_ScheduledTimerWithTimeInterval:(NSTimeInterval)timeInterval block:
(void(^)(void))block repeats:(BOOL)repeats;
@end
//NSTimer+PFSafeTimer.m
#import "NSTimer+PFSafeTimer.h"
@implementation NSTimer (PFSafeTimer)
+ (NSTimer *)PF_ScheduledTimerWithTimeInterval:(NSTimeInterval)timeInterval block:(void(^)(void))block repeats:(BOOL)repeats {
return [NSTimer scheduledTimerWithTimeInterval:timeInterval target:self selector:@selector(handle:) userInfo:[block copy] repeats:repeats];
}
+ (void)handle:(NSTimer *)timer {
void(^block)(void) = timer.userInfo;
if (block) {
block();
}
}
@end
//TimeViewController.m
#import "TimerViewController.h"
#import "NSTimer+PFSafeTimer.h"
@interface TimerViewController ()
@property (nonatomic, strong) NSTimer *timer1;
@end
@implementation TimerViewController
- (void)viewDidLoad {
[super viewDidLoad];
self.view.backgroundColor = [UIColor whiteColor];
}
- (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event
{
[self setupTimer];
}
- (void)setupTimer {
__weak typeof(self) weakSelf = self;
self.timer1 = [NSTimer PF_ScheduledTimerWithTimeInterval:1.0 block:^{
__strong typeof(self) strongSelf = weakSelf;
[strongSelf timerHandle];
} repeats:YES];
}
//定时触发的事件
- (void)timerHandle {
NSLog(@"正在计时中。。。。。。");
}
- (void)dealloc {
NSLog(@"%s",__func__);
}
@end
该方案主要要点:将计时器所应执行的任务封装成"Block",在调用计时器函数时,把block作为userInfo参数传进去。userInfo参数用来存放"不透明值",只要计时器有效,就会一直保留它。在传入参数时要通过copy方法,将block拷贝到"堆区",否则等到稍后要执行它的时候,该blcok可能已经无效了。计时器现在的target是NSTimer类对象,这是个单例,因此计时器是否会保留它,其实都无所谓。此处依然有保留环,然而因为类对象(class object)无需回收,所以不用担心。
如果在block里面直接调用self,还是会保留环的。因为block对self强引用,self对timer强引用,timer又通过userInfo参数保留block(强引用block),这样就构成一个环block->self->timer->userinfo->block,所以要打破这个环的话要在block里面弱引用self。
使用NSProxy来解决循环引用(2种方案OC&Swift)
Swift
class WeakProxy: NSObject {
weak var target: NSObjectProtocol?
init(target: NSObjectProtocol) {
self.target = target
super.init()
}
override func responds(to aSelector: Selector!) -> Bool {
return (target?.responds(to: aSelector) ?? false) || super.responds(to: aSelector)
}
override func forwardingTarget(for aSelector: Selector!) -> Any? {
return target
}
}
class FPSLabel: UILabel {
var link:CADisplayLink!
//记录方法执行次数
var count: Int = 0
//记录上次方法执行的时间,通过link.timestamp - _lastTime计算时间间隔
var lastTime: TimeInterval = 0
var _font: UIFont!
var _subFont: UIFont!
fileprivate let defaultSize = CGSize(width: 55,height: 20)
override init(frame: CGRect) {
super.init(frame: frame)
if frame.size.width == 0 && frame.size.height == 0 {
self.frame.size = defaultSize
}
self.layer.cornerRadius = 5
self.clipsToBounds = true
self.textAlignment = NSTextAlignment.center
self.isUserInteractionEnabled = false
self.backgroundColor = UIColor.white.withAlphaComponent(0.7)
_font = UIFont(name: "Menlo", size: 14)
if _font != nil {
_subFont = UIFont(name: "Menlo", size: 4)
}else{
_font = UIFont(name: "Courier", size: 14)
_subFont = UIFont(name: "Courier", size: 4)
}
link = CADisplayLink(target: WeakProxy.init(target: self), selector: #selector(FPSLabel.tick(link:)))
link.add(to: RunLoop.main, forMode: .commonModes)
}
//CADisplayLink 刷新执行的方法
@objc func tick(link: CADisplayLink) {
guard lastTime != 0 else {
lastTime = link.timestamp
return
}
count += 1
let timePassed = link.timestamp - lastTime
//时间大于等于1秒计算一次,也就是FPSLabel刷新的间隔,不希望太频繁刷新
guard timePassed >= 1 else {
return
}
lastTime = link.timestamp
let fps = Double(count) / timePassed
count = 0
let progress = fps / 60.0
let color = UIColor(hue: CGFloat(0.27 * (progress - 0.2)), saturation: 1, brightness: 0.9, alpha: 1)
let text = NSMutableAttributedString(string: "\(Int(round(fps))) FPS")
text.addAttribute(NSAttributedStringKey.foregroundColor, value: color, range: NSRange(location: 0, length: text.length - 3))
text.addAttribute(NSAttributedStringKey.foregroundColor, value: UIColor.white, range: NSRange(location: text.length - 3, length: 3))
text.addAttribute(NSAttributedStringKey.font, value: _font, range: NSRange(location: 0, length: text.length))
text.addAttribute(NSAttributedStringKey.font, value: _subFont, range: NSRange(location: text.length - 4, length: 1))
self.attributedText = text
}
// 把displaylin从Runloop modes中移除
deinit {
link.invalidate()
}
required init?(coder aDecoder: NSCoder) {
fatalError("init(coder:) has not been implemented")
}
}
OC
//PFProxy.h
#import <Foundation/Foundation.h>
@interface PFProxy : NSProxy
//通过创建对象
- (instancetype)initWithObjc:(id)object;
//通过类方法创建创建
+ (instancetype)proxyWithObjc:(id)object;
@end
//PFProxy.m
#import "PFProxy.h"
@interface PFProxy()
@property (nonatomic, weak) id object;
@end
@implementation PFProxy
- (instancetype)initWithObjc:(id)object {
self.object = object;
return self;
}
+ (instancetype)proxyWithObjc:(id)object {
return [[self alloc] initWithObjc:object];
}
- (void)forwardInvocation:(NSInvocation *)invocation {
if ([self.object respondsToSelector:invocation.selector]) {
[invocation invokeWithTarget:self.object];
}
}
- (NSMethodSignature *)methodSignatureForSelector:(SEL)sel {
return [self.object methodSignatureForSelector:sel];
}
@end
// VC.m
#import "ViewController1.h"
#import "PFProxy.h"
@interface ViewController1 ()
//使用NSProxy
@property (nonatomic, strong) NSTimer *timer2;
@end
@implementation ViewController1
- (void)viewWillDisappear:(BOOL)animated {
[super viewWillDisappear:animated];
}
- (void)viewDidLoad {
[super viewDidLoad];
self.title = @"VC1";
self.view.backgroundColor = [UIColor whiteColor];
PFProxy *proxy = [[PFProxy alloc] initWithObjc:self];
self.timer2 = [NSTimer scheduledTimerWithTimeInterval:1.0 target:proxy selector:@selector(timerHandle) userInfo:nil repeats:YES];
}
//定时触发的事件
- (void)timerHandle {
NSLog(@"正在计时中。。。。。。");
}
- (void)dealloc {
[self.timer2 invalidate];
self.timer2 = nil;
NSLog(@"%s",__func__);
}
@end
通过PFProxy这个伪基类(相当于ViewController1的复制类),避免直接让timer和viewController造成循环。