HDWindowLoggerSwift

iOS端将输出日志log悬浮显示在屏幕上，可以生成日志文件分享，便于在真机没有连接xcode的情况下调试信息。可以分享、筛选log等操作。使用SQLite存储日志信息，支持系统分享和屏幕FPS显示

The iOS side displays the output log log on the screen, and can generate log file sharing, which is convenient for debugging information when the real machine is not connected to xcode. Log information can be filtered and shared. Use SQLite to store log information. support system sharing and FPS

Document for English | Objective-C Version

中文文档 | Objective-C版本

Introduction to English

Project address: https://github.com/DamonHu/HDWindowLoggerSwift

In addition to displaying on the screen, you can set whether to automatically scroll the log for debugging, or you can share the output log to WeChat, twitter, etc. for offline viewing. At the same time, you can search for output content, Sensitive content can be encrypted with a password, and shared files are also encrypted, and can be decrypted online with a password.

The project uses' SQLite 'efficient storage, only records data during the background operation, and not affect the performance of the interface. The foreground operation is efficient. It basically outputs logs synchronously with Xcode, and you can view the GIF chart of the comparison with Xcode log output

Preview GIF picture	Xcode debug GIF

mobile preview	Xcode preview	share & FPS

I. Installation

You can choose to install using cocoaPod, or you can download the source file directly into the project.

1.1, cocoaPod installation

pod 'HDWindowLoggerSwift'

1.2, file installation

You can drag the files in the HDWindowLoggerSwift folder into the project under the project.

II. Use

1、Import header file

Import HDWindowLoggerSwift

2、 display the floating window

HDWindowLoggerSwift.show()

3 、 Print log content

The font colors of the three output methods are different, and the corresponding types of printLog are different.

HDDebugLog(log)	//, the log will not be written to the window, only output in xcode

HDNormalLog (log) // Log's textColor is green

HDWarnLog (log) // log's textColor is yellow

HDErrorLog (log) // Log's textColor is red

HDPrivacyLog (log) // Output of encrypted data, the specific encryption method is described in the following encryption

Output format

13: 45: 00.153> [
  "1111111",
  "22222222",
  "sdjkhfsjkdfjkhsdhjfk",
  "3333sjdhgfhjg"
]

III. more settings

1、Set whether to output all information

HDWindowLoggerSwift.mCompleteLogOut = true

If set to output all debugging information, the output format is as follows, including the output file, the number of lines called, and the function called

13: 51: 38.498> [File: ViewController.swift]: [Line: 41: [Function: onClickButton ()]]-Log:
[
  "1111111",
  "22222222",
  "sdjkhfsjkdfjkhsdhjfk",
  "3333sjdhgfhjg"
]

2、 Whether to output content synchronously in the debug bar at the bottom of xcode

HDWindowLoggerSwift.mDebugAreaLogOut = true

3、Separate log folder for different users

HDWindowLoggerSwift.mUserID = "1001"

4、Clear the log

HDWindowLoggerSwift.cleanLog()

5、hide the entire log window

HDWindowLoggerSwift.hide()

6、only hide the log output window

HDWindowLoggerSwift.hideLogWindow()

7、set the log maximum number of records, 0 is not limited, default value is 100

HDWindowLoggerSwift.mMaxShowCount = 100

8、 delete the local LogFile

HDWindowLoggerSwift.deleteLogFile()

9、 The validity period of the local log file (days), the local log beyond the validity period will be deleted, 0 is no validity period, the default is 7 days

HDWindowLoggerSwift.shared.mLogExpiryDay = 0

10、Get the array of logs. You can specify the date

//today
HDWindowLoggerSwift.getAllLog()

//Special date
HDWindowLoggerSwift.getAllLog(date: Date(timeIntervalSinceNow: 1000))

If you want to get all the log files, you can get the folder where the log is stored, return a URL result, and then traverse to process it yourself

HDWindowLoggerSwift.getDBFolder()

for example

let dbFolder = HDWindowLoggerSwift.getDBFolder()
        
if let enumer = FileManager.default.enumerator(atPath: dbFolder.path) {
    while let file = enumer.nextObject() {
       if let file: String = file as? String {
            if file.hasSuffix(".db") {
	            //Get the specific log file log
                let logFilePath = dbFolder.appendingPathComponent(file, isDirectory: false)              
            }
        }
    }
}

LogContent protocol

If you want to customize the output content, you can integrate and use this type of LogContent protocol. For example, you can print the URL type to output only its path. You can directly set the returned logStringValue.

extension URL: LogContent {
    public var logStringValue: String {
        return self.path
    }
}

IV. sensitive information output encryption and decryption

