Storyboard Segue 标识符命名约定

Question

我正在构建一个大型故事板，我想知道是否有人为 segue identifiers提出了有用的命名约定。

看起来苹果只是在他们的例子中使用了“ShowX”，其中 X 是它显示的视图的名称。 到目前为止，我更喜欢使用“PushX”或“ModalX”来跟踪它是哪种类型的过渡。 任何人有任何其他技巧或提示？

Answer 1

与编程中的大多数事情一样，您可以使用任何您喜欢的名称。

但是，与编程中的大多数事情一样，名字很重要，好名字很难。

这是我如何命名 segues…

好的转场名称

像命名操作方法一样命名 segues 。 根据他们将做什么来命名 segue。 好的 segue 名称示例：

• addUser
• showReport
• editAccount
• composeMessage
• reviewChanges

错误的 segue 名称

避免只描述被 segue 对象是什么或它是如何工作的 segue 名称。

一些不好的 segue 名称的例子！！ ：

• 坏名字 1！ – segueUserDetailViewController – 避免这种情况！
• 坏名字2！ – segueImageViewController – 避免这种情况！
• 坏名字3！ – RecipeViewControllerToIngredientViewController – 避免这种情况！

为什么这些名字不好？

这些名称很糟糕，因为它们明确说明了它们的实现。 他们没有命名他们做什么，而是命名他们如何做。 这是一种 耦合形式。

因此，如果您正在做的是“显示购物篮”，那么今天恰好通过呈现ZZBasketViewController来完成这一事实，与调用者完全无关，只会给他们带来他们不关心的细节。 也许明天它会用ZZShoppingItemsViewController或STSuperConfigurableStuffList来完成。

所以：

• 使用诸如showShopping的名称。
• 避免使用诸如showBasketViewController的名称。

所有程序的命名规则

通常抽象的要点是用户不知道也不应该知道抽象是如何工作的。 他们只知道它会对他们做什么——这对他们意味着什么。

任何抽象的名称不必要地指定必须如何完成某事是不好的，因为这样调用者就规定了被调用者必须如何工作。

这种耦合将：

• 用它不需要的知识增加呼叫者的负担。
• 以不必要的方式任意约束被调用者的实现。
• 以一种需要维护或将来移除的无意义且昂贵的方式将调用者与被调用者耦合。

如果随后有人忽略了耦合并更改了实现，那么给定的名称开始撒谎并会误导未来查看代码的程序员，除非名称也被更改。

Segue 是抽象的。 Segue 名称不应引用实现。

遵循 Cocoa 的标识符约定

Swift 和 Objective C 都使用camelCase作为标识符。

• 名称从不包含_或-字符。
• 除了类型、类和协议之外，所有名称的首字母都应该小写。

用camelCase命名你的 segue 并给它们一个小写的第一个字母。

唯一性不是必需的

Segue公司名称不需要是一个故事板中是唯一的。 名称只需要在特定场景（视图控制器）中是唯一的。

Ilea 的回答提到了这一点，引用自 Ray 的网站：

它只需要在源场景中是唯一的； 不同的场景可以使用相同的标识符。

......其实，这往往使有很大的意义在故事板的许多场景具有相同的名称赛格瑞，因为你可能能够addLocation从多个场景。

---

命名和使用 Segues 的更多提示......

场景可以有 >1 个转场转到同一个其他场景

这是我稍微使用的东西。 您可能有一个可以显示和编辑帐户信息的视图控制器： AccountVC 。 没有什么能阻止你从一个场景中获得两个或更多转场，这些转场转到同一个其他视图控制器的场景： editAccount和showAccount 。 您的prepareForSegue:sender:然后可以使用 segue ID 适当地设置AccountVC以进行编辑或仅显示。

使用sender

因为 segues 是用发送者调用的，所以感觉很像 action 消息。

在你的prepareForSegue:sender:实现中使用 segue 的sender来配置目标视图控制器。 这可以避免使用临时状态污染您的视图控制器。

这是处理点击的表视图委托的示例：

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath
{
  Account *const account = [self accountAtIndexPath: indexPath];
  [self performSegueWithIdentifier: showAccount sender: account];
}

这让你的prepare…方法看起来像这样：

- (void)prepareForSegue:(UIStoryboardSegue *)segue sender:(id)sender
{
  if([showAccount isEqualToString: segue.identifier])
  {
    AccountViewController *accountVC = segue.destinationViewController;
    accountVC.account = sender;
  }
}

避免在performSegue:调用中使用@"stringLiterals"

