webentwicklung-frage-antwort-db.com.de

Logging Methodensignatur mit swift

Ich versuche, meine Protokollierungsklasse neu zu schreiben, und ich würde gerne wissen, wie man PRETTY_FUNCTION oder NSStringFromSelector (_cmd) in einer Swift-Datei ersetzt, um die Methodenaufrufe zu verfolgen.

48
Essa A. Haddad

Schauen Sie sich eine neue Bibliothek an, die ich gerade veröffentlicht habe: https://github.com/DaveWoodCom/XCGLogger

Es ist eine Debug-Protokollierungsbibliothek für Swift.

Um die #function-Makros verwenden zu können, müssen Sie sie als Standardwerte für Ihre Protokollierungsfunktion festlegen. Der Compiler füllt sie dann mit den erwarteten Werten aus.

func log(logMessage: String, functionName: String = #function) {
    print("\(functionName): \(logMessage)")
}

Dann rufen Sie einfach an:

log("my message")

Und es funktioniert wie erwartet und gibt dir so etwas wie:

whateverFunction(): my message

Weitere Informationen zur Funktionsweise: https://www.cerebralgardens.com/blog/entry/2016/06/09/the-first-essential-Swift-3rd-party-library-to-include-in-your -projekt

56
Dave Wood

Spezielle Literale in Swift lauten wie folgt (aus [der Swift Anleitung])

#file String Der Name der Datei, in der sie angezeigt wird.

#line Int Die Zeilennummer, auf der es erscheint.

#column Int Die Spaltennummer, in der es beginnt.

#function String Der Name der Deklaration, in der sie vorkommt.


Vor Swift 2.2b4 waren dies

