注解處理器

平時大家用的注解都是運行時通過反射機(jī)制運行處理|的注解翅睛,本篇文章討論的是編譯時處理的注解力喷,一般用來自動生成代碼的注解例如ButterKnife慷妙;
如果需要使用注解處理器址儒,引用時使用代碼如下(以butterknife舉例):

 implementation 'com.jakewharton:butterknife:8.5.1'
//引用注解處理器芹枷,在編譯是自動生成相關(guān)代碼
 annotationProcessor 'com.jakewharton:butterknife-compiler:8.5.1'
使用ButterKnife的主代碼
public class ScrollingActivity extends AppCompatActivity {

    private static final String TAG = "ScrollingActivity";
    @BindView(R.id.btn_bk)
    Button mBtnBk;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_scrolling);
        ButterKnife.bind(this);
    }

    private void annotationStartActivity() {
        RouterService routerService = new Router(this).create(RouterService.class);
        User user = new User("張三來了", 300);
        routerService.startLibraryActivity("xiaoma", user);
    }

    @OnClick(R.id.btn_bk)
    public void onClick(View v) {
        switch (v.getId()) {
            default:
                break;
            case R.id.btn_bk:
               annotationStartActivity();
                break;
        }
    }
}
編譯后自動生成了ScrollingActivity_ViewBinding類,而 ButterKnife.bind(this)相當(dāng)于初始化了這個類,如果去掉 ButterKnife.bind(this)莲趣,改成new ScrollingActivity_ViewBinding(this)是跟上面的代碼功能一致的鸳慈;該類代碼如下:
public class ScrollingActivity_ViewBinding implements Unbinder {
  private ScrollingActivity target;

  private View view2131230756;

  @UiThread
  public ScrollingActivity_ViewBinding(ScrollingActivity target) {
    this(target, target.getWindow().getDecorView());
  }

  @UiThread
  public ScrollingActivity_ViewBinding(final ScrollingActivity target, View source) {
    this.target = target;

    View view;
    view = Utils.findRequiredView(source, R.id.btn_bk, "field 'mBtnBk' and method 'onClick'");
    target.mBtnBk = Utils.castView(view, R.id.btn_bk, "field 'mBtnBk'", Button.class);
    view2131230756 = view;
    view.setOnClickListener(new DebouncingOnClickListener() {
      @Override
      public void doClick(View p0) {
        target.onClick(p0);
      }
    });
  }

  @Override
  @CallSuper
  public void unbind() {
    ScrollingActivity target = this.target;
    if (target == null) throw new IllegalStateException("Bindings already cleared.");
    this.target = null;

    target.mBtnBk = null;

    view2131230756.setOnClickListener(null);
    view2131230756 = null;
  }

下面說下注解處理器

  1. 虛處理器AbstractProcessor
    注解處理器的入口就是繼承了AbstractProcessor的繼承類的process方法
@AutoService(Processor.class)
public class InjectProcessor extends AbstractProcessor {
   
   private Types mTypeUtils;
    private Filer mFiler;
    private Messager mMessages;
    private Elements mElementUtils;

    @Override
    public synchronized void init(ProcessingEnvironment env){
        /* Element代表程序的元素,例如包喧伞、類和方法*/
        mElementUtils = processingEnv.getElementUtils();
        /*處理TypeMirror的工具類走芋,用于取類信息*/
        mTypeUtils = processingEnv.getTypeUtils();
        /* File可以創(chuàng)建文件*/
        mFiler = processingEnv.getFiler();
        mMessages = processingEnv.getMessager();
 }

    @Override
    public boolean process(Set<? extends TypeElement> annoations, RoundEnvironment env) { }

    @Override
    public Set<String> getSupportedAnnotationTypes() { }

    @Override
    public SourceVersion getSupportedSourceVersion() { }

}
  • init(ProcessingEnvironment env)方法用來提供核心的四個參數(shù)分別是Elements、Types潘鲫、Filer翁逞、Messager
  • process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)核心入口
  • getSupportedAnnotationTypes() 必須指定這個注解處理器是注冊給那個注解的,注意返回的是一個字符串的集合,也就是改注解處理器處理你指定的注解結(jié)合
  • getSupportedSourceVersion() 用來指定你使用的java版本溉仑;建議直接使用SourceVersion.latestSupported()返回
  1. 注冊你的處理器
    怎么把處理器InjectProcessor注冊到j(luò)avac中挖函,通過google提供的auto-service引用到項目中,并且把@AutoService(Processor.class)放到類InjectProcessor 上面就可以
