2. 程式人生 > >java註解之編譯時註解RetentionPolicy.CLASS 基本用法

java註解之編譯時註解RetentionPolicy.CLASS 基本用法

阿新 • • 發佈：2018-11-01

1 前言

我們知道，在日常開發中我們常用的兩種註解是執行時註解和編譯時註解，執行時註解是通過反射來實現註解處理器的，對效能稍微有一點損耗，而編譯時註解是在程式編譯期間生成相應的代理類，替我們完成某些功能。今天我們來講解一下編譯時註解以及寫一個小例子，以便加深對編譯時註解的理解。

2 編譯時註解

編譯時註解(RetentionPolicy.CLASS)，指@Retention(RetentionPolicy.CLASS)作用域class位元組碼上，生命週期只有在編譯器間有效。編譯時註解註解處理器的實現主要依賴於AbstractProcessor來實現，這個類是在javax.annotation.processing包中，同時為了我們自己生成java原始檔方便，我們還需要引入一些第三方庫，主要包括
javapoet 用於生成java原始檔，可參考

https://github.com/square/javapoet
auto-service 主要用於生成一些輔助資訊，例如META-INF/services 一些資訊等

編譯時註解的核心就是實現AbstractProcessor的process()方法，一般來說主要有以下兩個步驟
1 蒐集資訊，包括被註解的類的類資訊，方法，欄位等資訊，還有註解的值
2 生成對應的java原始碼，主要根據上一步的資訊，生成響應的程式碼

下面我們來實際的寫一個編譯時註解的例子

3 編譯時註解例子

假設我們寫這樣一個類註解

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.CLASS)
public
 
 @interface Bind {

    int value();

}

這個Bind註解只能作用與類上面，一般我們作用於某個類上面了，我們做什麼工作呢，我們新建一個類，這個類的內容大體如下：

public class XXX$$value {
  public int sayHello(int n) {
    return value;
  }
}

其中，XXX是被註解的類名，value是註解的值。
看起來很簡單，對吧？下面我們就開始吧。

1 新建兩個java model，注意不是Android library model
這裡寫圖片描述
model的gradle配置如下

apply plugin: 'java'

為什麼要新建兩個module呢，
（1） 是因為後面再引用的時候，兩者有些不一樣，可以看一下

    api project(':ioc-annotation')
    annotationProcessor project(':ioc-compiler')

（2） 因為兩者的引用方式不同，導致最好把註解處理器和註解分開，這樣我們也能更好的解耦

注意，ioc-compiler需要引用以下兩個開源庫

apply plugin: 'java'

//解決編譯中文亂碼問題
tasks.withType(JavaCompile) {
    options.encoding = "UTF-8"
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])

    compile 'com.google.auto.service:auto-service:1.0-rc4'
    compile 'com.squareup:javapoet:1.7.0'
    compile project(':ioc-annotation')
}

sourceCompatibility = "1.8"
targetCompatibility = "1.8"

2 新建Bind註解，指定註解型別為class

/**
 * @author Created by qiyei2015 on 2018/4/14.
 * @version: 1.0
 * @email: [email protected]
 * @description: Bind註解 指明註解作用域為類
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.CLASS)
public @interface Bind {

    int value();

}

這一步挺好理解的。

3 新建BindProcessor繼承與AbstractProcessor並實現其process方法

/**
 * @author Created by qiyei2015 on 2018/4/15.
 * @version: 1.0
 * @email: [email protected]
 * @description: Bind註解處理器
 */
@AutoService(Processor.class)
public class BindProcessor extends AbstractProcessor{

    /**
     * java原始檔操作相關類，主要用於生成java原始檔
     */
    private Filer mFiler;
    /**
     * 註解型別工具類，主要用於後續生成java原始檔使用
     * 類為TypeElement，變數為VariableElement，方法為ExecuteableElement
     */
    private Elements mElementsUtils;
    /**
     * 日誌列印，類似於log,可用於輸出錯誤資訊
     */
    private Messager mMessager;

    private static final ClassName sClassName = ClassName.get("com.qiyei.ioc.api", "Test");

