android 註解入門（Acitivity路由demo）

參考《Java編程思想》

概述

近期接觸了路由和模塊間通信的內容，發現Java註解非常常用。
避免後面看各源碼被其阻塞，大致瞭解了下，作此文記錄之。

本文的Demo是 運行時註解的Demo。
編譯時註解將在其他文章講述，本文不作具體闡述。

註解類型

• @Target
• @Retention
• @Documented
• @Inherited

@Target

用於描述註解的使用範圍，可能的ElementType參數如下：

• CONSTRUCTOR:用於描述構造器
• FIELD:用於描述域
• LOCAL_VARIABLE:用於描述局部變量
• METHOD:用於描述方法
• PACKAGE:用於描述包
• PARAMETER:用於描述參數
• TYPE:用於描述類、接口(包括註解類型) 或enum聲明

@Retention

表示需要在什麼級別保存該註釋信息。可選的RetentionPolicy參數如下：

• SOURCE:在源文件中有效（不做任何保留，編譯之後就拋棄,比如@AutoService）
• CLASS:在class文件中有效（保留在class文件中，可以用來動態生成java文件等）
• RUNTIME:在運行時有效（保留在class文件中，運行時可以通過反射獲取）

@Documented

將此註解包含在JavaDoc中

@Inherited

允許子類繼承父類中的註解

Demo——Activity路由

Activity路由是一個比較常見會使用到註解的場景。
此處爲了演示，代碼非常簡略，實際實現路由不會這麼簡單。

最終輸出log：

com.example.annotaiontest D/RouterManager: {com.example.annotaiontest.MainActivity=scheme://test}

MainActivity.java

使用註解，並且在RouterManager初始化後輸出註冊的內容。

@TestRouter(url = "scheme://test")
public class MainActivity extends AppCompatActivity {

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

    RouterManager.getInstance().init();//初始化
    RouterManager.getInstance().showAllActivity();//show目前註冊的
  }
}

TestRouter.java

自定義註解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestRouter {
  public String url() default "";
}

RouterManager.java

用於存儲註冊的路由。初始化的時候會執行註冊操作。

public class RouterManager {
  //data
  private ArrayMap<String, String> map = new ArrayMap<>();

  private static final class Host {
    private static final RouterManager instance = new RouterManager();
  }

  private RouterManager() {
  }

  public void init() {
    RouterManager.getInstance().register(MainActivity.class);
  }

  public static RouterManager getInstance() {
    return Host.instance;
  }

  public void register(Class<? extends Activity> clazz) {
    TestRouter testEvent = clazz.getAnnotation(TestRouter.class);//嘗試獲取註解對象
    if (testEvent != null) {
      map.put(clazz.getName(), testEvent.url());
    }
  }

  public void showAllActivity() {
    Log.d("RouterManager", map.toString());
  }
}