Swift 语言中的 #ifdef 替换

Question

在 C/C++/Objective C 中，您可以使用编译器预处理器定义宏。 此外，您可以使用编译器预处理器包含/排除代码的某些部分。

#ifdef DEBUG
    // Debug-only code
#endif

Swift 中有类似的解决方案吗？

Answer 1

是的，你可以做到。

在 Swift 中，您仍然可以根据Apple 文档使用“#if/#else/#endif”预处理器宏（尽管受到更多限制）。 下面是一个例子：

#if DEBUG
    let a = 2
#else
    let a = 3
#endif

现在，您必须在别处设置“DEBUG”符号。 在“Swift Compiler - Custom Flags”部分的“Other Swift Flags”行中设置它。 您可以使用-D DEBUG条目添加 DEBUG 符号。

像往常一样，您可以在 Debug 或 Release 中设置不同的值。

我在实际代码中对其进行了测试，并且可以正常工作； 不过在操场上似乎没有人认出它。

你可以在这里阅读我的原帖。

---

重要说明： -DDEBUG=1不起作用。 只有-D DEBUG有效。 似乎编译器忽略了具有特定值的标志。

Answer 2

如Apple Docs 所述

Swift 编译器不包含预处理器。 相反，它利用编译时属性、构建配置和语言特性来完成相同的功能。 出于这个原因，预处理器指令不会在 Swift 中导入。

通过使用自定义构建配置，我设法实现了我想要的：

1. 转到您的项目/选择您的目标/构建设置/搜索自定义标志
2. 对于您选择的目标，使用 -D 前缀（不带空格）设置您的自定义标志，用于调试和发布
3. 为您拥有的每个目标执行上述步骤

以下是检查目标的方法：

#if BANANA
    print("We have a banana")
#elseif MELONA
    print("Melona")
#else
    print("Kiwi")
#endif

使用 Swift 2.2 测试

Answer 3

在许多情况下，您并不真正需要条件编译； 您只需要可以打开和关闭的条件行为。 为此，您可以使用环境变量。 这具有您实际上不必重新编译的巨大优势。

您可以在方案编辑器中设置环境变量，并轻松打开或关闭它：

您可以使用 NSProcessInfo 检索环境变量：

    let dic = NSProcessInfo.processInfo().environment
    if dic["TRIPLE"] != nil {
        // ... do secret stuff here ...
    }

这是一个现实生活中的例子。 我的应用程序仅在设备上运行，因为它使用模拟器上不存在的音乐库。 那么，如何在模拟器上为我不拥有的设备拍摄屏幕截图？ 没有这些屏幕截图，我无法提交到 AppStore。

我需要假数据和不同的处理方式。 我有两个环境变量：一个在打开时告诉应用程序在我的设备上运行时从真实数据生成假数据； 另一个，当打开时，在模拟器上运行时使用假数据（不是丢失的音乐库）。 由于方案编辑器中的环境变量复选框，打开/关闭这些特殊模式中的每一个都很容易。 好处是我不能在我的 App Store 构建中意外使用它们，因为存档没有环境变量。

Answer 4

Xcode 8 对ifdef替换进行了重大更改。即使用Active Compilation Conditions 。

请参阅Xcode 8 发行说明中的构建和链接。

新的构建设置

新设置： SWIFT_ACTIVE_COMPILATION_CONDITIONS

“Active Compilation Conditions” is a new build setting for passing conditional compilation flags to the Swift compiler.

以前，我们必须在 OTHER_SWIFT_FLAGS 下声明您的条件编译标志，记住在设置前加上“-D”。 例如，要使用 MYFLAG 值有条件地编译：

#if MYFLAG1
    // stuff 1
#elseif MYFLAG2
    // stuff 2
#else
    // stuff 3
#endif

要添加到设置-DMYFLAG的值

现在我们只需要将值 MYFLAG 传递给新设置。 是时候移动所有这些条件编译值了！

有关 Xcode 8 中更多 Swift 构建设置功能，请参阅以下链接： http : //www.miqu.me/blog/2016/07/31/xcode-8-new-build-settings-and-analyzer-improvements/

Answer 5

从 Swift 4.1 开始，如果您只需要检查代码是使用调试配置还是发布配置构建的，您可以使用内置函数：

• _isDebugAssertConfiguration() （当优化设置为-Onone时为-Onone ）
• _isReleaseAssertConfiguration() （当优化设置为-O时为真） （在 Swift 3+ 上不可用）
• _isFastAssertConfiguration() （当优化设置为-Ounchecked时为-Ounchecked ）

例如

func obtain() -> AbstractThing {
    if _isDebugAssertConfiguration() {
        return DecoratedThingWithDebugInformation(Thing())
    } else {
        return Thing()
    }
}

与预处理器宏相比，

• ✓ 你不需要定义一个自定义的-D DEBUG标志来使用它
• ~ 其实是从优化设置的角度定义的，不是Xcode构建配置

• ✗ 未记录，这意味着该函数可以在任何更新中删除（但它应该是 AppStore 安全的，因为优化器会将这些转换为常量）

  • 这些曾经被删除，但由于缺乏@testable属性而重新公开，未来 Swift 的命运不确定。

• ✗ 在 if/else 中使用将始终生成“永远不会被执行”警告。

Answer 6

Xcode 8 及以上

在Build settings/Swift compiler-Custom flags 中使用Active Compilation Conditions设置。

• 这是将条件编译标志传递给 Swift 编译器的新构建设置。
• 简单地添加如下标志： ALPHA 、 BETA等。

然后用这样的编译条件检查它：

#if ALPHA
    //
#elseif BETA
    //
#else
    //
#endif

提示：您也可以使用#if !ALPHA等。

Answer 7

没有 Swift 预处理器。 （一方面，任意代码替换破坏了类型和内存安全。）