    /**
     * 初始化，主要用於初始化各個變數
     * @param processingEnv
     */
    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);

        mFiler = processingEnv.getFiler();
        mElementsUtils = processingEnv.getElementUtils();
        mMessager = processingEnv.getMessager();
    }

    /**
     * 支援的註解型別
     * @return
     */
    @Override
    public Set<String> getSupportedAnnotationTypes() {

        Set<String> typeSet = new LinkedHashSet<>();

        typeSet.add(Bind.class.getCanonicalName());

        return typeSet;
    }

    /**
     * 支援的版本
     * @return
     */
    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }

    /**
     *
     * 1.蒐集資訊
     * 2.生成java原始檔
     * @param annotations
     * @param roundEnv
     * @return
     */
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {

        if (!annotations.isEmpty()){
            //獲取Bind註解型別的元素，這裡是類型別TypeElement
            Set<? extends Element> bindElement = roundEnv.getElementsAnnotatedWith(Bind.class);

            try {
                generateCode(bindElement);
            } catch (IOException e) {
                e.printStackTrace();
            }
            return true;
        }

        return false;
    }

    /**
     *
     * @param elements
     */
    private void generateCode(Set<? extends Element> elements) throws IOException{

        for (Element element : elements){

            //由於是在類上註解，那麼獲取TypeElement
            TypeElement typeElement = (TypeElement) element;

            //獲取全限定類名
            String className = typeElement.getQualifiedName().toString();

            mMessager.printMessage(Diagnostic.Kind.WARNING,"className:" + className);

            //獲取包路徑
            PackageElement packageElement = mElementsUtils.getPackageOf(typeElement);
            String packageName = packageElement.getQualifiedName().toString();

            mMessager.printMessage(Diagnostic.Kind.WARNING,"packageName:" + packageName);

            //獲取用於生成的類名
            className = getClassName(typeElement,packageName);

            //獲取註解值
            Bind bindAnnotation = typeElement.getAnnotation(Bind.class);
            int value = bindAnnotation.value();
            System.out.println("value:" + value);

            //生成方法
            MethodSpec.Builder methodBuilder = MethodSpec
                    .methodBuilder("sayHello")
                    .addModifiers(Modifier.PUBLIC)
                    .addParameter(TypeName.INT,"n")
                    .returns(TypeName.INT);

            //$L表示字面量 $T表示型別
            methodBuilder.addStatement("return $L",value);

            //生成的類
            TypeSpec type = TypeSpec
                    .classBuilder(className + "$$" + value)
                    .addModifiers(Modifier.PUBLIC)
                    .addMethod(methodBuilder.build())
                    .build();

            //建立javaFile檔案物件
            JavaFile javaFile = JavaFile.builder(packageName,type).build();
            //寫入原始檔
            javaFile.writeTo(mFiler);

        }
    }

    /**
     * 根據type和package獲取類名
     * @param type
     * @param packageName
     * @return
     */
    private static String getClassName(TypeElement type, String packageName) {
        int packageLen = packageName.length() + 1;
        return type.getQualifiedName().toString().substring(packageLen)
                .replace('.', '$');
    }
}

其他方法暫時不做講解，邏輯都很簡單，主要講解generateCode(Set

            //獲取全限定類名
            String className = typeElement.getQualifiedName().toString();
            //獲取包路徑
            PackageElement packageElement = mElementsUtils.getPackageOf(typeElement);
            String packageName = packageElement.getQualifiedName().toString();

(2) 構造如上所示的java原始檔

            //生成方法
            MethodSpec.Builder methodBuilder = MethodSpec
                    .methodBuilder("sayHello")
                    .addModifiers(Modifier.PUBLIC)
                    .addParameter(TypeName.INT,"n")
                    .returns(TypeName.INT);

            //$L表示字面量 $T表示型別
            methodBuilder.addStatement("return $L",value);

            //生成的類
            TypeSpec type = TypeSpec
                    .classBuilder(className + "$$" + value)
                    .addModifiers(Modifier.PUBLIC)
                    .addMethod(methodBuilder.build())
                    .build();

這裡主要是用到javapoet，關於為什麼用這個開源庫，首先是用法比較簡單，其次很多開源框架都在用，包括ButterKnife等。關於生成java程式碼請一定參考https://github.com/square/javapoet 裡面有很詳細的說明。

(3) 將java原始碼寫入檔案

            //建立javaFile檔案物件
            JavaFile javaFile = JavaFile.builder(packageName,type).build();
            //寫入原始檔
            javaFile.writeTo(mFiler);

(4) 使用Bind註解，然後編譯生成程式碼
我們在我們的一個Activity上使用Bind註解，如下：

/**
 * @author Created by qiyei2015 on 2017/8/28.
 * @version: 1.0
 * @email: [email protected]
 * @description:
 */
@Bind(10)
public class MainActivity extends BaseSkinActivity {

    private RecyclerView mRecyclerView;

    private static final int MY_PERMISSIONS_REQUEST_WRITE_STORE = 1;

    /**
     * ViewModel
     */
    private MainMenuViewModel mMenuViewModel;

    private MainMenuAdapter mMenuAdapter;

    /**
     * 標題欄
     */
    private CommonTitleBar mTitleBar = null;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
//        PermissionManager.requestAllDangerousPermission(this);
        initData();
        initView();
        LogManager.i(TAG,"onCreate");
    }
    .......

}

