DebugMan

Debugger tool for iOS, support both Swift and Objective-C language.

Introduction

DebugMan has the following features:

Display all app network http requests details, including SDKs and image preview.
Display app device informations and app identity informations.
Preview and share sandbox files on device/simulator.
Display all app logs in different colors as you like.
App memory real-time monitoring.
Display app crash logs.

And More, DebugMan support shake device/simulator to hide/show the black bubble.

Requirements

iOS 8.0+
Xcode 9.0+
Swift 3.0+

Installation

Use CocoaPods to install DebugMan by adding it to your Podfile: (I recommend import DebugMan only in Xcode debug-mode)

platform :ios, '8.0'
use_frameworks!

target 'your_project' do
   pod 'DebugMan', :configurations => ['Debug'] #Swift4
  #pod 'DebugMan', '~> 3.x.x', :configurations => ['Debug'] #Swift3
end

Usage

Swift :

//
//  AppDelegate.swift
//  Swift Example
//

#if DEBUG
    import DebugMan
#endif

class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool
    {
        #if DEBUG
            DebugMan.shared.enable()
        #endif
        
        return true
    }
}

//MARK: - over write print()
public func print<T>(file: String = #file, function: String = #function, line: Int = #line, _ message: T, _ color: UIColor? = nil)
{
    #if DEBUG
        DebugManLog(file, function, line, message, color)
    #endif
}

Objective-C :

//
//  AppDelegate.m
//  Objective-C Example
//

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    #ifdef DEBUG
        [[DebugMan shared] enableWithServerURL:nil ignoredURLs:nil onlyURLs:nil tabBarControllers:nil recordCrash:YES];
    #endif
    
    return YES;
}

@end

//
//  PrefixHeader.pch
//  Objective-C Example
//

#pragma clang diagnostic ignored "-Wunused-value"//ignore Xcode warning

#import "YourProject-Swift.h"

//default logs: white color
#ifdef DEBUG
#define NSLog(fmt, ...) [DebugMan NSLog:[[NSString stringWithUTF8String:__FILE__] lastPathComponent] :NSStringFromSelector(_cmd) :__LINE__ :(fmt, ##__VA_ARGS__) :[UIColor whiteColor]]
#else
#define NSLog(fmt, ...) nil
#endif

//custom logs: red, yellow, blue, orange, gray colors...
#ifdef DEBUG
#define RedLog(fmt, ...) [DebugMan NSLog:[[NSString stringWithUTF8String:__FILE__] lastPathComponent] :NSStringFromSelector(_cmd) :__LINE__ :(fmt, ##__VA_ARGS__) :[UIColor redColor]]
#else
#define RedLog(fmt, ...) nil
#endif

For More, See Swift and Objective-C demo Examples.

Screenshots

References

Dotzu (https://github.com/remirobert/Dotzu)
Sandboxer (https://github.com/meilbn/Sandboxer-Objc)
JxbDebugTool (https://github.com/JxbSir/JxbDebugTool)
SWHttpTrafficRecorder (https://github.com/Amindv1/SWHttpTrafficRecorder)

Matters Need Attention

Crash Reprting

https://github.com/liman123/Notes/wiki/iOS-collecting-app-crash-information

If you are using crash reporting SDKs like Crashlytics or Bugly, I recommend to close DebugMan crash reporting (set recordCrash value to be false).

key window

When using DebugMan, app's key window is DebugMan's transparent window. You can check app's UI layout by Reveal.
If you want to get the root view controller for the app's key window, UIApplication.shared.keyWindow?.rootViewController may crash. You should use UIApplication.shared.delegate?.window??.rootViewController.
If you want to show a toast in app's key window, like MBProgressHUD SVProgressHUD, UIApplication.shared.keyWindow to get app's key window may cause toast invisible. You should use UIApplication.shared.delegate?.window.

Author

License

DebugMan is available under the MIT license. See the LICENSE file for more info.

lovemeaha / DebugMan