Android注解利器：ButterKnife 的基本使用

前言

• ButterKnife 簡介

  ButterKnife是一個專注於Android系統的View注入框架,可以減少大量的findViewById以及setOnClickListener代碼，可視化一鍵生成。

項目github地址：https://github.com/JakeWharton/butterknife

• ButterKnife 優勢

  1、強大的View綁定和Click事件處理功能，簡化代碼，提升開發效率
  2、方便的處理Adapter里的ViewHolder綁定問題
  3、運行時不會影響APP效率，使用配置方便
  4、代碼清晰，可讀性強

如何添加依賴

• 在項目的project 的build.gredle 文件中的dependencies標簽下添加。

  classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'

例如：

buildscript {
    repositories {
        jcenter()
    }

    dependencies {
        classpath 'com.android.tools.build:gradle:2.2.2'
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
    }
}

allprojects {
    repositories {
        jcenter()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

 

• 在module的build.gredle 文件中添加

  apply plugin: 'android-apt'

• 在module的build.gredle 文件中的dependencies標簽中添加

  compile 'com.jakewharton:butterknife:8.4.0'
  apt 'com.jakewharton:butterknife-compiler:8.4.0'

例如

apply plugin: 'com.android.application'
apply plugin: 'android-apt'

android {
    compileSdkVersion 24
    buildToolsVersion "24.0.3"

    defaultConfig {
        applicationId "com.zyj.wifi"
        minSdkVersion 14
        targetSdkVersion 24
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    
    compile 'com.jakewharton:butterknife:8.4.0'
    apt 'com.jakewharton:butterknife-compiler:8.4.0'
}

 

如何使用

• 控件id 注解： @BindView（）

package com.dl.ButterKnifeDemo;

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.widget.Button;

import butterknife.BindView;
import butterknife.ButterKnife;

public class ButterknifeActivity extends AppCompatActivity {

    @BindView( R.id.button1 )
    public Button button1 ;
    
    // 注意：button 的修飾類型不能是：private 或者 static 。 否則會報錯：錯誤: @BindView fields must not be private or static. (com.zyj.wifi.ButterknifeActivity.button1)

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_butterknife);
        //綁定activity
        ButterKnife.bind( this ) ;

        button1.setText( "I am a button ");
    }
}

 

• 多個控件id 注解： @BindViews（）

package com.dl.ButterKnifeDemo;

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.widget.Button;
import java.util.List;
import butterknife.BindViews;
import butterknife.ButterKnife;

public class Main2Activity extends AppCompatActivity {

    @BindViews({ R.id.button1  , R.id.button2 ,  R.id.button3 })
    public List<Button> buttonList ;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main2);

        ButterKnife.bind(this);

        buttonList.get( 0 ).setText( "hello 1 ");
        buttonList.get( 1 ).setText( "hello 2 ");
        buttonList.get( 2 ).setText( "hello 3 ");
    }
}

• fragment 使用

package com.dl.ButterKnifeDemo;

import android.os.Bundle;
import android.support.v4.app.Fragment;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.Button;

import butterknife.BindView;
import butterknife.ButterKnife;

public class ButterknifeFragment extends Fragment {

    @BindView( R.id.button1 )
    public Button button1 ;

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment_butterknife, container, false);

        //綁定fragment
        ButterKnife.bind( this , view ) ;
        button1.setText( "I am a button ");
        return view ;
    }
}

• @BindString() ：綁定string 字符串

package com.dl.ButterKnifeDemo;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.Button;

import butterknife.BindString;
import butterknife.BindView;
import butterknife.ButterKnife;

public class ButterknifeActivity extends AppCompatActivity {

    @BindView( R.id.button1 ) //綁定button 控件
    public Button button1 ;

    @BindString( R.string.app_name )  //綁定string 字符串
    String meg;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_butterknife);

        //綁定activity
        ButterKnife.bind( this ) ;

        button1.setText( meg );
    }
}

• @BindArray() : 綁定string里面array數組

