Java&Android 基礎知識梳理(1) 註解

時間 2019-11-21

標籤 java&android java android 基礎知識梳理註解欄目 Java 简体版

原文原文鏈接

1、什麼是註解

註解能夠向編譯器、虛擬機等解釋說明一些事情。舉一個最多見的例子，當咱們在子類當中覆寫父類的aMethod方法時，在子類的aMethod上會用@Override來修飾它，反之，若是咱們給子類的bMethod用@Override註解修飾，可是在它的父類當中並無這個bMethod，那麼就會報錯。這個@Override就是一種註解，它的做用是告訴編譯器它所註解的方法是重寫父類的方法，這樣編譯器就會去檢查父類是否存在這個方法。註解是用來描述Java代碼的，它既能被編譯器解析，也能在運行時被解析。html

2、元註解

元註解是描述註解的註解，也是咱們編寫自定義註解的基礎，好比如下代碼中咱們使用@Target元註解來講明MethodInfo這個註解只能應用於對方法進行註解：java

@Target(ElementType.METHOD)
public @interface MethodInfo {
    //....
}
複製代碼

下面咱們來介紹4種元註解，咱們能夠發現這四個元註解的定義又藉助到了其它的元註解：android

2.1 `Documented`

當一個註解類型被@Documented元註解所描述時，那麼不管在哪裏使用這個註解，都會被Javadoc工具文檔化，咱們來看如下它的定義：git

@Documented 
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
    //....
}
複製代碼

定義註解時使用@interface關鍵字：
@Document表示它自己也會被文檔化；
Retention表示@Documented這個註解能保留到運行時；
@ElementType.ANNOTATION_TYPE表示@Documented這個註解只可以被用來描述註解類型。

2.2 `Inherited`

代表被修飾的註解類型是自動繼承的，若一個註解被Inherited元註解修飾，則當用戶在一個類聲明中查詢該註解類型時，若發現這個類聲明不包含這個註解類型，則會自動在這個類的父類中查詢相應的註解類型。咱們須要注意的是，用inherited修飾的註解，它的這種自動繼承功能，只能對類生效，對方法是不生效的。也就是說，若是父類有一個aMethod方法，而且該方法被註解a修飾，那麼不管這個註解a是否被Inherited修飾，只要咱們在子類中覆寫了aMethod，子類的aMethod都不會繼承父類aMethod的註解，反之，若是咱們沒有在子類中覆寫aMethod，那麼經過子類咱們依然能夠得到註解a。github

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Inherited {
    //....
}
複製代碼

2.3 `Retention`

這個註解表示一個註解類型會被保留到何時，它的原型爲：數組

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention { 
    RetentionPolicy value();
}
複製代碼

其中，RetentionPolicy.xxx的取值有：緩存

SOURCE：表示在編譯時這個註解會被移除，不會包含在編譯後產生的class文件中。
CLASS：表示這個註解會被包含在class文件中，但在運行時會被移除。
RUNTIME：表示這個註解會被保留到運行時，咱們能夠在運行時經過反射解析這個註解。

2.4 `Target`

這個註解說明了被修飾的註解的應用範圍，其用法爲：bash

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target { 
    ElementType[] value();
}
複製代碼

ElementType是一個枚舉類型，它包括：app

TYPE：類、接口、註解類型或枚舉類型。
PACKAGE：註解包。
PARAMETER：註解參數。
ANNOTATION_TYPE：註解註解類型。
METHOD：方法。
FIELD：屬性（包括枚舉常量）
CONSTRUCTOR：構造器。
LOCAL_VARIABLE：局部變量。

3、常見註解

3.1 `@Override`

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {}
複製代碼

告訴編譯器被修飾的方法是重寫的父類中的相同簽名的方法，編譯器會對此作出檢查，若發現父類中不存在這個方法或是存在的方法簽名不一樣，則會報錯。框架

3.2 `@Deprecated`

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {}
複製代碼

不建議使用這些被修飾的程序元素。

3.3 `@SuppressWarnings`

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings { 
  String[] value();
}
複製代碼

告訴編譯器忽略指定的警告信息。

4、自定義註解

在自定義註解前，有一些基礎知識：

註解類型是用@interface關鍵字定義的。
全部的方法均沒有方法體，且只容許public和abstract這兩種修飾符號，默認爲public。
註解方法只能返回：原始數據類型，String，Class，枚舉類型，註解，它們的一維數組。

