澳门新葡萄京官网首页 14

[转]注解支持(Support Annotations)

本文由码农网 –
小峰原创翻译,转载请看清文末的转载要求,欢迎参与我们的付费投稿计划!

int dw = getWindowManager().getDefaultDisplay().getWidth();


移动app开发是一个漫长而费力的过程。然而,现在的企业总是希望能够尽快发布app。幸运的是,我们有很多帮助移动开发人员加快工作步伐的工具。

int dh = getWindowManager().getDefaultDisplay().getHeight();

  1. 注解支持(Support Annotations)
    Android
    support
    library从19.1版本开始引入了一个新的注解库,它包含很多有用的元注解,你能用它们修饰你的代码,帮助你发现bug。Support
    library自己本身也用到了这些注解,所以作为support
    library的用户,Android
    Studio已经基于这些注解校验了你的代码并且标注其中潜在的问题。Support
    library 22.2版本又新增了13个新的注解以供使用。

  2. 使用注解库
    澳门新葡萄京官网首页,注解默认是没有包含的;他们被包装成一个独立的库。(support
    library现在由一些更小的库组成:v4-support, appcompat, gridlayout,
    mediarouter等等)(如果你正在使用appcompat库,那么你已经可以使用这些注解了,因为appcomat它自己也依赖它。)
    添加使用注解最简单的方式就是打开Project
    Structure对话框。首先在左边选中module,然后在右边选中Dependencies标签页,点击面板底部的+按钮,选择Library
    Dependency,假设你已经把Android Support
    Repository安装到你的SDK中了,那么注解库将会出现在列表中,你只需点击选中它即可(这里是列表中的第一个):

    澳门新葡萄京官网首页 1

    添加依赖

可用的工具集随着移动平台新版本的出现而不断更新。是的,我们很难紧跟所有创新的脚步。这同样适用于通常不被公布的附加功能,尽管它们在常规作业中真的非常有用。

cases.azoft.com/4-must-know-tools-for-effective-android-development/

点击OK完成Project
Structure的编辑。这会修改你的build.gradle文件,当然你也可以手动编辑它:

澳门新葡萄京官网首页 2

以下所写皆为上述所描。

特别是,在创建移动app的时候,每个Android开发者必须解决一系列的问题。例如:

像王国维 在《人间词话》 中所说一样,一个 app开发也要经历几种阶段

dependencies {    
compile 'com.android.support:support-annotations:22.2.0'
}
  • 在布局运行到设备之前先检查它看上去如何
  • 运行代码检查工具,如Lint:在编译之前很难发现代码中的错误
  • 为位图图形的所有显示分辨率和状态(启用,禁用,按压等)提供选择选项,并将它们导出到不同的数字设备
  • 在调试app构建中的开发阶段检测内存泄漏

1 Checking how a layout looks before running it on a device

对于Android application和Android
library这两个类型的module(你应用了com.android.application或者com.android.library插件的)来说,你需要做的已经都做好了。如果你想只在Java
module使用这些注解,那么你就明确的包含SDK仓库了,因为support
libraries不能从jcenter获得(Android
Gradle插件会自动的包含这些依赖,但是Java插件却没有。)

有经验的开发人员可以轻松地处理上述任务。然而,快速而高效解决紧迫问题的方法并不是每个人都知道的。下面让我们为大家详细介绍一些高效Android开发中必知的好工具。

2 Running code inspection tools such as Lint; finding hardly revealed
code errors before compilation

repositories {
  jcenter()
  maven { 
    url '<your-SDK-path>/extras/android/m2repository'           
  }
}

1.Tools Attributes

任务:检查UI元素在开发阶段是什么样的,避免它们在最终构建中出意外。

解决方案:Tools
Attributes

Tools Attributes可以使用额外的命名空间来帮助管理Android
Studio,这样开发框架就不会传输运行时版本的属性到最终构建。

