CocoaLumberjack 官方文档翻译

https://github.com/CocoaLumberjack/CocoaLumberjack

在练习双拼，顺手随便翻下，慢慢更新吧，不对之处还请指正。

CocoaLumberjack

CocoaLumberjack is a fast & simple, yet powerful & flexible logging framework for Mac and iOS.
CocoaLumberjack 是一个快速&简单，是 Mac 和 iOS 上强大&灵活的日志框架.

How to get started

怎么开始

• install via CocoaPods
• 通过 CocoaPods 安装

Swift version via CocoaPods

通过 CocoaPods 安装 Swift 版本

platform :ios, '8.0'
pod 'CocoaLumberjack/Swift'
use_frameworks!

Note: Swift is a subspec which will include all the Obj-C code plus the Swift one, so this is sufficient.
For more details about how to use Swift with Lumberjack, see this conversation.

Swift Usage

If you installed using CocoaPods or manually:

import CocoaLumberjack

DDLog.addLogger(DDTTYLogger.sharedInstance()) // TTY = Xcode console
DDLog.addLogger(DDASLLogger.sharedInstance()) // ASL = Apple System Logs

let fileLogger: DDFileLogger = DDFileLogger() // File Logger
fileLogger.rollingFrequency = 60*60*24  // 24 hours
fileLogger.logFileManager.maximumNumberOfLogFiles = 7
DDLog.addLogger(fileLogger)

...

DDLogVerbose("Verbose");
DDLogDebug("Debug");
DDLogInfo("Info");
DDLogWarn("Warn");
DDLogError("Error");

Obj-C version via CocoaPods

通过 CocoaPods 安装 Obj-C 版本

platform :ios, '7.0'
pod 'CocoaLumberjack'

Obj-C usage

Obj-C 用法

If you're using Lumberjack as a framework, you can @import CocoaLumberjack.
如果你在使用 Lumberjack 作为框架，你可以@import CocoaLumberjack.

Otherwise, #import
否则，#import

[DDLog addLogger:[DDTTYLogger sharedInstance]]; // TTY = Xcode console
// TTY = Xcode 控制台
[DDLog addLogger:[DDASLLogger sharedInstance]]; // ASL = Apple System Logs
// ASL = 苹果系统日志

DDFileLogger *fileLogger = [[DDFileLogger alloc] init]; // File Logger
fileLogger.rollingFrequency = 60 * 60 * 24; // 24 hour rolling
fileLogger.logFileManager.maximumNumberOfLogFiles = 7;
[DDLog addLogger:fileLogger];

...

DDLogVerbose(@"Verbose");
DDLogDebug(@"Debug");
DDLogInfo(@"Info");
DDLogWarn(@"Warn");
DDLogError(@"Error");

Installation with Carthage (iOS 8+)

Carthage 的安装方式 （iOS 8+）

Carthage is a lightweight dependency manager for Swift and Objective-C. It leverages CocoaTouch modules and is less invasive than CocoaPods.
Carthage是一个轻量级的 Swift 和 Objective-C 的依赖管理器。它会对 CocoaTouch 模块起作用，比 CocoaPods 影响的东西要少。

To install with Carthage, follow the instruction on Carthage
按照这个指示安装Carthage
Cartfile

github "CocoaLumberjack/CocoaLumberjack"