如果您问“这是什么showAccount ？您的意思是@"showAccount" ，对吗？ 一个重要提示是：为您的 segue 名称使用文件范围变量。 不要使用@"string literals" 。 所以，在我的视图控制器的顶部通常有一个像这样的块：

DEFINE_KEY(showReport);
DEFINE_KEY(showPDF);
DEFINE_KEY(shareReport);

宏DEFINE_KEY位于我项目的.pch ，如下所示：

#define DEFINE_KEY(keyName) static NSString *const keyName = @#keyName

... 它创建了一个 const NSString*变量，其值等于其名称。 static意味着它仅在此“编译单元”中可用，并且不会在链接时污染全局名称空间。

如果您使用这样的变量，则编译器就在您身边。 你不能把名字弄错，因为那样它就不会建立。 代码完成将帮助您完成您开始的名称。 您可以像重构任何其他变量一样重构名称。 甚至语法荧光笔也在你身边！

将 unwind segues 视为例外

将目标视图控制器视为 unwind segue 的异常处理程序。 unwind segue 向上传播导航堆栈，非常类似于异常向上传播调用堆栈。 segue 寻找 unwind 处理程序，就像异常寻找异常处理程序（catch 块）一样。 它正在寻找适合于 unwind segue 类型的 unwind 处理程序——同样，这就像正在搜索的异常类型的异常处理程序。

重要的是，您可以让许多视图控制器实现相同的 unwind handler 。 展开将像第一个处理它的视图控制器的异常一样冒泡。

展开命名的通常建议类似于unwindToMessageList 。 这可能是有道理的，但是按照“异常处理程序”的比喻，通过它们正在处理的内容来命名展开处理程序可能非常有用。 因此， unwindFromEventDetails 、 unwindFromReport或unwindFromCloseupImage可能是描述捕获内容的好名字。 这些处理程序可以在多个可能的捕获点实现。 将使用导航层次结构自动选择适当的处理程序。

Answer 2

这个问题没有正确答案。 这取决于口味。 我减轻了可读性。 不要羞于为您的 segue 标识符提供一个长名称； 给出长而富有表现力的名字，因为 Objective-C 是一种非常冗长的语言，它利用我们编写非常易读的代码。

我已经搜索了一个官方会议，但我找不到任何。 这是Apple必须说的话：

您可以在 Interface Builder 中为您的 segue 分配标识符。 标识符是您的应用程序用来区分一个 segue 和另一个 segue 的字符串。 例如，如果您有一个源视图控制器可以连接到两个或多个不同的目标视图控制器，您可以为每个 segue 分配不同的标识符，以便源视图控制器的 prepareForSegue:sender: 方法可以区分它们并适当地准备每个 segue .

来自Ray Wenderlich 网站的另一句话：

给 segue 一个唯一的标识符。 （它只需要在源场景中是唯一的；不同的场景可以使用相同的标识符。）

一种选择标识符名称的有趣方法（有关更多信息，请参见上面的链接）：

1. 在您甚至在界面构建器中设置名称之前，首先编写验证 segue 标识符名称的代码。 我说的是这段代码： if ([segue.identifier isEqualToString:@"SegueIdentifierName"])

2. 构建和运行！ 暂时不要在 Interface Builder 中填写标识符名称。 你这样做是因为你可能有多个来自一个视图控制器的传出 segue，你需要能够区分它们。 如果在您运行并触发您正在处理的 segue 时没有任何反应，那么您的 segue 名称标识符是唯一的并且可以很好地使用。 相反，如果代码执行了您不想要的 segue，那么您的 sague 名称标识符就会发生冲突。

3. 解决冲突 - 如果有的话。

4. 在 Interface Builder 中填写 segue 标识符并测试它是否满足您的要求。

我喜欢这个，因为它就像 TDD 方法：编写一个失败的测试，编写一些代码来通过失败的测试，重构，重复。

Answer 3

"ViewControllerAToViewControllerB"

例如，如果你有一个 MasterViewController 和一个 DetailViewController，segue 标识符可以是：

"MasterToDetail"

Answer 4

我个人不会使用前面的动画类型，如果你改变动画，你需要回到代码中。 但是，如果在源控制器中将 segue 标识符声明为常量，则可以在稍后更轻松地更改名称，而无需深入研究代码。

我通常使用我给控制器起的名字，没有“ViewController”。 所以 RatingViewController 将“评级”作为故事板。 一个例外是展开转场，我将那些以“returnTo”开头的转场命名为以目的地名称结尾的转场（“returnToRating”）。