看似Android开发人员只有一种方法来检查成品布局——在设备上运行它。但是,你还可以使用内置于开发框架的Tools
Attributes,在我们的例子中所使用的框架是Android Studio。

Tools Attributes的两个主要类别:

  • Lint Attributes
  • Design Attributes

作为一个静态分析工具,Lint被用于很多编程语言和软件平台。应用Lint Attributes有助于协调Lint工作。

下面是一些具体的Lint Attributes:

tools:ignore

tools:ignore属性允许你建立Lint工具来禁止XML文件中特定属性的警告。例如:

tools:ignore="ContentDescription"

从根本上说tools:ignore类似于Java的@SupressWarning注解。

tools:targetApi

tools:targetApi和@TargetApi注解的工作方式相同,它显示了app将使用的最低API版本。举个例子,如果你正在应用Android
KitKat,并且项目中最低的API版本是21。在这种情况下,你只要在代码中写下tools:targetApi以及适合的版本号即可。这可以避免恼人的Lint警告。

tools:locale

这个属性可以帮助你配置语言,并关闭关于错误拼写的Lint警告。例如,如果你的字符串仅包含西班牙文本,那么你可以设置“西班牙语为默认”:

<resources xmlns:tools="http://schemas.android.com/tools" tools:locale="es">

这样,你就将西班牙语设置为默认语言,并且会检查西班牙语的拼写。

至于Design Attributes,可以大大便利创建开发框架中的XML布局。

Design Attributes包括:

tools:context

tools:context可用来显示开发框架选择什么活动类来实施布局。使用这个属性,Android
Studio会自动选择所需的主题用于预览。

tools:showIn

tools:showIn有助于指出想要哪个布局在预览中显示。例如:

tools:showIn="@layout/activity_main"

用来包括布局。通过这样做,开发人员就告诉了框架在哪个地方inflate什么特定布局。

tools:listitem, listheader, listfooter

你可以轻松地用特定布局调整组件视图,以便于分开list、header和footer的元素。例如:

tools:layout

使用tools:layout属性,可以在运行时屏幕上显示片段标签布局:

tools:layout="@android:layout/list_content"

因此,Tools
Attributes可以帮助开发人员确保他们总是能够远离在最终app构建中显示临时文本的风险。

3 Selecting options for bitmapped graphics for all the display
resolutions and states (enabled, disabled, pressed etc.), and exporting
them into different digital devices

  1. 执行注解
    当你用Android
    Studio和IntelliJ的时候,如果给标注了这些注解的方法传递错误类型的参数,那么IDE就会实时标记出来。
    从Gradle插件1.3.0-beta1版本开始,并且安装了Android M
    Preview平台工具的情况下,通过命令行调用gradle的lint
    任务就可以执行这些检查。如果你想把标记问题作为持续集成的一部分,那么这种方式是非常有用的。说明:这并不包含nullness注解。本文中所介绍的其他注解都可以通过lint执行检查。

  2. 注解用法

2.Support Annotations

任务:在编译前检查代码中的可能错误,并且为了防止错误,对代码做一个全面的审查。

解决方案:Android Support
Library

Android Support Library Annotations可以帮助Android
Studio提升代码。它从Android Studio
1.3.0开始有用。对于之前的版本,你需要单独插入注解。

Android Support Annotations
Library允许你在开发下找app中的bug。添加注解到项目,开发人员就可以让保持纯代码的任务变得更容易。

Support Annotations可分为:

  • Nullness Annotations
  • @Nullable, @NonNull

Nullness
Annotations的目的是检查null。它们可被应用于代码字段,参数和方法。使用这些完全没有注解的注解的主要区别在于,Nullness
Annotations只定义变量是否具有“null”值。

  • Resource Annotations
  • @StringRes, @DrawableRes, @ColorRes

