Scala Traits

Traits are a powerful feature in Scala, similar to Java's interfaces but with richer functionality. Traits can contain abstract methods, concrete methods, fields, and type definitions, and support multiple inheritance.

Trait Basics

Defining and Using Traits

// Basic trait definition
trait Drawable {
  def draw(): Unit  // Abstract method
}

trait Colorable {
  def setColor(color: String): Unit
  def getColor: String
}

// Concrete implementation
class Circle extends Drawable with Colorable {
  private var color: String = "black"

  def draw(): Unit = {
    println(s"Drawing a $color circle")
  }

  def setColor(color: String): Unit = {
    this.color = color
  }

  def getColor: String = color
}

class Rectangle extends Drawable with Colorable {
  private var color: String = "black"

  def draw(): Unit = {
    println(s"Drawing a $color rectangle")
  }

  def setColor(color: String): Unit = {
    this.color = color
  }

  def getColor: String = color
}

object BasicTraitExample {
  def main(args: Array[String]): Unit = {
    val circle = new Circle()
    circle.setColor("red")
    circle.draw()

    val rectangle = new Rectangle()
    rectangle.setColor("blue")
    rectangle.draw()

    // Polymorphism
    val shapes: List[Drawable with Colorable] = List(circle, rectangle)
    shapes.foreach { shape =>
      shape.setColor("green")
      shape.draw()
    }
  }
}

Traits with Concrete Implementations

trait Logger {
  // Abstract method
  def log(message: String): Unit

  // Concrete methods
  def info(message: String): Unit = log(s"INFO: $message")
  def warn(message: String): Unit = log(s"WARN: $message")
  def error(message: String): Unit = log(s"ERROR: $message")

  // Method with default implementation
  def debug(message: String): Unit = {
    if (isDebugEnabled) log(s"DEBUG: $message")
  }

  // Method that can be overridden
  def isDebugEnabled: Boolean = false
}

trait ConsoleLogger extends Logger {
  def log(message: String): Unit = println(message)
}

trait FileLogger extends Logger {
  val filename: String

  def log(message: String): Unit = {
    // Simplified file writing
    println(s"Writing to $filename: $message")
  }
}

class Application extends ConsoleLogger {
  override def isDebugEnabled: Boolean = true

  def run(): Unit = {
    info("Application starting")
    debug("Debug information")
    warn("This is a warning")
    error("An error occurred")
  }
}

class FileBasedApp extends FileLogger {
  val filename = "app.log"

  def run(): Unit = {
    info("File-based app starting")
    warn("Warning logged to file")
  }
}

object ConcreteTraitExample {
  def main(args: Array[String]): Unit = {
    val app = new Application()
    app.run()

    println()

    val fileApp = new FileBasedApp()
    fileApp.run()
  }
}

Advanced Trait Features

Traits with Fields

trait Timestamped {
  val timestamp: Long = System.currentTimeMillis()

  def age: Long = System.currentTimeMillis() - timestamp

  def isOlderThan(seconds: Int): Boolean = age > seconds * 1000
}

trait Identifiable {
  val id: String = java.util.UUID.randomUUID().toString

  def shortId: String = id.take(8)
}

class Document(val title: String, val content: String)
  extends Timestamped with Identifiable {

  override def toString: String =
    s"Document($shortId, $title, created ${age}ms ago)"
}

class User(val name: String, val email: String)
  extends Timestamped with Identifiable {

  override def toString: String =
    s"User($shortId, $name, $email, created ${age}ms ago)"
}

object FieldTraitExample {
  def main(args: Array[String]): Unit = {
    val doc = new Document("Scala Guide", "This is a comprehensive Scala guide")
    val user = new User("Alice", "alice@example.com")

    println(doc)
    println(user)

    Thread.sleep(1000)

    println(s"Document age: ${doc.age}ms")
    println(s"User age: ${user.age}ms")

    println(s"Document is older than 500ms: ${doc.isOlderThan(0)}")
  }
}

Self Types

trait Database {
  def save(data: String): Unit
  def load(id: String): String
}

trait UserService {
  // Self type: Requires that classes mixing in this trait also mix in Database
  self: Database =>

