Android Support库——support annotations

简介:   Android Support库是官方出的支持扩展库,包含了丰富的组件、工具类等,通过在Android SDK Manager中勾选以下两项来获取到。   其中,Android Support Library下载的是对应的源码或jar包,在使用Eclipse时会从这里拷贝出需要的文件到项目中。

  Android Support库是官方出的支持扩展库,包含了丰富的组件、工具类等,通过在Android SDK Manager中勾选以下两项来获取到。
这里写图片描述
  其中,Android Support Library下载的是对应的源码或jar包,在使用Eclipse时会从这里拷贝出需要的文件到项目中。而Android Support Repository下载的是这个support库所对应的本地Maven库。如果你是使用Gradle进行构建(如Android Studio),并通过远程依赖的方式来使用support库的话,则需要下载它,才能获取到对应的依赖。
  如上面所说,Android support库包含了众多有用的类库,包括目前基本在项目中都会用到的support-v4包。而本序列第一篇要讲的是,除此support-v4库之外,我们用得特别多的一个库:android-support-annotations。
  由于我所使用的是Android Studio,所以对于Eclipse相关的知识在本篇及后续博客中都会略过不谈。

  android-support-annotations是Android官方提供的一个注解库,它提供了许多有用的注解,这些注解的生命周期为源码时期,也就是在编译之后则不再保留,通常用于辅助代码上的静态检查。
  在Gradle中引入这个库的方式通常如下:

  compile 'com.android.support:support-annotations:23.1.1'

  但是如果你已经通过这种方式依赖了support-v4库的话,则不必再显式声明依赖它,因为support-v4也依赖于这个库,由于Gradle的传递依赖的特性,你的项目如果依赖了support-v4库的话,也会依赖到这个注解库。
  通过使用support-annotations的注解,我们可以限定一些变量、方法参数或者是方法返回值的范围,这些注解涵盖的使用范围如下:
  

22个资源类注解:

  • AnimatorRes :指出一个integer的参数,成员变量,或方法返回值是一个animator资源的引用。
  • AnimRes:指出一个integer的参数,成员变量,或方法返回值是一个anim资源的引用。
  • AnyRes:指出一个integer的参数,成员变量,或方法返回值是一个任意资源类型的引用。
  • ArrayRes:指出一个integer的参数,成员变量,或方法返回值是一个array资源类型的引用。
  • AttrRes:指出一个integer的参数,成员变量,或方法返回值是一个attr资源的引用。
  • BoolRes:指出一个integer的参数,成员变量,或方法返回值是一个boolean资源的引用。
  • ColorRes:指出一个integer的参数,成员变量,或方法返回值是一个color资源的引用。
  • DimenRes:指出一个integer的参数,成员变量,或方法返回值是一个dimen资源的引用。
  • DrawableRes:指出一个integer的参数,成员变量,或方法返回值是一个drawable资源的引用(包括@mipmap)。
  • FractionRes:指出一个integer的参数,成员变量,或方法返回值是一个fraction资源的引用。
  • IdRes:指出一个integer的参数,成员变量,或方法返回值是一个id资源的引用。
  • IntegerRes:指出一个integer的参数,成员变量,或方法返回值是一个integer资源的引用。
  • InterpolatorRes:指出一个integer的参数,成员变量,或方法返回值是一个interpolator资源的引用。
  • LayoutRes:指出一个integer的参数,成员变量,或方法返回值是一个layout资源的引用。
  • MenuRes:指出一个integer的参数,成员变量,或方法返回值是一个menu资源的引用。
  • PluralsRes:指出一个integer的参数,成员变量,或方法返回值是一个plurals资源的引用。
  • RawRes:指出一个integer的参数,成员变量,或方法返回值是一个raw资源的引用。
  • StringRes:指出一个integer的参数,成员变量,或方法返回值是一个string资源的引用。
  • StyleableRes:指出一个integer的参数,成员变量,或方法返回值是一个styleable资源的引用。
  • StyleRes:指出一个integer的参数,成员变量,或方法返回值是一个style资源的引用。
  • TransitionRes:指出一个integer的参数,成员变量,或方法返回值是一个transition资源的引用。
  • XmlRes:指出一个integer的参数,成员变量,或方法返回值是一个xml资源的引用。

