android-annotations使用入门

转载请标明出处：http://write.blog.csdn.net/postedit/41577317

androidannotation是一个非常牛逼的框架（https://github.com/excilys/androidannotations/wiki），可以做到：依赖注入（Dependency Injection），简化的线程模型（Simplified  threading model)，事件绑定（Event binding），REST Client。

非常好用，更重要的是它对性能无影响！本文我们简要的来看一下一些入门的东西。

1.从例子开始（参考https://github.com/excilys/androidannotations/wiki/FirstActivity）：

AndroidManifest.xml

[html] view
plaincopy

1. <?xml version="1.0" encoding="utf-8"?>
2. <manifest xmlns:android="http://schemas.android.com/apk/res/android"
3. package="com.example.hello"
4. android:versionCode="1"
5. android:versionName="1.0" >
6. <uses-sdk
7. android:minSdkVersion="14"
8. android:targetSdkVersion="18" />
9. <application
10. android:allowBackup="true"
11. android:icon="@drawable/ic_launcher"
12. android:label="@string/app_name">
13. <activity
14. android:name="com.example.hello.MainActivity_"
15. android:label="@string/app_name" >
16. <intent-filter>
17. <action android:name="android.intent.action.MAIN" />
18. <category android:name="android.intent.category.LAUNCHER" />
19. </intent-filter>
20. </activity>
21. <activity android:name="com.example.hello.SecondActivity_" />
22. </application>
23. </manifest>

里面定义了两个activity，注意名字后面都带了一个下划线。

2.MainActivity.java:注意这里的名字没有下划线

[java] view
plaincopy

1. @EActivity(R.layout.activity_main)
2. public class MainActivity extends Activity {
3. @ViewById(R.id.myInput)
4. EditText myInput;
5. @ViewById(R.id.myTextView)
6. TextView textView;
7. @ViewById(R.id.myButton2)
8. Button btn2;
9. @StringRes(R.string.go_to_second)
10. String btn2Txt;
11. @AfterViews
12. protected void afterViews(){
13. btn2.setText(btn2Txt);
14. }
15. @Click
16. void myButton() {
17. String name = myInput.getText().toString();
18. textView.setText("Hello " + name);
19. }
20. @Click
21. void myButton2(){
22. SecondActivity_.intent(this).start();
23. }
24. }
25. activity_main.xml
26. <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
27. xmlns:tools="http://schemas.android.com/tools"
28. android:layout_width="match_parent"
29. android:layout_height="match_parent"
30. android:orientation="vertical" >
31. <EditText
32. android:id="@+id/myInput"
33. android:layout_width="fill_parent"
34. android:layout_height="wrap_content"  />
35. <Button
36. android:id="@+id/myButton"
37. android:layout_width="fill_parent"
38. android:layout_height="wrap_content"
39. android:text="Click me!" />
40. <TextView
41. android:id="@+id/myTextView"
42. android:layout_width="fill_parent"
43. android:layout_height="wrap_content" />
44. <Button
45. android:id="@+id/myButton2"
46. android:layout_width="fill_parent"
47. android:layout_height="wrap_content"
48. android:text="@string/go_to_second"/>
49. </LinearLayout>

SecondActivity的源码就不贴了。

使用注入以后，代码看上去变得很简洁，再也没有那一大堆findViewById之类的了。

如何进行编译运行呢（参考https://github.com/excilys/androidannotations/wiki/CustomizeAnnotationProcessing）：

（1）如果是使用javac，需要传递-AandroidManifestFile=/path/to/AndroidManifest.xml这个参数，指明Manifest文件。

（2）如果是使用Eclipse，在项目上点击右键->Properties->Java Compiler->Annotation Processing->Enable annotation processing，

然后在Factory Path中添加AndroidAnnotations的jar包。

（3）如果是使用maven，maven-compiler-plugin的3.1版本可以设置编译参数。

[html] view
plaincopy

1. <plugin>
2. <artifactId>maven-compiler-plugin</artifactId>
3. <version>3.1</version>
4. <configuration>
5. <encoding>UTF-8</encoding>
6. <source>1.6</source>
7. <target>1.6</target>
8. <compilerArgs>
9. <arg>-Atrace=true</arg>
10. <arg>-AlogLevel=trace</arg>
11. <arg>-AlogConsoleAppender=true</arg>
12. <arg>-AandroidManifestFile=/path/to/AndroidManifest.xml</arg>
13. </compilerArgs>
14. </configuration>
15. </plugin>

所有的可用的参数如下：

（1）trace：boolean，用来启用或者禁用@Trace注解，这个注解用会通过log记录方法的执行。

（2）androidManifestFile：string，默认情况下，AndroidAnnotations会在它的父文件夹中递归查找AndroidManifest.xml，假如你的工程的结构比较特殊，可以用这个进行指定。

（3）resourcePackageName：string，默认情况下，AndroidAnnotations会从AndroidManifest.xml文件中提取应用的package来找到R文件，假如R文件是在一个定制的package中，可以用它来设置。

（4）logFile：string，从3.0开始，AndroidAnnotations使用自定义的logger来在记录代码执行过程中的日志。日志默认会写在{outputFolder}/androidannotations.log文件中。

{outputFolder}参数按照下面的顺序进行查找：target-> build -> bin -> root project folder。如果找不到{outputFolder}，可以使用logFile指定输出的文件。{outputFolder}可以使用占位符来动态改变文件名。

（5）logLevel：string，enum(trace, debug, info, warn, error)：默认的日志级别是DEBUG，改为TRACE可能会有用。

