Objective-C 代码重构与优化技巧
2023-07-021.7k 阅读
一、代码重构基础概念
（一）什么是代码重构
代码重构是对现有代码进行一系列不改变其外部行为，却旨在改进其内部结构、提高可维护性、可读性以及性能的修改。在Objective - C项目中，随着功能的不断添加，代码可能变得复杂、冗余，重构就显得尤为重要。例如，一段原本简单的计算两个数之和的方法，随着业务扩展，可能逐渐添加了各种复杂的条件判断和临时变量，导致方法变得难以理解和修改。通过重构，可以将这些杂乱的代码整理成清晰、简洁且易于维护的形式。
（二）为什么要进行代码重构
- 提高可维护性：清晰的代码结构使得后续开发人员更容易理解代码逻辑，修改代码时也能降低引入新错误的风险。例如，在一个大型Objective - C项目中，如果不同模块的代码风格混乱，方法命名不规范，新加入的开发者可能需要花费大量时间去梳理代码逻辑，而重构后的代码能大大缩短这一过程。
- 增强可读性：重构能够使代码更符合良好的编程习惯和设计模式，提高代码的可读性。比如，将一段冗长的方法分解成多个具有明确职责的小方法，并且使用有意义的方法名，使得代码如同自然语言一样容易理解。
- 优化性能：在重构过程中，可以发现并优化那些效率低下的代码段。例如，通过分析Objective - C中集合的使用方式，可能会发现某些频繁的遍历操作可以通过更合适的数据结构或算法来优化，从而提高程序的整体性能。
二、Objective - C代码重构技巧
（一）提炼方法
- 识别可提炼的代码块：在Objective - C代码中，当一个方法过长，包含多个不同职责的代码段时，就可以考虑提炼方法。例如，以下是一个处理用户登录并获取用户信息的复杂方法：
- (void)handleUserLoginAndInfo {
NSString *username = self.usernameTextField.text;
NSString *password = self.passwordTextField.text;
// 登录验证
BOOL isValid = [self validateLoginWithUsername:username password:password];
if (isValid) {
NSURL *url = [NSURL URLWithString:@"https://example.com/api/userinfo"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"GET"];
NSURLSessionDataTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
if (data) {
NSDictionary *userInfo = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableContainers error:nil];
self.userNameLabel.text = userInfo[@"name"];
self.userAgeLabel.text = [NSString stringWithFormat:@"%ld", (long)[userInfo[@"age"] integerValue]];
}
}];
[task resume];
}
}
这个方法既处理了登录验证，又负责获取用户信息并更新UI，职责过于复杂。 2. 提炼方法的步骤： - 提取登录验证部分：
- (BOOL)validateLoginWithUsername:(NSString *)username password:(NSString *)password {
// 实际验证逻辑，这里简单示例
if ([username isEqualToString:@"admin"] && [password isEqualToString:@"123456"]) {
return YES;
}
return NO;
}
- **提取获取用户信息并更新UI部分**：
- (void)fetchAndUpdateUserInfo {
NSURL *url = [NSURL URLWithString:@"https://example.com/api/userinfo"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"GET"];
NSURLSessionDataTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
if (data) {
NSDictionary *userInfo = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableContainers error:nil];
self.userNameLabel.text = userInfo[@"name"];
self.userAgeLabel.text = [NSString stringWithFormat:@"%ld", (long)[userInfo[@"age"] integerValue]];
}
}];
[task resume];
}
- **修改原方法**：
- (void)handleUserLoginAndInfo {
NSString *username = self.usernameTextField.text;
NSString *password = self.passwordTextField.text;
// 登录验证
BOOL isValid = [self validateLoginWithUsername:username password:password];
if (isValid) {
[self fetchAndUpdateUserInfo];
}
}
通过这样的提炼，每个方法的职责清晰，代码更易于理解和维护。
（二）消除重复代码
- 寻找重复代码：在Objective - C项目中，重复代码可能出现在不同的类或方法中。例如，有两个不同的视图控制器，都需要获取当前设备的系统版本号并显示在标签上：
// FirstViewController.m
- (void)displaySystemVersion {
NSString *systemVersion = [[UIDevice currentDevice] systemVersion];
self.versionLabel.text = systemVersion;
}
// SecondViewController.m
- (void)showSystemVersion {
NSString *systemVersion = [[UIDevice currentDevice] systemVersion];
self.versionLabel.text = systemVersion;
}
- 消除重复代码的方法：
- 提取公共方法：可以在一个基类或者工具类中提取这个公共方法。假设创建一个
DeviceUtil工具类：
- 提取公共方法：可以在一个基类或者工具类中提取这个公共方法。假设创建一个
// DeviceUtil.h
@interface DeviceUtil : NSObject
+ (NSString *)fetchSystemVersion;
@end
// DeviceUtil.m
@implementation DeviceUtil
+ (NSString *)fetchSystemVersion {
return [[UIDevice currentDevice] systemVersion];
}
@end
- **修改原视图控制器方法**：
// FirstViewController.m
- (void)displaySystemVersion {
self.versionLabel.text = [DeviceUtil fetchSystemVersion];
}
// SecondViewController.m
- (void)showSystemVersion {
self.versionLabel.text = [DeviceUtil fetchSystemVersion];
}
这样就消除了重复代码，提高了代码的复用性。
（三）优化条件语句
- 复杂条件语句的问题：在Objective - C代码中，复杂的条件语句会使代码逻辑难以理解和维护。例如，以下是一个根据用户角色来决定是否显示某些功能按钮的方法：
- (void)updateFunctionButtonsVisibility {
NSString *userRole = self.user.role;
if ([userRole isEqualToString:@"admin"]) {
self.addButton.hidden = NO;
self.deleteButton.hidden = NO;
self.editButton.hidden = NO;
} else if ([userRole isEqualToString:@"moderator"]) {
self.addButton.hidden = NO;
self.deleteButton.hidden = YES;
self.editButton.hidden = NO;
} else if ([userRole isEqualToString:@"user"]) {
self.addButton.hidden = YES;
self.deleteButton.hidden = YES;
self.editButton.hidden = YES;
} else {
self.addButton.hidden = YES;
self.deleteButton.hidden = YES;
self.editButton.hidden = YES;
}
}
- 优化条件语句的方式：
- 使用多态：可以通过创建不同角色的子类，并在子类中重写一个统一的方法来设置按钮的可见性。首先定义一个基类
User和不同角色的子类：
- 使用多态：可以通过创建不同角色的子类，并在子类中重写一个统一的方法来设置按钮的可见性。首先定义一个基类
// User.h
@interface User : NSObject
@property (nonatomic, strong) NSString *role;
- (void)updateFunctionButtonsVisibility:(UIButton *)addButton deleteButton:(UIButton *)deleteButton editButton:(UIButton *)editButton;
@end
// User.m
@implementation User
- (void)updateFunctionButtonsVisibility:(UIButton *)addButton deleteButton:(UIButton *)deleteButton editButton:(UIButton *)editButton {
addButton.hidden = YES;
deleteButton.hidden = YES;
editButton.hidden = YES;
}
@end
// AdminUser.h
@interface AdminUser : User
@end
// AdminUser.m
@implementation AdminUser
- (void)updateFunctionButtonsVisibility:(UIButton *)addButton deleteButton:(UIButton *)deleteButton editButton:(UIButton *)editButton {
addButton.hidden = NO;
deleteButton.hidden = NO;
editButton.hidden = NO;
}
@end
// ModeratorUser.h
@interface ModeratorUser : User
@end
// ModeratorUser.m
@implementation ModeratorUser
- (void)updateFunctionButtonsVisibility:(UIButton *)addButton deleteButton:(UIButton *)deleteButton editButton:(UIButton *)editButton {
addButton.hidden = NO;
deleteButton.hidden = YES;
editButton.hidden = NO;
}
@end
- **修改原方法**：
- (void)updateFunctionButtonsVisibility {
[self.user updateFunctionButtonsVisibility:self.addButton deleteButton:self.deleteButton editButton:self.editButton];
}
这样代码逻辑更加清晰，当需要添加新的角色时，只需要创建新的子类并重写相应方法，而不需要修改原有的复杂条件语句。
三、Objective - C代码优化技巧
（一）内存管理优化
- 自动释放池的合理使用：在Objective - C中，自动释放池（
NSAutoreleasePool）用于管理对象的内存释放。当创建大量临时对象时，合理使用自动释放池可以避免内存峰值过高。例如，以下代码在一个循环中创建大量字符串对象：
- (void)createManyStrings {
for (NSInteger i = 0; i < 10000; i++) {
NSString *tempString = [NSString stringWithFormat:@"%ld", (long)i];
// 对tempString进行一些操作
}
}
在这种情况下，可以使用自动释放池来及时释放这些临时字符串对象：
- (void)createManyStrings {
for (NSInteger i = 0; i < 10000; i++) {
@autoreleasepool {
NSString *tempString = [NSString stringWithFormat:@"%ld", (long)i];
// 对tempString进行一些操作
}
}
}
这样在每次循环结束时，自动释放池中的对象就会被释放，减少内存占用。 2. 避免循环引用：循环引用是Objective - C内存管理中的常见问题，会导致对象无法正常释放。例如，两个对象相互持有对方的强引用：
@interface ClassA : NSObject
@property (nonatomic, strong) ClassB *classB;
@end
@interface ClassB : NSObject
@property (nonatomic, strong) ClassA *classA;
@end
@implementation ClassA
@end
@implementation ClassB
@end
// 使用时
ClassA *a = [[ClassA alloc] init];
ClassB *b = [[ClassB alloc] init];
a.classB = b;
b.classA = a;
为了解决这个问题，可以将其中一个引用改为弱引用（weak）。假设将ClassB中的classA改为弱引用：
@interface ClassB : NSObject
@property (nonatomic, weak) ClassA *classA;
@end
这样就打破了循环引用，对象能够正常释放。
（二）性能优化
- 优化集合操作：在Objective - C中，常用的集合类如
NSArray、NSMutableArray、NSDictionary和NSMutableDictionary，不同的操作在不同场景下性能有差异。例如，在查找元素时，NSDictionary的性能要优于NSArray，因为NSDictionary使用哈希表进行查找，时间复杂度为O(1)，而NSArray需要遍历，时间复杂度为O(n)。假设需要根据用户ID查找用户信息，使用NSDictionary会更高效：
// 使用NSDictionary查找用户信息
NSDictionary *userDict = @{
@"1": @"John",
@"2": @"Jane"
};
NSString *userName = userDict[@"1"];
- 减少不必要的计算：在方法中，如果某些计算结果不会改变，就可以将其提取到方法外部或者缓存起来。例如，以下方法每次调用都会计算一个固定的数值：
- (CGFloat)calculateFixedValue {
CGFloat value = M_PI * 2.0;
return value;
}
可以将这个固定值提取到类的属性中，只计算一次：
@interface MyClass : NSObject
@property (nonatomic, readonly) CGFloat fixedValue;
@end
@implementation MyClass
- (instancetype)init {
self = [super init];
if (self) {
_fixedValue = M_PI * 2.0;
}
return self;
}
- (CGFloat)calculateFixedValue {
return self.fixedValue;
}
@end
这样每次调用calculateFixedValue方法时，直接返回缓存的值，提高了性能。
（三）代码结构优化
- 合理使用分类（Category）：分类可以在不修改原有类的情况下，为类添加新的方法。例如，在
NSString类中添加一个判断字符串是否为数字的方法：
// NSString+NumberCheck.h
@interface NSString (NumberCheck)
- (BOOL)isNumeric;
@end
// NSString+NumberCheck.m
@implementation NSString (NumberCheck)
- (BOOL)isNumeric {
NSCharacterSet *nonNumberSet = [[NSCharacterSet decimalDigitCharacterSet] invertedSet];
return ![self rangeOfCharacterFromSet:nonNumberSet].location != NSNotFound;
}
@end
这样在项目中任何需要判断字符串是否为数字的地方，都可以直接调用isNumeric方法，使代码结构更加清晰，功能更加模块化。
2. 遵循设计模式：在Objective - C项目中，遵循设计模式可以提高代码的可维护性和扩展性。例如，使用单例模式来确保某个类在整个应用程序中只有一个实例。以下是一个简单的单例类示例：
@interface SingletonClass : NSObject
+ (instancetype)sharedInstance;
@end
@implementation SingletonClass
static SingletonClass *sharedInstance = nil;
+ (instancetype)sharedInstance {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
sharedInstance = [[self alloc] init];
});
return sharedInstance;
}
@end
通过使用单例模式，可以方便地管理一些全局资源或者状态，并且避免了多次创建实例带来的资源浪费。
四、重构与优化实践案例
（一）案例背景
假设我们正在开发一个简单的待办事项应用，初始版本已经实现了基本的添加待办事项、显示待办事项列表等功能。随着功能的逐步增加，代码变得越来越混乱，出现了重复代码、方法职责不明确等问题，性能也有所下降，因此需要进行重构与优化。
（二）重构过程
- 提炼方法：在处理待办事项保存的方法中，发现既包含了数据验证，又包含了实际的保存逻辑。原方法如下：
- (void)saveTodoItem:(NSString *)todoText {
if (todoText.length == 0) {
UIAlertController *alert = [UIAlertController alertControllerWithTitle:@"提示" message:@"待办事项内容不能为空" preferredStyle:UIAlertControllerStyleAlert];
UIAlertAction *okAction = [UIAlertAction actionWithTitle:@"确定" style:UIAlertActionStyleDefault handler:nil];
[alert addAction:okAction];
[self presentViewController:alert animated:YES completion:nil];
return;
}
NSManagedObjectContext *context = [self managedObjectContext];
TodoItem *todo = [NSEntityDescription insertNewObjectForEntityForName:@"TodoItem" inManagedObjectContext:context];
todo.text = todoText;
todo.createdAt = [NSDate date];
NSError *error = nil;
if (![context save:&error]) {
NSLog(@"保存待办事项失败: %@", error);
}
[self.tableView reloadData];
}
可以将数据验证和保存逻辑分别提炼成方法：
- (BOOL)validateTodoText:(NSString *)todoText {
if (todoText.length == 0) {
UIAlertController *alert = [UIAlertController alertControllerWithTitle:@"提示" message:@"待办事项内容不能为空" preferredStyle:UIAlertControllerStyleAlert];
UIAlertAction *okAction = [UIAlertAction actionWithTitle:@"确定" style:UIAlertActionStyleDefault handler:nil];
[alert addAction:okAction];
[self presentViewController:alert animated:YES completion:nil];
return NO;
}
return YES;
}
- (void)saveTodoItemToDatabase:(NSString *)todoText {
NSManagedObjectContext *context = [self managedObjectContext];
TodoItem *todo = [NSEntityDescription insertNewObjectForEntityForName:@"TodoItem" inManagedObjectContext:context];
todo.text = todoText;
todo.createdAt = [NSDate date];
NSError *error = nil;
if (![context save:&error]) {
NSLog(@"保存待办事项失败: %@", error);
}
[self.tableView reloadData];
}
- (void)saveTodoItem:(NSString *)todoText {
if ([self validateTodoText:todoText]) {
[self saveTodoItemToDatabase:todoText];
}
}
- 消除重复代码：在待办事项列表的显示和编辑页面，都需要获取待办事项的创建时间并格式化显示。原代码如下：
// ListViewController.m
- (NSString *)formatTodoCreationDate:(NSDate *)date {
NSDateFormatter *formatter = [[NSDateFormatter alloc] init];
[formatter setDateFormat:@"yyyy - MM - dd HH:mm:ss"];
return [formatter stringFromDate:date];
}
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:@"TodoCell" forIndexPath:indexPath];
TodoItem *todo = self.todoItems[indexPath.row];
cell.textLabel.text = todo.text;
cell.detailTextLabel.text = [self formatTodoCreationDate:todo.createdAt];
return cell;
}
// EditViewController.m
- (NSString *)formatTodoCreationDate:(NSDate *)date {
NSDateFormatter *formatter = [[NSDateFormatter alloc] init];
[formatter setDateFormat:@"yyyy - MM - dd HH:mm:ss"];
return [formatter stringFromDate:date];
}
- (void)viewDidLoad {
[super viewDidLoad];
TodoItem *todo = self.selectedTodo;
self.dateLabel.text = [self formatTodoCreationDate:todo.createdAt];
}
可以将格式化日期的方法提取到一个工具类中：
// DateUtil.h
@interface DateUtil : NSObject
+ (NSString *)formatDate:(NSDate *)date;
@end
// DateUtil.m
@implementation DateUtil
+ (NSString *)formatDate:(NSDate *)date {
NSDateFormatter *formatter = [[NSDateFormatter alloc] init];
[formatter setDateFormat:@"yyyy - MM - dd HH:mm:ss"];
return [formatter stringFromDate:date];
}
@end
// ListViewController.m
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:@"TodoCell" forIndexPath:indexPath];
TodoItem *todo = self.todoItems[indexPath.row];
cell.textLabel.text = todo.text;
cell.detailTextLabel.text = [DateUtil formatDate:todo.createdAt];
return cell;
}
// EditViewController.m
- (void)viewDidLoad {
[super viewDidLoad];
TodoItem *todo = self.selectedTodo;
self.dateLabel.text = [DateUtil formatDate:todo.createdAt];
}
- 优化条件语句：在处理待办事项的优先级显示时，原代码使用了复杂的条件语句：
- (NSString *)priorityLabelTextForTodo:(TodoItem *)todo {
if (todo.priority == 1) {
return @"高";
} else if (todo.priority == 2) {
return @"中";
} else if (todo.priority == 3) {
return @"低";
} else {
return @"未知";
}
}
可以使用枚举和switch - case语句优化：
typedef NS_ENUM(NSInteger, TodoPriority) {
TodoPriorityHigh = 1,
TodoPriorityMedium = 2,
TodoPriorityLow = 3
};
- (NSString *)priorityLabelTextForTodo:(TodoItem *)todo {
switch (todo.priority) {
case TodoPriorityHigh:
return @"高";
case TodoPriorityMedium:
return @"中";
case TodoPriorityLow:
return @"低";
default:
return @"未知";
}
}
（三）优化过程
- 内存管理优化：在待办事项列表滚动时，发现内存占用持续上升。分析后发现，在
UITableViewCell的prepareForReuse方法中，没有正确释放一些临时创建的视图。原代码如下：
- (void)prepareForReuse {
[super prepareForReuse];
// 这里创建了一个临时视图，但没有释放
UIView *tempView = [[UIView alloc] initWithFrame:CGRectMake(0, 0, 100, 100)];
// 对tempView进行一些操作
}
修改为：
- (void)prepareForReuse {
[super prepareForReuse];
if (self.tempView) {
[self.tempView removeFromSuperview];
self.tempView = nil;
}
}
- 性能优化：在加载大量待办事项时，发现列表加载缓慢。通过分析，发现是在
tableView:cellForRowAtIndexPath:方法中进行了一些复杂的计算。原代码如下：
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:@"TodoCell" forIndexPath:indexPath];
TodoItem *todo = self.todoItems[indexPath.row];
cell.textLabel.text = todo.text;
// 复杂计算，每次都重新计算
CGFloat progress = [self calculateTodoProgress:todo];
cell.detailTextLabel.text = [NSString stringWithFormat:@"进度: %.2f%%", progress * 100];
return cell;
}
- (CGFloat)calculateTodoProgress:(TodoItem *)todo {
// 复杂计算逻辑，例如根据完成的子任务数量和总任务数量计算进度
NSInteger completedCount = [todo.subTasks filteredArrayUsingPredicate:[NSPredicate predicateWithFormat:@"isCompleted == YES"]].count;
NSInteger totalCount = todo.subTasks.count;
if (totalCount == 0) {
return 0;
}
return (CGFloat)completedCount / (CGFloat)totalCount;
}
可以将计算结果缓存到TodoItem对象中：
@interface TodoItem : NSManagedObject
@property (nonatomic, assign) CGFloat progress;
@end
@implementation TodoItem
// 在保存待办事项或者子任务状态改变时更新progress
- (void)updateProgress {
NSInteger completedCount = [self.subTasks filteredArrayUsingPredicate:[NSPredicate predicateWithFormat:@"isCompleted == YES"]].count;
NSInteger totalCount = self.subTasks.count;
if (totalCount == 0) {
self.progress = 0;
} else {
self.progress = (CGFloat)completedCount / (CGFloat)totalCount;
}
}
@end
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:@"TodoCell" forIndexPath:indexPath];
TodoItem *todo = self.todoItems[indexPath.row];
cell.textLabel.text = todo.text;
cell.detailTextLabel.text = [NSString stringWithFormat:@"进度: %.2f%%", todo.progress * 100];
return cell;
}
- 代码结构优化：原项目中，所有与待办事项数据处理相关的代码都写在视图控制器中，导致视图控制器过于臃肿。可以将数据处理部分提取到一个专门的
TodoDataManager类中：
// TodoDataManager.h
@interface TodoDataManager : NSObject
+ (instancetype)sharedManager;
- (NSArray *)fetchAllTodoItems;
- (void)saveTodoItem:(NSString *)todoText;
@end
// TodoDataManager.m
@implementation TodoDataManager
static TodoDataManager *sharedManager = nil;
+ (instancetype)sharedManager {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
sharedManager = [[self alloc] init];
});
return sharedManager;
}
- (NSArray *)fetchAllTodoItems {
NSManagedObjectContext *context = [self managedObjectContext];
NSFetchRequest *fetchRequest = [NSFetchRequest fetchRequestWithEntityName:@"TodoItem"];
NSError *error = nil;
return [context executeFetchRequest:fetchRequest error:&error];
}
- (void)saveTodoItem:(NSString *)todoText {
if ([self validateTodoText:todoText]) {
[self saveTodoItemToDatabase:todoText];
}
}
// 其他数据处理方法...
@end
// 在视图控制器中使用
@interface TodoListViewController : UIViewController
@property (nonatomic, strong) NSArray *todoItems;
@end
@implementation TodoListViewController
- (void)viewDidLoad {
[super viewDidLoad];
self.todoItems = [TodoDataManager sharedManager].fetchAllTodoItems;
[self.tableView reloadData];
}
- (IBAction)addTodoItem:(UIButton *)sender {
NSString *todoText = self.todoTextField.text;
[[TodoDataManager sharedManager] saveTodoItem:todoText];
self.todoItems = [TodoDataManager sharedManager].fetchAllTodoItems;
[self.tableView reloadData];
}
@end
通过以上重构与优化过程，待办事项应用的代码变得更加清晰、易于维护，性能也得到了提升。
五、总结重构与优化的要点
在Objective - C项目中，代码重构与优化是一个持续的过程，它贯穿于项目的整个生命周期。通过提炼方法、消除重复代码、优化条件语句等重构技巧，可以使代码结构更加清晰，逻辑更加易懂。而在优化方面，合理的内存管理、性能优化以及代码结构优化，能够提高程序的运行效率和稳定性。在实际项目中，要善于发现代码中存在的问题，灵活运用这些技巧，不断提升代码的质量，为项目的长期发展奠定坚实的基础。同时，重构与优化过程中要注意进行充分的测试，确保不改变代码的外部行为，避免引入新的错误。