地市分站

地市(您可以选择进入以下地市首页)

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

浅谈Android开发

bellchet58 创建于 2015-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 声明方法的参数不能为空

[java] view plaincopy在CODE上查看代码片派生到我的代码片

  1. public class MainActivity extends ActionBarActivity {  

  2.   

  3.     @Override  

  4.     protected void onCreate(Bundle savedInstanceState) {  

  5.         super.onCreate(savedInstanceState);  

  6.         setContentView(R.layout.activity_main);  

  7.   

  8.         String name = null;  

  9.   

  10.         sayHello(name);  

  11.     }  

  12.   

  13.   

  14.     void sayHello(@NonNull String s) {  

  15.         Toast.makeText(this"Hello " + s, Toast.LENGTH_LONG).show();  

  16.     }  

  17.   

  18. }  


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




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

2、@Nullable注解


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

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


[java] view plaincopy在CODE上查看代码片派生到我的代码片

  1. public class MainActivity extends ActionBarActivity {  

  2.   

  3.     @Override  

  4.     protected void onCreate(Bundle savedInstanceState) {  

  5.         super.onCreate(savedInstanceState);  

  6.         setContentView(R.layout.activity_main);  

  7.   

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

  9.   

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

  11.     }  

  12.   

  13.     @Nullable  

  14.     String getName(@NonNull User user) {  

  15.         return user.getName();  

  16.     }  

  17.   

  18. }  



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


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

3、资源类型的注解


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


[java] view plaincopy在CODE上查看代码片派生到我的代码片

  1. public class MainActivity extends ActionBarActivity {  

  2.   

  3.     @Override  

  4.     protected void onCreate(Bundle savedInstanceState) {  

  5.         super.onCreate(savedInstanceState);  

  6.         setContentView(R.layout.activity_main);  

  7.   

  8.         sayHello(R.style.AppTheme);  

  9.     }  

  10.   

  11.   

  12.     void sayHello(@StringRes int id) {  

  13.         Toast.makeText(this"Hello " + getString(id), Toast.LENGTH_LONG).show();  

  14.     }  

  15.   

  16. }  



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




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

sayHello(R.string.name);

4、IntDef  StringDef 注解

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

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

[java] view plaincopy在CODE上查看代码片派生到我的代码片

  1. public class IceCreamFlavourManager {  

  2.   

  3.     private int flavour;  

  4.   

  5.     public static final int VANILLA = 0;  

  6.     public static final int CHOCOLATE = 1;  

  7.     public static final int STRAWBERRY = 2;  

  8.   

  9.     @IntDef({VANILLA, CHOCOLATE, STRAWBERRY})  

  10.     public @interface Flavour {  

  11.     }  

  12.   

  13.     @Flavour  

  14.     public int getFlavour() {  

  15.         return flavour;  

  16.     }  

  17.   

  18.     public void setFlavour(@Flavour int flavour) {  

  19.         this.flavour = flavour;  

  20.     }  

  21.   

  22. }  

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





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



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

[java] view plaincopy在CODE上查看代码片派生到我的代码片

  1. @IntDef(flag = true, value = {VANILLA, CHOCOLATE, STRAWBERRY})  

  2.  public @interface Flavour {  

  3.  }  


我们可以这样调用

iceCreamFlavourManager.setFlavour(IceCreamFlavourManager.VANILLA & IceCreamFlavourManager

[java] view plaincopy在CODE上查看代码片派生到我的代码片

  1. .CHOCOLATE);  



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


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

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

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


转自:http://blog.csdn.net/icedream_hong/article/details/44103083

  • 收藏
  • 赞 (0)
0/300
请登录后评论。

网友评论