不过，Swift 确实包含构建时配置选项，因此您可以有条件地包含某些平台或构建样式的代码，或者响应您使用-D编译器参数定义的标志。 但是，与 C 不同的是，代码的条件编译部分必须在语法上完整。 在将 Swift 与 Cocoa 和 Objective-C一起使用中有一节是关于这个的。

例如：

#if os(iOS)
    let color = UIColor.redColor()
#else
    let color = NSColor.redColor()
#endif

Answer 8

基于活动编译条件的 isDebug 常量

另一个可能更简单的解决方案仍然会产生一个布尔值，您可以将其传递给函数，而无需在整个代码库中添加#if条件，就是将DEBUG定义为项目构建目标的Active Compilation Conditions并包括以下内容（我将其定义为全局常量）：

#if DEBUG
    let isDebug = true
#else
    let isDebug = false
#endif

---

基于编译器优化设置的 isDebug 常量

这个概念建立在kennytm 的回答之上

与 kennytm 相比的主要优势在于，这不依赖于私有或未记录的方法。

在Swift 4 中：

let isDebug: Bool = {
    var isDebug = false
    // function with a side effect and Bool return value that we can pass into assert()
    func set(debug: Bool) -> Bool {
        isDebug = debug
        return isDebug
    }
    // assert:
    // "Condition is only evaluated in playgrounds and -Onone builds."
    // so isDebug is never changed to true in Release builds
    assert(set(debug: true))
    return isDebug
}()

与预处理器宏和 kennytm 的回答相比，

• ✓ 你不需要定义一个自定义的-D DEBUG标志来使用它
• ~ 其实是从优化设置的角度定义的，不是Xcode构建配置

• ✓ 已记录，这意味着该功能将遵循正常的 API 发布/弃用模式。

• ✓ 在 if/else 中使用不会产生“永远不会被执行”的警告。

Answer 9

我的 Xcode 8 两分钱：

a) 使用-D前缀的自定义标志可以正常工作，但是...

b) 更简单的使用：

在 Xcode 8 中有一个新部分：“Active Compilation Conditions”，已经有两行，用于调试和发布。

只需添加您的定义而不添加-D 。

Answer 10

Moignans 的回答在这里工作正常。 这是另一条信息，以防万一，

#if DEBUG
    let a = 2
#else
    let a = 3
#endif

您可以否定如下所示的宏，

#if !RELEASE
    let a = 2
#else
    let a = 3
#endif

Answer 11

在使用 Xcode 9.4.1、Swift 4.1 创建的 Swift 项目中

#if DEBUG
#endif

默认情况下工作，因为在预处理器宏中 DEBUG=1 已经由 Xcode 设置。

所以你可以使用#if DEBUG“开箱即用”。

顺便说一句，Apple 的书 The Swift Programming Language 4.1（编译器控制语句部分）中编写了一般如何使用条件编译块，以及如何编写编译标志以及 Swift 中 C 宏的对应部分编写在另一本 Apple 的书 Using Swift with Cocoa and Objective C（在 Preprocessor Directives 部分）

希望以后苹果会为他们的书写出更详细的内容和索引。

Answer 12

Xcode 9 及以上

#if DEVELOP
    //
#elseif PRODCTN
    //
#else
    //
#endif

Answer 13

有一些处理器会接受参数，我在下面列出了它们。 您可以根据需要更改参数：

#if os(macOS) /* Checks the target operating system */

#if canImport(UIKit) /* Check if a module presents */

#if swift(<5) /* Check the Swift version */

#if targetEnvironment(simulator) /* Check envrionments like Simulator or Catalyst */

#if compiler(<7) /* Check compiler version */

此外，您可以使用任何自定义标志，如DEBUG或您定义的任何其他标志

#if DEBUG
print("Debug mode")
#endif

Answer 14

在GCC_PREPROCESSOR_DEFINITIONS构建设置中设置DEBUG=1 ，我更喜欢使用函数进行此调用：

func executeInProduction(_ block: () -> Void)
{
    #if !DEBUG
        block()
    #endif
}

然后在这个函数中包含我想在调试版本中省略的任何块：

executeInProduction {
    Fabric.with([Crashlytics.self]) // Compiler checks this line even in Debug
}

相比之下的优势：

#if !DEBUG
    Fabric.with([Crashlytics.self]) // This is not checked, may not compile in non-Debug builds
#endif

是编译器检查了我的代码的语法，所以我确信它的语法是正确的并且构建。

Answer 15

![在 Xcode 8 及以上版本中，转到构建设置 -> 搜索自定义标志] 1

在代码中

 #if Live
    print("Live")
    #else
    print("debug")
    #endif

Answer 16

func inDebugBuilds(_ code: () -> Void) {
    assert({ code(); return true }())
}

来源

Answer 17

这建立在Jon Willis 的答案之上，该答案依赖于断言，它仅在调试编译中执行：

func Log(_ str: String) { 
    assert(DebugLog(str)) 
}
func DebugLog(_ str: String) -> Bool { 
    print(str) 
    return true
}

我的用例是记录打印语句。 这是 iPhone X 上发布版本的基准测试：

let iterations = 100_000_000
let time1 = CFAbsoluteTimeGetCurrent()
for i in 0 ..< iterations {
    Log ("⧉ unarchiveArray:\(fileName) memoryTime:\(memoryTime) count:\(array.count)")
}
var time2 = CFAbsoluteTimeGetCurrent()
print ("Log: \(time2-time1)" )

印刷：

Log: 0.0

看起来 Swift 4 完全消除了函数调用。

Answer 18

斯威夫特 5 更新马特的答案

let dic = ProcessInfo.processInfo.environment
if dic["TRIPLE"] != nil {
// ... do your secret stuff here ...
}