If there is sensitive information that you don't want users to see when debugging, you can set encryption in two simple steps

// 1. Set the encryption password,  32 characters
HDWindowLoggerSwift.mPrivacyPassword = "12345678901234561234567890123456"

// 2, output encrypted content
HDPrivacyLog ("This is test data 222 for encrypted data")

4.2 Decrypt the contents of the display window

After the setting, the display in the display window is This content is encrypted, please view it after decryption, enter the set encryption password and click decrypt to display the normal encrypted content.

4.1. Decrypting shared files

If the data has been decrypted in the display window, the content of the shared file will not be encrypted at this time, and all content will be displayed.
If it is not decrypted in the display window, the content of the file shared at this time is AES encrypted content, you can search the AES Online Decryption Website to decrypt the content, and the settings are as follows:

Mode: CBC
Fill: Pkcs7
Data block: 128 bits
Offset: abcdefghijklmnop
Encoding: Base64
Character set: UTF8
Password: The password you set in the SDK yourself

Then click Decrypt.

Here are a few online sites recommended, you can also Google it by yourself

V. Other instructions

For the convenience of viewing, it is divided into three types: normal, warning and error. It corresponds to three different colors for easy viewing.
Click the corresponding cell to copy the output log directly to the system clipboard.
Share the system share that is called. Which software you can share depends on which software is installed on your phone.

简体中文介绍

项目地址:https://github.com/DamonHu/HDWindowLoggerSwift

调试窗口可在屏幕上显示，可以设置是否自动滚动日志便于调试，也可以将输出的日志分享到微信、twitter等程序，以便离线查看。同时可以搜索输出内容，敏感内容可以设置密码进行加密，分享出来的文件也会进行加密，可以通过密码在线解密。

该项目使用sqlite高效存储，后台运行期间只记录数据，不会影响界面性能，前台运行效率高，基本和Xcode同步输出日志，可以查看和xCode日志输出的对比gif图

预览gif图	Xcode对比gif图

手机预览图	XCode预览图	分享 & FPS

一、安装

你可以选择使用cocoaPod安装，也可以直接下载源文件拖入项目中

1.1、cocoaPod安装

pod 'HDWindowLoggerSwift'

如果你集成了腾讯的Tencent/wcdb，由于修改优化了sqlite的系统功能，会导致函数名一样报错，可以使用wcdb版本

pod 'HDWindowLoggerSwift/WCDB'

1.2、文件安装

可以将工程底下，HDWindowLoggerSwift文件夹内的文件拖入项目即可

二、使用

简单三步即可调用

1、导入头文件

import HDWindowLoggerSwift

2、显示悬浮窗

HDWindowLoggerSwift.show()

3、打印日志内容

四种输出方式字体颜色显示不同，对应的printLog不同的类型

HDDebugLog(log)	//调试输出，内容不会写入到窗口，只在xcode输出

HDNormalLog(log)	//日志为绿色

HDWarnLog(log)	//日志为黄色

HDErrorLog(log)	//日志为红色

HDPrivacyLog(log)	//加密数据的输出，具体加密方式在下面的加密中说明

log可以为一个、也可以为多个参数

HDNormalLog("点击了按钮111")
HDNormalLog("输出多个",22,33)

输出格式

13:45:00.153  >   [
  "1111111",
  "22222222",
  "sdjkhfsjkdfjkhsdhjfk",
  "3333sjdhgfhjg"
]

三、更多设置

通过其他设置可以实现获取更多功能

1、设置是否输出全部信息

HDWindowLoggerSwift.mCompleteLogOut = true

如果设置为输出全部调试信息，那么输出的格式是下面这样的，包含了输出文件、调用的行数、和调用的函数

13:51:38.498  >   [File:ViewController.swift]:[Line:41:[Function:onClickButton()]]-Log:
[
  "1111111",
  "22222222",
  "sdjkhfsjkdfjkhsdhjfk",
  "3333sjdhgfhjg"
]

2、是否在xcode底部的调试栏同步输出内容

HDWindowLoggerSwift.mDebugAreaLogOut = true

3、针对不同用户设置独立日志文件夹

HDWindowLoggerSwift.mUserID = "1001"

4、清空log

HDWindowLoggerSwift.cleanLog()

5、隐藏整个log窗口

HDWindowLoggerSwift.hide()

6、仅隐藏log输出窗口

HDWindowLoggerSwift.hideLogWindow()

7、设置显示log最大记录数，0为不限制, 默认为100

HDWindowLoggerSwift.mMaxShowCount = 100

8、删除本地日志文件

HDWindowLoggerSwift.deleteLogFile()

9、本地日志文件的有效期（天），超出有效期的本地日志会被删除，0为没有有效期，默认为7天

