Android中封装SDK时常用的注解总结
2019/7/7 20:40:49
本文主要是介绍Android中封装SDK时常用的注解总结,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!
前言
在工作中我们经常需要将功能模块封装成库供合作厂商调用, 如何写好一个健壮的Android Library有很多讲究,使用注解可以对SDK暴露给开发者的接口做出一些限制,从而尽可能地避免开发者错误地使用API。 下面我们介绍几种封装SDK时常用到的注解,需要的朋友们可以参考学习。
一、IntDef与StringDef
我们有时候会使用int常量或者String常量来代替枚举, 特别在你编写SDK的时候,你可以通过IntDef或者StringDef来限制接口可接受的参数。
比如,有一个 disableChannel
的接口,用来关闭指定的channel
。 我们可以先定义自己的注解@RequirePayChannel
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 {}
这样,你便可以通过@RequirePayChannel
来指定disableChannel()
的可接受参数
public void enableChannel(@RequirePayChannel int channel) { // do something }
这样,一些IDE还会自动提供给你建议参数。如果填入指点范围之外的参数,将会出现错误提示并无法编译通过。
值得一说的是, 在这里,我们使用到了@Retention(RetentionPolicy.SOURCE)
。 它指定了编译器在处理Animation
时候的处理方法。 默认编译器会将常量替换成对应的数值,如果没指定该注解,你编译完成后将得到这样的class文件:
这样会导致IDE不能提示到有意义的信息。并且一定要指定为特定的int数值,否则也无法编译通过。
所以,应该指定Retention
让编译器不对该注解做额外的优化处理。
二、DrawableRes, StringRes 与 DimenRes
当我们在编写指定资源文件的接口时,可以通过资源注解来指定该方法接受的资源类型。 指定错误的资源将不能编译通过。 下面代码中,我们使用@DrawableRes
来表明setLogo
方法只支持Drawable
资源的ID。
public void setLogo(@DrawableRes int resurceId) { // do something }
当我们提供错误的资源,IDE将会报错。
@StringRes
与 @DimenRes
的使用方法也类似。
三、NonNull 与 Nullable
将一个空值传入一个方法中可能引发潜在的Crash
。 我们应该极力避免这种情况, @NonNull
可以指定参数是否接受空值,当我们传入一个空值的时候,IDE会给出响应的警告。 我们可以这样使用它:
public void setContext(@NonNull Context context) { // do something }
当我们对其传入一个空值的时候,将会显示警告(但代码仍然能通过编译)
@Nullable
用于修饰参数或者方法的返回值可能为空,提醒开发者主要空值检查。
@Nullable public Context getContext() {return null;}
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,谢谢大家对找一找教程网的支持。
这篇关于Android中封装SDK时常用的注解总结的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!
- 2024-01-18android.permission.read_media_video
- 2024-01-18android_getaddrinfo failed eai_nodata
- 2024-01-18androidmo
- 2024-01-15Android下三种离屏渲染技术
- 2024-01-09Android 蓝牙使用
- 2024-01-06Android对接华为AI - 文本识别
- 2023-11-15代码安全之代码混淆及加固(Android)
- 2023-11-10简述Android语音播报TTS
- 2023-11-06Android WiFi工具类
- 2023-07-22Android开发未来的出路