根据谷歌，我必须在发布我的Android应用程序谷歌播放之前“停用源代码中的Log方法的任何调用”。出版清单第3节节选:
在构建应用程序发布之前，请确保禁用了日志记录并禁用了调试选项。您可以通过删除源文件中对Log方法的调用来禁用日志记录。
我的开源项目很大，每次发布都要手动完成，这很痛苦。此外，删除Log行可能很棘手，例如:
if(condition)
Log.d(LOG_TAG, "Something");
data.load();
data.show();
如果注释Log行，则该条件将应用于下一行，并且可能不会调用load()。这样的情况是否罕见到我可以决定它不应该存在?
那么，是否有更好的源代码级方法来做到这一点呢?或者是一些聪明的ProGuard语法，有效但安全地删除所有Log行?
当前回答
如果您希望使用编程方法而不是使用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")
}
因为我们使用的是内联函数，所以没有额外的对象分配，也没有额外的虚方法调用。
其他回答
我对上述解决方案进行了改进，提供了对不同日志级别的支持，并根据代码是在活动设备上运行还是在模拟器上运行而自动更改日志级别。
public class Log {
final static int WARN = 1;
final static int INFO = 2;
final static int DEBUG = 3;
final static int VERB = 4;
static int LOG_LEVEL;
static
{
if ("google_sdk".equals(Build.PRODUCT) || "sdk".equals(Build.PRODUCT)) {
LOG_LEVEL = VERB;
} else {
LOG_LEVEL = INFO;
}
}
/**
*Error
*/
public static void e(String tag, String string)
{
android.util.Log.e(tag, string);
}
/**
* Warn
*/
public static void w(String tag, String string)
{
android.util.Log.w(tag, string);
}
/**
* Info
*/
public static void i(String tag, String string)
{
if(LOG_LEVEL >= INFO)
{
android.util.Log.i(tag, string);
}
}
/**
* Debug
*/
public static void d(String tag, String string)
{
if(LOG_LEVEL >= DEBUG)
{
android.util.Log.d(tag, string);
}
}
/**
* Verbose
*/
public static void v(String tag, String string)
{
if(LOG_LEVEL >= VERB)
{
android.util.Log.v(tag, string);
}
}
}
如果您希望使用编程方法而不是使用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")
}
因为我们使用的是内联函数，所以没有额外的对象分配，也没有额外的虚方法调用。
我发布的这个解决方案特别适用于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模式。
我在我的项目中使用了以下方法
创建自定义记录器类:
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);
}
}
}
希望它也能帮助到你。
如果您不想弄乱额外的库或手动编辑代码，以下是我的解决方案。我创建了这个Jupyter笔记本来检查所有的java文件并注释掉所有的日志消息。虽然不完美，但它帮我完成了任务。
