Android Debug Database
A library for debugging android databases and shared preferences - Make Debugging Great Again
Under Apache License 2.0
By amitshekhariitbhu
A library for debugging android databases and shared preferences - Make Debugging Great Again
Under Apache License 2.0
By amitshekhariitbhu
Add this to your app's build.gradle
groovy
debugImplementation 'com.amitshekhar.android:debug-db:1.0.6'
Using the Android Debug Database with encrypted database
groovy
debugImplementation 'com.amitshekhar.android:debug-db-encrypt:1.0.6'
And to provide the password for the DB, you should add this in the Gradle:
DB_PASSWORD_{VARIABLE}, if for example, PERSON is the database name: DB_PASSWORD_PERSONgroovy
debug {
resValue("string", "DB_PASSWORD_PERSON", "password")
}
Use debugImplementation so that it will only compile in your debug build and not in your release build.
That’s all, just start the application, you will see in the logcat an entry like follows :
D/DebugDB: Open http://XXX.XXX.X.XXX:8080 in your browser
You can also always get the debug address url from your code by calling the method DebugDB.getAddressLog();
Now open the provided link in your browser.
Important:
adb forward tcp:8080 tcp:8080Note : If you want use different port other than 8080.
In the app build.gradle file under buildTypes do the following change
groovy
debug {
resValue("string", "PORT_NUMBER", "8081")
}
You will see something like this :
adb forward tcp:8080 tcp:8080 and open http://localhost:8080As this library is auto-initialize, if you want to get the address log, add the following method and call (we have to do like this to avoid build error in release build as this library will not be included in the release build) using reflection.
```java
public static void showDebugDBAddressLogToast(Context context) {
if (BuildConfig.DEBUG) {
try {
Class<?> debugDB = Class.forName("com.amitshekhar.DebugDB");
Method getAddressLog = debugDB.getMethod("getAddressLog");
Object value = getAddressLog.invoke(null);
Toast.makeText(context, (String) value, Toast.LENGTH_LONG).show();
} catch (Exception ignore) {
}
}
}
```
As this library is auto-initialize, if you want to debug custom database files, add the following method and call
```java
public static void setCustomDatabaseFiles(Context context) {
if (BuildConfig.DEBUG) {
try {
Class<?> debugDB = Class.forName("com.amitshekhar.DebugDB");
Class[] argTypes = new Class[]{HashMap.class};
Method setCustomDatabaseFiles = debugDB.getMethod("setCustomDatabaseFiles", argTypes);
HashMap> customDatabaseFiles = new HashMap<>();
// set your custom database files
customDatabaseFiles.put(ExtTestDBHelper.DATABASE_NAME,
new Pair<>(new File(context.getFilesDir() + "/" + ExtTestDBHelper.DIR_NAME +
"/" + ExtTestDBHelper.DATABASE_NAME), ""));
setCustomDatabaseFiles.invoke(null, customDatabaseFiles);
} catch (Exception ignore) {
}
}
}
```
As this library is auto-initialize, if you want to debug inMemory Room databases, add the following method and call
```java
public static void setInMemoryRoomDatabases(SupportSQLiteDatabase... database) {
if (BuildConfig.DEBUG) {
try {
Class<?> debugDB = Class.forName("com.amitshekhar.DebugDB");
Class[] argTypes = new Class[]{HashMap.class};
HashMap inMemoryDatabases = new HashMap<>();
// set your inMemory databases
inMemoryDatabases.put("InMemoryOne.db", database[0]);
Method setRoomInMemoryDatabase = debugDB.getMethod("setInMemoryRoomDatabases", argTypes);
setRoomInMemoryDatabase.invoke(null, inMemoryDatabases);
} catch (Exception ignore) {
}
}
}
```
```
Copyright (C) 2019 Amit Shekhar
Copyright (C) 2011 Android Open Source Project
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
All pull requests are welcome, make sure to follow the contribution guidelines
when you submit pull request.