• or install manually
• read the Getting started guide, check out the FAQ section or the other docs
• if you find issues or want to suggest improvements, create an issue or a pull request
• for all kinds of questions involving CocoaLumberjack, use the Google group or StackOverflow (use #lumberjack).

CocoaLumberjack 2

Migrating to 2.x

迁移至 2.x 版本

• Replace DDLog.h imports by #import .
• 导入用#import 替换 DDLog.h .

Advanced users, third party libraries:

• Replace all DDLogC macros for regular DDLog macros.
• Replace log level (LOG_LEVEL_*) macros with DDLogLevel enum values
• Replace log flag (LOG_FLAG_*) macros with DDLogFlag enum values
• Replace DDLogMessage ivars and method calls to the new ivars and methods
  • logMsg with _message
  • logLevel with _level
  • logFlag with _flag
  • logContext with _context
  • lineNumber with _line (type changed from int to NSUInteger)
  • file with _file (filename contains just the file name, without the extension and the full path)
  • timestamp with _timestamp
  • methodName with function
• Replace DDAbstractLogger formatter to logFormatter
• YSSingleFileLogger ivars are no longer accesible, use the methods instead
• Replace [DDLog addLogger:withLogLevel:] with [DDLog addLogger:withLevel:]

Forcing 1.x

If an included library requires it, you can force CocoaLumberjack 1.x by setting the version before the conflicting library:

pod 'CocoaLumberjack', '~> 1.9'
pod 'ConflictingLibrary'

Features

特色

Lumberjack is Fast & Simple, yet Powerful & Flexible.

It is similar in concept to other popular logging frameworks such as log4j, yet is designed specifically for Objective-C, and takes advantage of features such as multi-threading, grand central dispatch (if available), lockless atomic operations, and the dynamic nature of the Objective-C runtime.
它和其他像 log4j 这样的热门日志记录框架的概念相似，目前只特别针对 Objective-C,在多线程，grand central dispatch（GCD），无锁的原子性操作比较有优势，还有Objective-C 运行时的动态特色。

Lumberjack is Fast

In most cases it is an order of magnitude faster than NSLog.
在大多数情况下，它比 NSLog 快速、有条理。

Lumberjack is Simple

It takes as little as a single line of code to configure lumberjack when your application launches. Then simply replace your NSLog statements with DDLog statements and that's about it. (And the DDLog macros have the exact same format and syntax as NSLog, so it's super easy.)
配置lumberjack 只需要很少的几行代码。只需简单的用DDLog替换 NSLog 。（并且DDLog的宏和NSLog的格式语法完全相同，所以它超级简单）

Lumberjack is Powerful:

One log statement can be sent to multiple loggers, meaning you can log to a file and the console simultaneously. Want more? Create your own loggers (it's easy) and send your log statements over the network. Or to a database or distributed file system. The sky is the limit.
一个日志声明可以被多次发送，意味着你可以同时输出日志到控制台和文件。想要更多？创建你自己的日志器，并且通过网络发送日志，或者发送到数据库、文件分发系统。完全没有限制。

Lumberjack is Flexible:

Configure your logging however you want. Change log levels per file (perfect for debugging). Change log levels per logger (verbose console, but concise log file). Change log levels per xcode configuration (verbose debug, but concise release). Have your log statements compiled out of the release build. Customize the number of log levels for your application. Add your own fine-grained logging. Dynamically change log levels during runtime. Choose how & when you want your log files to be rolled. Upload your log files to a central server. Compress archived log files to save disk space...

This framework is for you if:

如果

• You're looking for a way to track down that impossible-to-reproduce bug that keeps popping up in the field.
• 你在寻找一种方式来跟踪不可复现的bug。
• You're frustrated with the super short console log on the iPhone.
• 你被iphone上非常短的日志所困扰。
• You're looking to take your application to the next level in terms of support and stability.
• 你想让你的应用规范与稳定。
• You're looking for an enterprise level logging solution for your application (Mac or iPhone).
• 你在为你的应用寻找企业级的日志解决方案。

Documentation

说明文档

• Get started using Lumberjack
• Different log levels for Debug and Release builds
  
• Different log levels for each logger
  
• Use colors in the Xcode debugging console
  
• Write your own custom formatters
  
• FAQ
  
• Analysis of performance with benchmarks
  
• Common issues you may encounter and their solutions
  
• AppCode support
• Full Lumberjack documentation
  

Requirements

The current version of Lumberjack requires:

• Xcode 7.3 or later
• iOS 5 or later
• OS X 10.7 or later
• WatchOS 2 or later
• TVOS 9 or later

Backwards compability

• for Xcode 7.2 and 7.1, use the 2.2.0 version
• for Xcode 7.0 or earlier, use the 2.1.0 version
• for Xcode 6 or earlier, use the 2.0.x version
• for OS X < 10.7 support, use the 1.6.0 version

Communication

• If you need help, use Stack Overflow. (Tag 'lumberjack')
• If you'd like to ask a general question, use Stack Overflow.
• If you found a bug, open an issue.
• If you have a feature request, open an issue.
• If you want to contribute, submit a pull request.

Author

• Robbie Hanson
• Love the project? Wanna buy me a coffee? (or a beer :D)
  

  donation

Collaborators

• Ernesto Rivera
• Dmitry Vorobyov
• Bogdan Poplauschi

License

• CocoaLumberjack is available under the BSD license. See the LICENSE file.

Architecture