（6）logAppenderConsole：boolean，默认情况下，AndroidAnnotations会使用FileAppender和MessagerAppender2个日志appender，FileAppender会写在日志文件中，MessagerAppender在IDE的消息列表中显示。可以设置logAppenderConsole为true来启用另一个ConsoleAppender。

（7）threadControl：boolean，用来启用或者禁用@SupposeUiThread和@SupposeBackground注解，默认是true，可以保证方法是在正确的线程中调用。

3.对性能的影响

无影响！因为它的原理是生成Activity类的子类，并不是使用反射！我们可以看下编译器帮我们自动生成的activity：

[java] view
plaincopy

1. public final class MainActivity_ extends MainActivity{
2. @Override
3. public void onCreate(Bundle savedInstanceState) {
4. init_(savedInstanceState);//这里会处理@StringRes，@ColorRes等等
5. super.onCreate(savedInstanceState);
6. setContentView(layout.activity_main);//这里对应@EActivity(R.layout.activity_main)
7. }
8. private void init_(Bundle savedInstanceState) {
9. Resources resources_ = this.getResources();
10. btn2Txt = resources_.getString(string.go_to_second);
11. }
12. @Override
13. public void setContentView(int layoutResID) {
14. super.setContentView(layoutResID);
15. afterSetContentView_();
16. }
17. @Override
18. public void setContentView(View view, LayoutParams params) {
19. super.setContentView(view, params);
20. afterSetContentView_();
21. }
22. @Override
23. public void setContentView(View view) {
24. super.setContentView(view);
25. afterSetContentView_();
26. }
27. private void afterSetContentView_() {
28. //@ViewById
29. textView = ((TextView) findViewById(id.myTextView));
30. myInput = ((EditText) findViewById(id.myInput));
31. btn2 = ((Button) findViewById(id.myButton2));
32. //@Click
33. {
34. View view = findViewById(id.myButton2);
35. if (view!= null) {
36. view.setOnClickListener(new OnClickListener() {
37. @Override
38. public void onClick(View view) {
39. MainActivity_.this.myButton2();
40. }
41. }
42. );
43. }
44. }
45. //@Click
46. {
47. View view = findViewById(id.myButton);
48. if (view!= null) {
49. view.setOnClickListener(new OnClickListener() {
50. @Override
51. public void onClick(View view) {
52. MainActivity_.this.myButton();
53. }
54. }
55. );
56. }
57. }
58. afterViews();//这里调用了@AfterViews标注的afterViews()方法
59. }
60. public static MainActivity_.IntentBuilder_ intent(Context context) {
61. return new MainActivity_.IntentBuilder_(context);
62. }
63. public static class IntentBuilder_ {//这个是给startActivity和startActivityForResult用的
64. private Context context_;
65. private final Intent intent_;
66. public IntentBuilder_(Context context) {
67. context_ = context;
68. intent_ = new Intent(context, MainActivity_.class);
69. }
70. public Intent get() {
71. return intent_;
72. }
73. public MainActivity_.IntentBuilder_ flags(int flags) {
74. intent_.setFlags(flags);
75. return this;
76. }
77. public void start() {
78. context_.startActivity(intent_);
79. }
80. public void startForResult(int requestCode) {
81. if (context_ instanceof Activity) {
82. ((Activity) context_).startActivityForResult(intent_, requestCode);
83. } else {
84. context_.startActivity(intent_);
85. }
86. }
87. }
88. }

最后看一下完整的pom.xml的例子（https://github.com/excilys/androidannotations/blob/develop/examples/maveneclipse/pom.xml）：

[html] view
plaincopy

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
3. <modelVersion>4.0.0</modelVersion>
4. <groupId>org.androidannotations</groupId>
5. <artifactId>maveneclipse</artifactId>
6. <version>0.0.1-SNAPSHOT</version>
7. <packaging>apk</packaging>
8. <name>maveneclipse</name>
9. <properties>
10. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
11. <android.version>4.1.1.4</android.version>
12. <android.platform>16</android.platform>
13. <androidannotations.version>3.2</androidannotations.version>
14. <java.version>1.6</java.version>
15. </properties>
16. <dependencies>
17. <dependency>
18. <groupId>com.google.android</groupId>
19. <artifactId>android</artifactId>
20. <version>${android.version}</version>
21. <scope>provided</scope>
22. </dependency>
23. <dependency>
24. <groupId>org.androidannotations</groupId>
25. <artifactId>androidannotations</artifactId>
26. <version>${androidannotations.version}</version>
27. <scope>provided</scope>
28. </dependency>
29. <dependency>
30. <groupId>org.androidannotations</groupId>
31. <artifactId>androidannotations-api</artifactId>
32. <version>${androidannotations.version}</version>
33. </dependency>
34. </dependencies>
35. <build>
36. <plugins>
37. <plugin>
38. <artifactId>maven-compiler-plugin</artifactId>
39. <version>3.1</version>
40. <configuration>
41. <source>${java.version}</source>
42. <target>${java.version}</target>
43. <compilerArgs>
44. <arg>-AlogLevel=trace</arg>
45. </compilerArgs>
46. </configuration>
47. </plugin>
48. <plugin>
49. <groupId>com.jayway.maven.plugins.android.generation2</groupId>
50. <artifactId>android-maven-plugin</artifactId>
51. <version>3.9.0-rc.3</version>
52. <configuration>
53. <sdk>
54. <platform>${android.platform}</platform>
55. </sdk>
56. <undeployBeforeDeploy>true</undeployBeforeDeploy>
57. </configuration>
58. <extensions>true</extensions>
59. </plugin>
60. </plugins>
61. </build>
62. </project>