Как вы обычно помечаете записи журнала? (Android)

Я предполагаю, что большинство из вас знает об android.util.Log. Все методы ведения журналов принимают «String tag» в качестве первого аргумента.

И мой вопрос: как вы обычно отмечаете свои журналы в своих приложениях? Я видел такой жесткий код:

public class MyActivity extends Activity {
    private static final String TAG = "MyActivity";
    //...
    public void method () {
        //...
        Log.d(TAG, "Some logging");
    }
}

Это выглядит не очень красиво по многим причинам:

• Вы можете сказать мне, что у этого кода нет жесткого кода, но он есть.
• В моем приложении могло быть любое количество классов в разных пакетах с одинаковым именем. Так что читать журнал будет сложно.
• Это не гибко. Вы всегда добавляли в свой класс приватное поле TAG.

Есть ли какой-нибудь изящный способ получить ТЕГ для класса?

Я использую TAG, но инициализирую его так:

private static final String TAG = MyActivity.class.getName();

Таким образом, когда я реорганизую свой код, тег также изменится соответствующим образом.

Обычно я создаю Appкласс, который находится в другом пакете и содержит полезные статические методы. Один из методов - это getTag()метод, таким образом я могу получить ТЕГ везде.
Appкласс выглядит так:

РЕДАКТИРОВАТЬ : улучшено для каждого комментария моба br (спасибо :))

public class App {

    public static String getTag() {
        String tag = "";
        final StackTraceElement[] ste = Thread.currentThread().getStackTrace();
        for (int i = 0; i < ste.length; i++) {
            if (ste[i].getMethodName().equals("getTag")) {
                tag = "("+ste[i + 1].getFileName() + ":" + ste[i + 1].getLineNumber()+")";
            }
        }
        return tag;
    }

}

И когда я захочу его использовать:

Log.i(App.getTag(), "Your message here");

Выходные данные getTagметода - это имя класса вызывающего (с именем пакета) и номер строки, из которой getTagвызывается, для облегчения отладки.

Перейдите в Android Studio -> Preference -> Live Templates -> AndroidLog, затем выберите Log.d (TAG, String) .

В тексте шаблона заменить

android.util.Log.d(TAG, "$METHOD_NAME$: $content$");

с участием

android.util.Log.d("$className$", "$METHOD_NAME$: $content$");

Затем нажмите « Изменить переменные» и введите className () в столбец Expression рядом со столбцом className Name .

Теперь, когда вы вводите ярлык, logdон помещает

Log.d("CurrentClassName", "currentMethodName: ");

Вам больше не нужно определять ТЕГ.

Мне нравится улучшать ответ Янива, если у вас есть журнал в этом формате (filename.java:XX) xx номер строки, вы можете связать ярлык таким же образом, как связывается при возникновении ошибки, таким образом я могу напрямую перейти к рассматриваемой строке просто щелкнув логарифм

Я поместил это в свое расширенное приложение, чтобы я мог использовать его в любом другом файле

public static String getTag() {
    String tag = "";
    final StackTraceElement[] ste = Thread.currentThread().getStackTrace();
    for (int i = 0; i < ste.length; i++) {
        if (ste[i].getMethodName().equals("getTag")) {
            tag = "("+ste[i + 1].getFileName() + ":" + ste[i + 1].getLineNumber()+")";
        }
    }
    return tag;
}

Скриншот:

AndroidStudio имеет logtшаблон по умолчанию (вы можете ввести logtи нажать вкладку, чтобы развернуть его до фрагмента кода). Я рекомендую использовать это, чтобы избежать копирования и вставки определения TAG из другого класса и забыть изменить класс, о котором вы говорите. По умолчанию шаблон расширяется до

private static final String TAG = "$CLASS_NAME$"

Чтобы избежать использования старого имени класса после рефакторинга, вы можете изменить его на

private static final String TAG = $CLASS_NAME$.class.getSimpleName();

Не забудьте проверить кнопку «Изменить переменные» и убедиться, что CLASS_NAMEпеременная определена для использования className()Выражения и для нее установлен флажок «Пропустить, если определено».

Я создал класс статических переменных, методов и классов с именем S.

Ниже приводится метод регистрации:

public static void L(Context ctx, Object s) {
    Log.d("CCC " + ctx.getClass().getName().replace(ctx.getPackageName(), ""), s.toString());
}

Он вызывается в любом классе, так как S.L(this, whaterver_object);The getClass().getName()также добавляет имя пакета, поэтому я удаляю его, чтобы не делать тег излишне длинным.

Преимущества:

1. Короче чем Log.d(TAG,
2. Нет необходимости преобразовывать значения int в их строку. Фактически нет необходимости вводитьtoString
3. Не забуду удалить, так Log.dкак мне просто нужно удалить метод, и местоположения всех журналов будут отмечены красным.
4. Нет необходимости определять TAG в верхней части действия, поскольку он принимает имя класса.
5. Тег имеет префикс CCC(короткую, легко вводимую строку), так что в Android Studio легко отображать только ваши журналы на мониторе Android. Иногда вы запускаете службы или другие классы одновременно. Если вам нужно искать только по названию действия, вы не можете точно увидеть, когда был получен ответ службы, а затем произошло действие из вашей активности. Префикс, такой как CCC, помогает, поскольку он дает вам журналы в хронологическом порядке с активностью, в которой это произошло.

Вы можете использовать this.toString()для получения уникального идентификатора для конкретного класса, в котором вы печатаете в журнал.

За счет обновления этих строк, когда я перемещаю код между методами или переименовываю методы, мне нравится делать следующее. С философской точки зрения также кажется, что лучше оставить в теге «местоположение» или «контекст», а не сообщение.

public class MyClass {

    // note this is ALWAYS private...subclasses should define their own
    private static final LOG_TAG = MyClass.class.getName();

    public void f() {
        Log.i(LOG_TAG + ".f", "Merry Christmas!");
    }

}

Преимущество здесь в том, что вы можете отфильтровать один метод, даже если содержимое не статично, например

Log.i(LOG_TAG + ".f", String.valueOf(new Random().nextInt()));

Единственный недостаток заключается в том, что при переименовании f()в g()нужно помнить об этой строке. Кроме того, автоматический рефакторинг IDE их не улавливает.

Я имею в виду, что какое-то время я был поклонником использования короткого имени класса LOG_TAG = MyClass.class.getSimpleName(). Я обнаружил, что их труднее фильтровать в журналах, потому что там было меньше дел.

Это очень старый вопрос, но даже с учетом обновленного ответа на июль 2018 года предпочтительнее использовать Timber. Для правильного ведения журнала ошибки и предупреждения могут отправляться в сторонние библиотеки аварийного завершения, такие как Firebase или Crashlytics.

В класс, реализующий Application, вы должны добавить это:

@Override
public void onCreate() {
    super.onCreate();
    if (BuildConfig.DEBUG) {
        Timber.plant(new Timber.DebugTree());
    } else {
        Timber.plant(new CrashReportingTree());
    }
}

/** A tree which logs important information for crash reporting. */
private static class CrashReportingTree extends Timber.Tree {
    @Override protected void log(int priority, String tag, String message, Throwable t) {
        if (priority == Log.VERBOSE || priority == Log.DEBUG) {
            return;
        }

        FakeCrashLibrary.log(priority, tag, message);

        if (t != null) {
            if (priority == Log.ERROR) {
                FakeCrashLibrary.logError(t);
            } else if (priority == Log.WARN) {
                FakeCrashLibrary.logWarning(t);
            }
        }
    }
}

Не забывайте о зависимости от древесины.

implementation 'com.jakewharton.timber:timber:4.7.1'

Для тех пользователей, которые посещают этот вопрос:

private val TAG:String = this.javaClass.simpleName;

они используют Timber для приложения IOsched 2019 для отображения отладочной информации:

implementation 'com.jakewharton.timber:timber:4.7.1'

class ApplicationController: Application() {

override fun onCreate() {  
    super.onCreate()
    if(BuildConfig.DEBUG){
        Timber.plant(Timber.DebugTree())
    }
}   
// enables logs for every activity and service of the application
// needs to be registered in manifest like:  
 <application
    android:label="@string/app_name"
    android:name=".ApplicationController"
    ... >

использование

  Timber.e("Error Message") 
  // will print ->  D/MainActivity: Error Message

  Timber.d("Debug Message");
  Timber.tag("new tag").e("error message");

обратите внимание, что это делает журналы доступными только во время состояния DEBUG и облегчает вам задачу удаления их вручную для запуска в Google Play -

при выпуске приложения в магазине воспроизведения нам необходимо удалить все операторы журнала из приложения, чтобы никакие данные приложения, такие как информация о пользователе, скрытые данные приложения, токены аутентификации, не были доступны пользователю в logcat в виде простого текста

ознакомьтесь с этой статьей https://medium.com/mindorks/better-logging-in-android-using-timber-72e40cc2293d

Обычно я использую имя метода в качестве тега, но из потока

String TAG = Thread.currentThread().getStackTrace()[1].getMethodName();

Это позволяет избежать нового исключения.

private static final String TAG = new RuntimeException().getStackTrace()[0].getClassName();