Kotlin基础学习之Deprecated与Suppress注解使用

前言

在 Java 中通常对一些方法进行一些注解操作，但是很多注解在 Java 代码上没有问题，如果切换到 Kotlin 上时，如果继续使用这些注解就会存在一些问题，本篇主要对比一些常用 Java 注解和 Kotlin 注解使用转换。

Deprecated

在 Java 方法中，如果需要废弃一个方法，只需要在方法钱加上 @Deprecated 即可，例如这样：

@Deprecated
public void test(){

}

但是如果在 Kotlin 代码中直接使用这个注释，就存在问题了：

Deprecated

翻看源码发现，Kotlin 中对 Deprecated 这个注解做了加强：

@Target(CLASS, FUNCTION, PROPERTY, ANNOTATION_CLASS, CONSTRUCTOR, PROPERTY_SETTER, PROPERTY_GETTER, TYPEALIAS)
@MustBeDocumented
public annotation class Deprecated(
 val message: String,
 val replaceWith: ReplaceWith = ReplaceWith(""),
 val level: DeprecationLevel = DeprecationLevel.WARNING
)

源码中 Deprecated 存在三个参数，其中第二个和第三个参数存在默认值，第一个参数 message 没有，也就是说，要想正常使用时，必须要带上 message 信息，正常写法是这样：

@Deprecated("xxx")
fun testKt(){

}

三个参数说明：

message：解释弃用并建议使用替代 API 的信息

level：指定如何在代码中报告已弃用的元素用法，level 存在三种枚举

public enum class DeprecationLevel {
/** Usage of the deprecated element will be reported as a warning. */
WARNING,
/** Usage of the deprecated element will be reported as an error. */
ERROR,
/** Deprecated element will not be accessible from code. */
HIDDEN
}
  • WARNING：仅用于警告 API 使用者，不会中断其编译或运行时使用
  • ERROR：禁止使用该 API，如果调用了这类API直接编译报错
  • HIDDEN：直接隐藏该 API

replaceWith：指定可用于替换已弃用的函数，属性或类的代码片段。不明白？一图看懂：

replace

SuppressWarnings 与 Suppress

在 Java 代码中，如果需要消除一些编译时的警告，通常使用 @SuppressWarnings("xxx") 来进行解决的，而在 Kotlin 中，不能使用这个注解，需要使用Kotlin中内置的 @Suppress("xxx") 带替代。

例如，做 SDK 开发的时候，通常有很多对外 API ，正常情况下，不调用的时候，会有如下类似警告：

hello

对于有强迫症的来说这很难受，为了消除这种警告我们可以这样：

@Suppress("unused")
fun hello() {
 println("hello")
}

如果是Java代码则写成这样：

@SuppressWarnings("unused")
public void hello(){

}

又例如，有时候需要做一些类型转换时:

hello

此时为了消除这种警告，我们可以这样操作：

fun unChecked(){
 val list: List<Any> = emptyList()

 @Suppress("UNCHECKED_CAST")
 list as List<String>
}

如果在Java代码中则需要写成 @SuppressWarnings("unchecked")

Kotlin 中，Suppress 支持消除的警告有很多，可以通过源码查阅更多相关参数信息，例如：

hello

总结

其实这两种注解使用起来都不难，主要是平常 Java 代码写习惯了，切换到 Kotlin 之后，很多 API 并不熟悉，需要在开发过程中慢慢了解与积累，俗话说好记性不如烂笔头就是这么个道理。

好了，以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，谢谢大家对我们的支持。

赞 (0)