颜色注解:

  假如我们定义了一个方法用来设置颜色,但是因为表示颜色用的是int类型,这样就会导致使用的人无法区分是要传一个表示颜色的资源还是颜色值,对于这种情况,support-annotations给我们提供了以下这个注解:

  • ColorInt:指出一个被注解的元素,是一个int颜色值,表示的是AARRGGBB

4个线程相关的注解:

  • BinderThread:指出被注解的方法应该只在binder线程中被调用。
  • MainThread:指出被注解的方法应该只在主线程中被调用。
  • WorkerThread:指出被注解的方法应该只在工作线程中被调用。
  • UiThread:指出被注解的方法应该只在UI线程中被调用。

关于这四个注解的差异,可参见stackoverflow的回答:Difference between MainThread, UiThread, WorkerThread, BinderThread in Android Annotation

其他方法相关的注解:

  • CallSuper:指出一个方法如果被重写了,它必须也被调用。比如Activity的生命周期方法onCreate方法等。
  • CheckResult:指出一个方法返回的结果通常是否为一个忽略的错误。比如删除文件:new File("xx").delete();
  • Keep:指出一个方法在被混淆的时候应该被保留。

取值范围的注解:

  • FloatRange:指出一个被注解的元素应该是一个给定范围内的float值或double值。比如:
    @FloatRange(from=0.0,to=1.0)
    public float getAlpha() {
        ...
    }
  • IntRange:指出一个被注解的元素应该是一个给定范围内的int值或long值。
  • IntDef:指出一个int类型的元素,它表示的是一个逻辑上的类型,并且它的值必须是被明确声明的常量之一。官方常使用这种方式使int类型代替enum类型。
  • StringDef:指出一个String类型的元素,它表示的是一个逻辑上的类型,并且它的值必须是被明确声明的常量之一。

空指针检查

  通常我们如果对一个变量进行主动的赋值为null,编译器可能会进行可能引发空指针异常的警告,我们可以使用以下注解对这种行为进行控制。
- NonNull:指出一个参数,变量,或方法返回值永远不可为null。
- Nullable:指出一个参数,变量,或方法返回值可能为null。

其他注解:

  • Size:表示一个被注解的元素应该有一个给定的大小或长度。
  • VisibleForTesting:可注解一个类,方法,或变量,表示有更宽松的可见性,这样它能够有更宽泛的可见性,使代码可以被测试。

  本文原创,转载请注明出处。
  关于博文内容,如有遗误错讹,欢迎指出。如果你觉得写得还可以,欢迎微信扫描左侧栏底部二维码进行打赏。