apply plugin: 'java-library'

dependencies {
    implementation fileTree(include: ['*.jar'], dir: 'libs')
    implementation 'com.squareup:javapoet:1.8.0'
    implementation 'com.google.auto.service:auto-service:1.0-rc5'
    implementation project(':processor')
}

sourceCompatibility = "7"
targetCompatibility = "7"
  1. 拋出問題處理
    如果你在process()中拋出一個異常,那么運行注解處理器的JVM將會崩潰(就像其他Java應(yīng)用一樣)浊竟,使用我們注解處理器FactoryProcessor第三方開發(fā)者將會從javac中得到非常難懂的出錯信息怨喘,因為它包含F(xiàn)actoryProcessor的堆棧跟蹤(Stacktace)信息。因此振定,注解處理器就有一個Messager類哲思,它能夠打印非常優(yōu)美的錯誤信息,并且return true,退出處理
  2. 自動生成代碼,也是注解處理器的關(guān)鍵內(nèi)容吩案,這樣生成的新類就可以直接使用棚赔,建議使用如下引用庫生成java代碼
implementation 'com.squareup:javapoet:1.8.0'

相關(guān)內(nèi)容可以搜索javapoet相關(guān)內(nèi)容

  1. 分離注解處理器和注解
    這樣處理器相關(guān)的代碼就無序引用到項目內(nèi)了,只把對應(yīng)的注解引入就ok

關(guān)于路由和注解的項目地址
參考文章: 注解處理器

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市靠益,隨后出現(xiàn)的幾起案子丧肴,更是在濱河造成了極大的恐慌,老刑警劉巖胧后,帶你破解...
    沈念sama閱讀 218,682評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件芋浮,死亡現(xiàn)場離奇詭異,居然都是意外死亡壳快,警方通過查閱死者的電腦和手機(jī)纸巷,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,277評論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來眶痰,“玉大人瘤旨,你說我怎么就攤上這事∈” “怎么了存哲?”我有些...
    開封第一講書人閱讀 165,083評論 0 355
  • 文/不壞的土叔 我叫張陵,是天一觀的道長七婴。 經(jīng)常有香客問我祟偷,道長,這世上最難降的妖魔是什么打厘? 我笑而不...
    開封第一講書人閱讀 58,763評論 1 295
  • 正文 為了忘掉前任修肠,我火速辦了婚禮,結(jié)果婚禮上户盯,老公的妹妹穿的比我還像新娘嵌施。我一直安慰自己,他們只是感情好先舷,可當(dāng)我...
    茶點故事閱讀 67,785評論 6 392
  • 文/花漫 我一把揭開白布艰管。 她就那樣靜靜地躺著,像睡著了一般蒋川。 火紅的嫁衣襯著肌膚如雪牲芋。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,624評論 1 305
  • 那天捺球,我揣著相機(jī)與錄音缸浦,去河邊找鬼。 笑死氮兵,一個胖子當(dāng)著我的面吹牛裂逐,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播泣栈,決...
    沈念sama閱讀 40,358評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼卜高,長吁一口氣:“原來是場噩夢啊……” “哼弥姻!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起掺涛,我...
    開封第一講書人閱讀 39,261評論 0 276
  • 序言:老撾萬榮一對情侶失蹤庭敦,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后薪缆,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體秧廉,經(jīng)...
    沈念sama閱讀 45,722評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年拣帽,在試婚紗的時候發(fā)現(xiàn)自己被綠了疼电。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,030評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡减拭,死狀恐怖蔽豺,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情峡谊,我是刑警寧澤茫虽,帶...
    沈念sama閱讀 35,737評論 5 346
  • 正文 年R本政府宣布刊苍,位于F島的核電站既们,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏正什。R本人自食惡果不足惜啥纸,卻給世界環(huán)境...
    茶點故事閱讀 41,360評論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望婴氮。 院中可真熱鬧斯棒,春花似錦、人聲如沸主经。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,941評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽罩驻。三九已至穗酥,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間惠遏,已是汗流浹背砾跃。 一陣腳步聲響...
    開封第一講書人閱讀 33,057評論 1 270
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留节吮,地道東北人抽高。 一個月前我還...
    沈念sama閱讀 48,237評論 3 371
  • 正文 我出身青樓,卻偏偏與公主長得像透绩,于是被迫代替她去往敵國和親翘骂。 傳聞我的和親對象是個殘疾皇子壁熄,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,976評論 2 355