# JJSwiftLog

**Repository Path**: git-forking/JJSwiftLog

## Basic Information

- **Project Name**: JJSwiftLog
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-02
- **Last Updated**: 2021-12-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![CocoaPods Compatible](https://img.shields.io/cocoapods/v/JJSwiftLog.svg)](https://img.shields.io/cocoapods/v/JJSwiftLog.svg)
[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![Platform](https://img.shields.io/cocoapods/p/JJSwiftLog.svg?style=flat)](http://cocoadocs.org/docsets/JJSwiftLog)
![License MIT](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)

# JJSwiftLog

![JJSwiftLog screenshot](https://raw.githubusercontent.com/jezzmemo/JJSwiftLog/master/screenshots/main.jpg)

使用Unix file descriptor的stdout原理，将日志模块的日志输出到stdout,然后将日志抽象成接口，内置控制台和文件日志，由开发者自行添加，自定义日志可以满足自行分发到任意渠道.

## 主要功能

- [x] 控制台展示(Console Log)

- [x] 日志文件存储(File Log)

- [x] 用户自定义日志,实现`JJLogOutput`协议即可

- [x] 全局开关日志

- [x] 只显示指定文件日志

- [x] 自定义日志格式, 内置样式供开发者选择

## 如何安装

*  Swift 4.0+


__Podfile__


```
pod 'JJSwiftLog'
```

__Carthage__

```
github "jezzmemo/JJSwiftLog"
```

__Swift Package Manager__

```
.package(url: "https://github.com/jezzmemo/JJSwiftLog.git"),
```

## 如何使用

* 导入模块

```
import JJSwiftLog
```

* 使用示例

```swift
override func viewDidLoad() {
     super.viewDidLoad()
     var file = JJFileOutput()
     file?.targetMaxFileSize = 1000 * 1024
     file?.targetMaxTimeInterval = 600
     file?.targetMaxLogFiles = 20
     JJLogger.addLogOutput(file)
     #if DEBUG
     JJLogger.addLogOutput(JJConsoleOutput())
     #endif
     JJLogger.verbose("verbose")
     JJLogger.debug("debug")   
     JJLogger.info("info")
     JJLogger.warning("warn")
     JJLogger.error("error")
     // 任意类型
     JJLogger.verbose(123)
     JJLogger.debug(1.2)
     JJLogger.info(Date())
     JJLogger.warning(["1", "2"])
}
```

* `JJConsoleOutput`可以使用 `NSLog`样式,使用`isUseNSLog`属性即可

```swift
var console = JJConsoleOutput()
console.isUseNSLog = false
```

* `JJFileOutput`有几个属性可以调整存储文件策略

    * `targetMaxFileSize`文件最大体积

    * `targetMaxTimeInterval`生成新文件间隔

    * `targetMaxFileSize`文件最大个数，如果超出这个数，就会删除之前的文件

```swift
var file = JJFileOutput()
file?.targetMaxFileSize = 1000 * 1024
file?.targetMaxTimeInterval = 600
file?.targetMaxLogFiles = 20
```

* 使用`enable`，实时开关日志，默认是开启的

```swift
JJLogger.enable = true
```

* 使用`onlyLogFile`方法，让指定文件显示日志

```swift
JJLogger.onlyLogFile("ViewController")
```

* JJSwiftLog支持自定义格式日志，以下表格是简写字母对应关系:

| 简写   | 描述     |
|------|--------|
| %M | 日志文本 |
| %L | 日志级别 |
| %l | 行数 |
| %F | 文件名，不带后缀 |
| %f | 函数名 |
| %D | 日期(目前仅支持yyyy-MM-dd HH:mm:ss.SSSZ) |
| %T | 线程，如果主线程不显示，子线程显示地址 |
| %t | 显示HH:mm:ss格式 |
| %d | 显示yyyy-MM-dd格式 |
| %N | 文件名，带后缀 |

代码示例:

```swift
JJLogger.format = "%M %F %L%l %f %D"
```

还内置了一些样式，如:`JJLogger.format = JJSwiftLog.simpleFormat`,样式如下:

```
2020-04-08 22:56:54.888+0800 -> ViewController:18 - setupVendor(parameter:) method set the parameter
2020-04-08 22:56:54.889+0800 -> ViewController:28 - viewDidLoad() Start the record
2020-04-08 22:56:54.889+0800 -> ViewController:29 - viewDidLoad() Debug the world
2020-04-08 22:56:54.890+0800 -> ViewController:30 - viewDidLoad() Show log info
2020-04-08 22:56:54.890+0800 -> ViewController:31 - viewDidLoad() Build warning
2020-04-08 22:56:54.890+0800 -> ViewController:32 - viewDidLoad() can’t fetch user info without user id
```

* 高级使用，根据需要实现自定义接口`JJLogOutput`，示例如下:

```swift
public struct CustomerOutput: JJLogOutput {
    
    /// 自定义队列
    public var queue: DispatchQueue? {
        return nil
    }
    
    /// 重写日志的级别
    public var logLevel: JJSwiftLog.Level {
        get {
            return _consoleLevel
        }
        set {
            _consoleLevel = newValue
        }
    }
    
    /// 获取日志方法，本地或者网络都可以
    public func log(_ level: JJSwiftLog.Level, msg: String, thread: String,
     file: String, function: String, line: Int) {
    }
    
}
```

## TODO(记得给我星哦)

* 线程信息的展示
* 组件的启动信息

## Linker
* [保护App不闪退](https://github.com/jezzmemo/JJException)

## License
JJSwiftLog is released under the MIT license. See LICENSE for details.