  def createUser(name: String, email: String): String = {
    val userData = s"User($name, $email)"
    save(userData)
    s"User created: $userData"
  }

  def getUser(id: String): String = {
    val userData = load(id)
    s"Retrieved: $userData"
  }
}

trait InMemoryDatabase extends Database {
  private var storage = scala.collection.mutable.Map[String, String]()
  private var nextId = 1

  def save(data: String): Unit = {
    val id = nextId.toString
    storage(id) = data
    nextId += 1
    println(s"Saved with ID $id: $data")
  }

  def load(id: String): String = {
    storage.getOrElse(id, "Not found")
  }
}

// This class must mix in both Database and UserService
class UserManager extends InMemoryDatabase with UserService {
  def listAllUsers(): Unit = {
    println("All users in database:")
    // Can directly access Database's methods because self type guarantees its existence
  }
}

object SelfTypeExample {
  def main(args: Array[String]): Unit = {
    val userManager = new UserManager()

    userManager.createUser("Alice", "alice@example.com")
    userManager.createUser("Bob", "bob@example.com")

    println(userManager.getUser("1"))
    println(userManager.getUser("2"))
    println(userManager.getUser("3"))
  }
}

Abstract Type Members

trait Container {
  type Element  // Abstract type

  def add(element: Element): Unit
  def get(): Option[Element]
  def size: Int
}

class StringContainer extends Container {
  type Element = String  // Concrete type

  private var elements = List[String]()

  def add(element: String): Unit = {
    elements = element :: elements
  }

  def get(): Option[String] = elements.headOption

  def size: Int = elements.length
}

class IntContainer extends Container {
  type Element = Int

  private var elements = List[Int]()

  def add(element: Int): Unit = {
    elements = element :: elements
  }

  def get(): Option[Int] = elements.headOption

  def size: Int = elements.length
}

// Generic version
trait GenericContainer[T] {
  def add(element: T): Unit
  def get(): Option[T]
  def size: Int
}

class ListContainer[T] extends GenericContainer[T] {
  private var elements = List[T]()

  def add(element: T): Unit = {
    elements = element :: elements
  }

  def get(): Option[T] = elements.headOption

  def size: Int = elements.length
}

object AbstractTypeExample {
  def main(args: Array[String]): Unit = {
    val stringContainer = new StringContainer()
    stringContainer.add("Hello")
    stringContainer.add("World")
    println(s"String container: ${stringContainer.get()}, size: ${stringContainer.size}")

    val intContainer = new IntContainer()
    intContainer.add(42)
    intContainer.add(24)
    println(s"Int container: ${intContainer.get()}, size: ${intContainer.size}")

    // Generic version
    val genericStringContainer = new ListContainer[String]()
    genericStringContainer.add("Generic Hello")
    println(s"Generic container: ${genericStringContainer.get()}")
  }
}

Trait Linearization

Multiple Inheritance and Method Resolution

trait A {
  def message: String = "A"
  def process(): Unit = println(s"Processing in A: $message")
}

trait B extends A {
  override def message: String = "B"
  override def process(): Unit = {
    println(s"Pre-processing in B: $message")
    super.process()
    println(s"Post-processing in B: $message")
  }
}

trait C extends A {
  override def message: String = "C"
  override def process(): Unit = {
    println(s"Pre-processing in C: $message")
    super.process()
    println(s"Post-processing in C: $message")
  }
}

trait D extends B with C {
  override def message: String = "D"
  override def process(): Unit = {
    println(s"Pre-processing in D: $message")
    super.process()
    println(s"Post-processing in D: $message")
  }
}

class MyClass extends D {
  override def message: String = "MyClass"
}

// Demonstrate different mixin orders
class MyClass1 extends A with B with C {
  override def message: String = "MyClass1"
}

class MyClass2 extends A with C with B {
  override def message: String = "MyClass2"
}