在编码时,移动开发者经常引用字符串、图像等资源。使用Resource
Annotations可以强制输入的文本。例如,通过添加resource annotation
@ColorRes,当你试图输入颜色代码,而不是引用resource ID的时候,就会得到框架警告。没有注解,IDE就不反应,因为代码以及resource ID的引用的期望类型为int。

  • ColorInt Annotations
  • @ColorInt

@ColorInt是@ColorRes的相反注解。在这种情况下,你定义方法不引用resource ID,而是引用具体的颜色。应用@ColorInt Annotations可以让你快速找到错误,如果方法呼吁颜色资源ID的话。

  • Thread Annotations
  • @UiThread,@MainThread,@WorkerThread,@BinderThread

这些注解的目的是确定方法和特定类型的线程之间的连接。

  • Value Constraint Annotations
  • @Size(min = 5), @IntRange(from = 0, to = 12), @FloatRange(…)

在编码时使用参数的正常值几乎是不可能的。要定义可能的值的范围,你可以添加@IntRange或@FloatRange注解。如果你想限制数据数组、集合或线程中字符串的大小或长度,那么@Size注解将是一个极好的工具。

  • Permission Annotations
  • @RequestPremission(Manifest.permission.ACCESS_FINE_LOCATION)

使用Permission
Annotations,你可以验证一个权限或一列权限。每当app引用方法时,它会提供确认,并且这列权限对你开放。如果权限不存在,你会在代码中发现错误。

  • CallSuper Annotations
  • @CallSuper

当你需要调用方法的super实现时可以使用这个注解。

  • Enumerated Annotations
  • IntDef和StringDef

这种类型的注释允许创建用于替换一些枚举常数值的广义定义。例如,你有IceCreamFlavourManager类,它包括3个模式:VANILLA(香草),CHOCOLATE(巧克力)和STRAWBERRY(草莓)。使用@IntDef,你就可以创建一个名为@Flavour的新的注释并定义它的具体数值。

4 Detecting memory leaks during the development stage in debugging app
builds

  • Nullness Annotations
    @Nullable注解能被用来标注给定的参数或者返回值可以为null。类似的,@NonNull注解能被用来标注给定的参数或者返回值不能为null。
    如果一个本地变量的值为null(比如因为过早的代码检查它是否为null),而你又把它作为参数传递给了一个方法,并且该方法的参数又被@NonNull标注,那么IDE会提醒你,你有一个潜在的崩溃问题。

    v4 support library中的FragmentActivity的示例代码:

3.Cut&Slice me

任务:接收位图图形所有显示分辨率的选项。

澳门新葡萄京官网首页 3

解决办法:Photoshop插件Cut&Slice me