下面是一個例子：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Inherited
public @interface MethodInfo { 
  String author() default "absfree"; 
  String date(); 
  int version() default 1;
}
複製代碼

5、註解的解析

5.1 編譯時解析

ButterKnife是解析編譯時註解很經典的例子，由於在Activity/ViewGroup/Fragment中，咱們有不少的findViewById/setOnClickListener，這些代碼具備一個特色，就是重複性很高，它們僅僅是id和返回值不一樣。這時候，咱們就能夠給須要執行findViewById的View加上註解，而後在編譯時根據規則生成特定的一些類，這些類中的方法會執行上面那些重複性的操做。

下面是網上一個大神寫的模仿ButterKnife的例子，咱們來看一下編譯時解析是若是運用的。

整個項目的結構以下：

app：示例模塊，它和其它3個模塊的關係爲：
viewfinder：android-library，它聲明瞭API的接口。
viewfinder-annotation：Java-library，包含了須要使用到的註解。
viewfinder-compiler：Java-library，包含了註解處理器。

5.1.1 建立註解

新建一個viewfinder-annotation的java-library，它包含了所須要用到的註解，注意到這個註解是保留到編譯時：

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.FIELD)
public @interface BindView {
    int id();
}
複製代碼

5.1.2 聲明`API`接口

新建一個viewfinder的android-library，用來提供給外部調用的接口。首先新建一個Provider接口和它的兩個實現類：

public interface Provider {
    Context getContext(Object source);
    View findView(Object source, int id);
}

public class ActivityProvider implements Provider{

    @Override
    public Context getContext(Object source) {
        return ((Activity) source);
    }

    @Override
    public View findView(Object source, int id) {
        return ((Activity) source).findViewById(id);
    }
}

public class ViewProvider implements Provider {

    @Override
    public Context getContext(Object source) {
        return ((View) source).getContext();
    }

    @Override
    public View findView(Object source, int id) {
        return ((View) source).findViewById(id);
    }
}
複製代碼

定義接口Finder，後面咱們會根據被@BindView註解所修飾的變量所在類（host）來生成不一樣的Finder實現類，而這個判斷的過程並不須要使用者去關心，而是由框架的實現者在編譯器時就處理好的了。

public interface Finder<T> {

    /**
     * @param host 持有註解的類
     * @param source 調用方法的所在的類
     * @param provider 執行方法的類
     */
    void inject(T host, Object source, Provider provider);

}
複製代碼

ViewFinder是ViewFinder框架的使用者惟一須要關心的類，當在Activity/Fragment/View中調用了inject方法時，會通過一下幾個過程：

得到調用inject方法所在類的類名xxx，也就是註解類。
得到屬於該類的xxx$$Finder，調用xxx$$Finder的inject方法。

public class ViewFinder {

    private static final ActivityProvider PROVIDER_ACTIVITY = new ActivityProvider();
    private static final ViewProvider PROVIDER_VIEW = new ViewProvider();

    private static final Map<String, Finder> FINDER_MAP = new HashMap<>(); //因爲使用了反射,所以緩存起來.

    public static void inject(Activity activity) {
        inject(activity, activity, PROVIDER_ACTIVITY);
    }

    public static void inject(View view) {
        inject(view, view);
    }

    public static void inject(Object host, View view) {
        inject(host, view, PROVIDER_VIEW);
    }

    public static void inject(Object host, Object source, Provider provider) {
        String className = host.getClass().getName(); //得到註解所在類的類名.
        try {
            Finder finder = FINDER_MAP.get(className); //每一個Host類,都會有一個和它關聯的Host$$Finder類,它實現了Finder接口.
            if (finder == null) {
                Class<?> finderClass = Class.forName(className + "$$Finder");
                finder = (Finder) finderClass.newInstance();
                FINDER_MAP.put(className, finder);
            }
            //執行這個關聯類的inject方法.
            finder.inject(host, source, provider);
        } catch (Exception e) {
            throw new RuntimeException("Unable to inject for " + className, e);
        }
    }
}
複製代碼

那麼這上面全部的xxx$$Finder類，究竟是何時產生的呢，它們的inject方法裏面又作了什麼呢，這就須要涉及到下面註解處理器的建立。

5.1.3 建立註解處理器

建立viewfinder-compiler（java-library），在build.gradle中導入下面須要的類：

