使用 Annotation 改善 Android 代码

简评:作为一名开发者,没有人不想写出高质量的代码,善用注解就能帮我们大大改善代码质量。

Annotation(注解)是用于提供有关其他数据信息的,这里我们讨论如何用 annotation 改善我们的 Android 代码。

Android 官方已经支持了 annotation,可以用下面的方式来集成:

compile ‘com.android.support:support-annotations:x.x.x’

下面介绍一些最常用的 annotation:

@Nullable 和 @NonNull,用来检查给定的变量、参数或返回值是否能够为空。

  • @Nullable,表示变量、参数或返回值可以为 null。
  • @NonNull,表示变量、参数或返回值不能为 null。

例如:

@NonNull
public View getView(@Nullable String s1, @NonNull String s2) {
  // s1 can be null
  // s2 should not be null
  // it must return non null view
}

当你这样调用时:

View view = getView("Amit", null);

Android Studio 会警告你 s2 不应为空。

资源相关注解

肯定都知道在 Android 中的资源文件都是使用 Integer 类型值作为 resId,因为所有的资源 ID 都是 Integer 类型,所以这时可以用注解来声明要传入的是什么资源类型。

例如:

public void setText(@StringRes int resId) {
  // resId must be string resources
  // resId should not be a normal int
}

当你直接传入一个普通数字时:

textView.setText(56);

Android Studio 就会警告没有传入 R.string 引用。

线程注解

线程注解用于检查指定方法是否是在指定线程中被调用的。

目前支持的有:

  • @MainThread
  • @UiThread
  • @WorkerThread
  • @BinderThread
  • @AnyThread

用法就是直接在特定方法上声明即可。

数值限制类注解

有些时候,我们需要对参数做一些限制约束,这时可以使用 @IntRange, @FloatRange 和 @Size 来校验参数。

比如在下面的例子中,我们用到 @IntRange 来确保传入的整数值在 0 至 255 之间。

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

权限注解

@RequestPermission 注解能检查方法调用者是否有某些权限,但只局限于检查 manifest 中是否声明了权限,不适用与 Android M 之后的动态权限。

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

当 manifest 中没有写 SET_WALLPAPER 权限时,就会显示警告。

更多关于 Android annotation 的知识,大家感兴趣的可以去官网进一步学习:annotations
原文:Improve Your Android Coding Through Annotations

扩展阅读:

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容