这些高效的Android注解，你有使用过么？

介绍几个support library 19.1中的注解，这几个注解在项目中非常有用，而且library本身也是用了这些注解。让我们来研究下。

在项目中使用这些注解很简单，只需要在build.gradle中增加compile 'com.android.support:support-annotations:20.0.0'。

下面是三个我们能够使用的基础类型的注解：

Nullness annotations

Resource type annotations

IntDef and StringDef annotations

下面介绍下在项目中的具体使用讲解.

1、Nullness Annotations @NonNull

@NonNull 声明方法的参数不能为空

public class MainActivity extends ActionBarActivity {

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

        String name = null;

        sayHello(name);
    }


    void sayHello(@NonNull String s) {
        Toast.makeText(this, "Hello " + s, Toast.LENGTH_LONG).show();
    }

}

上面的实例代码中，有一个空值String对象name，而sayHello方法的参数使用了@NonNull，当我们传递name给sayHello的时候，IDE会给出类似下面的警告

如果我们给name设置一个值，比如：String name = "Our Lord Duarte"，警告就会消失。

2、@Nullable注解

@Nullable注解表示一个方法的参数或者返回值可以是Null的。

假设我们有一个User类，User有一个可以通过User#getName()方法的name属性，我们可以写下如下代码。

public class MainActivity extends ActionBarActivity {

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

        User user = new User("Our Lord Duarte");

        Toast.makeText(this, "Hello " + getName(user), Toast.LENGTH_LONG).show();
    }

    @Nullable
    String getName(@NonNull User user) {
        return user.getName();
    }

}

返回的userName就被标记为@Nullable的了，也就是说return的值可能为Null。如下的调用，如果没有检查Null，就有可能引发潜在的Crash。

Toast.makeText(this, "Hello " + getName(user), Toast.LENGTH_LONG).show();

3、资源类型的注解

传递不适合的int值给一个方法，会发生潜在错误。资源类型的注解可以很好的解决这个问题。在下面的代码中，我们有一个方法sayHello，需要一个String类型的资源id，并且使用@StringRes注解进行了标示。

public class MainActivity extends ActionBarActivity {

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

        sayHello(R.style.AppTheme);
    }


    void sayHello(@StringRes int id) {
        Toast.makeText(this, "Hello " + getString(id), Toast.LENGTH_LONG).show();
    }

}

如果我们传递一个style资源的id给sayHello，IDE将会给出如下警告。

如果我们传递一个String资源类型的id，警告就会消失。如下：

sayHello(R.string.name);

4、IntDef 和 StringDef 注解

最后一个注解类型是基于Intellij’s “Magic Constant”的（我们不需要关心详细，如果感兴趣了解点这里）

很多时候，我们使用int常量来代替枚举。例如：有一个IceCreamFlavourManager 类，有三种操作VANILLA, CHOCOLATE  和 STRAWBERRY模式。我们可以自己定义一个注解@Flavour ，并且指定可以使用@IntDef的值，如下：

public class IceCreamFlavourManager {

    private int flavour;

    public static final int VANILLA = 0;
    public static final int CHOCOLATE = 1;
    public static final int STRAWBERRY = 2;

    @IntDef({VANILLA, CHOCOLATE, STRAWBERRY})
    public @interface Flavour {
    }

    @Flavour
    public int getFlavour() {
        return flavour;
    }

    public void setFlavour(@Flavour int flavour) {
        this.flavour = flavour;
    }

}

当我们使用错误的int值调用IceCreamFlavourManager#setFlavour方法时，IDE会给出如下的错误提示。

甚至会给我们列出可用的参数列表：

我们还可以指定int作为一个flag，意味着这个值可以使用“|”“&”等操作符连接。如果我们像下面定义@Flavour 

@IntDef(flag = true, value = {VANILLA, CHOCOLATE, STRAWBERRY})
 public @interface Flavour {
 }

我们可以这样调用

iceCreamFlavourManager.setFlavour(IceCreamFlavourManager.VANILLA & IceCreamFlavourManager

                .CHOCOLATE);

而@StringDef 基本就是 @IntDef 的字符串类型。使用方法基本一样，就不在多说了。

如果想要了解更多在未来加入的新的注解类型，以及如何使用请移步这里（需要科学上网哟）。

第一次翻译，水平有限，有任何问题，欢迎拍砖，提建议！！！

如果想要看英语原文点这里。