<resources>
    <string name="app_name">WiFi管家</string>
    
    <string-array name="city">
        <item>廈門市</item>
        <item>福州市</item>
        <item>泉州市</item>
        <item>漳州市</item>
        <item>龍岩市</item>
    </string-array>
    
</resources>



package com.dl.ButterKnifeDemo;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.Button;

import butterknife.BindArray;
import butterknife.BindView;
import butterknife.ButterKnife;

public class ButterknifeActivity extends AppCompatActivity {

    @BindView( R.id.button1 ) //綁定button 控件
    public Button button1 ;

    @BindArray(R.array.city )  //綁定string里面array數組
    String [] citys ;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_butterknife);

        //綁定activity
        ButterKnife.bind( this ) ;

        button1.setText( citys[0] );
    }
}

• @BindBitmap( ) : 綁定Bitmap 資源

package com.dl.ButterKnifeDemo;

import android.graphics.Bitmap;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.ImageView;

import butterknife.BindBitmap;
import butterknife.BindView;
import butterknife.ButterKnife;

public class ButterknifeActivity extends AppCompatActivity {

    @BindView( R.id.imageView ) //綁定ImageView 控件
    public ImageView imageView ;

    @BindBitmap( R.mipmap.wifi )  //綁定Bitmap 資源
    public Bitmap wifi_bitmap ;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_butterknife);

        //綁定activity
        ButterKnife.bind( this ) ;

        imageView.setImageBitmap( wifi_bitmap );
    }
}

 

• @BindColor( ) : 綁定一個顏色值

package com.dl.ButterKnifeDemo;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.Button;

import butterknife.BindColor;
import butterknife.BindView;
import butterknife.ButterKnife;

public class ButterknifeActivity extends AppCompatActivity {

    @BindView( R.id.button1 )  //綁定一個控件
    public Button button1 ;

    @BindColor( R.color.colorAccent ) int black ;  //綁定一個顏色值

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_butterknife);

        //綁定activity
        ButterKnife.bind( this ) ;

        button1.setTextColor(  black );

    }
}

• @OnClick( ) : 綁定控件點擊事件
• @OnLongClick( ) ： 綁定控件長按事件

package com.dl.ButterKnifeDemo;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.Toast;

import butterknife.ButterKnife;
import butterknife.OnClick;
import butterknife.OnLongClick;

public class ButterknifeActivity extends AppCompatActivity {

    @OnClick(R.id.button1 )   //給 button1 設置一個點擊事件
    public void showToast(){
        Toast.makeText(this, "is a click", Toast.LENGTH_SHORT).show();
    }

    @OnLongClick( R.id.button1 )    //給 button1 設置一個長按事件
    public boolean showToast2(){
        Toast.makeText(this, "is a long click", Toast.LENGTH_SHORT).show();
        return true  ;
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_butterknife);

        //綁定activity
        ButterKnife.bind( this ) ;

    }
}

• zelezny : Butterknife插件的使用

  插件的安裝

插件的使用

安裝完成插件后，會提示重啟AS，重啟完后，可以寫一個布局並且新建一個代碼類測試下。測試的過程中要注意的是，需要將光標移到setContentView(R.layout.acty_login)，將光標放到R.layout.acty_login，然后右鍵Generate就有了。要注意一定要將光標放在R.layout.acty_login上面。

這里需要注意的是在勾選控件的界面上，有一個CreateViewHolder , 很明顯這個是專門為ListView或者RecyclerView的適配器專門提供的。


筆　　者： MysticCoder

出　　處： http://www.cnblogs.com/mysticCoder/p/6266544.html

關於作者：專注於移動端開發。如有問題或建議，請多多賜教！

版權聲明：本文版權歸作者和博客園共有，歡迎轉載，但未經作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文鏈接。

特此聲明：所有評論和私信都會在第一時間回復。也歡迎園子的大大們指正錯誤，共同進步。或者 直接私信我

聲援博主：如果您覺得文章對您有幫助，可以點擊文章右下角 【推薦】一下。您的鼓勵是作者堅持原創和持續寫作的最大動力！