DebugModule


Source link: https://github.com/Raizlabs/DebugModule

DebugModule

A powerful debug module that is fully pluggable, extendable, and very useful. It enables you to create your own Critter that contain UI elements which enable you configure your application on the fly.

It also can inject a right-facing DrawerLayout into your activity on top of all other content, making it very unobtrusive and accessible from everywhere within your application.

Getting Started

Add the library to the project-level build.gradle, using the Griddle plugin to simplify your build.gradle and link sources:

  apply plugin: 'com.raizlabs.griddle'
 dependencies {

  mod 'com.raizlabs.android:DebugModule:2.1.0', 'debugCompile`   
}
 

or by standard Gradle use (without linking sources support):

  dependencies {

  debugCompile "com.raizlabs.android:DebugModule:2.1.0"

}
 

Injection

In order to make this work as expected, this section will contain how to properly ensure interaction between the Debugger and the application.

Create A Common Interface or Abstract Class

The common abstract class or interface that you include in src/main/java will ensure that our completed implementations can differ between release and debug as well as allow the implementation to be uniformly used.

Here is an example of a provider with UrlCritter capabilities:

public abstract class AppOptionsProvider {

private static CompletedAppUrlProvider provider;

/** 
  * @return The static instance of the provider. Choosing debug vs. release will pick the correct 
  * provider to use. 
  */
  public static CompletedAppUrlProvider getProvider() {

if (provider == null) {

 provider = new CompletedAppUrlProvider();

}

return provider;
  
}

/** 
  * Called in the Application class. It will perform some 
  * setup here. 
  * 
  * @param context The application context. 
  */
  public abstract void init(Context context);

/** 
  * Attaches the debug options to the activity if its in debug mode, otherwise we do nothing. 
  * 
  * @param activity The activity that the debugger is attached to 
  */
  public void attach(FragmentActivity activity) {

}

/** 
  * @return The URL that the app uses 
  */
  public abstract String getConfigUrl();

/** 
  * @param activity The activity that the debugger is attached to. 
  * @return true if the CompletedAppUrlProvider consumed the event. 
  */
  public boolean onBackPressed(FragmentActivity activity) {

return false;
  
}
 
}
 

Implement the Abstract Class or Interface in all variants

For this example, we are relying on the buildType to implement the abstract class properly. First we will show what the release version is expected to do (in src/release/java):

/**  * Description: Defines the implementation for an DebugOptionsProvider for release.  * We only return the main app endpoint.  */ public class CompletedDebugOptionsProvider extends AppOptionsProvider {

private String mUrl;

@Override
  public void init(Context context) {

mUrl = context.getString(R.string.Endpoint_AppConfig);

  
}

@Override
  public String getConfigUrl() {

return mUrl;
  
}
 
}
  

In this case an abstract class is an advantage, since we only need to implement methods that we intend to use. Using that, all other methods as part of AppOptionsProvider will do nothing.

Here is the debug version of the implementation. Please note that the package name and class name must be the same.

/**  * Description: Defines the implementation for an {
@link DebugOptionsProvider
}
  * for debug. We use the debug module to show the menu.  */ public class CompletedAppUrlProvider extends AppOptionsProvider {

public static final String CRITTER_URL_NAME = "Select App Endpoint";

public static final String CRITTER_APP_NAME = "Build Information";

@Override
  public void init(Context context) {

UrlCritter urlCritter = new UrlCritter(context.getString(R.string.Endpoint_AppConfig), context);

urlCritter.addUrlTypedArray(R.array.AppConfig_Endpoints, context);

Debugger.getInstance().use(CRITTER_URL_NAME, urlCritter)

  .use(CRITTER_APP_NAME, new AppInformationCritter(BuildConfig.FLAVOR, BuildConfig.BUILD_TYPE));

 urlCritter.registerUrlChangeListener(mChangeListener);

  
}

@Override
  public void attach(FragmentActivity fragmentActivity) {

Debugger.getInstance().attach(fragmentActivity);

  
}

@Override
  public String getConfigUrl() {

return ((UrlCritter) Debugger.getInstance().getCritter(CRITTER_URL_NAME)).getCurrentUrl();

  
}

@Override
  public boolean onBackPressed(FragmentActivity activity) {

return Debugger.getInstance().onBackPressed(activity);

  
}

/** 
  * Called when URL changes 
  */
  private final UrlCritter.UrlChangeListener mChangeListener = new UrlCritter.UrlChangeListener() {

@Override

public void onUrlChanged(String url) {

 // URL for the app changed, do something here

}

  
}
; 
}
 