apply plugin: 'java'

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    compile project(':viewfinder-annotation')
    compile 'com.squareup:javapoet:1.7.0'
    compile 'com.google.auto.service:auto-service:1.0-rc2'
}
targetCompatibility = '1.7'
sourceCompatibility = '1.7'
複製代碼

TypeUtil定義了須要用到的類的包名和類名：

public class TypeUtil {
    public static final ClassName ANDROID_VIEW = ClassName.get("android.view", "View");
    public static final ClassName ANDROID_ON_LONGCLICK_LISTENER = ClassName.get("android.view", "View", "OnLongClickListener");
    public static final ClassName FINDER = ClassName.get("com.example.lizejun.viewfinder", "Finder");
    public static final ClassName PROVIDER = ClassName.get("com.example.lizejun.viewfinder.provider", "Provider");
}
複製代碼

每一個BindViewField和註解類中使用了@BindView修飾的View是一一對應的關係。

public class BindViewField {

    private VariableElement mFieldElement;
    private int mResId;
    private String mInitValue;

    public BindViewField(Element element) throws IllegalArgumentException {
        if (element.getKind() != ElementKind.FIELD) { //判斷被註解修飾的是不是變量.
            throw new IllegalArgumentException(String.format("Only fields can be annotated with @%s", BindView.class.getSimpleName()));
        }
        mFieldElement = (VariableElement) element; //得到被修飾變量.
        BindView bindView = mFieldElement.getAnnotation(BindView.class); //得到被修飾變量的註解.
        mResId = bindView.id(); //得到註解的值.
    }

    /**
     * @return 被修飾變量的名字.
     */
    public Name getFieldName() {
        return mFieldElement.getSimpleName();
    }

    /**
     * @return 被修飾變量的註解的值,也就是它的id.
     */
    public int getResId() {
        return mResId;
    }

    /**
     * @return 被修飾變量的註解的值.
     */
    public String getInitValue() {
        return mInitValue;
    }

    /**
     * @return 被修飾變量的類型.
     */
    public TypeMirror getFieldType() {
        return mFieldElement.asType();
    }
}
複製代碼

AnnotatedClass封裝了添加被修飾註解element，經過element列表生成JavaFile這兩個過程，AnnotatedClass和註解類是一一對應的關係：

public class AnnotatedClass {
    public TypeElement mClassElement;
    public List<BindViewField> mFields;
    public Elements mElementUtils;

    public AnnotatedClass(TypeElement classElement, Elements elementUtils) {
        this.mClassElement = classElement;
        mFields = new ArrayList<>();
        this.mElementUtils = elementUtils;
    }

    public String getFullClassName() {
        return mClassElement.getQualifiedName().toString();
    }

    public void addField(BindViewField bindViewField) {
        mFields.add(bindViewField);
    }

    public JavaFile generateFinder() {
        //生成inject方法的參數.
        MethodSpec.Builder methodBuilder = MethodSpec
                .methodBuilder("inject") //方法名.
                .addModifiers(Modifier.PUBLIC) //訪問權限.
                .addAnnotation(Override.class) //註解.
                .addParameter(TypeName.get(mClassElement.asType()), "host", Modifier.FINAL) //參數.
                .addParameter(TypeName.OBJECT, "source")
                .addParameter(TypeUtil.PROVIDER, "provider");
        //在inject方法中,生成重複的findViewById(R.id.xxx)的語句.
        for (BindViewField field : mFields) {
            methodBuilder.addStatement(
                    "host.$N = ($T)(provider.findView(source, $L))",
                    field.getFieldName(),
                    ClassName.get(field.getFieldType()),
                    field.getResId());
        }
        //生成Host$$Finder類.
        TypeSpec finderClass = TypeSpec
                .classBuilder(mClassElement.getSimpleName() + "$$Finder")
                .addModifiers(Modifier.PUBLIC)
                .addSuperinterface(ParameterizedTypeName.get(TypeUtil.FINDER, TypeName.get(mClassElement.asType())))
                .addMethod(methodBuilder.build())
                .build();
        //得到包名.
        String packageName = mElementUtils.getPackageOf(mClassElement).getQualifiedName().toString();
        return JavaFile.builder(packageName, finderClass).build();

    }
}
複製代碼

在作完前面全部的準備工做以後，後面的事情就很清楚了：