Cut&Slice
me仅允许通过按下一个按钮来生成位图图形的切割。它用于实施所有显示分辨率和状态(启用,禁用,按下)。对于Android,resource会被自动传送到不同的文件夹(drawable-xxhdpi,
drawable-xhdpi,..),对于iOS,正确的名称前缀会被创建((@2x, @3x)。

澳门新葡萄京官网首页 4

我们从2013年开始活跃地使用插件Cut&Slice
me。并且它在Android以及iOS开发人员中很受欢迎。

  1. Tools Attributes :  工具属性

4. LeakCanary

任务:及时检测内存泄漏以防止OutOfMemoryError崩溃,并降低app内存溢出的风险。

解决方案:库LeakCanary

LeakCanary有助于在调试构建运行时检测内存泄漏,并提供舒适的UI用于堆栈跟踪历史。

澳门新葡萄京官网首页 5

大多数时候,开发人员必须手动查找内存泄漏。首先,他们要揭开OutOfMemoryError崩溃。然后使用不同的设备,他们尝试重现可导致错误的问题。此外,他们希望能够跟随会导致泄漏的操作的序列。他们创造了内存转储,并详细研究以发现应该垃圾回收的对象。然后,他们制作从对象到垃圾回收的最短引用路径,并且最后,他们得到激起内存泄漏的引用。

LeakCanary允许自动化所有的搜索研究,并能很快找到所有的泄漏。还有一个附加优点涉及到发送有关于泄漏的数据到服务器,并排除反射引用和来自于方法的特定活动。

总之,我们可以说,Android开发者有各种不同的工具可用于促进app开发过程。特别是,对于移动开发人员,还存在着一系列被遗忘或甚至是不知道的解决方案,如Tools
Attributes,Support Annotations, Cut&Slice me,LeakCanary,以及bug
reporting
systems。关于最后那个提到的工具,我们将在以后深入探讨。选择什么工具主要取决于开发人员个人的喜好和具体的项目情况。

如果你愿意告诉我你认为必须拥有的工具,那么非常欢迎在评论中畅所欲言。期待听到不同的声音。

祝大家都能代码整洁,项目成功!

关于 tools的使用 :

import android.support.annotation.NonNull;
import android.support.annotation.Nullable;  
@Nullable
@Override
public View onCreateView(String name, 
                @NonNull Context context, 
                @NonNull AttributeSet attrs) {

  (如果你执行Analyze > Infer Nullity,或者你在键入时把@NonNull替换成了@NotNull,那么IDE可能会提供附加的IntelliJ注解。参考底部的“IntelliJ Annotations”段落了解更多)

The Task: To check what the UI elements look like at the development
stage without the risk of them showing up accidentally in the final
build.

注意@NonNull和@Nullable并不是对立的:还有第三种可能:未指定。当你没有指定@NonNull或者@Nullable的时候,工具就不能确定,所以这个API也就不起作用。
最初,我们在findViewById方法上标注@Nullable,从技术上说,这是正确的:findViewById可以返回null。但是如果你知道你在做什么的时候(如果你传递给他一个存在的id)他是不会返回null的。当我们使用@Nullable注解它的时候,就意味着源代码编辑器中会有大量的代码出现高亮警告。如果你已经意识到每次使用该方法都应该明确的进行null检查,那么就只能用@Nullable标注返回值。有个经验规则:看现有的“好的代码”(比如审查产品代码),看看这些API是怎么被使用的。如果该代码为null检查结果,你应该为方法注解@Nullable。

任务:在开发阶段检查UI元素的外观,而不会在最终版本中出现意外的风险。

  • 资源类型注解
    Android的资源值通常都是使用整型传递。这意味着获取一个drawable使用的参数,也能很容易的传递给一个获取string的方法;因为他们都是int类型,编译器很难区分。

    资源类型注解可以在这种情况下提供类型检查。比如一个被@StringRes住进诶的int类型参数,如果传递一个不是R.string类型的引用将会被IDE标注:

    澳门新葡萄京官网首页 6

    资源类型注解

    以ActionBar为例:

也就是说为了方便开发者开发调试,最终不会打包到APK中。

解决方案:工具属性 有助于使用额外的命名空间来管理Android
Studio,以便开发框架不将属性运行时版本传输到最终版本。

import android.support.annotation.StringRes;
public abstract void setTitle(@StringRes int resId);

有很多不同资源类型的注解:如下的每一个Android资源类型: @StringRes, @DrawableRes, @ColorRes, @InterpolatorRes,等等。一般情况下,如果有一个foo 类型的资源,那么它的相应的资源类型注解就是FooRes. 除此之外,还有一个名为@AnyRes特殊的资源类型注解。它被用来标注一个未知的特殊类型的资源,但是它必须是一个资源类型。比如在框架中,它被用Resources#getResourceName(@AnyRes int resId)

原先 Android开发人员只能使用一种方法来检查一个完成的布局
-也就是在设备上运行它,然后再整改。
然而,有一个很好的机会使用开发框架中内置的 工具属性
,在我们的例子中是Android Studio

上,使用的时候,你可以这样getResources().getResourceName(R.drawable.icon)
用,也可以getResources().getResourceName(R.string.app_name)
这样用,但是却不能这样getResources().getResourceName(42)
用。
请注意,如果你的API支持多个资源类型,你可以使用多个注解来标注你的参数。

tools:context=”com.susion.boring.xxActivity”  

  • IntDef/StringDef: 类型定义注解
    整型除了可以作为资源的引用之外,也可以用作“枚举”类型使用。
    @IntDef和”typedef”作用非常类似,你可以创建另外一个注解,然后用@IntDef指定一个你期望的整型常量值列表,最后你就可以用这个定义好的注解修饰你的API了。
    appcompat库里的一个例子:

preview的时候能看到一些预览的主题效果。

tools:layout=”@android:layout/list_content”   //
预览时可以看得到一些布局

import android.support.annotation.IntDef;
public abstract class ActionBar {

    @IntDef({NAVIGATION_MODE_STANDARD, NAVIGATION_MODE_LIST, NAVIGATION_MODE_TABS})
    @Retention(RetentionPolicy.SOURCE)
    public @interface NavigationMode {}

    public static final int NAVIGATION_MODE_STANDARD = 0;
    public static final int NAVIGATION_MODE_LIST = 1;
    public static final int NAVIGATION_MODE_TABS = 2;

    @NavigationMode
    public abstract int getNavigationMode();
    public abstract void setNavigationMode(@NavigationMode int mode);
}

上面非注解的部分是现有的API。我们创建了一个新的注解(NavigationMode)并且用@IntDef标注它,通过@IntDef我们为返回值或者参数指定了可用的常量值。我们还添加了@Retention(RetentionPolicy.SOURCE)

tools:textcolor   等等

告诉编译器这个新定义的注解不需要被记录在生成的.class文件中(译者注:源代码级别的,生成class文件的时候这个注解就被编译器自动去掉了)。

澳门新葡萄京官网首页 7

使用这个注解后,如果你传递的参数或者返回值不在指定的常量值中的话,IDE将会标记出这种情况。

澳门新葡萄京官网首页 8

类型定义注解

你也可以指定一个整型是一个标记性质的类型;这样客户端代码就通过|,&等操作符同时传递多个常量了:

@IntDef(flag=true, value={
        DISPLAY_USE_LOGO,
        DISPLAY_SHOW_HOME,
        DISPLAY_HOME_AS_UP,
        DISPLAY_SHOW_TITLE,
        DISPLAY_SHOW_CUSTOM
})
@Retention(RetentionPolicy.SOURCE)
public @interface DisplayOptions {}

最后,还有一个字符串版本的注解,就是@StringDef,它和@IntDef的作用基本上是一样,所不同的是它是针对字符串的。该注解一般不常用,但是有的时候非常有用,比如在限定向Activity#getSystemService方法传递的参数范围的时候。

要了解关于类型注解的更多详细信息,请参考https://developer.android.com/tools/debugging/annotations.html#enum-annotations

  • 线程注解: @UiThread, @WorkerThread, … (Support library
    22.2及其之后版本支持.)
    如果你的方法只能在指定的线程类型中被调用,那么你就可以使用以下4个注解来标注它:
    @UiThread
    @MainThread
    @WorkerThread
    @BinderThread

    如果一个类中的所有方法都有相同的线程需求,那么你可以注解类本身。比如android.view.View,就被用@UiThread标注。
    关于线程注解使用的一个很好的例子就是AsyncTask:

@WorkerThread
protected abstract Result doInBackground(Params... params);
@MainThread
protected void onProgressUpdate(Progress... values) {}

如果你在重写的doInBackground方法里尝试调用onProgressUpdate方法或者View的任何方法,IDE工具就会马上把它标记为一个错误:![线程注解](http://upload-images.jianshu.io/upload_images/1642441-1db1f71c2ba18464.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

@UiThread还是@MainThread?
在进程里只有一个主线程。这个就是@MainThread。同时这个线程也是一个@UiThread。比如activity的主要窗口就运行在这个线程上。然而它也有能力为应用创建其他线程。这很少见,一般具备这样功能的都是系统进程。通常是把和生命周期有关的用@MainThread标注,和View层级结构相关的用@UiThread标注。但是由于@MainThread本质上是一个@UiThread,而大部分情况下@UiThread又是一个@MainThread,所以工具(lint
,Android
Studio,等等)可以把他们互换,所以你能在一个可以调用@MainThread方法的地方也能调用@UiThread方法,反之亦然。

  • RGB颜色整型
    当你的API期望一个颜色资源的时候,可以用@ColorRes标注,但是当你有一个相反的使用场景时,这种用法就不可用了,因为你并不是期望一个颜色资源id,而是一个真实的RGB或者ARGB的颜色值。
    在这种情况下,你可以使用@ColorInt注解,表示你期望的是一个代表颜色的整数值:

public void setTextColor(@ColorInt int color){}

有了这个,当你传递一个颜色id而不是颜色值的时候,lint就会标记出这段不正确的代码:

澳门新葡萄京官网首页 9

颜色值注解

  • 值约束: @Size, @IntRange, @FloatRange
    如果你的参数是一个float或者double类型,并且一定要在某个范围内,
    你可以使用@FloatRange注解:

public void setAlpha(@FloatRange(from=0.0, to=1.0) float alpha) {}

如果有人使用该API的时候传递一个0-255的值,比如尝试调用setAlpha(128),那么工具就会捕获这一问题:

澳门新葡萄京官网首页 10

值约束注解

(你也可以指定是否包括起始值。)
同样的,如果你的参数是一个int或者long类型,你可以使用@IntRange注解约束其值在一个特定的范围内:

public void setAlpha(@IntRange(from=0,to=255) int alpha) { … }

把这些注解应用到参数上是非常有用的,因为用户很有可能会提供错误范围的参数,比如上面的setAlpha例子,有的API是采用0-255的方式,而有的是采用0-1的float值的方式。
最后,对于数据、集合以及字符串,你可以用@Size注解参数来限定集合的大小(当参数是字符串的时候,可以限定字符串的长度)。

举几个例子
集合不能为空: @Size(min=1)
字符串最大只能有23个字符: @Size(max=23)
数组只能有2个元素: @Size(2)
数组的大小必须是2的倍数 (例如图形API中获取位置的x/y坐标数组:

@Size(multiple=2)

澳门新葡萄京官网首页 11

值约束注解

  • 权限注解: @RequiresPermission
    如果你的方法的调用需要调用者有特定的权限,你可以使用@RequiresPermission注解:

@RequiresPermission(Manifest.permission.SET_WALLPAPER)
public abstract void setWallpaper(Bitmap bitmap) throws IOException;

如果你至少需要权限集合中的一个,你可以使用anyOf属性:

@RequiresPermission(anyOf = { 
    Manifest.permission.ACCESS_COARSE_LOCATION, 
    Manifest.permission.ACCESS_FINE_LOCATION})
public abstract Location getLastKnownLocation(String provider);

如果你同时需要多个权限,你可以用allOf属性:

@RequiresPermission(allOf = { 
    Manifest.permission.READ_HISTORY_BOOKMARKS, 
    Manifest.permission.WRITE_HISTORY_BOOKMARKS})
public static final void updateVisitedHistory(ContentResolver cr, String url, boolean real) {}

对于intents的权限,可以直接在定义的intent常量字符串字段上标注权限需求(他们通常都已经被@SdkConstant注解标注过了):

@RequiresPermission(android.Manifest.permission.BLUETOOTH)
public static final String ACTION_REQUEST_DISCOVERABLE = "android.bluetooth.adapter.action.REQUEST_DISCOVERABLE";

对于content
providers的权限,你可能需要单独的标注读和写的权限访问,所以可以用@Read或者@Write标注每一个权限需求:

@RequiresPermission.Read(@RequiresPermission(READ_HISTORY_BOOKMARKS))
@RequiresPermission.Write(@RequiresPermission(WRITE_HISTORY_BOOKMARKS))
public static final Uri BOOKMARKS_URI = Uri.parse("content://browser/bookmarks");

澳门新葡萄京官网首页 12

权限注解

  • 方法重写: @CallSuper
    如果你的API允许使用者重写你的方法,但是呢,你又需要你自己的方法(父方法)在重写的时候也被调用,这时候你可以使用@CallSuper标注:

@CallSuper
protected void onCreate(@Nullable Bundle savedInstanceState) {}

用了这个后,当重写的方法没有调用父方法时,工具就会给予标记提示:

澳门新葡萄京官网首页 13

方法重写

(Android Studio 1.3 Preview
1的lint检查有个关于这个注解的bug,这个bug就是即使是对的重写也会报错,这个bug已经在Preview
2版本修改,可以通过canary channel更新到Preview 2版本。)

  • 返回值: @CheckResult
    如果你的方法返回一个值,你期望调用者用这个值做些事情,那么你可以使用@CheckResult注解标注这个方法。
    你并不需要微每个非空方法都进行标注。它主要的目的是帮助哪些容易被混淆,难以被理解的API的使用者。
    比如,可能很多开发者都对String.trim()一知半解,认为调用了这个方法,就可以让字符串改变以去掉空白字符。如果这个方法被@CheckResult标注,工具就会对那些没有使用trim()返回结果的调用者发出警告。
    Android中,Context#checkPermission这个方法已经被@CheckResult标注了:

@(suggest="#enforcePermission(String,int,int,String)")
public abstract int checkPermission(@NonNull String permission, int pid, int uid);

这是非常重要的,因为有些使用context.checkPermission的开发者认为他们已经执行了一个权限
—-但其实这个方法仅仅只做了检查并且反馈一个是否成功的值而已。如果开发者使用了这个方法,但是又不用其返回值,那么这个开发者真正想调用的可能是这个Context#enforcePermission方法,而不是checkPermission。

澳门新葡萄京官网首页 14

返回值

  • @VisibleForTesting
    你可以把这个注解标注到类、方法或者字段上,以便你在测试的时候可以使用他们。

  • @Keep
    我们还在注解库里添加了@Keep注解,但是Gradle插件还支持(尽管已经在进行中)。被这个注解标注的类和方法在混淆的时候将不会被混淆。
    在你自己的库中使用注解
    如果你在你自己的库中使用了这些注解,并且是通过Gradle构建生成aar包,那么在构建的时候Android
    Gradle插件会提取注解信息放在AAR文件中供引用你的库的客户端使用。在AAR文件中你可以看到一个名为annotations.zip的文件,这个文件记录的就是注解信息,使用的是IntelliJ的扩展注解XML格式。这是必须的,因为.class文件不能包含足够的要处理以上@IntDef注解的信息;注意我们只需记录该常量的一个引用,而不是它的值。当且仅当你的工程依赖注解库的时候,Android
    Gradle插件会把提取注解的任务作为构建的一部分执行它。(说明:只有源保留注解被放置在.aar文件中;class级别的会被放在classes.jar里。)

  • IntelliJ注解
    IntelliJ,Android
    Studio就是基于它开发的,IntelliJ有一套它自己的注解;IntDef分析其实重用的是MagicConstant分析的代码,IntelliJ
    null分析其实用的是一组配置好的null注解。如果你执行Analyze > Infer
    Nullity…,它会试图找出所有的null约束并添加他们。这个检查有时会插入IntelliJ注解。你可以通过搜索,替换为Android注解库的注解,或者你也可以直接用IntelliJ注解。在build.gradle里或者通过Project
    Structure对话框的Dependencies面板都可以添加如下依赖:

dependencies { 
    compile 'com.intellij:annotations:12.0'
}

发表评论

电子邮件地址不会被公开。 必填项已用*标注