相关推荐

  • Kotlin中Suppress的非常规用法示例

    前言 在 Java 中,有个叫 SuppressWarnings 的注解,用于忽略特定的编译器警告.Kotlin 中也有一个类似功能的注解,叫做 Suppress,本文主要讲讲这个注解有什么用. 常规用法 有时候会写出这样的一些代码.这些在Kotlin编译器的眼里可能出现问题的代码,实际上却非常正确,跑起来不会出任何问题. 然后你就得到了一个编译器警告(warning),甚至是编译错误(error). 比较常见的,比如说 unchecked cast: val some: List<*> =

  • Kotlin 基础教程之注解与java中的注解比较

    Kotlin 的注解完全兼容 Java 的注解. 声明注解 @Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.EXPRESSION) @Retention(AnnotationRetention.SOURCE) @MustBeDocumented annotation class Fancy 可以通过向注解类添加元注解(meta

  • Kotlin 的注解类详解及实例

    Kotlin 的注解类详解及实例 注解声明 注解是将元数据附加到代码的方法.要声明注解,请将 annotation 修饰符放在类的前面: annotation class Fancy 注解的附加属性可以通过用元注解标注注解类来指定: @Target 指定可以用 该注解标注的元素的可能的类型(类.函数.属性.表达式等): @Retention 指定该注解是否 存储在编译后的 class 文件中,以及它在运行时能否通过反射可见 (默认都是 true): @Repeatable 允许 在单个元素上多次

  • Kotlin基础学习之Deprecated与Suppress注解使用

    Kotlin基础学习之Deprecated与Suppress注解使用

    前言 在 Java 中通常对一些方法进行一些注解操作,但是很多注解在 Java 代码上没有问题,如果切换到 Kotlin 上时,如果继续使用这些注解就会存在一些问题,本篇主要对比一些常用 Java 注解和 Kotlin 注解使用转换. Deprecated 在 Java 方法中,如果需要废弃一个方法,只需要在方法钱加上 @Deprecated 即可,例如这样: @Deprecated public void test(){ } 但是如果在 Kotlin 代码中直接使用这个注释,就存在问题了: D

  • Kotlin基础学习之位运算

    什么是位运算? 程序中的所有数在计算机内存中都是以二进制的形式储存的.位运算说穿了,就是直接对整数在内存中的二进制位进行操作.比如,and运算本来是一个逻辑运算符,但整数与整数之间也可以进行and运算.举个例子,6的二进制是110,11的二进制是1011,那么6 and 11的结果就是2,它是二进制对应位进行逻辑运算的结果(0表示False,1表示True,空位都当0处理): 110 AND 1011 ---- 0010 –> 2 由于位运算直接对内存数据进行操作,不需要转成十进制,因此处理速度

  • Kotlin基础学习之循环和异常

    前言 Kotlin并没有想象中的那么牛逼哄哄,也并不难,我更喜欢把他看做一枚语法糖,所谓的语法糖就是:能够让代码变得更加简单易读的辅助工具.而工具这种东西,看看说明书,实操几遍基本就能掌握,都是记忆性的东西,熟能生巧.如果你的Java基础扎实,看看Kotlin的开发文档,写写Demo,分分钟就上手了. 说到这个Kotlin提升写代码效率,还是谈谈几个最直观简单的例子吧: 1.不用再去 findViewById 或者 @BindView,拿到控件id直接用 2.不用再为 Bean 写一堆 gett

  • Kotlin基础学习之lambda中return语句详解

    前言 当我们爱上lambda并且大范围使用它的时候,我想大家都会被lambda中的return语句狠狠地调戏过,所以今天我们需要一起来揭开lambda中return的神秘面纱. 首先来看一个例子: fun demo() { val indexes = arrayOf(1, 2, 3, 4, 5, 6, 7) indexes.forEach { if (it > 5) { return } println(it) } println("End") } 按照我们的预期,调用demo后

  • kotlin 官方学习教程之基础语法详解

    kotlin 官方学习教程之基础语法详解 Google 在今天的举行了 I/O 大会,大会主要主要展示内有容 Android O(Android 8.0)系统.Google Assistant 语音助手.Google 智能音箱.人工智能.机器学习.虚拟现实等.作为一个 Android 开发者,我关心的当然是 Android O(Android 8.0)系统了,那么关于 Android O 系统的一个重要消息是全面支持 Kotlin 编程语言,使得 Kotlin 成为了 Android 开发的官方

  • Kotlin 基础教程之类、对象、接口

    Kotlin 基础教程之类.对象.接口 Kotlin中类.接口相关概念与Java一样,包括类名.属性.方法.继承等,如下示例: interface A { fun bar() fun foo() { // 可选方法体 } } class Child: A { override fun bar() { // todo } override fun foo() { super.foo() } } class 构造器 Kotlin 中的类可以有一个 主构造器, 以及一个或多个次构造器, 主构造器是类头

  • java基础之反射和泛型以及注解

     java基础之反射和泛型以及注解 泛型擦除 泛型擦除: 泛型只在编译时期有效,编译后的字节码文件中不存在泛型信息. 声明泛型集合,集合两端类型必须一致.类型也可以用包装类型,泛型的类型必须是引用类型,不能为基本类型. 实现公用的类和方法,对公用的业务进行抽取. 泛型方法/泛型类/泛型接口 public class GenericTest { /** * 泛型声明,定义泛型方法 * @param <T> * @param <K> * @param t * @param k */ p

  • Kotlin语法学习-变量定义、函数扩展、Parcelable序列化等简单总结

    Kotlin语法学习-变量定义.函数扩展.Parcelable序列化等简单总结 今年 Google I/O 2017 开发者大会中,Google 宣布正式把 Kotlin 纳入 Android 程序的官方一级开发语言(First-class language),作为Android开发者,当然要逐步熟悉这门语言,第一步就要从语法开始学习. 在这之前,我们需要了解怎么使用Kotlin编写一个Android应用.对于Android Studio 3.0版本,我们在创建工程的时候直接勾选 Include

  • kotlin基础教程之类和继承

    kotlin基础教程之类和继承 类声明 使用class关键字声明类,查看其声明格式: : modifiers ("class" | "interface") SimpleName typeParameters? primaryConstructor? (":" annotations delegationSpecifier{","})? typeConstraints (classBody? | enumClassBody)

  • Java8函数式接口的基础学习教程

    函数式接口 1.1 函数式接口概述 函数式接口:有且仅有一个抽象方法的接口 Java中的函数式编程体现就是Lambda表达式,所以函数式接口就是可以使用与Lambda使用的接口 只有确保接口只能够有且只有一个抽象方法,Lambda才能顺利的进行推导 检测接口是不是函数式接口: @FunctionalInterface 放在接口定义的上方:如果接口是函数式接口,编译通过,反之失败. 注意: 我们自己定义函数式接口的时候,@FunctionalInterface是可选的,就算不写,只要爆炸慢煮函数式

随机推荐