object LinearizationExample {
  def main(args: Array[String]): Unit = {
    println("=== MyClass (extends D) ===")
    val obj = new MyClass()
    obj.process()

    println("\n=== MyClass1 (A with B with C) ===")
    val obj1 = new MyClass1()
    obj1.process()

    println("\n=== MyClass2 (A with C with B) ===")
    val obj2 = new MyClass2()
    obj2.process()

    // Linearization order:
    // MyClass: MyClass -> D -> C -> B -> A
    // MyClass1: MyClass1 -> C -> B -> A
    // MyClass2: MyClass2 -> B -> C -> A
  }
}

Diamond Problem Resolution

trait Animal {
  def name: String
  def sound(): Unit = println(s"$name makes a sound")
}

trait Mammal extends Animal {
  override def sound(): Unit = {
    println(s"$name is a mammal")
    super.sound()
  }
}

trait Pet extends Animal {
  def owner: String
  override def sound(): Unit = {
    println(s"$name is a pet owned by $owner")
    super.sound()
  }
}

class Dog(val name: String, val owner: String) extends Mammal with Pet {
  override def sound(): Unit = {
    println(s"$name barks")
    super.sound()
  }
}

class Cat(val name: String, val owner: String) extends Pet with Mammal {
  override def sound(): Unit = {
    println(s"$name meows")
    super.sound()
  }
}

object DiamondProblemExample {
  def main(args: Array[String]): Unit = {
    println("=== Dog (Mammal with Pet) ===")
    val dog = new Dog("Buddy", "Alice")
    dog.sound()

    println("\n=== Cat (Pet with Mammal) ===")
    val cat = new Cat("Whiskers", "Bob")
    cat.sound()

    // Linearization order different leads to different invocation order
    // Dog: Dog -> Pet -> Mammal -> Animal
    // Cat: Cat -> Mammal -> Pet -> Animal
  }
}

Practical Application Examples

Plugin System

trait Plugin {
  def name: String
  def version: String
  def initialize(): Unit
  def shutdown(): Unit

  def isCompatible(systemVersion: String): Boolean = {
    // Default compatibility check
    true
  }
}

trait Configurable {
  type Config

  def configure(config: Config): Unit
  def getConfig: Config
}

trait Loggable {
  def logInfo(message: String): Unit = println(s"[INFO] $message")
  def logError(message: String): Unit = println(s"[ERROR] $message")
}

// Concrete plugin implementations
class DatabasePlugin extends Plugin with Configurable with Loggable {
  type Config = Map[String, String]

  private var config: Config = Map.empty

  def name: String = "Database Plugin"
  def version: String = "1.0.0"

  def initialize(): Unit = {
    logInfo(s"Initializing $name v$version")
    logInfo(s"Database URL: ${config.getOrElse("url", "not configured")}")
  }

  def shutdown(): Unit = {
    logInfo(s"Shutting down $name")
  }

  def configure(config: Config): Unit = {
    this.config = config
    logInfo("Database plugin configured")
  }

  def getConfig: Config = config

  def connect(): Unit = {
    logInfo("Connecting to database...")
  }
}

class CachePlugin extends Plugin with Loggable {
  def name: String = "Cache Plugin"
  def version: String = "2.1.0"

  def initialize(): Unit = {
    logInfo(s"Initializing $name v$version")
  }

  def shutdown(): Unit = {
    logInfo(s"Shutting down $name")
  }

  def clearCache(): Unit = {
    logInfo("Cache cleared")
  }
}

// Plugin manager
class PluginManager {
  private var plugins = List[Plugin]()

  def registerPlugin(plugin: Plugin): Unit = {
    plugins = plugin :: plugins
    println(s"Registered plugin: ${plugin.name}")
  }

  def initializeAll(): Unit = {
    plugins.foreach(_.initialize())
  }

  def shutdownAll(): Unit = {
    plugins.reverse.foreach(_.shutdown())  // Reverse order shutdown
  }

  def getPlugin[T <: Plugin](implicit manifest: Manifest[T]): Option[T] = {
    plugins.find(manifest.runtimeClass.isInstance).map(_.asInstanceOf[T])
  }
}