然後編譯，生成的程式碼如下：
程式碼路徑：\build\generated\source\apt\baidu\debug\com\qiyei\appdemo\ui\activity 

package com.qiyei.appdemo.ui.activity;

public class MainActivity$$10 {
  public int sayHello(int n) {
    return 10;
  }
}

可以看到，符合我們的預期，這樣我們一個簡單的編譯時註解就已經完成了

注：雖然我們的程式碼如約生成了，但是我們並沒有用生成的程式碼，所以我們還應該寫一個api來使用生成的java原始碼檔案，不過這都是後話了，下次再介紹。

相關推薦

java註解之編譯時註解RetentionPolicy.CLASS 基本用法

1 前言 我們知道，在日常開發中我們常用的兩種註解是執行時註解和編譯時註解，執行時註解是通過反射來實現註解處理器的，對效能稍微有一點損耗，而編譯時註解是在程式編譯期間生成相應的代理類，替我們完成某些功能。今天我們來講解一下編譯時註解以及寫一個小例子，以便加深對編譯時註解的理解。

自定義註解之編譯時註解(RetentionPolicy.CLASS)（二）——JavaPoet

在使用編譯時註解時，需要在編譯期間對註解進行處理，在這裡我們沒辦法影響程式的執行邏輯，但我們可以進行一些需處理，比如生成一些功能性程式碼來輔助程式的開發，最常見的是生成.java 原始檔，並在程式中可以呼叫到生成的檔案。這樣我們就可以用註解來幫助我們處理一些固定邏輯的重複性

自定義註解之執行時註解(RetentionPolicy.RUNTIME)

前面有提到註解按生命週期來劃分可分為3類： 1、RetentionPolicy.SOURCE：註解只保留在原始檔，當Java檔案編譯成class檔案的時候，註解被遺棄； 2、RetentionPolicy.CLASS：註解被保留到class檔案，但jvm載入class檔案

利用編譯時註解生成Java原始碼

我們在編寫註解的時候，需要指定@Retention，有三個可選值，表示註解會被保留到那個階段。 RetentionPolicy.SOURCE       這種型別的Annotations只在原始碼級別保留,編譯時就會被忽略，因此一般用來為編譯器提供額外資訊，以便於檢測錯誤，

Java編譯時註解自動生成程式碼

在開始之前，我們首先申明一個非常重要的問題：我們並不討論那些在執行時（Runtime）通過反射機制執行處理的註解，而是討論在編譯時（Compile time）處理的註解。註解處理器是一個在javac中的，用來編譯時掃描和處理的註解的工具。可以為特定的註解，註冊自己的註解處

Java編譯時註解應用-生成格式化原始檔

引言 有許多開源框架在編譯時通過註解資訊生成新的原始檔，已到達簡化樣板程式碼的書寫，比如說典型的Builder模式，或者實現框架的功能的橋接程式碼。因為我使用編譯時註解只是想要簡化樣板程式碼，下面我就以Builder模式作為示例。 Builder模式

關於java編譯時註解你需要知道的二三事。解除你的顧慮！

做Android開發。大家肯定會關心你的app的效能問題。不知道從何時開始。網上有流傳一句。不要使用註解。用註解會影響效能。這不能說錯。但是也不能說對。這裡普及一下關於註解的一些你需要知道的知識 網上常說的註解。基本是執行時註解。而所說的註解會影響效能。則

