下面是三个我们能够使用的基础类型的注解:
Nullnessannotations
Resourcetypeannotations
IntDefandStringDefannotations
下面介绍下在项目中的具体使用讲解.
1、NullnessAnnotations @NonNull
@NonNull声明方法的参数不能为空
public class MainActivity extends ActionBarActivity {@Overrideprotected 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();}}
使用了给出类似下面的警告
2、@Nullable注解
@Nullable注解表示一个方法的参数或者返回值可以是Null的。
假设我们有一个User类,User有一个可以通过User#getName()方法的name属性,我们可以写下如下代码。
public class MainActivity extends ActionBarActivity {@Overrideprotected 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();}@NullableString getName(@NonNull User user) {return user.getName();}}
返回的userName就被标记为@Nullable的了,也就是说return的值可能为Null。如下的调用,如果没有检查Null,就有可能引发潜在的Crash。
3、资源类型的注解
传递不适合的int值给一个方法,会发生潜在错误。资源类型的注解可以很好的解决这个问题。在下面的代码中,我们有一个方法sayHello,需要一个String类型的资源id,并且使用@StringRes注解进行了标示。
public class MainActivity extends ActionBarActivity {@Overrideprotected 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();}}
如果我们传递一个String资源类型的id,警告就会消失。如下:
sayHello(R.string.name);
和
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 {}@Flavourpublic int getFlavour() {return flavour;}public void setFlavour(@Flavour int flavour) {this.flavour = flavour;}}
甚至会给我们列出可用的参数列表:
我们还可以指定int作为一个flag,意味着这个值可以使用“|”“&”等操作符连接。如果我们像下面定义@Flavour
<span style="font-size:18px;">@IntDef(flag = true, value = {VANILLA, CHOCOLATE, STRAWBERRY}) public @interface Flavour { }</span>
我们可以这样调用
<span style="font-size:18px;">iceCreamFlavourManager.setFlavour(IceCreamFlavourManager.VANILLA & IceCreamFlavourManager.CHOCOLATE);</span>
如果想要了解更多在未来加入的新的注解类型,以及如何使用请移步这里(需要科学上网哟)。
第一次翻译,水平有限,有任何问题,欢迎拍砖,提建议!!!
如果想要看英语原文点。
离开睁眼闭眼看见的城市,逃离身边的纷纷扰扰,