編譯時，系統會調用全部AbstractProcessor子類的process方法，也就是調用咱們的ViewFinderProcess的類。
在ViewFinderProcess中，咱們得到工程下全部被@BindView註解所修飾的View。
遍歷這些被@BindView修飾的View變量，得到它們被聲明時所在的類，首先判斷是否已經爲所在的類生成了對應的AnnotatedClass，若是沒有，那麼生成一個，並將View封裝成BindViewField添加進入AnnotatedClass的列表，反之添加便可，全部的AnnotatedClass被保存在一個map當中。
當遍歷完全部被註解修飾的View後，開始遍歷以前生成的AnnotatedClass，每一個AnnotatedClass會生成一個對應的$$Finder類。
若是咱們在n個類中使用了@BindView來修飾裏面的View，那麼咱們最終會獲得n個$$Finder類，而且不管咱們最終有沒有在這n個類中調用ViewFinder.inject方法，都會生成這n個類；而若是咱們調用了ViewFinder.inject，那麼最終就會經過反射來實例化它對應的$$Finder類，經過調用inject方法來給被它裏面被@BindView所修飾的View執行findViewById操做。

@AutoService(Processor.class)
public class ViewFinderProcess extends AbstractProcessor{

    private Filer mFiler;
    private Elements mElementUtils;
    private Messager mMessager;

    private Map<String, AnnotatedClass> mAnnotatedClassMap = new HashMap<>();

    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        mFiler = processingEnv.getFiler();
        mElementUtils = processingEnv.getElementUtils();
        mMessager = processingEnv.getMessager();
    }

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> types = new LinkedHashSet<>();
        types.add(BindView.class.getCanonicalName());
        return types;
    }

    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        mAnnotatedClassMap.clear();
        try {
            processBindView(roundEnv);
        } catch (IllegalArgumentException e) {
            return true;
        }
        for (AnnotatedClass annotatedClass : mAnnotatedClassMap.values()) { //遍歷全部要生成$$Finder的類.
            try {
                annotatedClass.generateFinder().writeTo(mFiler); //一次性生成.
            } catch (IOException e) {
                return true;
            }
        }
        return true;
    }

    private void processBindView(RoundEnvironment roundEnv) throws IllegalArgumentException {
        for (Element element : roundEnv.getElementsAnnotatedWith(BindView.class)) {
            AnnotatedClass annotatedClass = getAnnotatedClass(element);
            BindViewField field = new BindViewField(element);
            annotatedClass.addField(field);
        }
    }

    private AnnotatedClass getAnnotatedClass(Element element) {
        TypeElement classElement = (TypeElement) element.getEnclosingElement();
        String fullClassName = classElement.getQualifiedName().toString();
        AnnotatedClass annotatedClass = mAnnotatedClassMap.get(fullClassName);
        if (annotatedClass == null) {
            annotatedClass = new AnnotatedClass(classElement, mElementUtils);
            mAnnotatedClassMap.put(fullClassName, annotatedClass);
        }
        return annotatedClass;
    }
}
複製代碼

5.2 運行時解析

首先咱們須要定義註解類型，RuntimeMethodInfo：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Inherited
public @interface RuntimeMethodInfo {
    String author() default  "tony";
    String data();
    int version() default 1;
}
複製代碼

以後，咱們再定義一個類RuntimeMethodInfoTest，它其中的testRuntimeMethodInfo方法使用了這個註解，並給它其中的兩個成員變量傳入了值：

public class RuntimeMethodInfoTest {
    @RuntimeMethodInfo(data = "1111", version = 2)
    public void testRuntimeMethodInfo() {}
}
複製代碼

最後，在程序運行時，咱們動態獲取註解中傳入的信息：

private void getMethodInfoAnnotation() {
        Class cls = RuntimeMethodInfoTest.class;
        for (Method method : cls.getMethods()) {
            RuntimeMethodInfo runtimeMethodInfo = method.getAnnotation(RuntimeMethodInfo.class);
            if (runtimeMethodInfo != null) {
                System.out.println("RuntimeMethodInfo author=" + runtimeMethodInfo.author());
                System.out.println("RuntimeMethodInfo data=" + runtimeMethodInfo.data());
                System.out.println("RuntimeMethodInfo version=" + runtimeMethodInfo.version());
            }
        }
}
複製代碼

最後獲得打印出的結果爲：