Аннотация: логирование вызовов методов по триггеру для отладочных сборок.

Как программист, вы часто добавляете операторы логирования для печати вызовов методов, их аргументов, возвращаемых значений и времени выполнения. Это не вопрос. Каждый из вас делает это. Разве это не должно быть проще?

Просто добавьте @DebugLog к своим методам, и вы автоматически получите всё перечисленное выше бесплатно.

@DebugLog
public String getName(String first, String last) {
  SystemClock.sleep(15); // Не делайте так на самом деле!
  return first + " " + last;
}

V/Example: ⇢ getName(first="Jake", last="Wharton")
V/Example: ⇠ getName [16ms] = "Jake Wharton"

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

Добавьте её в свой проект сегодня!

buildscript {
  repositories {
    mavenCentral()
  }

  dependencies {
    classpath 'com.jakewharton.hugo:hugo-plugin:1.2.1'
  }
}

apply plugin: 'com.android.application'
apply plugin: 'com.jakewharton.hugo'

Временно отключите логирование, добавив следующее:

hugo {
  enabled false
}

Если вы хотите переключать логирование во время выполнения, используйте Hugo.setEnabled(true|false).

Локальная разработка

Работаете над этим проектом? Вот несколько полезных задач Gradle:

• install — установить плагин, среду выполнения и аннотации в локальное хранилище.
• cleanExample — очистить сборку примера проекта.
• assembleExample — собрать пример проекта. Сначала необходимо запустить install.
• installExample — создать и установить отладочную APK-сборку примера проекта на устройство.

Лицензия

Copyright 2013 Jake Wharton

Licensed under the Apache License, Version 2.0 (the «License»);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an «AS IS» BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.