object PluginSystemExample {
  def main(args: Array[String]): Unit = {
    val manager = new PluginManager()

    // Register plugins
    val dbPlugin = new DatabasePlugin()
    val cachePlugin = new CachePlugin()

    manager.registerPlugin(dbPlugin)
    manager.registerPlugin(cachePlugin)

    // Configure database plugin
    dbPlugin.configure(Map("url" -> "jdbc:mysql://localhost:3306/mydb"))

    // Initialize all plugins
    manager.initializeAll()

    // Use plugins
    dbPlugin.connect()
    cachePlugin.clearCache()

    // Shutdown all plugins
    manager.shutdownAll()
  }
}

State Machine Pattern

trait State {
  def name: String
  def enter(): Unit = {}
  def exit(): Unit = {}
  def handle(event: String): Option[State] = None
}

trait StateMachine {
  private var currentState: State = initialState

  def initialState: State

  def getCurrentState: State = currentState

  def transition(event: String): Boolean = {
    currentState.handle(event) match {
      case Some(newState) =>
        currentState.exit()
        currentState = newState
        currentState.enter()
        true
      case None =>
        false
    }
  }
}

// Concrete state implementations
object IdleState extends State {
  def name: String = "Idle"

  override def enter(): Unit = println("Entering Idle state")

  override def handle(event: String): Option[State] = event match {
    case "start" => Some(RunningState)
    case _ => None
  }
}

object RunningState extends State {
  def name: String = "Running"

  override def enter(): Unit = println("Entering Running state")

  override def handle(event: String): Option[State] = event match {
    case "pause" => Some(PausedState)
  case "stop" => Some(StoppedState)
  case _ => None
  }
}

object PausedState extends State {
  def name: String = "Paused"

  override def enter(): Unit = println("Entering Paused state")

  override def handle(event: String): Option[State] = event match {
    case "resume" => Some(RunningState)
  case "stop" => Some(StoppedState)
  case _ => None
  }
}

object StoppedState extends State {
  def name: String = "Stopped"

  override def enter(): Unit = println("Entering Stopped state")

  override def handle(event: String): Option[State] = event match {
    case "reset" => Some(IdleState)
    case _ => None
  }
}

class MediaPlayer extends StateMachine {
  def initialState: State = IdleState

  def play(): Unit = {
    if (!transition("start")) {
      println("Cannot start from current state")
    }
  }

  def pause(): Unit = {
    if (!transition("pause")) {
      println("Cannot pause from current state")
    }
  }

  def resume(): Unit = {
    if (!transition("resume")) {
      println("Cannot resume from current state")
    }
  }

  def stop(): Unit = {
    if (!transition("stop")) {
      println("Cannot stop from current state")
    }
  }

  def reset(): Unit = {
    if (!transition("reset")) {
      println("Cannot reset from current state")
    }
  }

  def status(): Unit = {
    println(s"Current state: ${getCurrentState.name}")
  }
}

object StateMachineExample {
  def main(args: Array[String]): Unit = {
    val player = new MediaPlayer()

    player.status()  // Idle

    player.play()    // Idle -> Running
    player.status()  // Running

    player.pause()   // Running -> Paused
    player.status()  // Paused

    player.resume()  // Paused -> Running
    player.status()  // Running

    player.stop()    // Running -> Stopped
    player.status()  // Stopped

    player.reset()   // Stopped -> Idle
    player.status()  // Idle

    // Try invalid transitions
    player.pause()   // Invalid: cannot pause from Idle
  }
}

Best Practices

1. Prioritize Traits over abstract classes:

   • Traits support multiple inheritance
   • More flexible composition approach
   • Better code reuse

2. Keep Traits single responsibility:

   • Each trait should have clear responsibility
   • Avoid overly complex traits
   • Easier to test and maintain

3. Use self types appropriately:

   • Clearly express dependency relationships
   • Improve type safety
   • Avoid runtime errors

4. Pay attention to linearization order:

   • Understand trait mixin order
   • Use super calls appropriately
   • Avoid unexpected method resolution

5. Design composable traits:

   • Provide reasonable default implementations
   • Support method overriding
   • Consider compatibility with other traits

Traits are a powerful tool for implementing code reuse and modular design in Scala, and mastering their usage is crucial for writing high-quality Scala code.