HDWindowLoggerSwift.mLogExpiryDay = 0

10、获取数据库存储的日志信息数组，也可以指定日期

//获取今日的日志
HDWindowLoggerSwift.getAllLog()
//指定日期
HDWindowLoggerSwift.getAllLog(date: Date(timeIntervalSinceNow: 1000))

如果你想获取所有日志文件，可以获取日志存储的文件夹，返回的是一个URL结果，然后自己进行遍历去处理

HDWindowLoggerSwift.getDBFolder()

例如

let dbFolder = HDWindowLoggerSwift.getDBFolder()
        
if let enumer = FileManager.default.enumerator(atPath: dbFolder.path) {
    while let file = enumer.nextObject() {
         if let file: String = file as? String {
            if file.hasSuffix(".db") {
            	//获取到具体的log文件日志
                let logFilePath = dbFolder.appendingPathComponent(file, isDirectory: false)
             }
         }
    }
}

LogContent协议

如果你想自定义输出的内容，可以集成并该类型的LogContent协议，例如设置打印URL类型只输出它的path，可以直接设置返回的logStringValue即可。

extension URL: LogContent {
    public var logStringValue: String {
        return self.path
    }
}

四、敏感信息输出加密和解密

如果存在敏感信息，不希望用户或者手机调试时看到，简单两步就可以设置加密

//1、设置加密密码，32个字符数字
HDWindowLoggerSwift.mPrivacyPassword = "12345678901234561234567890123456"

//2、输出加密内容
HDPrivacyLog("这个是加密数据的测试数据222")

4.2、显示窗内容解密

设置之后，在显示窗中的显示为该内容已加密，请解密后查看，输入设置的加密密码然后点击解密之后即可显示正常的加密内容。

4.1、分享文件解密

如果已经在显示窗解密了数据，此时分享的文件内容不会加密，会显示所有内容。
如果在显示窗中未解密，此时分享出的文件内容为AES加密内容，可以搜索AES在线解密的网站去解密内容，设置参照下图：

模式: CBC
填充: Pkcs7
数据块: 128位
偏移量: abcdefghijklmnop
编码: Base64
字符集: UTF8
密码: 你自己在sdk中设置的密码

然后点击解密即可。

这里推荐几个在线的网站，你也可以自己百度

五、其他说明

为了查看方便，分为普通、警告、错误三种类型，对应了三种不同的颜色，方便查看
点击对应的cell可以直接将输出log复制到系统剪贴板
分享调用的系统分享，可以分享到哪个软件取决于你手机上安装的有哪些软件。

HDWindowLoggerSwift 2.5.0

HDWindowLoggerSwift 2.5.0

HDWindowLoggerSwift 2.5.0

HDWindowLoggerSwift

Document for English | Objective-C Version

中文文档 | Objective-C版本

Introduction to English

I. Installation

1.1, cocoaPod installation

1.2, file installation

II. Use

1、Import header file

2、 display the floating window

3 、 Print log content

III. more settings

1、Set whether to output all information

2、 Whether to output content synchronously in the debug bar at the bottom of xcode

3、Separate log folder for different users

4、Clear the log

5、hide the entire log window

6、only hide the log output window

7、set the log maximum number of records, 0 is not limited, default value is 100

8、 delete the local LogFile

9、 The validity period of the local log file (days), the local log beyond the validity period will be deleted, 0 is no validity period, the default is 7 days

10、Get the array of logs. You can specify the date

LogContent protocol

IV. sensitive information output encryption and decryption

4.2 Decrypt the contents of the display window

4.1. Decrypting shared files

V. Other instructions

简体中文介绍

一、安装

1.1、cocoaPod安装

1.2、文件安装

二、使用

1、导入头文件

2、显示悬浮窗

3、打印日志内容

三、更多设置

1、设置是否输出全部信息

2、是否在xcode底部的调试栏同步输出内容

3、针对不同用户设置独立日志文件夹

4、清空log

5、隐藏整个log窗口

6、仅隐藏log输出窗口

7、设置显示log最大记录数，0为不限制, 默认为100

8、 删除本地日志文件

9、 本地日志文件的有效期（天），超出有效期的本地日志会被删除，0为没有有效期，默认为7天

10、获取数据库存储的日志信息数组，也可以指定日期

LogContent协议

四、 敏感信息输出加密和解密

4.2、显示窗内容解密

4.1、 分享文件解密

五、其他说明

8、删除本地日志文件

9、本地日志文件的有效期（天），超出有效期的本地日志会被删除，0为没有有效期，默认为7天

四、敏感信息输出加密和解密

4.1、分享文件解密