这些高效的Android注解,你有使用过么?

翻译 2015年03月06日 19:04:02

介绍几个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

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

1Nullness 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,当我们传递namesayHello的时候,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 类,有三种操作VANILLACHOCOLATE  和 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 的字符串类型。使用方法基本一样,就不在多说了。


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

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

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








Android 关于@NonNull

本文介绍Android 代码编写过程中的一个注释@NonNull的源码解释。
  • qq_16628781
  • qq_16628781
  • 2015年10月22日 19:19
  • 14090

深入浅出Android Support Annotation(什么是android.support.annotation.NonNull的拓展)【转】

英文链接:http://anupcowkur.com/posts/a-look-at-android-support-annotations/ 译文链接 深入浅出Android Support ...
  • u011240877
  • u011240877
  • 2015年11月10日 20:01
  • 3384

用Indef和StringDef代替枚举

最近一直在了解一些性能优化上的知识,有一条是这样的: 不要过多的使用枚举,枚举占用的的内存空间比整型大。 那不使用枚举,那怎么搞呢?首先,我们要清楚,枚举有什么用。知道枚举的用处以后我们才能根据它的用...
  • jieqiang3
  • jieqiang3
  • 2016年01月15日 13:28
  • 1112

Java Enum枚举替代方案--Android IntDef/StringDef Annotation注解

Java Enum枚举替代方案--Android IntDef/StringDef Annotation注解
  • superxlcr
  • superxlcr
  • 2017年08月23日 15:48
  • 695

Java和Android中的注解

java和android的注解简析
  • CShawnX
  • CShawnX
  • 2016年06月07日 18:53
  • 5029

Java有关def的事项

1.参数列表java实际上只有基于位置的参数和可变参数两种关键字参数与默认参数都没有,其中默认参数还可以通过重载笨拙的实现, 而关键字参数貌似就没有。。。 就说一说唯一亮点的可变参数: 例如:v...
  • minghu9
  • minghu9
  • 2015年12月11日 22:43
  • 2374

安卓中@Nullable和NotNull 注释

@Nullable和NotNull的作用 IntelliJ IDEA makes it possible to analyse the source code for the element...
  • sung_ll
  • sung_ll
  • 2017年01月18日 20:15
  • 820

bug修复-android中的onCreate两个参数的方法是什么鬼?

一 bug阐述和解决 今天,在开发中遇到了这样一个问题: 就是没有界面显示。明明有setContentView xml文件在可视化开发环境下也正常显示.,原来是复写onCreate函数时出现了...
  • u014315849
  • u014315849
  • 2016年03月16日 10:50
  • 3082

Andoird Studio 1.1.0 "import android.support.annotation.Nullable;"失败

问题如题。   打开“Project Structure对话框”。 左边栏选择“Modules”,右边选择最后一项“Dependencies”。 选择添加“com.android.suppor...
  • raymond_lk
  • raymond_lk
  • 2015年04月16日 13:52
  • 1998

Android注解支持(Support Annotations)

原文地址:http://tools.android.com/tech-docs/support-annotations Android Support Library从19.1版本开始引入了一个新的注...
  • wanglu198506
  • wanglu198506
  • 2015年01月26日 18:31
  • 10435
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:这些高效的Android注解,你有使用过么?
举报原因:
原因补充:

(最多只允许输入30个字)