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

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

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

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

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

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

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

当前回答

我想添加一些关于使用Proguard与Android Studio和gradle的精度，因为我有很多问题，从最终的二进制文件中删除日志行。

为了使保护工作中的副作用假设，有一个先决条件。

在你的gradle文件中，你必须指定proguard-android- optimization .txt作为默认文件。

buildTypes {
    release {
        minifyEnabled true
        proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'

        // With the file below, it does not work!
        //proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
    }
}

实际上，在默认的proguard-android.txt文件中，通过以下两个标志禁用了优化:

-dontoptimize
-dontpreverify

proguard-android- optimization .txt文件没有添加这些行，所以现在假设副作用可以工作。

然后，就我个人而言，我使用SLF4J，特别是当我开发一些分发给其他人的库时。其优点是默认情况下没有输出。如果积分器想要一些日志输出，他可以使用Android的Logback并激活日志，这样日志就可以重定向到文件或LogCat。

如果我真的需要从最终库中剥离日志，我就会添加到我的Proguard文件中(当然是在启用了Proguard -android- optimization .txt文件之后):

-assumenosideeffects class * implements org.slf4j.Logger {
    public *** trace(...);
    public *** debug(...);
    public *** info(...);
    public *** warn(...);
    public *** error(...);
}

2015-09-09 15:08:47

其他回答

如果您希望使用编程方法而不是使用ProGuard，那么通过创建自己的类，其中包含两个实例(一个用于调试，一个用于发布)，您可以选择在任何一种情况下登录什么。

所以，如果你不想在发布时记录任何东西，只需实现一个什么都不做的Logger，如下例所示:

import android.util.Log

sealed class Logger(defaultTag: String? = null) {
    protected val defaultTag: String = defaultTag ?: "[APP-DEBUG]"

    abstract fun log(string: String, tag: String = defaultTag)

    object LoggerDebug : Logger() {
        override fun log(string: String, tag: String) {
            Log.d(tag, string)
        }
    }

    object LoggerRelease : Logger() {
        override fun log(string: String, tag: String) {}
    }

    companion object {
        private val isDebugConfig = BuildConfig.DEBUG

        val instance: Logger by lazy {
            if(isDebugConfig)
            LoggerDebug
            else
                LoggerRelease
        }

    }
}

然后使用记录器类:

class MainActivity : AppCompatActivity() {

private val logger = Logger.instance

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)
    logger.log("Activity launched...")
    ...
    myView.setOnClickListener {
        ...

        logger.log("My View clicked!", "View-click")
    }
}

== update ==

如果我们想避免字符串连接以获得更好的性能，我们可以添加一个带有lambda的内联函数，该函数只在调试配置中调用:

// Add this function to the Logger class.
inline fun commit(block: Logger.() -> Unit) {
    if(this is LoggerDebug)
        block.invoke(this)
}

然后:

 logger.commit {
     log("Logging without $myVar waste of resources"+ "My fancy concat")
 }

因为我们使用的是内联函数，所以没有额外的对象分配，也没有额外的虚方法调用。

2020-12-18 12:14:18

我在我的项目中使用了以下方法

创建自定义记录器类:

public class LoggerData 
{
   
    public static void showLog(String type, Object object) {
        try {
            Log.d("loggerData:" + type + "-", "showLog: " + new Gson().toJson(object));
        } catch (Exception e) {
            Log.d("TAG", "showLog: " + e.getLocalizedMessage());
            Log.d("loggerData:" + type + "-", "showLog: " + object);
        }

    }

    public static void showLog(Object object) {
        
            try {
                Log.d("loggerData:" + "-", "showLog: +" + new Gson().toJson(object));
            } catch (Exception e) {
                Log.d("TAG", "showLog: " + e.getLocalizedMessage());
                Log.d("loggerData:" + "-", "showLog: " + object);
            }
        
    }
}

然后每当需要登录代码时，就像这样使用

  LoggerData.showLog("Refreshed token: ", token);

在构建发布APK之前，在LoggerData类中只禁用一个地方的日志

例子

public class LoggerData {
    

    public static void showLog(String type, Object object) {
        try {
            //Log.d("loggerData:" + type + "-", "showLog: " + new Gson().toJson(object));
        } catch (Exception e) {
            //Log.d("TAG", "showLog: " + e.getLocalizedMessage());
            //Log.d("loggerData:" + type + "-", "showLog: " + object);
        }

    }

    public static void showLog(Object object) {
       
            try {
              //  Log.d("loggerData:" + "-", "showLog: +" + new Gson().toJson(object));
            } catch (Exception e) {
                //Log.d("TAG", "showLog: " + e.getLocalizedMessage());
                //Log.d("loggerData:" + "-", "showLog: " + object);
            }
        }
    }

希望它也能帮助到你。

2021-12-17 13:51:41

我知道这是个老问题了，但你为什么不把所有的日志调用都换成布尔logCallWasHere = true;//——剩下的日志在这里

这就是为什么你会知道什么时候你想把它们放回去，他们不会影响你的if语句调用:)

2017-09-06 23:40:59

我发现一个更简单的解决方案是忘记所有的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