Best Way to Include Debug Code?

Question

I am programming Android applications, and the best way here may or may not be the same as Java in general.

I simply want to be able to set a debug flag that will only execute certain portions of code when it's set to true––equiv to C++ setting a preprocessor #define DEBUG and using #ifdef DEBUG.

Is there an accepted or best way to accomplish this in Java?

Right now I'm just going to set a variable in my Application object, but I don't imagine this is the best way.

Check out this answer: http://stackoverflow.com/questions/1344270/java-preprocessor — zmbush, Apr 27 '10 at 05:35

HRJ · Answer 1 · 2014-09-26T06:46:00.840

Instead of using your own flag, you can use the flag set automatically by ADT, like this:

final static int appFlags = context.getApplicationInfo().flags;
final static boolean isDebug = (appFlags & ApplicationInfo.FLAG_DEBUGGABLE) != 0

The FLAG_DEBUGGABLE bit is automatically set to true or false, depending on the "debuggable" attribute of the application (set in AndroidManifest.xml). The latest version of ADT (version 8) automatically sets this attribute for you when not exporting a signed package.

Thus, you don't have to remember setting / resetting your own custom flag.

You can read more in this thread.

score 34 · Answer 2 · answered Mar 16 '17 at 15:52

34

I suggest to use inbuilt android API BuildConfig

if (BuildConfig.DEBUG) {
  // do something for a debug build
}

answered Mar 16 '17 at 15:52

Sunny Tambi

2,393
3
23
27

1

this should be marked at the correct answer or the one below for the correct use of the APis provided by SDK – DevZer0 Sep 26 '18 at 13:09

score 31 · Accepted Answer · answered Apr 27 '10 at 05:04

31

That's the way I do it:

// in some.class.with.Constants
public static final boolean DEV_MODE = true;

// in some other class
import static some.class.with.Constants.DEV_MODE;

if(DEV_MODE){
    Log.d('sometag', 'somemessage');
}

answered Apr 27 '10 at 05:04

yanchenko

56,576
33
147
165

3

Nice! I didn't know you could import all the way down to a single constant! I was looking to avoid typing X.X.CONST every time. This, combined with the answer referenced in the comment on my question (http://stackoverflow.com/questions/1344270/java-preprocessor), which shows how an 'if' statement with a false constant in its condition gets excluded from the compilation, is exactly what I was looking for. Thanks! – stormin986 Apr 27 '10 at 06:49
By my experiments (checking the byte code), this approach will only exclude the code from the class where the constant is defined.. other classes will still have the code in them (it won't execute though). am i wrong? – Vlad Oct 21 '15 at 15:22
import static is basically just a name thing – Vlad Oct 21 '15 at 17:07

score 27 · Answer 4 · answered Mar 29 '12 at 12:41

27

Revision 17 of SDK tools (March 2012) introduced a way to imitate C's #ifdef DEBUG

From the General Notes:

Added a feature that allows you to run some code only in debug mode. Builds now generate a class called BuildConfig containing a DEBUG constant that is automatically set according to your build type. You can check the (BuildConfig.DEBUG) constant in your code to run debug-only functions.

answered Mar 29 '12 at 12:41

IlDan

6,851
3
33
34

Always returns false for my library that my app is using – Ed of the Mountain Jan 24 '18 at 00:20

The Original Android · Answer 5 · 2015-12-12T01:07:48.747

13

This works for me with code if (BuildConfig.DEBUG), using the BuildConfig class. This is a safe and easy code to do. Be careful when using this style of code. Don't use it such that there are 2 different distinct branches of code, between Release and Debug versions. If you do, it might invalidate the app testing for the Release version. For me, I have used it only to skip calling Log messaging.

More details on this class BuildConfig @ Build System Concepts.

edited Dec 12 '15 at 01:07

answered Jul 28 '15 at 00:48

The Original Android

6,147
3
26
31

Almost zero CPU usage. Perfect. – romulof Dec 11 '15 at 19:03
@OrB, I am glad for you and I think it's the best choice for the modern Android Studio. I will edit my post since now it should be used as the easiest code to do. Thanks for noticing and giving me a reminder. – The Original Android Dec 12 '15 at 01:02

score 8 · Answer 6 · answered Apr 27 '10 at 05:29

8

if ( Debug.isDebuggerConnected() ) {
  // debug stuff
}

answered Apr 27 '10 at 05:29

drawnonward

53,459
16
107
112

I like this, and I imagine I'll find it quite useful at times, but I like how the other approach omits the entire block from the compilation with a false constant in the 'if' statement. – stormin986 Apr 27 '10 at 06:51
2

I use both methods and comment conditionals. Each has its place, although a real preprocessor would be best. – drawnonward Apr 27 '10 at 16:29
Problem with this is, the debugger is not always connected, when my app crashes. I am collecting the stack trace in exception & saving in a file. But I MUST do it in debug build only. – anishsane Oct 03 '13 at 15:22

score 1 · Answer 7 · answered Dec 29 '10 at 15:49

1

I think that writing tests is better alternative than adding DEBUG code.

My point is that when you write test for some component/method/class you don't pollute your original source code with some redundant debug code.

answered Dec 29 '10 at 15:49

Kiril Kirilov

11,167
5
49
74

Best Way to Include Debug Code?

7 Answers7

Linked