最完整iOS开发规范：Objective-C编码标准与最佳实践指南

郁勉能Lois

1215人浏览 · 2025-09-24 12:21:20

郁勉能Lois · 2025-09-24 12:21:20 发布

最完整iOS开发规范：Objective-C编码标准与最佳实践指南

【免费下载链接】styleguide 项目地址: https://gitcode.com/gh_mirrors/st/styleguide

你还在为iOS项目中的代码风格混乱而烦恼吗？团队协作时因命名不统一导致效率低下？本文将系统介绍Objective-C编码规范，帮你解决iOS开发中的代码规范问题。读完本文，你将掌握Google Objective-C编码标准，学会规范的命名方式、文件结构和代码风格，提升代码质量和团队协作效率。

为什么需要Objective-C编码规范

Objective-C是Apple平台的主要开发语言，具有动态性和面向对象特性。在iOS开发中，统一的编码规范能提高代码可读性、可维护性，减少错误。Google的Objective-C风格指南基于多年项目经验，结合Apple SDK设计理念，形成了一套实用的编码标准。

项目中相关的规范文件：objcguide.md

核心原则

为读者优化，而非作者

代码的生命周期往往很长，阅读代码的时间远多于编写时间。应优先考虑代码的可读性，例如在复杂逻辑处添加文字提示。

保持一致性

当风格指南允许多种选择时，应选择一种方式并保持一致。例如在整个代码库中使用统一的命名风格，让工程师能专注于更重要的问题。

与Apple SDK保持一致

与Apple SDK的Objective-C使用方式保持一致很有价值，但当某些语言特性存在缺陷时，应限制或禁止使用。

命名规范

文件命名

文件名称应反映包含的类实现，包括大小写。扩展名如下表：

扩展名	类型描述
.h	C/C++/Objective-C头文件
.m	Objective-C实现文件
.mm	Objective-C++实现文件
.cc	纯C++实现文件
.c	C实现文件

分类的文件名应包含被扩展的类名，如NSString+GTMParsing.h。

类名与前缀

类名应大写开头并使用混合大小写，跨项目共享的代码必须使用前缀（至少三个字符），避免与Apple的两字母前缀冲突。

// 正确示例
@interface GTMExample : NSObject
@end

方法命名

方法和参数名通常小写开头，使用混合大小写，应读起来像一个句子。获取属性的方法应直接使用属性名，布尔属性的getter方法以is开头。

// 正确示例
- (NSURL *)URLWithString:(NSString *)URLString;
- (BOOL)isGlorious;

代码示例

头文件示例

// GOOD:
#import <Foundation/Foundation.h>

@class Bar;

/**
 * 一个展示良好Objective-C风格的示例类。所有接口、分类和协议
 * （即头文件中所有非平凡的顶级声明）必须有注释。注释必须与
 * 被文档化的对象相邻。
 */
@interface Foo : NSObject

/** 被持有的Bar对象。 */
@property(nonatomic) Bar *bar;

/** 当前绘图属性。 */
@property(nonatomic, copy) NSDictionary<NSString *, NSNumber *> *attributes;

/**
 * 便利构造方法。
 * 详见 -initWithBar: 中关于 @c bar 的说明。
 *
 * @param bar 用于fooing的字符串。
 * @return Foo的实例。
 */
+ (instancetype)fooWithBar:(Bar *)bar;

@end

实现文件示例

// GOOD:
#import "Shared/Util/Foo.h"

@implementation Foo {
  /** 用于显示"hi"的字符串。 */
  NSString *_string;
}

+ (instancetype)fooWithBar:(Bar *)bar {
  return [[self alloc] initWithBar:bar];
}

- (instancetype)initWithBar:(Bar *)bar {
  self = [super init];
  if (self) {
    _bar = [bar copy];
    _string = [[NSString alloc] initWithFormat:@"hi %d", 3];
    _attributes = @{
      @"color" : UIColor.blueColor,
      @"hidden" : @NO
    };
  }
  return self;
}

@end

变量与类型

变量命名

变量名通常小写开头，使用混合大小写。实例变量有前导下划线，文件作用域或全局变量有前缀g。

// 正确示例
myLocalVariable    // 局部变量
_myInstanceVariable // 实例变量
gMyGlobalVariable  // 全局变量

常用类型

避免使用大小不一致的类型，如long、NSInteger在32位和64位构建中有不同大小。文件和缓冲区大小应使用int64_t。

// 正确示例
int32_t scalar1 = proto.intValue;
int64_t fileSize = [file attributesOfItemAtPath:path error:&error].fileSize;
CGFloat offset = view.bounds.origin.x;

注释规范

文件注释

文件可选择以内容描述开头，包括许可证声明和文件内容的基本描述。每个非平凡接口都应有注释，描述其目的和在整体架构中的位置。

声明注释

使用Doxygen风格的注释，便于Xcode解析显示格式化文档。为类、属性、实例变量、函数、分类、协议声明和枚举添加注释。

// 正确示例
/**
 * NSApplication的委托，处理应用启动和关闭通知。
 * 由主应用控制器拥有。
 */
@interface MyAppDelegate : NSObject {
  /**
   * 正在进行的后台任务（如果有）。初始化为UIBackgroundTaskInvalid。
   */
  UIBackgroundTaskIdentifier _backgroundTaskID;
}