源码网商城,靠谱的源码在线交易网站 我的订单 购物车 帮助

源码网商城

Android中封装SDK时常用的注解总结

  • 时间:2020-03-13 05:24 编辑: 来源: 阅读:
  • 扫一扫,手机访问
摘要:Android中封装SDK时常用的注解总结
[b]前言[/b] 在工作中我们经常需要将功能模块封装成库供合作厂商调用, 如何写好一个健壮的Android Library有很多讲究,使用注解可以对SDK暴露给开发者的接口做出一些限制,从而尽可能地避免开发者错误地使用API。 下面我们介绍几种封装SDK时常用到的注解,需要的朋友们可以参考学习。 [b]一、IntDef与StringDef[/b] 我们有时候会使用int常量或者String常量来代替枚举, 特别在你编写SDK的时候,你可以通过IntDef或者StringDef来限制接口可接受的参数。 比如,有一个 [code]disableChannel[/code]的接口,用来关闭指定的[code]channel [/code]。 我们可以先定义自己的注解[code]@RequirePayChannel[/code]
public static final int CHANNEL_UNIONPAY = 0x11000;
public static final int CHANNEL_ALIPAY = 0x12000;
public static final int CHANNEL_WECHAT = 0x13000;
@Retention(RetentionPolicy.SOURCE)
@IntDef({CHANNEL_UNIONPAY,CHANNEL_ALIPAY,CHANNEL_WECHAT})
public @interface RequirePayChannel {}
这样,你便可以通过[code]@RequirePayChannel[/code]来指定[code]disableChannel()[/code]的可接受参数
public void enableChannel(@RequirePayChannel int channel) {
 // do something
}
这样,一些IDE还会自动提供给你建议参数。如果填入指点范围之外的参数,将会出现错误提示并无法编译通过。 [img]http://files.jb51.net/file_images/article/201705/20175493726158.png?20174493756[/img] 值得一说的是, 在这里,我们使用到了[code]@Retention(RetentionPolicy.SOURCE)[/code] 。 它指定了编译器在处理[code]Animation[/code]时候的处理方法。 默认编译器会将常量替换成对应的数值,如果没指定该注解,你编译完成后将得到这样的class文件: [img]http://files.jb51.net/file_images/article/201705/20175493818090.png?20174493826[/img] 这样会导致IDE不能提示到有意义的信息。并且一定要指定为特定的int数值,否则也无法编译通过。 [img]http://files.jb51.net/file_images/article/201705/20175493843324.png?20174493853[/img] 所以,应该指定[code]Retention[/code]让编译器不对该注解做额外的优化处理。 [b]二、DrawableRes, StringRes 与 DimenRes[/b] 当我们在编写指定资源文件的接口时,可以通过资源注解来指定该方法接受的资源类型。 指定错误的资源将不能编译通过。 下面代码中,我们使用[code]@DrawableRes[/code]来表明[code]setLogo[/code]方法只支持[code]Drawable[/code]资源的ID。
public void setLogo(@DrawableRes int resurceId) {
 // do something
}
当我们提供错误的资源,IDE将会报错。 [img]http://files.jb51.net/file_images/article/201705/20175493934540.png?20174493942[/img] [code]@StringRes [/code]与 [code]@DimenRes [/code]的使用方法也类似。 [b]三、NonNull 与 Nullable[/b] 将一个空值传入一个方法中可能引发潜在的[code]Crash[/code]。 我们应该极力避免这种情况, [code]@NonNull [/code]可以指定参数是否接受空值,当我们传入一个空值的时候,IDE会给出响应的警告。 我们可以这样使用它:
public void setContext(@NonNull Context context) {
 // do something
}
当我们对其传入一个空值的时候,将会显示警告(但代码仍然能通过编译) [img]http://files.jb51.net/file_images/article/201705/20175494026509.png?20174494034[/img] [code]@Nullable[/code] 用于修饰参数或者方法的返回值可能为空,提醒开发者主要空值检查。
@Nullable
public Context getContext() {return null;}
[img]http://files.jb51.net/file_images/article/201705/20175494113895.png?20174494121[/img] [b]总结[/b] 以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,谢谢大家对编程素材网的支持。
  • 全部评论(0)
联系客服
客服电话:
400-000-3129
微信版

扫一扫进微信版
返回顶部