println()
如果我不在Debug版本中,我想全局忽略Swift代码中的所有调用。为此,我找不到任何可靠的逐步说明,希望能提供一些指导。有没有办法做到这一点从全球来看,还是我需要围绕每一个println()
与#IF DEBUG/#ENDIF
报表?
Answers:
最简单的方法是将自己的全局函数放在Swift的前面println
:
func println(object: Any) {
Swift.println(object)
}
当需要停止记录时,只需注释掉该函数的主体即可:
func println(object: Any) {
// Swift.println(object)
}
或者您可以通过使用条件使其自动:
func println(object: Any) {
#if DEBUG
Swift.println(object)
#endif
}
编辑在Swift 2.0println
中更改为print
。不幸的是,它现在具有可变参数的第一个参数。这很酷,但是这意味着您不能轻易覆盖它,因为Swift没有“ splat”运算符,因此您不能在代码中传递可变参数(只能按字面意义创建)。但是您可以制作一个简化版本,该版本在仅打印一个值的情况下(通常是这样)起作用:
func print(items: Any..., separator: String = " ", terminator: String = "\n") {
Swift.print(items[0], separator:separator, terminator: terminator)
}
在Swift 3中,您需要隐藏第一个参数的外部标签:
func print(_ items: Any..., separator: String = " ", terminator: String = "\n") {
Swift.print(items[0], separator:separator, terminator: terminator)
}
println()
它不是在发布模式下执行的。
println
更改为使用print
。它对您print
不起作用的原因是您的定义与Swift的定义不匹配,因此您不会覆盖它。这是一个小问题,因为正如很多次提到的那样,Swift没有splat运算符,因此您不能传递可变参数。但这对一项有效,您可以通过传递items[0]
。
为Swift 4.x更新:
随着Swift 2.0 / 3.0和Xcode 7/8现已脱离Beta版,对在发行版本中禁用打印功能的方式进行了一些更改。
上面@matt和@Nate Birkholz提到的一些重要点仍然有效。
该println()
功能已被替换为print()
要使用该 #if DEBUG
宏,则必须定义“ Swift Compiler-自定义标志-Other标志”以包含该值-D DEBUG
我建议Swift.print()
在全局范围内覆盖该函数,以便您可以print()
在代码中正常使用该函数,但是它将删除非调试版本的输出。您可以在全局范围内添加以下函数签名,以在Swift 2.0 / 3.0中执行此操作:
func print(items: Any..., separator: String = " ", terminator: String = "\n") {
#if DEBUG
var idx = items.startIndex
let endIdx = items.endIndex
repeat {
Swift.print(items[idx], separator: separator, terminator: idx == (endIdx - 1) ? terminator : separator)
idx += 1
}
while idx < endIdx
#endif
}
注意:我们在此处将默认分隔符设置为空格,将默认终止符设置为换行符。您可以根据需要在项目中进行不同的配置。
希望这可以帮助。
更新:
通常最好将此函数放在全局范围内,以便它位于Swift的 print
函数的。我发现最好的组织方式是在您的项目中添加一个实用程序文件(例如DebugOptions.Swift),您可以在其中将该函数放置在全局范围内。
从Swift 3开始,该++
运算符将被弃用。我已经更新了上面的代码片段以反映此更改。
public func print(_ items: Any..., separator: String = " ", terminator: String = "\n") {
所有这些方法(包括我的方法)的问题在于它们没有消除评估print
参数的开销。无论您使用哪种,这都将是昂贵的:
print(myExpensiveFunction())
唯一合理的解决方案是将实际的打印调用包装在条件编译中(假设DEBUG
仅针对调试版本进行了定义):
#if DEBUG
print(myExpensiveFunction())
#endif
只有这样,才能防止myExpensiveFunction
在发布版本中调用它。
但是,您可以使用autoclosure将评估推回一级。因此,您可以这样重写我的解决方案(这是Swift 3):
func print(_ item: @autoclosure () -> Any, separator: String = " ", terminator: String = "\n") {
#if DEBUG
Swift.print(item(), separator: separator, terminator: terminator)
#endif
}
仅在仅打印一件事的情况下,这解决了该问题,通常是这样。那是因为item()
在发布模式下没有调用它。print(myExpensiveFunction())
因此不再昂贵,因为该调用被包装在一个闭包中而没有被评估,而在释放模式下,则根本不会被评估。
@autoclosure
?
print
声明保留在运输代码中,但这与我在此处的答案有所不同。一个print
声明输出没有发送到您的Xcode独立发布版本的控制台,但它仍然是评估,所以知道如何抑制评估以防万一它是昂贵的或有不必要的副作用仍然有用。
如前所述,我是一名学生,需要对定义的事情有更清楚的了解。经过大量研究,我需要遵循的顺序是:
单击Xcode项目窗口左侧文件导航器顶部的项目名称。此行包含项目名称,有多少个构建目标以及iOS SDK版本。
选择“ Build Settings”选项卡,然后向下滚动到底部附近的“ Swift Compiler-Custom Flags ”部分。单击其他标志旁边的向下箭头以展开该部分。
单击“调试”行以将其选中。将鼠标光标放在该行的右侧,然后双击。将出现一个列表视图。点击+列表视图左下方按钮以添加一个值。文本字段将变为活动状态。
在文本字段中,输入文本-D DEBUG
,然后按Return键以提交该行。
将新的Swift文件添加到您的项目。您将要为文件创建一个自定义类,因此请按照以下内容输入文本:
class Log {
var intFor : Int
init() {
intFor = 42
}
func DLog(message: String, function: String = __FUNCTION__) {
#if DEBUG
println("\(function): \(message)")
#endif
}
}
我今天很难让该类被Xcode接受,因此init可能比必要的要重一些。
现在,您将需要在打算使用新的自定义函数的任何类中引用您的自定义类,而不是println()
在每个适用的类中将其添加为属性:
let logFor = Log()
现在,你可以替换的任何实例println()
与logFor.DLog()
。输出还包括在其中调用该行的函数的名称。
请注意,在类内部函数中,除非将函数的副本作为该类中的类函数进行复制,否则无法调用该函数,并且输入println()
内容也更加灵活,因此无法在每个实例中使用我的代码。
迅捷5
只需在项目中创建一个新文件并将此代码粘贴到:
func print(_ items: Any..., separator: String = " ", terminator: String = "\n") {
#if DEBUG
items.forEach {
Swift.print($0, separator: separator, terminator: terminator)
}
#endif
}
该函数签名与默认的Swift签名匹配,因此它“覆盖”了项目中的函数。如果需要,您仍然可以使用来访问原始文档Swift.print()
。
添加完以上代码后,请print()
照常使用,它将仅在调试版本中打印。
注意:在做forEach
打印每个项目摆脱恼人的阵列支架的周围出现,如果你只是通过打印报表items
直入Swift.print()
。
对于任何不熟悉Swift的人,您可能会想知道到底$0
是什么。它只是代表传递到forEach
块中的第一个参数。该forEach
语句也可以这样写:
items.forEach { item in
Swift.print(item, separator: separator, terminator: terminator)
}
最后,如果您有兴趣,Swift的声明print
如下:
public func print(_ items: Any..., separator: String = " ", terminator: String = "\n")
我在上面的回答反映了确切的Swift实现-尽管我从不打印多于一件东西或更改分隔符/终止符。但是谁知道呢,您可能想要。
这是我使用的一个功能,在Swift 3中可以正常使用:
func gLog<T>( _ object: @autoclosure() -> T, _ file: String = #file, _ function: String = #function, _ line: Int = #line)
{
#if DEBUG
let value = object()
let stringRepresentation: String
if let value = value as? CustomDebugStringConvertible
{
stringRepresentation = value.debugDescription
}
else if let value = value as? CustomStringConvertible
{
stringRepresentation = value.description
}
else
{
fatalError("gLog only works for values that conform to CustomDebugStringConvertible or CustomStringConvertible")
}
let fileURL = NSURL(string: file)?.lastPathComponent ?? "Unknown file"
let queue = Thread.isMainThread ? "UI" : "BG"
let gFormatter = DateFormatter()
gFormatter.dateFormat = "HH:mm:ss:SSS"
let timestamp = gFormatter.string(from: Date())
print("✅ \(timestamp) {\(queue)} \(fileURL) > \(function)[\(line)]: " + stringRepresentation + "\n")
#endif
}
这是它生成的输出的示例:
说明:
绿色的选中标记用于使您能够快速在控制台中查看打印(gLog)消息,有时它们会在其他消息中丢失
时间/日期戳
正在运行的线程-在我的情况下,它是MainThread(我称为UI),或者不是MainThread(我称为BG,对于后台线程)
gLog消息所在的文件的名称
gLog消息所在的文件中的功能
gLog消息的行号
您想打印出的实际gLog消息
希望这对其他人有用!
经过Swift 2.1和Xcode 7.1.1测试
一旦知道Swift编译器删除了空函数,就有一种简单的方法可以将所有print语句从发行版中排除。
旁注:在Objective-C时代,有一个预解析器可用于在编译器启动之前删除NSLog语句,如我在此处的答案所述。但是由于Swift不再具有预解析器,因此该方法不再有效。
这就是我今天用作高级且易于配置的日志功能的方式,而不必担心在发行版本中将其删除。同样,通过设置不同的编译器标志,您可以根据需要调整记录的信息。
您可以根据需要调整功能,欢迎提出任何改进建议!
// Gobal log() function
//
// note that empty functions are removed by the Swift compiler -> use #if $endif to enclose all the code inside the log()
// these log() statements therefore do not need to be removed in the release build !
//
// to enable logging
//
// Project -> Build Settings -> Swift Compiler - Custom flags -> Other Swift flags -> Debug
// add one of these 3 possible combinations :
//
// -D kLOG_ENABLE
// -D kLOG_ENABLE -D kLOG_DETAILS
// -D kLOG_ENABLE -D kLOG_DETAILS -D kLOG_THREADS
//
// you can just call log() anywhere in the code, or add a message like log("hello")
//
func log(message: String = "", filePath: String = #file, line: Int = #line, function: String = #function) {
#if kLOG_ENABLE
#if kLOG_DETAILS
var threadName = ""
#if kLOG_THREADS
threadName = NSThread.currentThread().isMainThread ? "MAIN THREAD" : (NSThread.currentThread().name ?? "UNKNOWN THREAD")
threadName = "[" + threadName + "] "
#endif
let fileName = NSURL(fileURLWithPath: filePath).URLByDeletingPathExtension?.lastPathComponent ?? "???"
var msg = ""
if message != "" {
msg = " - \(message)"
}
NSLog("-- " + threadName + fileName + "(\(line))" + " -> " + function + msg)
#else
NSLog(message)
#endif
#endif
}
在这里设置编译器标志:
带有所有标志的示例输出如下所示:
2016-01-13 23:48:38.026 FoodTracker[48735:4147607] -- [MAIN THREAD] ViewController(19) -> viewDidLoad() - hello
带有log()的代码如下所示:
override func viewDidLoad() { log("hello")
super.viewDidLoad()
// Handle the text field's user input through delegate callbacks
nameTextField.delegate = self
}
斯威夫特4 Xcode 10.0
也许你可以用这个
func dPrint(_ message: @autoclosure () -> Any) {
#if DEBUG
print(message())
#endif
}
使用的原因@autoclosure
是,如果将函数作为消息参数传递,则仅在调试模式下会调用该函数,这会导致性能下降。
与Swift.print(_ items: Any..., separator: String = default, terminator: String = default)
函数不同,我的解决方案只有一个参数,因为在大多数情况下,我们不传递多个参数,因为print函数仅在控制台中显示信息,我们可以将参数转换为String:,"\(param1)"+"\(param2)"
对吗?希望你喜欢我的解决方案
您可以定义debug_println
其内容大致为:
#if DEBUG
println()
#endif
我的解决方案是在上课之前在AppDelegate中使用此代码
// Disable console log in live app
#if !arch(x86_64) && !arch(i386)
public func debugPrint(items: Any..., separator: String = " ", terminator: String = "\n") {
}
public func print(_ items: Any..., separator: String = " ", terminator: String = "\n") {
}
#endif
class AppDelegate: UIResponder, UIApplicationDelegate {
// App Delegate Code
}
对于我的解决方案,我使其变得简单
import UIKit
class DLog: NSObject {
init(title:String, log:Any) {
#if DEBUG
print(title, log)
#endif
}
}
然后显示它只是调用
_ = DLog(title:"any title", log:Any)
我最终使用了这个:
#if DEBUG
func dLog(_ item: @autoclosure () -> Any, _ file: String = #file, _ function: String = #function, _ line: Int = #line) {
print("\(Date()) [\((file as NSString).lastPathComponent):\(line) \(function)] \(item())")
}
#else
func dLog(_ item: @autoclosure () -> Any) {}
#endif
它非常紧凑,可以打印一些有用的信息(时间戳,快速文件名,代码行,函数名),至少在我的测试中,以十六进制编辑器打开时,在应用程序二进制文件中找不到任何记录的字符串。
甚至更简单:利用断言从发行版本中删除并且仅从那里进行调用的事实。这将删除所有日志调用(是的,甚至包括Log.da的调用),因为它们在构建发行版时为空。
但是我也听说打印已被删除以用于发行版本,但无法以书面形式找到它。所以现在,我正在使用这样的东西Log
下面。我在GitHub上有一个更加生动的版本,其中包含表情符号(出于可读性)和日志主题(出于一致性):
https://github.com/Gatada/JBits/blob/master/Project/Utility/Log.swift
public enum Log {
/// A date formatter used to create the timestamp in the log.
///
/// This formatter is only created if it is actually used, reducing the
/// overhead to zero.
static var formatter: DateFormatter?
// MARK: - API
/// Call to print message in debug area.
///
/// Asserts are removed in release builds, which make
/// the function body empty, which caused all calls to
/// be removed as well.
///
/// Result is zero overhead for release builds.
public static func da(_ message: String) {
assert(debugAreaPrint(message))
}
// MARK: - Helpers
/// The function that actually does the printing. It returns `true` to
/// prevent the assert from kicking in on debug builds.
private static func debugAreaPrint(_ message: String) -> Bool {
print("\(timestamp) - \(message)")
return true
}
/// Creates a timestamp used as part of the temporary logging in the debug area.
static private var timestamp: String {
if formatter == nil {
formatter = DateFormatter()
formatter!.dateFormat = "HH:mm:ss.SSS"
}
let date = Date()
return formatter!.string(from: date)
}
}
在代码中:
Log.da("This is only handled in a debug build.")
仅在运行调试版本时才在Xcode调试区域中看到:
13:36:15.047-仅在调试版本中处理。
我的项目是在Objective C中开发的,但是从去年开始,我开始在Swift中合并新代码,因此在下面的解决方案对我有用的Swift中,我将该代码添加到了我的Swift常量文件中:
func print(_ items: Any..., separator: String = " ", terminator: String = "\n") {
#if DEBUG
items.forEach {
Swift.print($0, separator: separator, terminator: terminator)
}
#endif
}