关于androidannotations（注解）的理解和使用（文档篇）
本文內(nèi)容來(lái)自對(duì)github上提供的文檔的翻譯，由于本人英文水平有限，可能會(huì)有很多不當(dāng)之處，還請(qǐng)各位大神予以指教和批評(píng)。
androidannotations是由 Pierre-Yves Ricau創(chuàng)建的，文檔說(shuō)明由Kay-Uwe Janssen編寫。
github地址：
- 項(xiàng)目地址：https://github.com/excilys/androidannotations
- 文檔介紹：https://github.com/excilys/androidannotations/wiki
- 官網(wǎng)網(wǎng)址：http://androidannotations.org/
目標(biāo)
通過(guò)依賴注入的方式實(shí)現(xiàn)：
- View、資源的初始化
- 事件綁定
- 服務(wù)注冊(cè)
- 簡(jiǎn)單的線程模型，通過(guò)annotation表示方法運(yùn)行在UI線程還是后臺(tái)線程。
優(yōu)點(diǎn)
- 在編譯時(shí)生成子類，對(duì)性能沒有影響，并且我們能夠check the code 來(lái)查看它是如何工作的。
- 項(xiàng)目大小只有50kb。
- 有效的簡(jiǎn)化代碼，避免重復(fù)繁瑣工作的進(jìn)行。
- 使我們的代碼更加便于維護(hù)。
androidannotations是如何工作的
androidannotations使用 Java Annotation Processing Tool標(biāo)準(zhǔn)動(dòng)態(tài)添加一個(gè)額外的資源目錄，用來(lái)存放生成的子類。
Activity注解
例如：當(dāng)我們使用@EActivity 注解activity時(shí)，會(huì)在同一個(gè)包下的另一個(gè)資源目錄中生成一個(gè)在名稱末尾添加了“_”的同名子類。下面的例子清楚的顯示了這一特性。
//使用@EActivity注解MyActivity package com.some.company; @EActivity public class MyActivity extends Activity {// ... }//注解后生成的子類，會(huì)在原activity名稱后添加一個(gè)"_" package com.some.company; public final class MyActivity_ extends MyActivity {// ... }這個(gè)生成的子類會(huì)在注解的activity中添加一些重寫的方法，如oncreate()等，并將這些方法的調(diào)用權(quán)限授權(quán)給原activity。正是因?yàn)檫@個(gè)原因，我們?cè)谇鍐挝募凶?cè)activity時(shí)，名稱后面千萬(wàn)不能忘記在末尾加上”_”.
使用@EActivity注解進(jìn)行布局綁定
@EActivity(R.layout.main) public class MyActivity extends Activity {}
@EActivity的參數(shù)必須是有效的布局id，表示此布局將被作為the Content View在activity中使用，相當(dāng)于我們經(jīng)常使用的setContentView(R.layout.main)。代碼示例如下：可以不給此注解提供參數(shù)，這時(shí)表示我們將會(huì)采用傳統(tǒng)的方式，即在onCreate方法中調(diào)用setContentView方法進(jìn)行布局綁定。代碼示例如下：
利用annotated啟動(dòng)一個(gè)activity
通常情況下，我們start一個(gè)activity時(shí)，會(huì)調(diào)用startActivity(this,MyListActivity.class)，這時(shí)啟動(dòng)的activity參數(shù)是MyListActivity，但是使用AndroidAnnotations時(shí)，我們需要調(diào)用的activity參數(shù)應(yīng)該是MyListActivity_，即startActivity(this,MyListActivity_.class)。Intent綁定啟動(dòng)activity
從AndroidAnntations2.4開始，提供了一個(gè)啟動(dòng)注解生成activity的靜態(tài)幫助類，通過(guò)它我們可以：通過(guò)綁定intent來(lái)啟動(dòng)activity；
//// Starting the activity MyListActivity_.intent(context).start();綁定一個(gè)到activity的intent
// Building an intent from the activity Intent intent = MyListActivity_.intent(context).get();在綁定intent時(shí)，定義flags
// You can provide flags MyListActivity_.intent(context).flags(FLAG_ACTIVITY_CLEAR_TOP).start();定義通過(guò)intent傳送的數(shù)據(jù)
// You can even provide extras defined with @Extra in the activity MyListActivity_.intent(context).myDateExtra(someDate).start();
從AndroidAnntations2.7開始，我們可以使用startActivityForResult()方法來(lái)啟動(dòng)activity了。
MyListActivity_.intent(context).startForResult(REQUEST_CODE);使用@OnActivityResult注解來(lái)獲取結(jié)果：
@OnActivityResult(REQUEST_CODE) void onResult(int resultCode) { }@OnActivityResult的參數(shù)必須是integer常量，這個(gè)常量是啟動(dòng)activity時(shí)提供的請(qǐng)求碼。onResult方法可以有多個(gè)參數(shù)：
- 攜帶返回?cái)?shù)據(jù)的android.content.Intent
- int或Integer的resultCode。
下面是幾個(gè)@OnActivityResult的示例：
@OnActivityResult(REQUEST_CODE)void onResult(int resultCode, Intent data) {}@OnActivityResult(REQUEST_CODE)void onResult(int resultCode) {}@OnActivityResult(ANOTHER_REQUEST_CODE)void onResult(Intent data) {}@OnActivityResult(ANOTHER_REQUEST_CODE)void onResult() {}從AndroidAnntations3.2開始，可以使用@OnActivityResult.Extra向帶有返回參數(shù)的intent注入extra。這個(gè)注解只能作為參數(shù)使用，并要保證使用此參數(shù)的方法已經(jīng)和 @OnActivityResult注解進(jìn)行綁定了。參數(shù)的類型必須是可添加的Bundle，其value就是結(jié)果data的key。如果沒有設(shè)置，則使用變量名作為key。下面是幾個(gè)例子：
@OnActivityResult(REQUEST_CODE) void onResult(int resultCode, Intent data, @OnActivityResult.Extra String value) { }@OnActivityResult(REQUEST_CODE) void onResult(int resultCode, @OnActivityResult.Extra(value = "key") String value) { }@OnActivityResult(REQUEST_CODE) void onResult(@OnActivityResult.Extra String strVal, @OnActivityResult.Extra int intVal) { }
MyListActivity_.intent(context).withOptions(bundle).start();
從AndroidAnntations3.3開始，我們可以通過(guò)綁定intent來(lái)輕松的傳遞Bundle了。從AndroidAnntations4.0開始,可以在綁定intent時(shí)，添加過(guò)渡動(dòng)畫了！
MyListActivity_.intent(context).start().withAnimation(enterAnimRes, exitAnimRes));
Fragment注解
使用注解操作Fragments
@EActivity(R.id.main) public class DetailsActivity extends FragmentActivity {}
在AndroidAnnotation2.6之前，并沒有fragment使用的注解支持，然而我們確信通過(guò)繼承FragmentActivity取代繼承Activity并 不會(huì)破壞AndroidAnnotations。就像這樣：2.6之后AndroidAnnotations對(duì)android.app.Fragment和android.support.v4.app.Fragment都提供了支持，并能動(dòng)態(tài)識(shí)別fragment的類型來(lái)使用正確的API。
@EFragment public class MyFragment extends Fragment {}
對(duì)fragment而言，需要使用@EFragment注解。示例如下：使用注解后，同樣會(huì)生成一個(gè)以”“結(jié)尾的子類，如MyFragment。當(dāng)創(chuàng)建一個(gè)新的fragment時(shí)，需要在布局文件中使用生成的子類，像這樣：
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"android:layout_width="fill_parent"android:layout_height="fill_parent"android:orientation="horizontal" ><fragment android:id="@+id/myFragment"android:name="com.company.MyFragment_"android:layout_width="fill_parent"android:layout_height="fill_parent" /></LinearLayout>Java代碼中這樣創(chuàng)建新實(shí)例：
MyFragment fragment = new MyFragment_();或使用builder：
MyFragment fragment = MyFragment_.builder().build();在fragment中，我們可以使用所有的注解：
@EFragment public class MyFragment extends Fragment {@BeanSomeBean someBean;@ViewByIdTextView myTextView;@AppMyApplication customApplication;@SystemServiceActivityManager activityManager;@OrmLiteDao(helper = DatabaseHelper.class, model = User.class)UserDao userDao;@Clickvoid myButton() {}@UiThreadvoid uiThread() {}@AfterInjectvoid calledAfterInjection() {}@AfterViewsvoid calledAfterViewInjection() {}@Receiver(actions = "org.androidannotations.ACTION_1")protected void onAction1() {} }
View injection and event listener binding will only be based on viewscontained inside the fragment. Note, however, that it’s isn’t currently the case for @EBean injected inside fragments: they haveaccess to the activity views.
上面這段話摘自github上提供的文檔說(shuō)明，沒有看明白，如果有了解這方面的大神，可以在評(píng)論中告訴我，我將不勝感激！^_^
- 使用注解給fragment綁定布局
很簡(jiǎn)單，只需要給@EFragment添加參數(shù)即可。這個(gè)參數(shù)就是要綁定布局的ID。
@EFragment(R.layout.my_fragment_layout)
public class MyFragment extends Fragment {
}
如果我們需要重寫onCreateView()方法時(shí)，比如需要用到savedInstanceState時(shí)，我們?nèi)匀豢梢允褂眠@個(gè)注解，只需要將方法的返回值設(shè)置為null即可。 - 強(qiáng)制布局注入
從AndroidAnnotation3.3開始，如果使用注解的類中onCreateView方法返回null，或其父類的onCreateView方法返回null而子類沒用重寫父類的該方法，我們就只是把要注入的布局當(dāng)做第一個(gè)注解參數(shù)。這時(shí)因?yàn)槲覀儾幌胫剌donCreateView方法返回的空布局。在某些情況下，下面這些行為是可以預(yù)期的：例如，一個(gè)類繼承自ListFragment，它的onCreateView方法返回為null，并且布局沒有通過(guò)@EFragment注解注入。為了在這種情況下實(shí)現(xiàn)功能，我們需要添加一個(gè)boolean類型的forceLayoutInjection參數(shù)。如果設(shè)置為true，布局注入將忽視onCreateView方法的返回值。，但是這個(gè)參數(shù)默認(rèn)情況下為false，所以如果沒有明確的指出forceLayoutInjection為true，布局將會(huì)被該方法的返回值替代（It is false by default, so the old behavior takes place if you do not explicitly set forceLayoutInjection to true.）。 注入Fragments
可以使用 @EActivity, @EFragment, @EView, @EViewGroup, @EBean, using @FragmentById or @FragmentByTag注解標(biāo)簽將fragment注入到類中，如果沒有特殊給定值，將在注解中使用變量名。- 使用@FragmentById or @FragmentByTag只能將fragment注入，不能創(chuàng)建fragment。所以我們要保證fragment已經(jīng)存在activity中（布局文件中定義或者oncreate方法中創(chuàng)建）。
- 即使fragment沒有使用@EFragment注解標(biāo)注，我們也可以將這些fragment注入到activity中。
@EActivity(R.layout.fragments) public class MyFragmentActivity extends FragmentActivity {@FragmentByIdMyFragment myFragment;@FragmentById(R.id.myFragment)MyFragment myFragment2;@FragmentByTagMyFragment myFragmentTag;@FragmentByTag("myFragmentTag")MyFragment myFragmentTag2; }
相關(guān)方法
@EActivity(R.layout.fragments) public class MyFragmentActivity extends FragmentActivity {@FragmentByIdvoid setOneFragmentById(MyFragment myFragmentId){// do something with myFragmentId}void setMultipleFragmentsById(@FragmentById MyFragment myFragmentId, @FragmentById(R.id.myFragment) MyFragment myFragmentId2){// do something with myFragmentId and myFragmentId2}@FragmentByTagvoid setOneFragmentByTag(MyFragment myFragmentTag){// do something with myFragmentTag}void setMultipleFragmentsByTag(@FragmentByTag MyFragment myFragmentTag, @FragmentByTag("myFragmentTag") MyFragment myFragmentTag2){// do something with myFragmentTag and myFragmentTag2} }
從AndroidAnnotation4.0開始，出現(xiàn)的基于注解的方法：使用注解時(shí)，DialogFragment要注意：
很不幸，在使用注解@EFragment時(shí)，我們不能通過(guò)onCreateDialog()方法創(chuàng)建新的Dialog實(shí)例。我們只能調(diào)用super.onCreateDialog()，設(shè)置其返回的Dialog實(shí)例。然后我們可以在由@AfterViews注解的方法中來(lái)自定義views。Fragment Argument
從AndroidAnnotations 2.7開始，可以使用@FragmentArg注解標(biāo)簽對(duì)Fragment綁定對(duì)應(yīng)的參數(shù)。
在生成的builder中，setter方法總是使用字段名稱作為參數(shù)名稱。默認(rèn)情況下，綁定參數(shù)值的關(guān)鍵就是字段名稱，不過(guò)我們可以通過(guò)給標(biāo)簽提供一個(gè)值來(lái)改變這一點(diǎn)。
- 相關(guān)方法
從 AndroidAnnotations 4.0開始：
Fragment 構(gòu)造器擁有對(duì)這些參數(shù)的專用方法：
MyFragment myFragment = MyFragment_.builder().myMessage("Hello").anotherStringArgument("World").build();自定義類的注解（如實(shí)體類等）
我們可以使用注解@EBean標(biāo)注非Android標(biāo)準(zhǔn)組件（如Activity、service）的類。注意：這個(gè)@EBean要求被標(biāo)注的類只用一個(gè)構(gòu)造函數(shù)，并且這個(gè)構(gòu)造函數(shù)不能有參數(shù)（或者，向AndroidAnnotations 2.7中一樣，只能擁有一個(gè)Context類型的參數(shù)）。
@EBean public class MyClass {}- 在已經(jīng)使用注解的類中或Android組件中引用另外一個(gè)被注解的類只需要使用@Bean注解即可
如果這個(gè)被標(biāo)注類不是單例的話，使用@Bean注解后，我們將會(huì)獲得它的實(shí)例。
與@Bean相關(guān)的方法
@EActivity public class MyActivity extends Activity {@Beanvoid setOneBean(MyClass myClass){// do something with myClass}void setMultipleBeans(@Bean MyClass myClass, @Bean MyOtherClass myOtherClass){// do something with myClass and myOtherClass} }值得注意的是，生成的子類都是final類，也就意味著生成的子類是不可被繼承的。然而，我們可以繼承原始類，并且原始類中生成的代碼也將為子類使用（However, you can extends original classes and generated code will be also generated for the child class. ）。這適用于所有的注解。
@EActivity public class MyChildActivity extends MyActivity {}
例如：下面MyChildActivity也會(huì)有myOtherClass的注入。注入接口的實(shí)現(xiàn)類到定義的接口字段中
@EActivity public class MyActivity extends Activity {/* A MyImplementation instance will be injected. * MyImplementation must be annotated with @EBean and implement MyInterface.*/@Bean(MyImplementation.class)MyInterface myInterface;}
從Since AndroidAnnotations 2.5開始，如果想要根據(jù)Since AndroidAnnotations 的API使用依賴關(guān)系，比如實(shí)現(xiàn)接口。我們可以通過(guò)@Bean的參數(shù)來(lái)實(shí)現(xiàn)。只需要將實(shí)現(xiàn)類作為@Bean的參數(shù)傳進(jìn)去即可，但是要保證實(shí)現(xiàn)類由@EBean標(biāo)注了并且實(shí)現(xiàn)了該接口。雖然這樣做以后，類仍然知道其以來(lái)的實(shí)現(xiàn)，但是至少使用這些依賴的代碼必須根據(jù)API實(shí)現(xiàn)。
@EBean支持的注解
@EBean public class MyClass {@SystemServiceNotificationManager notificationManager;@UiThreadvoid updateUI() {}}
在@EBean標(biāo)注的類中可以使用幾乎全部的AA 注解。我們可以在@EBean標(biāo)注的類中使用和view相關(guān)的標(biāo)注（如@View，@Click… …）。
@EBean public class MyClass {@ViewByIdTextView myTextView;@Click(R.id.myButton)void handleButtonClick() {} }注意：只有在依賴MyClass類的根Android組件（Activity等）包含需要的views，上面的代碼才能有效。否則myTextView將會(huì)是null，handleButtonClick方法將永遠(yuǎn)不會(huì)被調(diào)用。
@EBean public class MyClass {//1.@RootContext能取到調(diào)用該Bean的context，構(gòu)造方法不用傳context@RootContextContext context;//2.得到的是調(diào)用Activity的context對(duì)象@RootContextActivity activity;// 3.得到的是調(diào)用service的Context對(duì)象@RootContextService service;// 4.得到的是調(diào)用MyActivity的context對(duì)象@RootContextMyActivity myActivity;}
使用@RootContext可以獲取到Bean的context對(duì)象，如下：- 與RootContext相關(guān)的方法
從AndroidAnnotations 4.0開始：
依賴注入后執(zhí)行代碼過(guò)程
@EActivity public class MyActivity extends Activity {@BeanMyClass myClass;//MyClass類可以看上文中的代碼 }
當(dāng)@EBean標(biāo)注的類的構(gòu)造方法被調(diào)用時(shí)，其字段還沒有被注入，所以下面代碼中的MyClass類的service字段將會(huì)是null。如果想要在build時(shí)執(zhí)行代碼，在依賴注入后我們需要使用@AfterInject注解標(biāo)注一些方法：
@EBean public class MyClass {@SystemServiceNotificationManager notificationManager;@BeanMyOtherClass dependency;public MyClass() {// notificationManager and dependency are null}//標(biāo)注后service將會(huì)被注入@AfterInjectpublic void doSomethingAfterInjection() {// notificationManager and dependency are set} }警告:
父類和子類中不能出現(xiàn)由@AfterViews, @AfterInject or @AfterExtras標(biāo)注的同名方法，否則會(huì)出現(xiàn)錯(cuò)誤。如github有人提出這樣的問(wèn)題（https://github.com/excilys/androidannotations/issues/591）：
如圖，當(dāng)把Test2中的init()方法名變更一下，就可以運(yùn)行正確了。
- 當(dāng)我們調(diào)用這些注解標(biāo)注的方法時(shí)有固定的順序，但是對(duì)于由相同注解@AfterXXX標(biāo)注的方法在調(diào)用時(shí)是沒有固定順序的。如github上有人提出這樣的問(wèn)題（https://github.com/excilys/androidannotations/issues/810）：
@AfterXXX調(diào)用順序
- 使用相同的@AfterXXX標(biāo)注的方法的調(diào)用順序
同一個(gè)類中使用相同@AfterXXX標(biāo)注的方法的調(diào)用順序是無(wú)法保證的。如果我們想要按照一定的順序調(diào)用多個(gè)方法，應(yīng)該創(chuàng)建一個(gè)被標(biāo)注的方法，然后按照一定的順序使用這個(gè)方法去調(diào)用其他的方法。如果要處理父/子類中使用相同@AfterXXX標(biāo)注的方法，我們可以在https://github.com/excilys/androidannotations/issues/810#issuecomment-31218529找到答案。
當(dāng) @AfterExtras標(biāo)注的方法被調(diào)用時(shí)，所有沒和view關(guān)聯(lián)的注入都會(huì)被完成。因此使用@Bean標(biāo)注的字段是很安全的方式。這些views只會(huì)在@AfterViews標(biāo)注的方法調(diào)用時(shí)才會(huì)被獲取。
每當(dāng)intent到達(dá)Activity時(shí)，@AfterExtras 標(biāo)注的方法都會(huì)被調(diào)用。
對(duì)于Activity而言，每次執(zhí)行setContentView()方法時(shí)，@AfterViews被標(biāo)注的方法都會(huì)被調(diào)用。- 使用相同的@AfterXXX標(biāo)注的方法的調(diào)用順序
Extras
使用注解@Extra標(biāo)注的字段，表示Activity的字段需要連同開啟此Activity的intent傳來(lái)的相應(yīng)Extra一起被注入。
示例：
@EActivity public class MyActivity extends Activity {//myStringExtra和字段myMessage一起被注入@Extra("myStringExtra")String myMessage;//myDateExtra和字段myDateExtraWithDefaultValue 一起被注入@Extra("myDateExtra")Date myDateExtraWithDefaultValue = new Date();}從AndroidAnnotations 2.6開始，如果沒有為@Extra添加參數(shù)，則直接使用字段名作為extra的名稱。如：
@EActivity public class MyActivity extends Activity {// The name of the extra will be "myMessage"@ExtraString myMessage; }- 相關(guān)方法
從AndroidAnnotations 4.0開始：
我們可以使用前面提到的Intent綁定啟動(dòng)activity方法來(lái)傳遞extra values。
onNewIntent()方法
@EActivity public class MyActivity extends Activity {@Extra("myStringExtra")String myMessage;@Overrideprotected void onNewIntent(Intent intent) {super.onNewIntent(intent);//傳遞intent時(shí)自動(dòng)注入extrassetIntent(intent);} }
從AndroidAnnotations 2.6開始，AndroidAnnotations重寫了setIntent方法，并會(huì)在調(diào)用該方法時(shí)自動(dòng)注入指定intent傳遞的extras。這就有便于我們?cè)趏nNewIntent方法中調(diào)用setIntent方法時(shí)自動(dòng)注入extras。從AndroidAnnotations 3.2開始，如果在Activity中有被 @AfterExtras標(biāo)注的方法，我們就可以重寫onNewIntent方法來(lái)調(diào)用setIntent方法。
警告：
從AndroidAnnotations 4.0開始，我們不再重載onNewIntent方法，如果有需要的話，只能自己手動(dòng)重載該方法了。extras注入后執(zhí)行的代碼
@EActivity public class MyClass {@ExtraString someExtra;@Extraint anotherExtra;@AfterExtraspublic void doSomethingAfterExtrasInjection() {// someExtra and anotherExtra are set to the value contained in the incoming intent// if an intent does not contain one of the extra values the field remains unchanged} }
如果在注入extras之后需要進(jìn)行操作的話，我們需要將執(zhí)行邏輯方法標(biāo)注上@AfterExtras。如：
Views注入
@ViewById代表Activity的字段和布局中的view進(jìn)行了綁定，相當(dāng)于調(diào)用了findViewById方法。可以把布局中相應(yīng)view的id可以放在注解參數(shù)的位置進(jìn)行指定，如@ViewById(R.id.myTextView)。如果沒有給注解添加參數(shù)，就會(huì)使用字段的名字。字段的訪問(wèn)權(quán)限千萬(wàn)不能設(shè)置為私有。
示例：
- 相關(guān)方法
從AndroidAnnotation4.0開始：
- @ViewsById
從AndroidAnnotations 3.1開始使用的注解標(biāo)簽。與@ViewById相似，只是此標(biāo)簽用來(lái)注入一系列的view。會(huì)在java.util.List or android.view.View的子類字段上進(jìn)行標(biāo)注。它的參數(shù)值是一組R.id.*的值。注入完成之后，除去為null的view之外（為了避免增加null檢查的代碼），這些view的ID會(huì)被保存在list集合中。
- 相關(guān)方法
從AndroidAnnotations 4.0開始：
- @AfterViews
@AfterViews表示被標(biāo)注的方法會(huì)在view綁定后被調(diào)用。
onCreate方法被調(diào)用時(shí)，@ViewById還沒有被執(zhí)行，因此，我們只能在@AfterViews標(biāo)注的方法中添加view綁定之后要執(zhí)行的邏輯。
我們可以用@AfterViews標(biāo)注多個(gè)方法，但是一定要記得，我們不可以在onCreate方法中使用任何和view綁定的字段，否則會(huì)拋出空指針異常。
@EActivity(R.layout.main) public class MyActivity extends Activity {@ViewByIdTextView myTextView;@Overridepublic void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);// DON'T DO THIS !! It will throw a NullPointerException, myTextView is not set yet.// myTextView.setText("Date: " + new Date());}注入總是盡快進(jìn)行的，因此我們可以很放心的使用任何被注解標(biāo)注的字段，如@AfterView標(biāo)注的方法中被@Extra或者@InstanceState標(biāo)注的字段，因?yàn)檫@些注解不要求任何view的注入。所以我們可以很安全地假設(shè)@AfterViews標(biāo)注的方法中這些字段已經(jīng)被它們的預(yù)期值初始化了。
@EActivity(R.layout.main) public class MyActivity extends Activity {@ViewByIdTextView myTextView;@InstanceStateInteger textPosition;@AfterViewsvoid updateTextPosition() {myTextView.setSelection(textPosition); //Sets the cursor position of myTextView}自定義view注解
從事一段時(shí)間的開發(fā)以后，我們會(huì)發(fā)現(xiàn)一件事情：我們經(jīng)常會(huì)在不同的位置用到相同的布局，從而會(huì)不停的調(diào)用相同的方法來(lái)控制這些布局。自定義view會(huì)幫我們從這些繁瑣的工作中解放出來(lái)。
創(chuàng)建自定義組件時(shí)，我們會(huì)用到@EView 和@EViewGroup 。
- @EView
從AndroidAnnotations 2.4開始：
創(chuàng)建一個(gè)繼承View的類并用@EView進(jìn)行標(biāo)注。這樣，我們就可以在這個(gè)類中使用注解進(jìn)行邏輯操作了。如：
在布局文件中使用自定義的view，名稱上不要忘記要加上“_”：
<?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"android:layout_width="match_parent"android:layout_height="match_parent"android:orientation="vertical" ><-- 名稱上記得加"_"--><com.androidannotations.view.CustomButton_ android:layout_width="match_parent"android:layout_height="wrap_content" /> </LinearLayout>當(dāng)然，也可以通過(guò)代碼動(dòng)態(tài)創(chuàng)建，只是名稱上也要添加”_”：
CustomButton button = CustomButton_.build(context);- 自定義ViewGroup注解
從AndroidAnnotations 2.2開始，我們可以使用@EViewGroup自定義ViewGroup。
1.創(chuàng)建要用到的布局文件：
使用merge標(biāo)簽可以：在布局文件被引用時(shí)，子布局會(huì)直接被添加到父布局上去，我們可以在view樹上看到。
上述代碼中使用了很多relativeLayout特有的屬性，是因?yàn)檫@個(gè)布局文件我打算放到RelativeLayout中去。
下面我們?cè)诖a中創(chuàng)建自定義的view：
如何使用自定義的view呢？
很簡(jiǎn)單，我們可以像引用其他控件一樣在布局文件中找到位置帶包名引用即可，要注意的是，類名稱一定是帶“_”的。
在Activity中聲明并使用自定義控件：
@EActivity(R.layout.main) public class Main extends Activity {@ViewByIdprotected TitleWithSubtitle firstTitle, secondTitle, thirdTitle;@AfterViewsprotected void init() {firstTitle.setTexts("decouple your code","Hide the component logic from the code using it.");secondTitle.setTexts("write once, reuse anywhere","Declare you component in multiple " +"places, just as easily as you " +"would put a single basic View.");thirdTitle.setTexts("Let's get stated!","Let's see how AndroidAnnotations can make it easier!");} }同樣的，很多其他的注解標(biāo)簽在自定義控件中也是可以使用的。
AdapterViewEvents
在AdapterView中，我們可以使用以下注解來(lái)綁定方法去處理事件：
- @ItemClick：點(diǎn)擊事件
- @ItemLongClick：長(zhǎng)點(diǎn)擊事件
- @ItemSelect：條目選擇事件
這些注解的值是R.id.*，可以是多個(gè)。如果沒有給定值，那么會(huì)把方法的名稱當(dāng)做值的名稱。
被@ItemClick或@ItemLongClick標(biāo)注的方法必須擁有一個(gè)參數(shù)，這個(gè)參數(shù)可以是任意類型，當(dāng)調(diào)用adapter.getItem(position)時(shí)，會(huì)使用這個(gè)參數(shù)。
被@ItemSelect標(biāo)注的方法可能會(huì)有一個(gè)或兩個(gè)參數(shù)。第一個(gè)參數(shù)必須是boolean類型，第二個(gè)參數(shù)是從adapter被選擇的位置傳來(lái)的object類型。
如：
從AndroidAnnotations 2.4開始，如果被這些注解標(biāo)注的方法的參數(shù)給定的是int類型，則說(shuō)明從adapter傳來(lái)的不是對(duì)象，而是該對(duì)象所在的位置，或者說(shuō)是被點(diǎn)擊的位置。
Resource注解
所有的@xxxRes標(biāo)簽代表Activity中的字段要和res文件夾下的相對(duì)應(yīng)的資源綁定了。res的ID同樣是作為@xxxRes的參數(shù)進(jìn)行傳遞的，如果沒有給定參數(shù)，那么將使用字段的名稱作為id的名稱。
- @StringRes
用來(lái)和string資源進(jìn)行綁定。如：
- @ColorRes
用來(lái)綁定顏色資源。
- @AnimationRes
用來(lái)綁定XmlResourceParser字段（不太常用）或Animation字段（常用）。
- @DimensionRes
用來(lái)檢索dimension資源。
- @DimensionPixelOffsetRes
用來(lái)檢索dimension資源，會(huì)將檢索到的dimension的小數(shù)部分全部截去，保留整型值，除此之外與@DimensionRes是一樣的。
- @DimensionPixelSizeRes
用來(lái)檢索dimension資源，會(huì)將檢索到的dimension四舍五入保留整型值，除此之外與@DimensionRes是一樣的。
- 其他的資源注解標(biāo)簽
- @BooleanRes
- @ColorStateListRes
- @DrawableRes
- @IntArrayRes
- @IntegerRes
- @LayoutRes
- @MovieRes
- @TextRes
- @TextArrayRes
- @StringArrayRes
- 相關(guān)方法
從AndroidAnnotations 4.0開始：這兩個(gè)方法適用于上面提到的所有資源注解標(biāo)簽。
Application注解
從AndroidAnnotations 2.4開始，我們可以對(duì)application類使用注解標(biāo)注了，用到的注解標(biāo)簽為：@EApplication。除了和view、extras相關(guān)的注解標(biāo)簽，其他的我們都可以用到這個(gè)類中。
@EApplication public class MyApplication extends Application {public void onCreate() {super.onCreate();initSomeStuff();}@SystemServiceNotificationManager notificationManager;@BeanMyEnhancedDatastore datastore;@RestServiceMyService myService;@OrmLiteDao(helper = DatabaseHelper.class, model = User.class)UserDao userDao;@Backgroundvoid initSomeStuff() {// init some stuff in background} }從AndroidAnnotations 2.1開始，我們可以使用@APP標(biāo)簽標(biāo)注我們的application字段，不僅可以在Application類中，其他被注解標(biāo)注的類中同樣可以使用。
@EActivity public class MyActivity extends Activity {@AppMyApplication application;} ============================================= @EBean public class MyBean {@AppMyApplication application;}從AndroidAnnotations 3.0開始,Application類必須由@EApplication進(jìn)行標(biāo)注
- 相關(guān)方法
從AndroidAnnotations 4.0開始：
Service注解
從AndroidAnnotations 2.4開始，我們可以使用@EService來(lái)標(biāo)注service。
@EService public class MyService extends Service {}除了與views、extras相關(guān)的注解標(biāo)簽，我們可以任意使用AA注解標(biāo)簽。如：
@EService public class MyService extends IntentService {@SystemServiceNotificationManager notificationManager;@BeanMyEnhancedDatastore datastore;@RestServiceMyRestClient myRestClient;@OrmLiteDao(helper = DatabaseHelper.class, model = User.class)UserDao userDao;public MyService() {super(MyService.class.getSimpleName());}@Overrideprotected void onHandleIntent(Intent intent) {// Do some stuff...showToast();}@UiThreadvoid showToast() {Toast.makeText(getApplicationContext(), "Hello World!", Toast.LENGTH_LONG).show();} }使用注解開啟服務(wù)
startService(this, MyService_.class);
和activity一樣，在啟動(dòng)服務(wù)時(shí)也要在服務(wù)名稱末尾添加“_”，如：通過(guò)內(nèi)部構(gòu)造器來(lái)增強(qiáng)服務(wù)：
MyService_.intent(getApplication()).start();從 AndroidAnnotations 3.0開始，通過(guò)內(nèi)部構(gòu)造器的stop方法來(lái)停止之前開啟的增強(qiáng)服務(wù)。
MyService_.intent(getApplication()).stop();intent綁定啟動(dòng)服務(wù)
從AndroidAnnotation2.7開始，提供了一個(gè)啟動(dòng)注解生成service的靜態(tài)幫助類。通過(guò)它我們可以：啟動(dòng)service
// Starting the service MyService_.intent(context).start();綁定到service的intent
// Building an intent from the activity Intent intent = MyService_.intent(context).build();設(shè)置flags
// You can provide flags MyService_.intent(context).flags(Intent.FLAG_GRANT_READ_URI_PERMISSION).start();
intentService
從AndroidAnnotations 3.0開始，對(duì)于@EIntentService標(biāo)注的類中的方法，我們可以通過(guò)@ServiceAction注解標(biāo)簽來(lái)進(jìn)行簡(jiǎn)單的操作。至于@EService，除了與view、extras相關(guān)的注解標(biāo)簽，我們幾乎可以任意使用。
我們可以通過(guò)內(nèi)部構(gòu)造器來(lái)增強(qiáng)intentService：
MyIntentService_.intent(getApplication()) //.myAction("test") //.start();如果在構(gòu)造器中調(diào)用多個(gè)方法，將只執(zhí)行最后一個(gè)。
從Since AndroidAnnotations 3.3開始注意：
即使IntentService#onHandleIntent 是抽象的，我們?nèi)匀恍枰砑右粋€(gè)空實(shí)現(xiàn)。為了簡(jiǎn)便，AndroidAnnotations提供了AbstractIntentService 類，實(shí)現(xiàn)了該方法，所以我們不用再添加空實(shí)現(xiàn)了。SystemService
@EActivity public class MyActivity extends Activity {@SystemServiceNotificationManager notificationManager; }
@SystemService注解標(biāo)簽表示Activity的字段被注入到對(duì)應(yīng)的安卓系統(tǒng)服務(wù)中。相當(dāng)于調(diào)用了 Context.getSystemService() 方法。相關(guān)方法
@EActivity public class MyActivity extends Activity {@SystemServicevoid setNotificationManager(NotificationManager notificationManager){// do something with notificationManager}void setMultipleServices(@SystemService NotificationManager notificationManager, @SystemService AudioManager audioManager){// do something with notificationManager and audioManager} }
從AndroidAnnotations 4.0開始：
broadcastreceivers注解
@EReceiver
@EReceiver public class MyReceiver extends BroadcastReceiver {}
從 AndroidAnnotations 2.4開始，我們可以使用@EReceiver注解標(biāo)簽標(biāo)注BroadcastReceiver。除了與view、extras相關(guān)的注解標(biāo)簽，我們幾乎可以使用任意的AA注解。
@EReceiver public class MyReceiver extends BroadcastReceiver {@SystemServiceNotificationManager notificationManager;@BeanSomeObject someObject;}- @ReceiverAction
從AndroidAnnotations 3.2開始，我們可以使用此注解標(biāo)簽在接受者中進(jìn)行簡(jiǎn)單的廣播操作。默認(rèn)情況下，AndroidAnnotations 會(huì)根據(jù)被標(biāo)注的方法名來(lái)判斷執(zhí)行的操作，不過(guò)我們可以通過(guò)給標(biāo)簽添加參數(shù)來(lái)傳遞另外一個(gè)操作。
被此標(biāo)簽標(biāo)注的方法可能包含以下參數(shù)：
- android.content.Context：void onReceive(Context context, Intent intent)傳遞過(guò)來(lái)額context；
- android.content.Intent：void onReceive(Context context, Intent intent)傳遞過(guò)來(lái)的intent；
- 任何可能通過(guò)intent傳遞的被@ReceiverAction.Extra標(biāo)注的序列化參數(shù)（Parcelable 或Serializable 類型的參數(shù)）。
從Since AndroidAnnotations 3.3開始，注意：
即使BroadcastReceiver#onReceive是抽象的，我們?nèi)匀恍枰砑右粋€(gè)空實(shí)現(xiàn)。為了方便，AndroidAnnotations提供了 AbstractBroadcastReceiver類，實(shí)現(xiàn)了該方法，因此我們不再需要添加空實(shí)現(xiàn)了。注意：
我們可以通過(guò)添加@ReceiverAction的參數(shù)來(lái)添加多個(gè)動(dòng)作。
我們可以通過(guò)dataScheme屬性 ，我們可以設(shè)置一個(gè)或多個(gè)接受者處理的數(shù)據(jù)類型。
@EReceiver public class MyIntentService extends BroadcastReceiver {@ReceiverAction(actions = android.content.Intent.VIEW, dataSchemes = "http")protected void onHttp() {// Will be called when an App wants to open a http website but not for https.}@ReceiverAction(actions = android.content.Intent.VIEW, dataSchemes = {"http", "https"})protected void onHttps() {// Will be called when an App wants to open a http or https website.}}- @Receiver
通過(guò)此標(biāo)簽，我們可以向Activity/Fragment/service/intentService發(fā)送通知，而省掉了聲明 BroadcastReceiver的過(guò)程。
被@Receiver標(biāo)記的方法 的參數(shù)：
- AndroidAnnotations 3.2之前，最多只有一個(gè)android.content.Intent。
- AndroidAnnotations 3.2之后，可能包含以下參數(shù)：
- android.content.Context：void onReceive(Context context, Intent intent)傳遞過(guò)來(lái)額context；
- android.content.Intent：void onReceive(Context context, Intent intent)傳遞過(guò)來(lái)的intent；
- 任何可能通過(guò)intent傳遞的被@Receiver.Extra標(biāo)注的序列化參數(shù)（Parcelable 或Serializable 類型的參數(shù)）。
Registration（注冊(cè)）
用于在父類（Activity、Fragment、service）的生命周期中注冊(cè)或注銷一個(gè)廣播接收者。
registerAt屬性用來(lái)指定何時(shí)注冊(cè)或注銷廣播接收者。默認(rèn)值為OnCreateOnDestroy。
下面這張圖標(biāo)顯示了何時(shí)注冊(cè)/注銷會(huì)發(fā)生，并顯示了其屬性值在什么時(shí)候會(huì)用到。
示例：
@EFragment public class MyFragment extends Fragment {@Receiver(actions = "org.androidannotations.ACTION_1")protected void onAction1RegisteredOnCreateOnDestroy() {}@Receiver(actions = "org.androidannotations.ACTION_2", registerAt = Receiver.RegisterAt.OnAttachOnDetach)protected void onAction2RegisteredOnAttachOnDetach(Intent intent) {}@Receiver(actions = "org.androidannotations.ACTION_3", registerAt = Receiver.RegisterAt.OnStartOnStop)protected void action3RegisteredOnStartOnStop() {}@Receiver(actions = "org.androidannotations.ACTION_4", registerAt = Receiver.RegisterAt.OnResumeOnPause)protected void action4RegisteredOnResumeOnPause(Intent intent) {}}Local 廣播
注冊(cè)廣播時(shí)，設(shè)置local參數(shù)可以通過(guò)LocalBroadcastManager實(shí)現(xiàn)本地注冊(cè)，而不是使用父類的context。
local的默認(rèn)值為false。
ContentProvider注解
從AndroidAnnotations 2.4開始，我們可以使用@EProvider注解標(biāo)簽標(biāo)注ContentProvider。
示例：
除了與view、extra相關(guān)的注解，我們幾乎可以使用所有的AA注解。
示例：
和TextView相關(guān)的注解
- HTML
AndroidAnnotations 2.2開始，我們可以通過(guò)@FromHtml和@HtmlRes兩個(gè)注解標(biāo)簽來(lái)向TextView中添加HTML。
下面給出HTML字符串的資源文件：
@HtmlRes
此注解和@StringRes類似，都是綁定字符串資源。不同的是，次注解會(huì)通過(guò)調(diào)用HTML.fromHtml()方法來(lái)格式話字符串。
示例：
@FromHtml
當(dāng)TextView被@ViewById標(biāo)注后，可以使用此注解標(biāo)注該TextView。作用是：將HTML字符串添加到TextView中。
示例：
文本變化監(jiān)聽
此功能適用于AndroidAnnotations 2.6及之后。@TextChange
當(dāng)指定TextView或其子類的TextView上的文本發(fā)生變化時(shí)，使用此注解可以接收到文本變化的監(jiān)聽事件。此事件由android.text.TextWatcher.onTextChanged(CharSequence s, int start, int before, int count)定義。
此注解的參數(shù)可以是一個(gè)或多個(gè)TextView的R.id.*，如果沒有給定參數(shù)，將使用被標(biāo)注的方法名作為參數(shù)。這個(gè)方法可能包含多個(gè)參數(shù)：- android.widget.TextView：明確監(jiān)聽事件的view；
- java.lang.CharSequence：獲得被修改的文本；
- int start：修改的起始位置；
- int before：修改前文本的長(zhǎng)度；
- int count：修改的文本個(gè)數(shù)。
示例：
@BeforeTextChange
當(dāng)指定TextView或其子類的TextView上的文本發(fā)生變化之前，使用此注解可以接收到文本變化的監(jiān)聽事件。此事件由android.text.TextWatcher.beforeTextChanged(CharSequence s, int start, int count, int after)定義。此注解的參數(shù)可以是一個(gè)或多個(gè)TextView的R.id.*，如果沒有給定參數(shù)，將使用被標(biāo)注的方法名作為參數(shù)。這個(gè)方法可能包含多個(gè)參數(shù)：- android.widget.TextView：明確監(jiān)聽事件的view；
- java.lang.CharSequence：獲取修改之前的文本；
- int start：修改的起始位置；
- int count：修改的文本個(gè)數(shù)；
- int after：修改后的文本長(zhǎng)度。
示例：
@AfterTextChange
當(dāng)指定TextView或其子類的TextView上的文本發(fā)生變化之后，使用此注解可以接收到文本變化的監(jiān)聽事件。此事件由android.text.TextWatcher.afterTextChanged(Editable s)定義。此注解的參數(shù)可以是一個(gè)或多個(gè)TextView的R.id.*，如果沒有給定參數(shù)，將使用被標(biāo)注的方法名作為參數(shù)。這個(gè)方法可能包含多個(gè)參數(shù)：- android.widget.TextView：明確監(jiān)聽事件的view；
- android.text.Editable：在修改的文本上做改變。
示例：
@EditorAction
從AndroidAnnotations 3.1開始。
當(dāng)指定TextView或其子類的TextView被編輯時(shí)，使用此注解可以接收到文本變化的監(jiān)聽事件。此事件由android.widget.TextView.OnEditorActionListener#onEditorAction(android.widget.TextView, int, android.view.KeyEvent)定義。此注解的參數(shù)可以是一個(gè)或多個(gè)TextView的R.id.*，如果沒有給定參數(shù)，將使用被標(biāo)注的方法名作為參數(shù)。這個(gè)方法可能包含多個(gè)參數(shù)：- android.widget.TextView：明確監(jiān)聽事件的view；
- int 類型的參數(shù)：獲取actionId；
- android.view.KeyEvent；
這個(gè)方法的返回值類型可以是void或boolean。
- boolean：被標(biāo)注的方法的返回值將被返回給生成的監(jiān)聽方法（指示別人處理）；
- void：監(jiān)聽方法總是返回true（自己處理）。
示例：
SharedPreference注解
AndroidAnnotations 從2.1開始，提供了SharedPreferencesHelpers，允許我們使用SharedPreference。
定義SharedPreference
1、創(chuàng)建一個(gè)接口，并用 @SharedPref進(jìn)行標(biāo)注。如：
使用@Pref注解標(biāo)簽，在Activity中創(chuàng)建定義的SharedPreferences 實(shí)例：
@EActivity public class MyActivity extends Activity {@PrefMyPrefs_ myPrefs;//注意：類型是帶“_”的 }在Activity中創(chuàng)建SharedPreferences 使用的類型，必須是生成的類，即名稱帶“_”的子類，千萬(wàn)不要使用原始類名
相關(guān)方法
從AndroidAnnotations 4.0開始：
之后可以調(diào)用如下方法：
// Simple edit myPrefs.name().put("John");// Batch edit myPrefs.edit().name().put("John").age().put(42).apply();// Preference clearing: myPrefs.clear();// Check if a value exists: boolean nameExists = myPrefs.name().exists();// Reading a value long lastUpdated = myPrefs.lastUpdated().get();// Reading a value and providing a fallback default value long now = System.currentTimeMillis(); long lastUpdated = myPrefs.lastUpdated().getOr(now);設(shè)置默認(rèn)值
從AndroidAnnotations 3.0開始，可以使用注解標(biāo)簽設(shè)置默認(rèn)值：@DefaultRes
示例：
使用字符串作為SharedPreferences的key
從AndroidAnnotations 3.1開始，我們可以使用strings文件中的字符串作為SharedPreferences的key，只需要將該字符串的ID設(shè)為keyRes的屬性值。如：
Scope
我們可以給通過(guò)設(shè)置value為下面的值來(lái)給SharedPreferences命名：
- ACTIVITY：名為MyActivity_MyPrefs的SharedPreferences專用；
- ACTIVITY_DEFAULT：名為MyActivity 的SharedPreferences專用；
- APPLICATION_DEFAULT：名為MyPrefs的SharedPreferences專用，是默認(rèn)的SharedPreference 或UNIQUE。
因此，如果定義的接口需要單獨(dú)的SharedPreferences，為了保證所有的Activity能夠分享同一個(gè)SharedPreferences，我們應(yīng)該這樣做：
在PreferenceActivity或PreferenceFragment中使用上面定義的SharedPreferences接口
public static String PREF_NAME = "MyPrefs";// in onCreate// Using your MyPrefs values this.getPreferenceManager().setSharedPreferencesName(PREF_NAME);// Opening the layout addPreferencesFromResource(R.xml.prefs);@PreferenceScreen
從AndroidAnnotations3.3開始，我們可以使用@PreferenceScreen注解來(lái)給組件（如Activity）添加preference布局了。此注解可以用在PreferenceActivity或PreferenceFragment或其子類上，同時(shí)，該組件必須用@EActivity或@EFragment標(biāo)注。
如：
注意：如果同時(shí)我們還是用了@ViewById或@AfterViews，可能會(huì)出現(xiàn)view為null的情況。(我們可以在這里找到原因：https://github.com/excilys/androidannotations/issues/1574#issuecomment-148840535)
從AndroidAnnotations3.3.1開始，@PreferenceScreen支持對(duì)android.support.v4.PreferenceFragment和com.github.machinarius.preferencefragment.PreferenceFragment的標(biāo)注。注意：這兩個(gè)類不是Android官方的類。
@PreferenceByKey
此注解可以用來(lái)標(biāo)注Preference及其子類中的字段、PreferenceActivity或PreferenceFragment的子類，并且保證這些類已經(jīng)被@EActivity或@EFragment標(biāo)注。
此標(biāo)注的值必須是字符串資源的id，和Preference的key關(guān)聯(lián)。
被標(biāo)注的Preference必須是在@AfterPreference標(biāo)注的方法中第一次出現(xiàn)。
例如：
相關(guān)方法
從AndroidAnnotations4.0開始：
@PreferenceChange
此標(biāo)簽代表指定的Preference被改變時(shí)，被標(biāo)注的方法會(huì)被調(diào)用，并會(huì)接收到OnPreferenceChangeListener.onPreferenceChange定義的事件。
此標(biāo)簽的值是和Preference及其子類關(guān)聯(lián)的字符串資源的id，可以給定有多個(gè)。如果沒有設(shè)置值，被標(biāo)注的方法名將作為該字符串資源的名稱進(jìn)行綁定。
被標(biāo)注的方法可能含有多個(gè)參數(shù)：
- Preference參數(shù)：標(biāo)志此方法的目標(biāo)preference；
- newVlaue：獲得這個(gè)preference的 Object、Set、Strings或String參數(shù)
如：
@PreferenceChange(R.string.myPref) void checkedChangedOnMyButton(boolean newValue, Preference preference) {// Something Here }@PreferenceChange void myPrefPreferenceChanged(Preference preference) {// Something Here }@PreferenceChange({R.string.myPref1, R.string.myPref2}) void preferenceChangeOnMultiplePrefs(Preference preference, String newValue) {// Something Here }@PreferenceChange(R.string.myPref) void preferenceChangeOnMyPref() {// Something Here }從AndroidAnnotations 3.3.1開始，Float、Integer、Long等原始 Android類也被支持作為上述參數(shù)中的newVlaue存在。因?yàn)锳ndroid Preference使用的是strings而不是numbers，AndroidAnnotations會(huì)自動(dòng)解析strings，并將獲得的數(shù)值傳給被@PreferenceChange標(biāo)注的方法。
例如：
從AndroidAnnotations 4.0開始，Preference的任意子類都能夠傳遞到方法中（如ListPreference）。
@PreferenceClick
此注解表示當(dāng)Preference被用戶點(diǎn)擊時(shí)，被它標(biāo)注的相對(duì)應(yīng)的方法將會(huì)被觸發(fā)，并接收到OnPreferenceClickListener#onPreferenceClick定義的事件。
此注解的值是相應(yīng)的Preference或其子類的id值，可以有多個(gè)。如果沒有設(shè)置值，那么方法名將被作為Preference的名稱進(jìn)行關(guān)聯(lián)。
被它標(biāo)注的方法可能含有這樣一個(gè)參數(shù)：
- Preference參數(shù)：表示被點(diǎn)擊的Preference對(duì)象。
如：
從AndroidAnnotations 4.0開始，任何Preference的子類都可以被傳送給被此注解標(biāo)注的方法（如ListPreference）。
@PreferenceHeaders
此注解可以用來(lái)標(biāo)注被@EActivity標(biāo)注的PreferenceActivity的子類，向其注入資源中定義的preference headers。它的值是一個(gè)R.xml.*。
如：
@AfterPreferences
在addPreferenceFromResource被調(diào)用后，此注解標(biāo)注的方法會(huì)被調(diào)用。addPreferenceFromResource會(huì)在super.onCreate()的末尾被調(diào)用。所有preference相關(guān)的代碼都在被此注解標(biāo)注的方法中完成。
如：
事件綁定
@Click表明被此注解標(biāo)注的方法必須和相對(duì)應(yīng)的具有點(diǎn)擊功能的view進(jìn)行綁定。我們可以通過(guò)給它設(shè)置參數(shù)來(lái)指定和誰(shuí)綁定在一塊，此參數(shù)就是該view的id，如果不指定參數(shù)，框架會(huì)把方法的名字作為view的名字進(jìn)行綁定，所以如果不給定參數(shù)的話，我們的參數(shù)要和控件的名字保持一致。
提示：方法不能設(shè)為私有。
例如：
從androidAnnotations4.0開始，view的任何子類都可以傳遞給方法（如button）中。
鍵盤的點(diǎn)擊事件
從AndroidAnnotations 4.0開始，在實(shí)現(xiàn)了KeyEvent.Callback接口的類中，我們可以很簡(jiǎn)單的操作下面這四種和鍵盤相關(guān)的事件。
- @KeyDown
- @KeyUp
- @KeyLongPress
- @KeyMultiple
我們可以通過(guò)注解的參數(shù)來(lái)設(shè)置key code或key codes。使用KeyEvent.KEYCODE_*常量，我們可以很容易地傳遞codes。例如，
如果沒有設(shè)置key code，會(huì)認(rèn)為方法的名稱就是key code。
如果Enter鍵的操作被調(diào)用，可能出現(xiàn)的命名是enter、onEnter、enterPressed、onEnterPressed。
被這四個(gè)注解標(biāo)注的方法可能的返回值類型為void、boolean或Boolean。如果返回的是void，將被認(rèn)為返回的是true（如：這個(gè)方法處理了這個(gè)事件）。
@KeyDown, @KeyUp, @KeyLongPress
被標(biāo)注的方法可能有一個(gè)或沒有參數(shù)。如果有參數(shù)，這個(gè)參數(shù)只能是可能被觸發(fā)的那個(gè)keyEvent。注意：這個(gè)方法絕對(duì)不能是私有的。同一個(gè)類中，不同的方法不能處理同一個(gè)事件。
@KeyMultiple
被標(biāo)注的方法可以有0-2個(gè)參數(shù)，這些參數(shù)可以是：
- int或Integer類型的參數(shù)：表示重復(fù)點(diǎn)擊的次數(shù)。
- 要觸發(fā)的keyEvent。
方法不能是私有的。同一個(gè)類中，不同的方法不能處理同一個(gè)事件。
例如：
PageChangeEvents
從AndroidAnnotations 4.0開始，當(dāng)頁(yè)面的滑動(dòng)狀態(tài)發(fā)生變化時(shí)，被此注解標(biāo)注的方法會(huì)接收到android.support.v4.view.ViewPager.OnPageChangeListener.onPageScrollStateChanged(int state) 定義的事件。注解的值是android.support.v4.view.ViewPager的子類的R.id.*，可以是多個(gè)。如果沒有設(shè)置值，方法名會(huì)被用作這個(gè)值。被標(biāo)注的方法可能有這樣參數(shù)：
- android.support.v4.view.ViewPager類型的參數(shù)：指定那個(gè)viewPager觸發(fā)這個(gè)事件；
- int類型的參數(shù)：獲取滑動(dòng)狀態(tài)。
這些參數(shù)都是可選的。
例如：
@PageScrolled
當(dāng)當(dāng)前頁(yè)面滑動(dòng)時(shí)，無(wú)論是程序啟動(dòng)的平滑滾動(dòng)的一部分還是用戶啟動(dòng)的觸摸滾動(dòng)，被注解的方法都會(huì)接收到android.support.v4.view.ViewPager.OnPageChangeListener.onPageScrolled(int position, float positionOffset, int positionOffsetPixels)定義的事件。注解的值是android.support.v4.view.ViewPager子類的R.id.*，可以是多個(gè)。如果沒有設(shè)置，方法名會(huì)被認(rèn)為是該值。被標(biāo)注的方法可能有以下幾個(gè)參數(shù)：
- android.support.v4.view.ViewPager：觸發(fā)事件的viewPager；
- int類型的參數(shù)：當(dāng)前顯示的第一個(gè)頁(yè)面的position。如果positionOffset不是0，那么第position+1個(gè)頁(yè)面將會(huì)被顯示。
- float參數(shù)：范圍為【0，1），表示頁(yè)面滑動(dòng)的偏移量，或者說(shuō)偏移的百分比。
- int參數(shù)：頁(yè)面偏移的像素?cái)?shù)。
這些參數(shù)都是可選的。
例如：
@PageSelected
當(dāng)某一頁(yè)面被選擇時(shí)，被此注解標(biāo)注的方法會(huì)接收到android.support.v4.view.ViewPager.OnPageChangeListener.onPageSelected(int position)定義的事件。它的值為 android.support.v4.view.ViewPager子類的R.id.*。如果值沒有設(shè)置，方法名將被認(rèn)為是該值。被標(biāo)注的方法可以有以下參數(shù)：
- android.support.v4.view.ViewPager：觸發(fā)事件的viewPager
- int參數(shù)：被選擇的頁(yè)面的position。
這些參數(shù)是可選的。
例如：
NonConfigurationInstance：配置改變，重新載入
從AndroidAnnotations 2.5開始，當(dāng)配置中發(fā)生改變時(shí)，Activity會(huì)被銷毀并重新創(chuàng)建。這個(gè)特性對(duì)于重載資源是很有利的，但是我們經(jīng)常需要在新舊Activity中進(jìn)行圖片加載、網(wǎng)絡(luò)訪問(wèn)、子線程等操作，這樣就很麻煩了。
這也就是我們需要這個(gè)注解的地方。我們可以使用這個(gè)注解標(biāo)注在Activity中定義的字段，這樣就可以在配置改變時(shí)保留它們的實(shí)例，如橫豎屏切換時(shí)，保留當(dāng)前Activity中的數(shù)據(jù)狀態(tài)。
如：
警告：我們可以使用這個(gè)注解標(biāo)注除了和Activity向關(guān)聯(lián)的字段之外的任何字段，如Drawable、Adapter、View或其他和context相關(guān)的對(duì)象，都不可以被標(biāo)注。如果標(biāo)注了，將會(huì)引起這些資源或view的泄露，從而導(dǎo)致內(nèi)存泄露。
上述警告內(nèi)容不適用于被@Bean標(biāo)注的實(shí)體類字段，因?yàn)锳ndroidAnnotations 自動(dòng)地重新綁定其上下文。
總結(jié)
以上是生活随笔為你收集整理的关于androidannotations（注解）的理解和使用（文档篇）的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇： bat一键修复打印机一直卡在正在删除提示
- 下一篇： webshell检测方式深度剖析 ---