butterknife README

The project's README from github.com/JakeWharton/butterknife. As one markdown file: README.md.

Butter Knife

Attention: This tool is now deprecated. Please switch to view binding. Existing versions will continue to work, obviously, but only critical bug fixes for integration with AGP will be considered. Feature development and general bug fixes have stopped.

Logo

Field and method binding for Android views which uses annotation processing to generate boilerplate code for you.

class ExampleActivity extends Activity {
  @BindView(R.id.user) EditText username;
  @BindView(R.id.pass) EditText password;

  @BindString(R.string.login_error) String loginErrorMessage;

  @OnClick(R.id.submit) void submit() {
    // TODO call server...
  }

  @Override public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.simple_activity);
    ButterKnife.bind(this);
    // TODO Use fields...
  }
}

For documentation and additional information see the website.

Remember: A butter knife is like a dagger, only infinitely less sharp.

Download

android {
  ...
  // Butterknife requires Java 8.
  compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
  }
}

dependencies {
  implementation 'com.jakewharton:butterknife:10.2.3'
  annotationProcessor 'com.jakewharton:butterknife-compiler:10.2.3'
}

If you are using Kotlin, replace annotationProcessor with kapt.

Snapshots of the development version are available in Sonatype's snapshots repository.

Library projects

To use Butter Knife in a library, add the plugin to your buildscript:

buildscript {
  repositories {
    mavenCentral()
    google()
  }
  dependencies {
    classpath 'com.jakewharton:butterknife-gradle-plugin:10.2.3'
  }
}

and then apply it in your module:

apply plugin: 'com.android.library'
apply plugin: 'com.jakewharton.butterknife'

Now make sure you use R2 instead of R inside all Butter Knife annotations.

class ExampleActivity extends Activity {
  @BindView(R2.id.user) EditText username;
  @BindView(R2.id.pass) EditText password;
...
}

License

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.

butterknife (JakeWharton/butterknife)

Searching Database…

25.3K ·GitHub
Butterknife
Что это такое?Butter Knife — это Android-библиотека, которая привязывает элементы интерфейса (views) и колбэки к полям и методам, а шаблонный код генерирует за вас с помощью обработки аннотаций.
Как это выглядит в коде?Вместо кода для поиска элементов вы просто ставите аннотации: @BindView избавляет от вызовов findViewById, @OnClick заменяет анонимные классы слушателей, а ресурсные аннотации убирают ручное получение ресурсов.
Как добавить её в Android-проект?Добавьте Butter Knife как Gradle-зависимость, подключённую через annotationProcessor; в проектах на Kotlin вместо этого используйте kapt.
Её ещё поддерживают, или новым проектам лучше её не брать?Проект устарел (deprecated): разработка новых возможностей и обычное исправление багов прекращены, рассматриваются только критические исправления интеграции с AGP. В README рекомендуют перейти на view binding.
Что можно делать, кроме привязки отдельных элементов?Можно сгруппировать несколько views в список или массив и работать со всеми сразу — через actions, сеттеры или свойства.
Она работает внутри Android-модулей-библиотек?Да — добавьте плагин Butter Knife в buildscript, примените его в модуле и используйте R2 вместо R во всех аннотациях Butter Knife.
Почему она называется Butter Knife?В README шутят, что butter knife — это как Dagger, только бесконечно менее острый: шуточная отсылка к библиотеке внедрения зависимостей Dagger.
What are similar projects?AndroidSwipeLayout, androidannotations, anko, EventBus, MVPArms, greenDAO, platform_frameworks_base, material-components-android
Which topics is it in?java-library, legacy, kotlin-android, android-development, jvm, android-library, boilerplate, build-tool, code-generation, mobile-development, deprecated, java
Creator
JakeWharton
Size
3.8 MB
Stars
25.3K
Updated
CommitSep 04
Age
13y
Commits · 90 Days