Companion vs top-level functions decision in Kotlin - When to Use Which

The Big Idea

Discover how choosing between companion and top-level functions can transform your Kotlin code from messy to masterful!

The Scenario

Imagine you have a bunch of functions related to a class, but you write them all separately outside the class. You have to remember which functions belong together and where to find them.

The Problem

This manual way makes your code messy and hard to maintain. You might forget to update all related functions or accidentally use the wrong one. It's like having tools scattered all over your room instead of in one toolbox.

The Solution

Using companion objects or top-level functions in Kotlin helps organize your code clearly. Companion objects keep functions tied to their class, like a toolbox attached to a workbench. Top-level functions let you keep simple helpers separate but easy to find.

Before vs After

✗ Before

fun printInfo() { println("Info") }
class User {}

✓ After

class User {
  companion object {
    fun printInfo() { println("Info") }
  }
}

What It Enables

This decision lets you write cleaner, easier-to-understand code that groups related functions logically, making your programs simpler to build and fix.

Real Life Example

Think of a music player app: companion functions inside a Song class can handle song-specific tasks, while top-level functions can manage general utilities like formatting time.

Key Takeaways

Manual separation scatters related functions, causing confusion.

Companion objects group functions inside classes for clarity.

Top-level functions keep simple helpers accessible and organized.