swift 中 #error 的一些妙用

这里每天分享一个 iOS 的新知识，快来关注我吧

如果你想搭建一个属于自己的 GPT AI 可以参考我这篇文章介绍：0 基础，1 分钟搭建自己的 AI 工具

前言

不知道你们平时有没有用过 #error 这个功能，它是一个编译器指令，允许我们发出编译错误，在开发中的某些场景下是非常有用的，今天就来分享一些我知道的使用场景。

1、防止某些未实现的代码跑到线上

有的时候，某些函数因为种种原因不能立即实现，或者需求尚未确定，这种情况下，我见过最多的处理方式是打上 TODO 标签，比如：

func getSomeNumber() -> [Int] {
    // TODO: 这里临时写死，需求待确认
    return [1, 2, 3]
}

这样写完，编译时就会产生一个 TODO 的警告，但是这种方法有些明显的问题：

1. TODO 太多的时候可能会被忽略掉

2. 上线前可能会忘记处理

3. 即使运行在线上，也不会报任何的错误

为了解决这种问题，使用 #error 是比较合适的，比如为了的 Debug 时正常运行，可以在 Release 下报一个人编译错误，以防止跑到线上：

func getSomeNumber() -> [Int] {
    // TODO: 这里临时写死，需求待确认
    #if DEBUG
    return [1, 2, 3]
    #else
    #error("函数尚未实现，需要及时处理！！！")
    #endif
}

这段代码在 Debug 时完全可以通过，但是一旦跑在 Release 下，就会编译失败，及时提醒需要处理：

2、Demo 中的一些重要提示

如果你在开发一个 Framework，在提供出去给其他人演示的 Demo 里肯定不能放一些你自己的敏感信息的，比如 api_token 之类的，这时候就需要加上一个 #error 来引导使用者替换他们自己的 token：

#error("请先替换你自己的 token，前往 https://xxx.com/ 申请")
let api_token = "1234567890"

这样，当别人首次运行你的 Demo 时，就会因为编译错误而注意到这个必要事项：

3、平台支持

如果你的 Framework 只支持某个平台，那么也可以用 #error 来告诉用户：

#if os(macOS)
    #error("这个 Framework 不支持 macOS 哦～")
#endif

或者：

#if !canImport(UIKit)
  #error("这个 Framework 需要 UIKit 才能使用哦～")
#endif

结语

以上就是今天分享的 #error 的一些妙用，你还知道其他的场景吗？也可以分享给我。

这里每天分享一个 iOS 的新知识，快来关注我吧

本文同步自微信公众号 "iOS新知"，每天准时分享一个新知识，这里只是同步，想要及时学到就来关注我吧！