Kotlin’s Delicate API Warning: Should You Ignore It?

Kotlin is known for its concise, expressive syntax and developer-friendly features. However, if you’ve worked with certain Kotlin libraries, you may have encountered a Delicate API warning. This warning often leaves developers wondering: Should I ignore it? or Is it something I need to worry about?

Let’s break it down in simple terms so you can make an informed decision.

What is a Delicate API in Kotlin?

A Delicate API in Kotlin is an API that requires extra caution. It’s not necessarily unsafe, but misusing it can lead to unexpected behavior, bugs, or maintenance headaches.

When you use a Delicate API, the compiler warns you with a message like this:

fun riskyFunction() {
    GlobalScope.launch { // Delicate API warning: Launching coroutine in an unsafe way
        println("Running in GlobalScope")
    }
}

In this snippet, launching a coroutine in the GlobalScope triggers the delicate API warning, reminding you to handle this coroutine with care. Actually, it creates a coroutine that lives for the application's lifetime, which can lead to memory leaks if not handled correctly.

Why Does Kotlin Mark APIs as Delicate?