Android Debug Vs Release Build Check in Running Code

IT_Programming/Android_Java

Android Debug Vs Release Build Check in Running Code

JJun ™ 2014. 8. 8. 10:27

출처: http://tekeye.biz/2013/android-debug-vs-release-build

Distinguishing Android Debug Mode Vs Release Mode

Your Android application (App) will execute in debug mode in you development environment (e.g. the Eclipse or Android Studio IDEs),
and it will execute in release mode when installed from Google Play. In release mode any debug logging, StrictMode and the debugging
option must be disabled. You can wrap the logging calls and StrictMode set up in code that checks for debug mode.

To detect Android debug vs release mode there are two objects that expose a debug flag, ApplicationInfo (since API Level 1)
and BuildConfig (recent SDK releases).

Android Debug vs Release Using ApplicationInfo Flags

With ApplicationInfo the flags field has a debug bit. It is set via the android:debuggable attribute on the application element in
AndroidManifest.xml. Usually the android:debuggable attribute does not need to be present, it is set automatically by Eclipse
or Android Studio. The IDEs set it to true to allow the App to be debugged.

It is set to false to turn off debugging when the final APK is generated.
To override the default settings add android:debuggable to the application element. Set it to true or false as required, e.g.:

1
2
3
4
5
<application
        android:debuggable="true"
        android:icon="@drawable/bug_icon"
        android:label="@string/app_name"
        android:theme="@style/AppTheme" >...</application>

To use it perform a boolean And on flags with ApplicationInfo.FLAG_DEBUGGABLE, if the result is not zero the App is in debug mode.

Android Debug vs Release Using BuildConfig.DEBUG

BuildConfig.DEBUG is set true when the App is running in the IDE.
It is set false in the released APK unless android:debuggable is present and set true.
Therefore BuildConfig.DEBUG reflects the android:debuggable value unless android:debuggable is set false
and the App is running in the IDE, in which case it will still be true. See the table later in the article.

Code Check for Android Debug Vs Release Mode

The ApplicationInfo instance is read from the App’s context:

1
ApplicationInfo appInfo = getApplicationInfo();

However to support Cupcake (API level 3) it needs to be obtained from the PackageManager:

1
2
3
4
5
6
7
8
9
PackageManager pacMan = getPackageManager();
String pacName = getPackageName();
ApplicationInfo appInfo=null;
try {
    appInfo = pacMan.getApplicationInfo(pacName, 0);
} catch (NameNotFoundException e) {
    Toast.makeText(this, "Could not find package " + pacName, Toast.LENGTH_SHORT).show();
    e.printStackTrace();
}

Once the ApplicationInfo instance has be assigned the flags value can be tested for the debug setting.
Here it is being used to update a TextView:

1
2
3
4
5
6
if(appInfo!=null) {
    if( (appInfo.flags & ApplicationInfo.FLAG_DEBUGGABLE) != 0)
        ((TextView)findViewById(R.id.textView2)).setText("TRUE");
    else
        ((TextView)findViewById(R.id.textView2)).setText("FALSE");
}

**Android Debug Vs Release Mode**
APPLICATION ELEMENT	RELEASED APK	IN IDE
No android:debuggable	FLAG_DEBUGGABLE bit is 0 and BuildConfig.DEBUG is false	FLAG_DEBUGGABLE bit is 1 and BuildConfig.DEBUG is true
android:debuggable=”true”	FLAG_DEBUGGABLE bit is 1 and BuildConfig.DEBUG is true	FLAG_DEBUGGABLE bit is 1 and BuildConfig.DEBUG is true
android:debuggable=”false”	FLAG_DEBUGGABLE bit is 0 and BuildConfig.DEBUG is false	FLAG_DEBUGGABLE bit is 0 and BuildConfig.DEBUG is true

Here’s the debugging settings in action. First no android:debuggable attribute is present and the code is running in the IDE,
or android:debuggable=”true” and the code is running in the IDE or in a released APK:

The same code running in a signed APK with no android:debuggable or it is present and set to false:

And now running from the IDE with the flag manually set to falseusing <application android:debuggable=”false”…:

Source Code

Here is the full source code used to generated the above screens. First the screen layout XML (activity_main.xml):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent">
    <TextView
        android:id="@+id/textView1"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="@string/message1"
        android:textAppearance="?android:attr/textAppearanceMedium" />
    <TextView
        android:id="@+id/textView2"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_below="@+id/textView1"
        android:layout_marginTop="20dp"
        android:text="@string/unknown"
        android:textAppearance="?android:attr/textAppearanceLarge" />   
    <TextView
        android:id="@+id/textView3"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_below="@+id/textView2"
        android:layout_marginTop="20dp"
        android:text="@string/message2"
        android:textAppearance="?android:attr/textAppearanceMedium" />
    <TextView
        android:id="@+id/textView4"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_below="@+id/textView3"
        android:layout_marginTop="20dp"
        android:text="@string/unknown"
        android:textAppearance="?android:attr/textAppearanceLarge" />
</RelativeLayout>

Here’s the associated strings.xml:

1
2
3
4
5
6
7
<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="app_name">Check Debuggable</string>
    <string name="message1">ApplicationInfo.FLAG_DEBUGGABLE bit is set:</string>
    <string name="message2">BuildConfig.DEBUG is set:</string>
    <string name="unknown">UNKNOWN</string>
</resources>

And the Java code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
import android.os.Bundle;
import android.app.Activity;
import android.content.pm.ApplicationInfo;
import android.content.pm.PackageManager;
import android.content.pm.PackageManager.NameNotFoundException;
import android.widget.TextView;
import android.widget.Toast;
 
public class MainActivity extends Activity {
	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);
 
		PackageManager pacMan = getPackageManager();
		String pacName = getPackageName();
		ApplicationInfo appInfo=null;
		try {
			appInfo = pacMan.getApplicationInfo(pacName, 0);
		} catch (NameNotFoundException e) {
			Toast.makeText(this, "Could not find package " + pacName, Toast.LENGTH_SHORT).show();
			e.printStackTrace();
		}
		if(appInfo!=null) {
			if( (appInfo.flags & ApplicationInfo.FLAG_DEBUGGABLE) != 0)
				((TextView)findViewById(R.id.textView2)).setText("TRUE");
			else
				((TextView)findViewById(R.id.textView2)).setText("FALSE");
		}
 
		if(BuildConfig.DEBUG) {
			((TextView)findViewById(R.id.textView4)).setText("TRUE");
		} else {
			((TextView)findViewById(R.id.textView4)).setText("FALSE");
		}
	}
}

Conclusion

To detect if code is running in the IDE test BuildConfig.DEBUG for true.
To detect if code is configured for debugging, whether running in the IDE or not, test ApplicationInfo flags
usingApplicationInfo.FLAG_DEBUGABBLE.

(See the Android Graphics Resources page for a bug icon.)

저작자표시 비영리 변경금지

'IT_Programming > Android_Java' 카테고리의 다른 글

[Android] MediaPlayer with SurfaceHolder (0)	2014.08.16
ListView Header에 Viewpager 추가 (0)	2014.08.11
[Android] activity-alias 태그를 사용하는 좋은 예. (0)	2014.08.06
Android Custom State 만들기. (0)	2014.08.06
Android RenderScript Blur (0)	2014.08.06

현재글Android Debug Vs Release Build Check in Running Code

삶의 모든 순간을 즐겨라!

Today :
Yesterday :

삶의 모든 순간을 즐겨라!