How to remove all debug logging calls before building the release version of an Android app?

前端 未结 27 1471
有刺的猬
有刺的猬 2020-11-22 07:39

According to Google, I must \"deactivate any calls to Log methods in the source code\" before publishing my Android app to Google Play. Extract from section 3 of th

27条回答
  •  一向
    一向 (楼主)
    2020-11-22 08:14

    I find a far easier solution is to forget all the if checks all over the place and just use ProGuard to strip out any Log.d() or Log.v() method calls when we call our Ant release target.

    That way, we always have the debug info being output for regular builds and don't have to make any code changes for release builds. ProGuard can also do multiple passes over the bytecode to remove other undesired statements, empty blocks and can automatically inline short methods where appropriate.

    For example, here's a very basic ProGuard config for Android:

    -dontskipnonpubliclibraryclasses
    -dontobfuscate
    -forceprocessing
    -optimizationpasses 5
    
    -keep class * extends android.app.Activity
    -assumenosideeffects class android.util.Log {
        public static *** d(...);
        public static *** v(...);
    }
    

    So you would save that to a file, then call ProGuard from Ant, passing in your just-compiled JAR and the Android platform JAR you're using.

    See also the examples in the ProGuard manual.


    Update (4.5 years later): Nowadays I used Timber for Android logging.

    Not only is it a bit nicer than the default Log implementation — the log tag is set automatically, and it's easy to log formatted strings and exceptions — but you can also specify different logging behaviours at runtime.

    In this example, logging statements will only be written to logcat in debug builds of my app:

    Timber is set up in my Application onCreate() method:

    if (BuildConfig.DEBUG) {
      Timber.plant(new Timber.DebugTree());
    }
    

    Then anywhere else in my code I can log easily:

    Timber.d("Downloading URL: %s", url);
    try {
      // ...
    } catch (IOException ioe) {
      Timber.e(ioe, "Bad things happened!");
    }
    

    See the Timber sample app for a more advanced example, where all log statements are sent to logcat during development and, in production, no debug statements are logged, but errors are silently reported to Crashlytics.

提交回复
热议问题