目录
相关文章
|
7月前
|
Linux 编译器 Android开发
FFmpeg开发笔记(九)Linux交叉编译Android的x265库
在Linux环境下,本文指导如何交叉编译x265的so库以适应Android。首先,需安装cmake和下载android-ndk-r21e。接着,下载x265源码,修改crosscompile.cmake的编译器设置。配置x265源码,使用指定的NDK路径,并在配置界面修改相关选项。随后,修改编译规则,编译并安装x265,调整pc描述文件并更新PKG_CONFIG_PATH。最后,修改FFmpeg配置脚本启用x265支持,编译安装FFmpeg,将生成的so文件导入Android工程,调整gradle配置以确保顺利运行。
262 1
FFmpeg开发笔记(九)Linux交叉编译Android的x265库
|
6月前
|
存储 缓存 Android开发
安卓Jetpack Compose+Kotlin, 使用ExoPlayer播放多个【远程url】音频,搭配Okhttp库进行下载和缓存,播放完随机播放下一首
这是一个Kotlin项目,使用Jetpack Compose和ExoPlayer框架开发Android应用,功能是播放远程URL音频列表。应用会检查本地缓存,如果文件存在且大小与远程文件一致则使用缓存,否则下载文件并播放。播放完成后或遇到异常,会随机播放下一首音频,并在播放前随机设置播放速度(0.9到1.2倍速)。代码包括ViewModel,负责音频管理和播放逻辑,以及UI层,包含播放和停止按钮。
|
7月前
|
Unix Linux Shell
FFmpeg开发笔记(八)Linux交叉编译Android的FFmpeg库
在Linux环境下交叉编译Android所需的FFmpeg so库,首先下载`android-ndk-r21e`,然后解压。接着,上传FFmpeg及相关库(如x264、freetype、lame)源码,修改相关sh文件,将`SYSTEM=windows-x86_64`改为`SYSTEM=linux-x86_64`并删除回车符。对x264的configure文件进行修改,然后编译x264。同样编译其他第三方库。设置环境变量`PKG_CONFIG_PATH`,最后在FFmpeg源码目录执行配置、编译和安装命令,生成的so文件复制到App工程指定目录。
362 9
FFmpeg开发笔记(八)Linux交叉编译Android的FFmpeg库
|
2月前
|
安全 Java 网络安全
Android远程连接和登录FTPS服务代码(commons.net库)
Android远程连接和登录FTPS服务代码(commons.net库)
35 1
|
2月前
|
Linux API 开发工具
FFmpeg开发笔记(五十九)Linux编译ijkplayer的Android平台so库
ijkplayer是由B站研发的移动端播放器,基于FFmpeg 3.4,支持Android和iOS。其源码托管于GitHub,截至2024年9月15日,获得了3.24万星标和0.81万分支,尽管已停止更新6年。本文档介绍了如何在Linux环境下编译ijkplayer的so库,以便在较新的开发环境中使用。首先需安装编译工具并调整/tmp分区大小,接着下载并安装Android SDK和NDK,最后下载ijkplayer源码并编译。详细步骤包括环境准备、工具安装及库编译等。更多FFmpeg开发知识可参考相关书籍。
116 0
FFmpeg开发笔记(五十九)Linux编译ijkplayer的Android平台so库
|
2月前
|
Ubuntu Shell API
Ubuntu 64系统编译android arm64-v8a 的openssl静态库libssl.a和libcrypto.a
Ubuntu 64系统编译android arm64-v8a 的openssl静态库libssl.a和libcrypto.a
|
4月前
|
编解码 测试技术 Android开发
Android经典实战之用 CameraX 库实现高质量的照片和视频拍摄功能
本文详细介绍了如何利用CameraX库实现高质量的照片及视频拍摄功能,包括添加依赖、初始化、权限请求、配置预览与捕获等关键步骤。此外,还特别针对不同分辨率和帧率的视频拍摄提供了性能优化策略,确保应用既高效又稳定。
447 1
Android经典实战之用 CameraX 库实现高质量的照片和视频拍摄功能
|
4月前
|
监控 Java API
Android经典实战之OkDownload:一个经典强大的文件下载开源库,支持断点续传
本文介绍的 OkDownload 是一个专为 Android 设计的开源下载框架,支持多线程下载、断点续传和任务队列管理等功能,具备可靠性、灵活性和高性能特点。它提供了多种配置选项和监听器,便于开发者集成和扩展。尽管已多年未更新,但依然适用于大多数文件下载需求。
430 1
|
4月前
|
API Android开发
Android项目架构设计问题之选择和使用合适的UI库如何解决
Android项目架构设计问题之选择和使用合适的UI库如何解决
56 0
|
4月前
|
安全 Java 网络安全
Android远程连接和登录FTPS服务代码(commons.net库)
很多文章都介绍了FTPClient如何连接ftp服务器,但却很少有人说如何连接一台开了SSL认证的ftp服务器,现在代码来了。
119 2