Inject the AbstractClass/Interface methods

Since we created the common interface, now we implement the methods where we intended them to be used:

In Application we initialize the provider:

public class ExampleApplication extends Application {

@Override
  public void onCreate() {

super.onCreate();

DebugOptionsProvider.getProvider().init(this);

  
}
 
}
  

Create a BaseActivity so that all our activities get access to the debugger when running the debug build variant:

public abstract class BaseActivity extends FragmentActivity {

@Override
  protected void onPostCreate(Bundle savedInstanceState) {

super.onPostCreate(savedInstanceState);

DebugOptionsProvider.getProvider().attach(this);

  
}

@Override
  public void onBackPressed() {

if(!DebugOptionsProvider.getProvider().onBackPressed(this)) {

 super.onBackPressed();

}

  
}
 
}
 

And that's it. Now you have a debugger that is only added to the .apk when running in debug variant! The release version will not contain this module at all if done properly.

Critters

A Critter is the main interface for constructing a debug submenu. It, at its base, only requires specifying a UI. That UI drives how the tester can change properties in an application during runtime.

We have provided a few default Critter for URL switching and app information display.

UrlCritter: Displays a list of URLs that a tester can select from, providing callbacks for when those change. It also enables adding custom endpoints at runtime (which are persisted in app data).

AppInformationCritter: Displays package name, build type, build variant, app version, and more.

PreferenceCritter: Enables dynamic changes to preferences you provide while the app is running. Instead of having to clear app data and reopen the app, you can change it within the app very easily.

DatabaseCritter: Viewing database tables (very basically) for an app without needing to pull the sqlite file off the device or using another machine.

You can create your own custom Critter fairly easily and it is flexible on what goes into it. It is up to your imagination on what you can configure at runtime for your app.

Critters

How to register to the Debugger:

// we register our critters here and can use any number of ones but names must remain unique Debugger.getInstance().use("critterName", new UrlCritter("http://www.google.com/", this))
  .use("anotherName", new PreferenceCritter());
 

How to retrieve from the Debugger:

UrlCritter urlCritter = Debugger.getInstance().getCritter(UrlCritter.class, "critterName");
 

Check out the currently included Critter:

UrlCritter

App Information Critter

Preference Critter

Database Browser

Maintainers

agrosner

Resources

ADP

Android Distribution Platform (ADP) is a fullstack framework for storing, distributing and installing versionized apk files based (mostly for internal team or roll-back purposes) on each CI git commit.

Twine is a command line tool for managing your strings and their translations. These strings are all stored in a master text file and then Twine uses this file to import and export strings in a variety of file types, including iOS and Mac OS X .strings files, Android .xml files, gettext .po files, and [jquery-localize][jquerylocalize] .json files.

This allows individuals and companies to easily share strings across multiple projects, as well as export strings in any format the user wants.

A simple yet-customizable Android drop-down menu. It supports Text with/without Icons, Separators, and even fully customized views.

Clean contacts is a sample repository to illustrate Clean architecture in Android. It has also many other details that hopefully will be useful too.

MarkdownView is an Android webview with the capability of loading Markdown text or file and display it as HTML, it uses MarkdownJ and extends Android webview.

Tool to output method counts in Android APK grouped by package.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes