Bir Android uygulamasının yayın sürümünü oluşturmadan önce tüm hata ayıklama günlüğü aramalarını nasıl kaldırırım?

Google'a göre, Android uygulamamı Google Play'de yayınlamadan önce " Kaynak koddaki Günlük yöntemlerine yapılan tüm aramaları devre dışı bırakmalıyım ". Yayın kontrol listesinin 3. bölümünden alıntı :

Uygulamanızı yayınlanmak üzere oluşturmadan önce günlüğe kaydetmeyi devre dışı bıraktığınızdan ve hata ayıklama seçeneğini devre dışı bıraktığınızdan emin olun. Kaynak dosyalarınızdaki Günlük yöntemlerine yapılan çağrıları kaldırarak günlüğü devre dışı bırakabilirsiniz.

Açık kaynaklı projem büyük ve her bıraktığımda bunu manuel olarak yapmak acı verici. Ayrıca, bir Günlük satırını kaldırmak potansiyel olarak zordur, örneğin:

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

Günlük satırına yorum yaparsam, koşul bir sonraki satıra uygulanır ve olasılıklar load () olarak adlandırılmaz. Böyle durumlar var olmamasına karar verebilecek kadar nadir midir?

Peki, bunu yapmanın daha iyi bir kaynak kodu düzeyinde yolu var mı? Ya da tüm Log satırlarını verimli ama güvenli bir şekilde kaldırmak için bazı akıllı ProGuard sözdizimi?

Her ifyerde tüm kontrolleri unutmak ve Ant hedefimizi aradığımızda herhangi bir veya yöntem çağrısını çıkarmak için ProGuard'ı kullanmak çok daha kolay bir çözüm buluyorum .Log.d()Log.v()release

Bu şekilde, normal derlemeler için her zaman hata ayıklama bilgilerinin çıktısını alırız ve sürüm derlemeleri için herhangi bir kod değişikliği yapmamız gerekmez. ProGuard, diğer istenmeyen ifadeleri, boş blokları kaldırmak için bayt kodu üzerinden birden fazla geçiş yapabilir ve uygun olduğunda kısa yöntemleri otomatik olarak satır içine alabilir.

Örneğin, Android için çok temel bir ProGuard yapılandırması:

-dontskipnonpubliclibraryclasses
-dontobfuscate
-forceprocessing
-optimizationpasses 5

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

Böylece bunu bir dosyaya kaydeder ve daha sonra derlenmiş JAR'ınızı ve kullandığınız Android platformunu JAR'dan geçirerek Ant'den ProGuard'ı ararsınız.

Ayrıca ProGuard kılavuzundaki örneklere bakın .

Güncelleme (4,5 yıl sonra): Bugünlerde kullandım Android günlüğü için Kereste .

Sadece varsayılandan biraz daha hoş değil Log uygulamadan - günlük etiketi otomatik olarak ayarlanır ve biçimlendirilmiş dizeleri ve istisnaları günlüğe kaydetmek kolaydır - aynı zamanda çalışma zamanında farklı günlükleme davranışları da belirtebilirsiniz.

Bu örnekte, günlük ifadeleri yalnızca uygulamamın hata ayıklama yapılarında logcat'e yazılır:

Kereste benim Application onCreate()yöntemimle kuruldu :

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

Sonra benim kodu başka bir yerde kolayca giriş yapabilirsiniz:

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

Tüm günlük deyimlerinin geliştirme sırasında logcat'e gönderildiği ve üretimde hata ayıklama deyimlerinin kaydedilmediği, ancak hataların sessizce Crashlytics'e bildirildiği daha gelişmiş bir örnek için Kereste örneği uygulamasına bakın .

Tüm iyi cevaplar, ancak gelişimimi bitirdiğimde, tüm Log çağrılarının etrafında if ifadelerini kullanmak istemiyordum ya da harici araçlar kullanmak istemiyordum.

Bu yüzden kullandığım çözüm android.util.Log sınıfını kendi Log sınıfımla değiştirmektir:

public class Log {
    static final boolean LOG = BuildConfig.DEBUG;

    public static void i(String tag, String string) {
        if (LOG) android.util.Log.i(tag, string);
    }
    public static void e(String tag, String string) {
        if (LOG) android.util.Log.e(tag, string);
    }
    public static void d(String tag, String string) {
        if (LOG) android.util.Log.d(tag, string);
    }
    public static void v(String tag, String string) {
        if (LOG) android.util.Log.v(tag, string);
    }
    public static void w(String tag, String string) {
        if (LOG) android.util.Log.w(tag, string);
    }
}

Tüm kaynak dosyalarda yapmak zorunda olduğum tek şey android.util.Log'u kendi sınıfımla değiştirmekti.

Günlük bir yerde olup olmadığını belirtmek için statik bir boole sahip öneririz:

sınıf MyDebug {
  statik son boolean LOG = doğru;
}

Ardından, kodunuzu girmek istediğiniz her yerde şunları yapın:

if (MyDebug.LOG) {
  eğer (koşul) Log.i (...);
}

Şimdi MyDebug.LOG öğesini false olarak ayarladığınızda, derleyici bu tür denetimlerin içindeki tüm kodu çıkarır (statik bir final olduğu için derleme zamanında kodun kullanılmadığını bilir.)

Daha büyük projeler için, gerektiğinde günlük kaydını kolayca etkinleştirmek veya devre dışı bırakmak için tek tek dosyalarda booleans kullanmaya başlamak isteyebilirsiniz. Örneğin, bunlar pencere yöneticisinde bulunan çeşitli günlük sabitleridir:

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;

Gibi karşılık gelen kod ile:

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

Christopher'ın Proguard çözümü en iyisidir, ancak herhangi bir nedenle Proguard'ı sevmiyorsanız, işte çok düşük teknolojili bir çözüm var:

Yorum günlükleri:

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

Uncomment günlükleri:

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

Bir kısıtlama, günlük kaydı talimatlarınızın birden çok satıra yayılmaması gerektiğidir.

(Bu satırları projenizin kökündeki UNIX kabuğunda yürütün. Windows kullanıyorsanız, UNIX katmanı edinin veya eşdeğer Windows komutlarını kullanın)

Proguard'ı Android Studio ve gradle ile kullanma hakkında bazı kesinlikler eklemek istiyorum, çünkü günlük satırlarını son ikili dosyadan kaldırmak için birçok sorunum vardı.

Yapabilmek için assumenosideeffectsProguard eserlerinde, bir ön koşul yoktur.

Gradle dosyanızda, proguard-android-optimize.txtvarsayılan dosyanın kullanımını belirtmeniz gerekir .

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'
    }
}

Aslında, varsayılan proguard-android.txtdosyada optimizasyon iki bayrakla devre dışı bırakılır:

-dontoptimize
-dontpreverify

proguard-android-optimize.txtDosya bu satırları eklemez, şimdi assumenosideeffectsçalışabilir.

Daha sonra, kişisel olarak, diğerlerine dağıtılan bazı kütüphaneler geliştirdiğimde, daha fazlasını SLF4J kullanıyorum . Avantajı, varsayılan olarak çıktı olmamasıdır. Ve tümleştirici bazı günlük çıktıları isterse, Android için Logback'i kullanabilir ve günlükleri etkinleştirebilir, böylece günlükler bir dosyaya veya LogCat'e yeniden yönlendirilebilir.

Günlükleri son kitaplıktan çıkarmam gerekirse, Proguard dosyama eklerim ( proguard-android-optimize.txttabii ki dosyayı etkinleştirdikten sonra ):

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

Jake Wharton'dan Kereste kullanmanızı şiddetle tavsiye ederim

https://github.com/JakeWharton/timber

etkinleştirme / devre dışı bırakma sorununuzu çözer ve etiket sınıfını otomatik olarak ekler

sadece

public class MyApp extends Application {

  public void onCreate() {
    super.onCreate();
    //Timber
    if (BuildConfig.DEBUG) {
      Timber.plant(new DebugTree());
    }
    ...

günlükleri yalnızca hata ayıklama sürümünüzde kullanılacaktır.

Timber.d("lol");

veya

Timber.i("lol says %s","lol");

yazdırmak

Etiketi belirtmeden "Sınıfınız / msg"

Google IO örnek uygulamasında olduğu gibi bir LogUtils sınıfı kullandım . BuildConfig.DEBUG güvenilir olmadığından , BuildConfig.DEBUG yerine uygulamaya özel bir DEBUG sabiti kullanmak için bunu değiştirdim . Sonra Sınıflarımda aşağıdakiler var.

import static my.app.util.LogUtils.makeLogTag;
import static my.app.util.LogUtils.LOGV;

public class MyActivity extends FragmentActivity {
  private static final String TAG = makeLogTag(MyActivity.class);

  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    LOGV(TAG, "my message");
  }
}

Yerleşik android.util.Log yerine roboguice'in günlük oluşturma özelliğini kullanmayı düşünürdüm

Tesisleri, sürüm derlemeleri için hata ayıklama ve ayrıntılı günlükleri otomatik olarak devre dışı bırakır. Ayrıca, ücretsiz bazı şık özellikler elde edersiniz (örneğin, özelleştirilebilir günlük kaydı davranışı, her günlük için ek veriler ve daha fazlası)

Proguard kullanmak oldukça zor olabilir ve bunun için iyi bir nedeniniz yoksa (günlükleri devre dışı bırakmak iyi bir şey değildir) yapılandırmanız ve uygulamanızla çalışmasını zorlaştırmam.

Özellikle Android Studio kullanıcıları için geçerli olan bu çözümü gönderiyorum. Ayrıca kısa süre önce Timber'i keşfettim ve aşağıdakileri yaparak uygulamama başarıyla aktardım:

Kütüphanenin en son sürümünü build.gradle dosyasına koyun:

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

Ardından Android Studios'ta Düzenle -> Bul -> Yolda Değiştir ... seçeneğine gidin.

Yazın Log.e(TAG,veya ancak içine Günlük iletisini tanımladınız "Text to find"metin. Sonra sadeceTimber.e(

Bul'u tıklayın ve ardından hepsini değiştirin.

Android Studios şimdi projenizdeki tüm dosyalarınızı gözden geçirecek ve tüm Günlükleri Kereste ile değiştirecektir.

Bu yöntem ile vardı tek sorun, gradle daha sonra milyon hata iletileri ile geliyor çünkü java dosyaları her ithalat için "Kereste" bulamıyor olmasıdır. Sadece hataları tıklayın ve Android Studios otomatik olarak "Kereste" java içine alacak. Tüm hata dosyalarınız için yaptıktan sonra, gradle tekrar derlenecektir.

Bu kod parçasını sınıfınızın onCreateyöntemine de koymanız gerekir Application:

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

Bu, uygulama günlüğüne yalnızca üretimde değil geliştirme modunda olduğunuzda neden olur. BuildConfig.RELEASESerbest bırakma modunda oturum açmak için de sahip olabilirsiniz .

Android.util.Log başına günlüğü etkinleştirmek / devre dışı bırakmak için bir yol sağlar:

public static native boolean isLoggable(String tag, int level);

İsLoggable (...) yöntemi varsayılan olarak false değerini döndürür, ancak cihazda setprop bunu beğendikten sonra:

adb shell setprop log.tag.MyAppTag DEBUG

DEBUG seviyesinin üzerindeki herhangi bir günlük yazdırılabilir. Referans android doc:

Belirtilen etiket için bir günlüğün belirtilen düzeyde günlüğe kaydedilip kaydedilemeyeceğini denetler. Herhangi bir etiketin varsayılan seviyesi INFO olarak ayarlanmıştır. Bu, INFO dahil olmak üzere herhangi bir seviyenin günlüğe kaydedileceği anlamına gelir. Bir kayıt yöntemine herhangi bir arama yapmadan önce etiketinizin günlüğe kaydedilip kaydedilmeyeceğini kontrol etmelisiniz. Bir system özelliğini ayarlayarak varsayılan düzeyi değiştirebilirsiniz: 'setprop log.tag. 'Seviyenin VERBOSE, DEBUG, INFO, WARN, ERROR, ASSERT veya SUPPRESS olduğu durumlarda. SUPPRESS, etiketiniz için tüm günlük kaydını kapatır. İçinde aşağıdakileri içeren bir local.prop dosyası da oluşturabilirsiniz: 'log.tag. =' Ve /data/local.prop içine yerleştirin.

Böylece özel günlük util kullanabilirsiniz:

public final class Dlog 
{
    public static void v(String tag, String msg)
    {
        if (Log.isLoggable(tag, Log.VERBOSE))
            Log.v(tag, msg);
    }

    public static void d(String tag, String msg)
    {
        if (Log.isLoggable(tag, Log.DEBUG))
            Log.d(tag, msg);
    }

    public static void i(String tag, String msg)
    {
        if (Log.isLoggable(tag, Log.INFO))
            Log.i(tag, msg);
    }

    public static void w(String tag, String msg)
    {
        if (Log.isLoggable(tag, Log.WARN))
            Log.w(tag, msg);
    }

    public static void e(String tag, String msg)
    {
        if (Log.isLoggable(tag, Log.ERROR))
            Log.e(tag, msg);
    }
}

Genel bir değiştirme çalıştırabilirseniz (bir kez) ve bundan sonra bazı kodlama kurallarını koruyorsanız, Android çerçevesinde sıklıkla kullanılan deseni takip edebilirsiniz .

Yazmak yerine

Log.d(TAG, string1 + string2 + arg3.toString());

olduğu gibi

if (BuildConfig.DEBUG) Log.d(TAG, string1 + String.format("%.2f", arg2) + arg3.toString());

Proguard, StringBuilder'ı ve yolda kullandığı tüm dizeleri ve yöntemleri optimize edilmiş DEX sürümünden kaldırabilir. Kullanım proguard-android-optimize.txtve hakkında endişe gerekmez android.util.Log Gözlerinde farklı proguard-rules.pro:

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

Android Studio gradle eklentisi ile oldukça güvenilirdir, bu nedenle sıyırma işlemini kontrol etmek için ekstra sabitlere ihtiyacınız yoktur.BuildConfig.DEBUG

Proguard-rules.txt dosyanıza aşağıdakileri ekleyin

-assumenosideeffects class android.util.Log {
  public static *** d(...);
  public static *** w(...);
  public static *** v(...);
  public static *** i(...);
}

Android projelerimde yaptığım şey budur ..

Android Studio'da, tüm projeden bulmak için Ctrl + Shift + F ve MacO'larda Command + Shift + F) ile Değiştirilecek Ctrl + Shift + R ile ((MacO'larda Command + Shift + R))

Çok basit bir çözümüm var. Geliştirme için IntelliJ kullanıyorum, bu yüzden ayrıntılar değişiyor, ancak fikir tüm IDE'ler için geçerli olmalı.

Kaynak ağacımın kökünü seçiyorum, sağ tıklayın ve "değiştir" i seçin. Daha sonra "Günlük" ü değiştirmeyi seçtim. "// Günlük" ile. Bu, tüm günlük ifadelerini kaldırır. Onları daha sonra geri koymak için aynı "" Log "yerine bu kez tekrar ediyorum. "Log."

Benim için harika çalışıyor. Yalnızca "İletişim Kutusu" gibi kazaları önlemek için değiştirmeyi büyük / küçük harfe duyarlı olarak ayarlamayı unutmayın. Daha fazla güvence için ilk adımı "Günlük" ile de yapabilirsiniz. aranacak dize olarak.

Parlak.

As zserge 'in yorumları önerdi

Kereste çok güzel, ancak zaten mevcut bir projeniz varsa - github.com/zserge/log'u deneyebilirsiniz. Bu android.util.Log için bir açılan yedek ve Kereste'nin sahip olduğu özelliklerin çoğuna ve daha fazlasına sahiptir.

kütük kütüphanesi , aşağıdaki gibi basit etkinleştirme / devre dışı bırakma günlük yazdırma anahtarı sağlar.

Ayrıca, yalnızcaimport satırların değiştirilmesi gerekir ve hiçbir şeyinLog.d(...); ifade için değiştirilmesi gerekmez.

if (!BuildConfig.DEBUG)
    Log.usePrinter(Log.ANDROID, false); // from now on Log.d etc do nothing and is likely to be optimized with JIT

Farklı günlük düzeyleri için destek sağlayarak ve kodun canlı bir aygıtta veya öykünücüsünde çalıştırılmasına bağlı olarak günlük düzeylerini otomatik olarak değiştirerek yukarıdaki çözümde iyileştirmeler yaptım.

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 sizin için sürüm yapınızı ve şimdi android.com'dan iyi haberleri sizin için yapacak:

http://developer.android.com/tools/help/proguard.html

ProGuard aracı, kullanılmayan kodu kaldırarak ve sınıfları, alanları ve yöntemleri semantik olarak belirsiz adlarla yeniden adlandırarak kodunuzu küçültür, optimize eder ve gizler. Sonuç, tersine mühendislik daha zor olan daha küçük boyutlu bir .apk dosyasıdır. ProGuard uygulamanızı tersine mühendislikle zorlaştırdığından, uygulamanız Uygulamalarınızı Lisanslarken olduğu gibi güvenliğe duyarlı özellikleri kullandığında kullanmanız önemlidir.

ProGuard, Android derleme sistemine entegre edilmiştir, bu yüzden manuel olarak çağırmanız gerekmez. ProGuard yalnızca uygulamanızı serbest bırakma modunda oluşturduğunuzda çalışır, bu nedenle uygulamanızı hata ayıklama modunda oluşturduğunuzda gizli kodla uğraşmanız gerekmez. ProGuard'ın çalıştırılması tamamen isteğe bağlıdır, ancak şiddetle tavsiye edilir.

Bu belgede, gizlenmiş yığın izlerinin kodunu çözmek için ProGuard'ın nasıl etkinleştirileceği ve yapılandırılacağı ve geri çekme aracının nasıl kullanılacağı açıklanmaktadır

Log.d (TAG, bazı dize, genellikle bir String.format ()) kullanmayı seviyorum.

TAG her zaman sınıf adıdır

Log.d'yi dönüştürün (TAG, -> Logd (sınıfınızın metninde)

private void Logd(String str){
    if (MainClass.debug) Log.d(className, str);
}

Bu şekilde, bir yayın sürümü oluşturmaya hazır olduğunuzda, MainClass.debug dosyasını false olarak ayarlayın!

Günlükler linux ve sed'de bash kullanılarak kaldırılabilir:

find . -name "*\.java" | xargs sed -ri ':a; s%Log\.[ivdwe].*\);%;%; ta; /Log\.[ivdwe]/ !b; N; ba'

Çok satırlı günlükler için çalışır. Bu çözümde, günlüklerin üretim kodunda bulunmadığından emin olabilirsiniz.

Bunun eski bir soru olduğunu biliyorum, ama neden tüm günlük çağrılarınızı Boolean logCallWasHere = true; // --- burada kalan günlüğünüz

Bu yüzden onları ne zaman geri koymak istediğinizi bileceksiniz ve if deyimi çağrınızı etkilemeyecek :)

Neden sadece

if(BuildConfig.DEBUG)
  Log.d("tag","msg");

? Ek kitaplığa gerek yok, projeyi bozma eğilimi olan hiçbir koruma kuralı yok ve java derleyici, sürüm oluştururken bu çağrı için bayt kodunu dışarıda bırakacak.

Ek kütüphanelerle uğraşmak veya kodunuzu manuel olarak düzenlemek istemiyorsanız çözümüm burada. Oluşturduğum bu Jupyter dizüstü tüm java dosyalarını gidip bütün Günlüğü iletileri yorum yapmak. Mükemmel değil ama benim için işi halletti.

benim yolum:

1) Sütun Seçim Modunu etkinleştir (alt + üst karakter + insert)

2) bir Günlük seçin. D (TAG, "metin"); 'Günlük' bölümü.

3) sonra shift + ctrl + alt + j yapın

4) Sol oku tıklayın

5) Shift + End Yap

6) Sil tuşuna basın.

bu, tüm LOG çağrılarını bir java dosyasında bir kerede kaldırır.

Bu basit geleneksel yöntemi kullanmayı deneyebilirsiniz:

Ctrl+ Shift+R

değiştirmek

Log.e(

İle

// Log.e(

Kotlin ile kolay, sadece birkaç üst düzey işlevi beyan edin

val isDebug: Boolean
    get() = BuildConfig.DEBUG

fun logE(tag: String, message: String) {
    if (isDebug) Log.e(tag, message)
}

fun logD(tag: String, message: String) {
    if (isDebug) Log.d(tag, message)
}

en basit yol;

kullanım DebugLog

Uygulama serbest bırakıldığında tüm günlükler DebugLog tarafından devre dışı bırakılır.

https://github.com/MustafaFerhan/DebugLog