如何在构建Android应用程序的发布版本之前删除所有调试日志调用?

根据谷歌，我必须在发布我的Android应用程序谷歌播放之前“停用源代码中的Log方法的任何调用”。出版清单第3节节选:

在构建应用程序发布之前，请确保禁用了日志记录并禁用了调试选项。您可以通过删除源文件中对Log方法的调用来禁用日志记录。

我的开源项目很大，每次发布都要手动完成，这很痛苦。此外，删除Log行可能很棘手，例如:

if(condition)
  Log.d(LOG_TAG, "Something");
data.load();
data.show();

如果注释Log行，则该条件将应用于下一行，并且可能不会调用load()。这样的情况是否罕见到我可以决定它不应该存在?

那么，是否有更好的源代码级方法来做到这一点呢?或者是一些聪明的ProGuard语法，有效但安全地删除所有Log行?

当前回答

我发现一个更简单的解决方案是忘记所有的if检查，只是使用ProGuard剥离任何Log.d()或Log.v()方法调用时，我们调用我们的Ant发布目标。

通过这种方式，我们总是可以输出常规构建的调试信息，而不必对发布构建进行任何代码更改。ProGuard还可以对字节码进行多次传递，以删除其他不需要的语句和空块，并可以在适当的地方自动内联短方法。

例如，这是一个非常基本的Android ProGuard配置:

-dontskipnonpubliclibraryclasses
-dontobfuscate
-forceprocessing
-optimizationpasses 5

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

因此，您可以将其保存到一个文件中，然后从Ant调用ProGuard，传入刚刚编译的JAR和正在使用的Android平台JAR。

请参见ProGuard手册中的示例。

更新(4.5年后):现在我使用Timber进行Android日志记录。

它不仅比默认的Log实现更好一些(日志标记是自动设置的，很容易记录格式化的字符串和异常)，而且您还可以在运行时指定不同的日志行为。

在这个例子中，日志语句只会在我的应用程序的调试版本中写入logcat:

木材是在我的Application onCreate()方法中设置的:

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

然后在我的代码中的其他地方，我可以很容易地记录:

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

请参阅Timber示例应用程序以获得更高级的示例，其中所有日志语句都在开发期间发送到logcat，在生产中，没有调试语句被记录，但错误会无声地报告给Crashlytics。

2010-03-17 23:30:02

其他回答

克里斯托弗的Proguard解决方案是最好的，但如果因为任何原因你不喜欢Proguard，这里有一个非常低技术含量的解决方案:

评论日志:

find . -name "*\.java" | xargs grep -l 'Log\.' | xargs sed -i 's/Log\./;\/\/ Log\./g'

取消日志:

find . -name "*\.java" | xargs grep -l 'Log\.' | xargs sed -i 's/;\/\/ Log\./Log\./g'

一个限制是您的日志记录指令不能跨越多行。

(在项目根的UNIX shell中执行这些行。如果使用Windows，请使用UNIX层或使用等效的Windows命令)

2010-03-15 13:34:24

最简单的方法;

使用DebugLog

当应用程序发布时，DebugLog会禁用所有日志。

https://github.com/MustafaFerhan/DebugLog

2015-07-01 08:55:35

我发布的这个解决方案特别适用于Android Studio用户。我最近也发现了Timber，并通过以下方法成功地将其导入到我的应用程序中:

将最新版本的库放入build.gradle:

compile 'com.jakewharton.timber:timber:4.1.1'

然后在Android工作室，点击编辑->查找->替换路径…

输入Log。e(TAG，或任何您已经定义到“Text to find”文本框中的日志消息。然后你只需将其替换为timber。

单击“查找”，然后替换全部。

Android Studios现在将遍历项目中的所有文件，并将所有日志替换为木材。

我用这个方法遇到的唯一问题是，gradle之后会出现一百万个错误消息，因为它无法在每个java文件的导入中找到“Timber”。只需点击错误和Android工作室将自动导入“木材”到你的java。一旦你为所有的错误文件做了这些，gradle就会再次编译。

你还需要把这段代码放在你的Application类的onCreate方法中:

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

这将导致只有当你处于开发模式而不是生产模式时才会出现应用日志记录。你也可以使用BuildConfig。RELEASE表示登录RELEASE模式。

2016-03-21 17:29:43

我建议在某个地方使用一个静态布尔值来指示是否记录日志:

class MyDebug {
  static final boolean LOG = true;
}

然后无论你想在哪里登录你的代码，只需要这样做:

if (MyDebug.LOG) {
  if (condition) Log.i(...);
}

现在，当你将MyDebug.LOG设置为false时，编译器将剔除这些检查中的所有代码(因为它是一个静态final，它在编译时知道代码没有被使用)。

对于较大的项目，您可能希望开始在单个文件中使用布尔值，以便能够根据需要轻松启用或禁用日志记录。例如，这些是我们在窗口管理器中拥有的各种日志常量:

static final String TAG = "WindowManager";
static final boolean DEBUG = false;
static final boolean DEBUG_FOCUS = false;
static final boolean DEBUG_ANIM = false;
static final boolean DEBUG_LAYOUT = false;
static final boolean DEBUG_RESIZE = false;
static final boolean DEBUG_LAYERS = false;
static final boolean DEBUG_INPUT = false;
static final boolean DEBUG_INPUT_METHOD = false;
static final boolean DEBUG_VISIBILITY = false;
static final boolean DEBUG_WINDOW_MOVEMENT = false;
static final boolean DEBUG_ORIENTATION = false;
static final boolean DEBUG_APP_TRANSITIONS = false;
static final boolean DEBUG_STARTING_WINDOW = false;
static final boolean DEBUG_REORDER = false;
static final boolean DEBUG_WALLPAPER = false;
static final boolean SHOW_TRANSACTIONS = false;
static final boolean HIDE_STACK_CRAWLS = true;
static final boolean MEASURE_LATENCY = false;

对应代码如下:

    if (DEBUG_FOCUS || DEBUG_WINDOW_MOVEMENT) Log.v(
        TAG, "Adding window " + window + " at "
        + (i+1) + " of " + mWindows.size() + " (after " + pos + ")");

2010-03-15 15:35:24