web-dev-qa-db-fra.com

Logging Method signature à l'aide de swift

J'essaye de réécrire ma classe de journalisation et j'aimerais savoir comment remplacer PRETTY_FUNCTION ou NSStringFromSelector (_cmd) dans un fichier Swift afin de suivre les appels de méthode?

ioscmdswiftios8
48
Essa A. Haddad

Découvrez une nouvelle bibliothèque que je viens de publier: https://github.com/DaveWoodCom/XCGLogger

C'est une bibliothèque de journalisation de débogage pour Swift.

La clé pour pouvoir utiliser les macros #function consiste à les définir comme valeurs par défaut pour votre fonction de journalisation. Le compilateur les remplira ensuite en utilisant les valeurs attendues.

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

Alors appelez juste:

log("my message")

Et cela fonctionne comme prévu vous donnant quelque chose comme:

whateverFunction(): my message

Plus d'informations sur la façon dont cela fonctionne: https://www.cerebralgardens.com/blog/entry/2014/06/09/the-first-essential-Swift-3rd-party-library-to-include-in-your -projet

56
Dave Wood

J'utiliserais quelque chose comme ça:

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

Améliorations par rapport aux réponses précédentes:

  • Utilise NSLog, pas print/println
  • N'utilise plus lastPathComponent qui n'est plus disponible sur les chaînes
  • Le message de log est facultatif
9
pipacs

Voici ce que j'ai utilisé dans: https://github.com/goktugyil/QorumLogs
C'est comme XCGLogger mais en mieux.

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

Essaye ça:

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
    }
}

Connectez-vous en utilisant:

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

Pour Swift 3 et plus: 

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

Cela n'imprimera qu'en mode débogage:

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

Résultat:

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

Cela vous donnera la classe et le nom de la fonction en une fois:

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

Swift 4, basé sur toutes ces réponses géniales. ❤️

/*
 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()))"
    }
}

Appeler avec Logger.log() - (emoji est activé par défaut):

 emojiLog

Appeler avec Logger.log(withEmoji: false):

 regularLog

Plus d'exemples d'utilisation:

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

cela semble fonctionner correctement dans Swift 3.1

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

Swift 3 supporte l’objet debugLog avec date, nom de fonction, nom de fichier, numéro de ligne:

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

Voici mon point de vue là-dessus.

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")}

Espérons que vous apprécierez.

 enter image description here

1
deeJ

J'ai publié une nouvelle bibliothèque: Printer .

Il a de nombreuses fonctions pour vous permettre de vous connecter de différentes manières.

Pour enregistrer un message de réussite:

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

Sortie:

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

Disclaimer: Cette bibliothèque a été créée par moi.

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

Une version alternative, utilisant os_log, pourrait être:

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)
}

Toujours lourd sur le traitement des chaînes, si vous ne pouvez vous le permettre, utilisez directement os_log.

0
pipacs