オブジェクト
この章では、オブジェクト宣言について学ぶことで、クラスへの理解を深めます。この知識は、プロジェクト全体で振る舞いを効率的に管理するのに役立ちます。
オブジェクト宣言
Kotlinでは、オブジェクト宣言(object declaration)を使用して、単一のインスタンスを持つクラスを宣言できます。ある意味では、クラスの宣言と単一インスタンスの生成を同時に行います。オブジェクト宣言は、プログラムの単一の参照ポイントとして使用するクラスを作成したい場合や、システム全体で振る舞いを調整したい場合に便利です。
容易にアクセス可能なインスタンスが1つだけ存在するクラスは、シングルトン(singleton)と呼ばれます。
Kotlinのオブジェクトは遅延(lazy)生成されます。つまり、アクセスされたときにのみ生成されます。また、Kotlinはすべてのオブジェクトがスレッドセーフな方法で生成されることを保証するため、これらを手動でチェックする必要はありません。
オブジェクト宣言を作成するには、object キーワードを使用します:
object DoAuth {}object の名前に続けて、波括弧 {} で定義されるオブジェクト本文内にプロパティやメンバー関数を追加します。
オブジェクトはコンストラクタを持てないため、クラスのようなヘッダーはありません。
例えば、認証を担当する DoAuth というオブジェクトを作成したいとします:
object DoAuth {
fun takeParams(username: String, password: String) {
println("input Auth parameters = $username:$password")
}
}
fun main(){
// takeParams() 関数が呼び出されたときにオブジェクトが生成されます
DoAuth.takeParams("coding_ninja", "N1njaC0ding!")
// input Auth parameters = coding_ninja:N1njaC0ding!
}このオブジェクトには、username と password 変数をパラメータとして受け取り、コンソールに文字列を出力する takeParams というメンバー関数があります。DoAuth オブジェクトは、この関数が初めて呼び出されたときにのみ生成されます。
オブジェクトはクラスやインターフェースを継承できます。例えば:
interface Auth {
fun takeParams(username: String, password: String)
}
object DoAuth : Auth {
override fun takeParams(username: String, password: String) {
println("input Auth parameters = $username:$password")
}
}データオブジェクト
オブジェクト宣言の内容を出力しやすくするために、Kotlinにはデータオブジェクト(data object)が用意されています。入門ツアーで学んだデータクラスと同様に、データオブジェクトには追加のメンバー関数である toString() と equals() が自動的に提供されます。
データクラスとは異なり、データオブジェクトにはコピーできない単一のインスタンスしか存在しないため、copy() メンバー関数は自動的には提供されません。
データオブジェクトを作成するには、オブジェクト宣言と同じ構文を使用しますが、先頭に data キーワードを付けます:
data object AppConfig {}例えば:
data object AppConfig {
var appName: String = "My Application"
var version: String = "1.0.0"
}
fun main() {
println(AppConfig)
// AppConfig
println(AppConfig.appName)
// My Application
}データオブジェクトの詳細については、データオブジェクト を参照してください。
コンパニオンオブジェクト
Kotlinでは、クラスがオブジェクトを持つことができます。それがコンパニオンオブジェクト(companion object)です。1つのクラスにつき1つのコンパニオンオブジェクトのみを持つことができます。コンパニオンオブジェクトは、そのクラスが初めて参照されたときにのみ生成されます。
コンパニオンオブジェクト内で宣言されたプロパティや関数は、すべてのクラスインスタンス間で共有されます。
クラス内にコンパニオンオブジェクトを作成するには、オブジェクト宣言と同じ構文を使用しますが、先頭に companion キーワードを付けます:
companion object Bonger {}コンパニオンオブジェクトには必ずしも名前をつける必要はありません。名前を定義しない場合のデフォルトは Companion です。
コンパニオンオブジェクトのプロパティや関数にアクセスするには、クラス名を参照します。例えば:
class BigBen {
companion object Bonger {
fun getBongs(nTimes: Int) {
repeat(nTimes) { print("BONG ") }
}
}
}
fun main() {
// クラスが初めて参照されたときにコンパニオンオブジェクトが生成されます。
BigBen.getBongs(12)
// BONG BONG BONG BONG BONG BONG BONG BONG BONG BONG BONG BONG
}この例では、Bonger というコンパニオンオブジェクトを含む BigBen というクラスを作成しています。コンパニオンオブジェクトには、整数を受け取り、その整数の回数だけコンソールに "BONG" を出力する getBongs() というメンバー関数があります。
main() 関数では、クラス名を参照することで getBongs() 関数が呼び出されます。この時点でコンパニオンオブジェクトが生成されます。getBongs() 関数は引数 12 で呼び出されます。
詳細については、コンパニオンオブジェクト を参照してください。
練習問題
注文追跡用のデータオブジェクトを実装する
あなたはコーヒーショップを経営しており、顧客の注文を追跡するシステムを持っています。以下のコードを確認し、main() 関数のコードが正常に実行されるように、2つ目のデータオブジェクトの宣言を完成させてください:
interface Order {
val orderId: String
val customerName: String
val orderTotal: Double
}
data object OrderOne: Order {
override val orderId = "001"
override val customerName = "Alice"
override val orderTotal = 15.50
}
data object // ここにコードを書いてください
fun main() {
// 各データオブジェクトの名前を出力
println("Order name: $OrderOne")
// Order name: OrderOne
println("Order name: $OrderTwo")
// Order name: OrderTwo
// 注文が同一かどうかを確認
println("Are the two orders identical? ${OrderOne == OrderTwo}")
// Are the two orders identical? false
if (OrderOne == OrderTwo) {
println("The orders are identical.")
} else {
println("The orders are unique.")
// The orders are unique.
}
println("Do the orders have the same customer name? ${OrderOne.customerName == OrderTwo.customerName}")
// Do the orders have the same customer name? false
}解答例 {...}
interface Order {
val orderId: String
val customerName: String
val orderTotal: Double
}
data object OrderOne: Order {
override val orderId = "001"
override val customerName = "Alice"
override val orderTotal = 15.50
}
data object OrderTwo: Order {
override val orderId = "002"
override val customerName = "Bob"
override val orderTotal = 12.75
}
fun main() {
// 各データオブジェクトの名前を出力
println("Order name: $OrderOne")
// Order name: OrderOne
println("Order name: $OrderTwo")
// Order name: OrderTwo
// 注文が同一かどうかを確認
println("Are the two orders identical? ${OrderOne == OrderTwo}")
// Are the two orders identical? false
if (OrderOne == OrderTwo) {
println("The orders are identical.")
} else {
println("The orders are unique.")
// The orders are unique.
}
println("Do the orders have the same customer name? ${OrderOne.customerName == OrderTwo.customerName}")
// Do the orders have the same customer name? false
}オブジェクト宣言を作成する
Vehicle インターフェースを継承したオブジェクト宣言を作成し、ユニークな乗り物タイプである FlyingSkateboard を作成してください。main() 関数のコードが正常に実行されるように、オブジェクト内に name プロパティと move() 関数を実装してください:
interface Vehicle {
val name: String
fun move(): String
}
object // ここにコードを書いてください
fun main() {
println("${FlyingSkateboard.name}: ${FlyingSkateboard.move()}")
// Flying Skateboard: Glides through the air with a hover engine
println("${FlyingSkateboard.name}: ${FlyingSkateboard.fly()}")
// Flying Skateboard: Woooooooo
}解答例 {...}
interface Vehicle {
val name: String
fun move(): String
}
object FlyingSkateboard : Vehicle {
override val name = "Flying Skateboard"
override fun move() = "Glides through the air with a hover engine"
fun fly(): String = "Woooooooo"
}
fun main() {
println("${FlyingSkateboard.name}: ${FlyingSkateboard.move()}")
// Flying Skateboard: Glides through the air with a hover engine
println("${FlyingSkateboard.name}: ${FlyingSkateboard.fly()}")
// Flying Skateboard: Woooooooo
}ユーザーを作成する前にメールアドレスを検証する
アプリ用のユーザー登録モジュールを構築しています。メールアドレスのバリデーションを User クラスに関連付けたいものの、メールアドレスが無効な場合に不要な User インスタンスを生成したくありません。
この練習問題では、メールアドレスに @ と . の両方が含まれている場合に有効であるとみなします。main() 関数のコードが正常に実行されるように、データクラスを完成させてください:
ヒント
User から直接呼び出せるように、User クラスのコンパニオンオブジェクト内にメールアドレスの検証関数を追加してください。 data class User(val name: String, val email: String) {
// ここにコードを書いてください
}
fun main() {
val candidates = listOf(
Pair("Alice", "alice@example.com"),
Pair("Bob", "bob2example-com")
)
for ((name, email) in candidates) {
if (User.isValidEmail(email)) {
val user = User(name, email)
println("Registered: ${user.name}, ${user.email}")
// Registered: Alice, alice@example.com
} else {
println("Error: '${email}' is not valid. The email should contain '@' and '.'")
// Error: 'bob2example-com' is not valid. The email should contain '@' and '.'
}
}
}解答例 {...}
data class User(val name: String, val email: String) {
companion object {
fun isValidEmail(email: String): Boolean =
email.contains('@') && email.contains('.')
}
}
fun main() {
val candidates = listOf(
Pair("Alice", "alice@example.com"),
Pair("Bob", "bob2example-com")
)
for ((name, email) in candidates) {
if (User.isValidEmail(email)) {
val user = User(name, email)
println("Registered: ${user.name}, ${user.email}")
// Registered: Alice, alice@example.com
} else {
println("Error: '${email}' is not valid. The email should contain '@' and '.'")
// Error: 'bob2example-com' is not valid. The email should contain '@' and '.'
}
}
}この練習問題の発展として、コンパニオンオブジェクト内の関数をファクトリメソッドとして使用し、クラスのインスタンスを生成してみてください。このパターンの例と詳細については、コンパニオンオブジェクト を参照してください。