編譯時註解（三）Arouter原始碼講解

專案中我們有時需要跨模組startActivity，但是這樣需要配置menifest，不方便。這時就需要阿里的一個路由框架Arouter Arouter的使用就不再多說了。這篇文章主要講解他的原始碼 1.初始化 ARouter.init( this ); public sta

Java基礎之《@Transactional註解需注意事項》

@Transactional註解預設值 String value() default ""; Propagation propagation() default Propagation.REQUIRED; Isolation isolation() default Isola

編譯時註解（一）AbstractProcessor實戰

Java中的註解(Annotation)是一個很神奇的東西，特別現在有很多Android庫都是使用註解的方式來實現的。 我們並不討論那些在執行時（Runtime）通過反射機制執行處理的註解，而是討論在編譯時（Compile time）處理的註解。下面便入手學習下

java基礎之-自定義註解一

（分類資訊來自百度搜索） 執行機制分類： 源註解 程式碼中註解編譯後class中沒有 編譯時註解 再class中存在的 執行時註解 執行時起作用的註解 按來源分 JDK自帶註解 三方註解 最常見 自定義註解 元註解 註解的註解 今天來看看J

Android 如何編寫基於編譯時註解的專案

                     一、概述在Android應用開發中，我們常常為了提升開發效率會選擇使用一些基於註解的框架，但是由於反射造成一定執行效率的損耗，所以我們會更青睞於編譯時註解的框架，例如：butterknife免去我們編寫View的初始化以及事件的注入的程式碼。fragmentargs輕

編譯時註解（二）JavaPoet的使用

上一篇文章提到AbstractProcessor中生成java類，可以使用JavaPoet開源庫進行編寫。但是有個問題，addModifier提示無法找到Modifier，其實只要把 compile project(’:libprocess’) 改成 annot

通過編譯時註解生成程式碼實現自己的ButterKnife

背景概述 註解的處理除了可以在執行時通過反射機制處理外，還可以在編譯期進行處理。 Java5中提供了apt工具來進行編譯期的註解處理。apt是命令列工具，與之配套的是一套描述“程式在編譯時刻的靜態結構”的API：Mirror API（com.sun.mirr

使用編譯時註解簡單實現類似 ButterKnife 的效果

讀完本文你將瞭解： 什麼是編譯時註解 上篇文章 什麼是註解以及執行時註解的使用 中我們介紹了註解的幾種使用場景，這裡回顧一下： 編譯前提示資訊：註解可以被編譯器用來發現錯誤，或者清除不必要的警告； 編譯時生成程式碼：一些處理器可以在編譯時根據註

kotlin編寫編譯時註解

1.定義註解 As裡新建一個Java Library module，必須是Java Library Module 此處命名為route-api 該module存放一些與純java類相關的檔案 1. 定義一個註解 Route /** * @param name

Android 如何編寫基於編譯時註解的專案---轉載張鴻洋博文

一、概述 在Android應用開發中，我們常常為了提升開發效率會選擇使用一些基於註解的框架，但是由於反射造成一定執行效率的損耗，所以我們會更青睞於編譯時註解的框架，例如： butterknife免去我們編寫View的初始化以及事件的注入的程式碼。fragmentargs輕鬆的為fragment新增引數資

如何除錯編譯時註解處理器AnnotationProcessor

本來的話是想跟大家分享如何製作自己的編譯時註解處理器的，後來搜尋了一下發現網上有不少這方面的文章，寫得都很全面很優秀，所以就不獻醜了。如果大家還不知道怎麼寫自己的編譯時註解處理器，可以看下這位大神寫的文章學習下：http://blog.csdn.net/lmj6

Android編譯時註解框架4-爬坑

概述 因為有關APT的資料過少，又因為是Java Moudle +Android Moudle的使用方式，在專案編寫過程中，會有一些匪夷所思的奇怪問題~入門階段真的是步履維艱。 這篇部落格就是編寫《Android編譯時註解框架》系列中，將所遇到的一些坑列舉出來，並給出

ButterKnife編譯時註解探祕

安卓中很多有名的開源框架都運用了編譯時註解，如ButterKnife，EventBus , Retrofit , GreenDao等。所以作為一個合格的安卓開發者，學會運用編譯時註解是非常有必要的。 下面就仿照ButterKnife的view的注入寫一個例子來