( https://developer.Apple.com/library/content/documentation/Swift/Conceptual/Swift_Programming_Language/Expressions.html )):

__FILE__ String Der Name der Datei, in der sie angezeigt wird.

__LINE__ Int Die Zeilennummer, auf der es erscheint.

__COLUMN__ Int Die Spaltennummer, in der es beginnt.

__FUNCTION__ String Der Name der Deklaration, in der sie vorkommt.

Sie können diese in Protokollanweisungen wie folgt verwenden:

println("error occurred on line \(__LINE__) in function \(__FUNCTION__)")

89
Nick

Ich würde so etwas verwenden:

func Log(message: String = "", _ path: String = __FILE__, _ function: String = __FUNCTION__) {
    let file = path.componentsSeparatedByString("/").last!.componentsSeparatedByString(".").first! // Sorry
    NSLog("\(file).\(function): \(message)")
}

Verbesserungen gegenüber früheren Antworten:

  • Verwendet NSLog, nicht print/println
  • Verwendet lastPathComponent nicht mehr, was für Strings nicht mehr verfügbar ist
  • Die Protokollmeldung ist optional
9
pipacs

Hier ist was ich verwendet habe: https://github.com/goktugyil/QorumLogs
Es ist wie XCGLogger, aber besser.

func myLog<T>(object: T, _ file: String = __FILE__, _ function: String = __FUNCTION__, _ line: Int = __LINE__) {
    let info = "\(file).\(function)[\(line)]:\(object)"
    print(info)
}
5
Esqarrouth

Versuche dies:

class Log {
    class func msg(message: String,
        functionName:  String = __FUNCTION__, fileNameWithPath: String = __FILE__, lineNumber: Int = __LINE__ ) {
        // In the default arguments to this function:
        // 1) If I use a String type, the macros (e.g., __LINE__) don't expand at run time.
        //  "\(__FUNCTION__)\(__FILE__)\(__LINE__)"
        // 2) A Tuple type, like,
        // typealias SMLogFuncDetails = (String, String, Int)
        //  SMLogFuncDetails = (__FUNCTION__, __FILE__, __LINE__) 
        //  doesn't work either.
        // 3) This String = __FUNCTION__ + __FILE__
        //  also doesn't work.

        var fileNameWithoutPath = fileNameWithPath.lastPathComponent

#if DEBUG
        let output = "\(NSDate()): \(message) [\(functionName) in \(fileNameWithoutPath), line \(lineNumber)]"
        println(output)
#endif
    }
}

Log mit:

let x = 100
Log.msg("My output message \(x)")
5
Chris Prince

Für Swift 3 und höher: 

print("\(#function)")
4
Yasir Ali

Ab Swift 2.2 können Sie es mit Literal Expressions Angeben, wie im Swift Programming Language Guide beschrieben.

Wenn Sie also eine Logger -Struktur mit einer Funktion hätten, die protokolliert, wo der Fehler aufgetreten ist, würden Sie sie folgendermaßen aufrufen:

Logger().log(message, fileName: #file, functionName: #function, atLine: #line)

3
luizParreira

Dies wird nur im Debug-Modus gedruckt:

func debugLog(text: String,  fileName: String = __FILE__, function: String =  __FUNCTION__, line: Int = __LINE__) {
    debugPrint("[\((fileName as NSString).lastPathComponent), in \(function)() at line: \(line)]: \(text)")
}

Ergebnis:

"[Book.Swift, in addPage() at line: 33]: Page added with success"
3
tesla

Dadurch erhalten Sie die Klasse und den Funktionsnamen auf einmal:

var name = NSStringFromClass(self.classForCoder) + "." + __FUNCTION__
2
floohh

Swift 4, basierend auf all diesen großartigen Antworten. ❤️

/*
 That's how I protect my virginity.
*/

import Foundation

/// Based on [this SO question](https://stackoverflow.com/questions/24048430/logging-method-signature-using-Swift).
class Logger {

    // MARK: - Lifecycle

    private init() {} // Disallows direct instantiation e.g.: "Logger()"

    // MARK: - Logging

    class func log(_ message: Any = "",
                   withEmoji: Bool = true,
                   filename: String = #file,
                   function: String =  #function,
                   line: Int = #line) {

        if withEmoji {
            let body = emojiBody(filename: filename, function: function, line: line)
            emojiLog(messageHeader: emojiHeader(), messageBody: body)

        } else {
            let body = regularBody(filename: filename, function: function, line: line)
            regularLog(messageHeader: regularHeader(), messageBody: body)
        }

        let messageString = String(describing: message)
        guard !messageString.isEmpty else { return }
        print(" └ ???? \(messageString)\n")
    }
}

// MARK: - Private

// MARK: Emoji

private extension Logger {

    class func emojiHeader() -> String {
        return "⏱ \(formattedDate())"
    }

    class func emojiBody(filename: String, function: String, line: Int) -> String {
        return "???? \(filenameWithoutPath(filename: filename)), in ???? \(function) at #️⃣ \(line)"
    }

    class func emojiLog(messageHeader: String, messageBody: String) {
        print("\(messageHeader) │ \(messageBody)")
    }
}

// MARK: Regular

private extension Logger {

    class func regularHeader() -> String {
        return " \(formattedDate()) "
    }

    class func regularBody(filename: String, function: String, line: Int) -> String {
        return " \(filenameWithoutPath(filename: filename)), in \(function) at \(line) "
    }

    class func regularLog(messageHeader: String, messageBody: String) {
        let headerHorizontalLine = horizontalLine(for: messageHeader)
        let bodyHorizontalLine = horizontalLine(for: messageBody)

        print("┌\(headerHorizontalLine)┬\(bodyHorizontalLine)┐")
        print("│\(messageHeader)│\(messageBody)│")
        print("└\(headerHorizontalLine)┴\(bodyHorizontalLine)┘")
    }

    /// Returns a `String` composed by horizontal box-drawing characters (─) based on the given message length.
    ///
    /// For example:
    ///
    ///     " ViewController.Swift, in viewDidLoad() at 26 " // Message
    ///     "──────────────────────────────────────────────" // Returned String
    ///
    /// Reference: [U+250x Unicode](https://en.wikipedia.org/wiki/Box-drawing_character)
    class func horizontalLine(for message: String) -> String {
        return Array(repeating: "─", count: message.count).joined()
    }
}

// MARK: Util

private extension Logger {

    /// "/Users/blablabla/Class.Swift" becomes "Class.Swift"
    class func filenameWithoutPath(filename: String) -> String {
        return URL(fileURLWithPath: filename).lastPathComponent
    }

    /// E.g. `15:25:04.749`
    class func formattedDate() -> String {
        let dateFormatter = DateFormatter()
        dateFormatter.dateFormat = "HH:mm:ss.SSS"
        return "\(dateFormatter.string(from: Date()))"
    }
}

Aufruf mit Logger.log() - (Emoji ist standardmäßig aktiviert):

 emojiLog


Aufruf mit Logger.log(withEmoji: false):

 regularLog


Weitere Anwendungsbeispiele:

Logger.log()
Logger.log(withEmoji: false)
Logger.log("I'm a virgin.")
Logger.log("I'm a virgin.", withEmoji: false)
Logger.log(NSScreen.min.frame.maxX) // Can handle "Any" (not only String).
1
backslash-f

dies scheint in Swift 3.1 gut zu funktionieren

print("File: \((#file as NSString).lastPathComponent) Func: \(#function) Line: \(#line)")
1
lozflan

Swift 3 unterstützt das debugLog-Objekt mit Datum, Funktionsname, Dateiname und Zeilennummer:

public func debugLog(object: Any, functionName: String = #function, fileName: String = #file, lineNumber: Int = #line) {
    let className = (fileName as NSString).lastPathComponent
    print("\(NSDate()): <\(className)> \(functionName) [#\(lineNumber)]| \(object)\n")
}
1
Chanraksmey

Hier ist meine Meinung dazu.

func Log<T>(_ object: Shit, _ file: String = #file, _ function: String = #function, _ line: Int = #line) {

var filename = (file as NSString).lastPathComponent
filename = filename.components(separatedBy: ".")[0]

let currentDate = Date()
let df = DateFormatter()
df.dateFormat = "HH:mm:ss.SSS"

print("┌──────────────┬───────────────────────────────────────────────────────────────")
print("│ \(df.string(from: currentDate)) │ \(filename).\(function) (\(line))")
print("└──────────────┴───────────────────────────────────────────────────────────────")
print("  \(object)\n")}

Ich hoffe dir gefällt es.

 enter image description here

1
deeJ

Es gibt eine neue Bibliothek, die ich veröffentlicht habe: Printer .

Es gibt viele Funktionen, mit denen Sie sich auf verschiedene Arten anmelden können.

So protokollieren Sie eine Erfolgsmeldung:

Printer.log.success(details: "This is a Success message.")

Ausgabe:

Printer ➞ [✅ Success] [⌚04-27-2017 10:53:28] ➞ ✹✹This is a Success message.✹✹
[Trace] ➞ ViewController.Swift ➞ viewDidLoad() #58

Disclaimer: Diese Bibliothek wurde von mir erstellt.

0
Hemang
func Log<T>(_ object: T, fileName: String = #file, function: String =  #function, line: Int = #line) {
    NSLog("\((fileName as NSString).lastPathComponent), in \(function) at line: \(line): \(object)")
}
0
hariszaman

Eine alternative Version mit os_log könnte sein:

func Log(_ msg: String = "", _ file: NSString = #file, _ function: String = #function) {
    let baseName = file.lastPathComponent.replacingOccurrences(of: ".Swift", with: "")
    os_log("%{public}@:%{public}@: %@", type: .default, baseName, function, msg)
}

Wenn Sie sich das nicht leisten können, verwenden Sie os_log einfach direkt.

0
pipacs