クラス
Kotlinはクラスとオブジェクトによるオブジェクト指向プログラミングをサポートしています。オブジェクトは、プログラム内にデータを格納するのに役立ちます。 クラスを使用すると、オブジェクトの一連の特性を宣言できます。クラスからオブジェクトを作成すれば、毎回それらの特性を宣言する必要がなくなるため、時間と手間を節約できます。
クラスを宣言するには、class キーワードを使用します:
class Customerプロパティ
クラスのオブジェクトが持つ特性は、プロパティで宣言できます。クラスのプロパティは次のように宣言できます:
- クラス名の後の丸括弧
()の内側。
class Contact(val id: Int, var email: String)- 波括弧
{}で定義されるクラス本体の内側。
class Contact(val id: Int, var email: String) {
val category: String = ""
}クラスのインスタンス作成後に変更する必要がない限り、プロパティは読み取り専用(val)として宣言することをお勧めします。
丸括弧の内側では val や var を付けずにプロパティを宣言することもできますが、それらのプロパティはインスタンス作成後にアクセスできなくなります。
- 丸括弧
()内に含まれる内容はクラスヘッダー(class header)と呼ばれます。 - クラスのプロパティを宣言する際には、末尾のカンマ(trailing comma)を使用できます。
関数のパラメーターと同様に、クラスのプロパティにもデフォルト値を持たせることができます:
class Contact(val id: Int, var email: String = "example@gmail.com") {
val category: String = "work"
}インスタンスの作成
クラスからオブジェクトを作成するには、コンストラクター(constructor)を使用してクラスのインスタンス(instance)を宣言します。
デフォルトでは、Kotlinはクラスヘッダーで宣言されたパラメーターを持つコンストラクターを自動的に作成します。
例:
class Contact(val id: Int, var email: String)
fun main() {
val contact = Contact(1, "mary@gmail.com")
}この例では:
Contactはクラスです。contactはContactクラスのインスタンスです。idとemailはプロパティです。idとemailは、contactを作成するためにデフォルトのコンストラクターとともに使用されています。
Kotlinのクラスには、自分で定義したコンストラクターを含め、複数のコンストラクターを持たせることができます。複数のコンストラクターを宣言する方法について詳しくは、コンストラクターを参照してください。
プロパティへのアクセス
インスタンスのプロパティにアクセスするには、インスタンス名の後にピリオド . を付け、その後にプロパティ名を書きます:
class Contact(val id: Int, var email: String)
fun main() {
val contact = Contact(1, "mary@gmail.com")
// プロパティの値を出力: email
println(contact.email)
// mary@gmail.com
// プロパティの値を更新: email
contact.email = "jane@gmail.com"
// プロパティの新しい値を出力: email
println(contact.email)
// jane@gmail.com
}文字列の一部としてプロパティの値を結合するには、文字列テンプレート($)を使用できます。 例:
println("Their email address is: ${contact.email}")メンバー関数
オブジェクトの特性の一部としてプロパティを宣言することに加え、メンバー関数を使用してオブジェクトの振る舞いを定義することもできます。
Kotlinでは、メンバー関数はクラス本体の内側で宣言する必要があります。インスタンスでメンバー関数を呼び出すには、インスタンス名の後にピリオド . を付け、その後にメンバー関数名を書きます。例:
class Contact(val id: Int, var email: String) {
fun printId() {
println(id)
}
}
fun main() {
val contact = Contact(1, "mary@gmail.com")
// メンバー関数 printId() を呼び出す
contact.printId()
// 1
}データクラス
Kotlinには、データの格納に特に便利なデータクラス(data class)があります。データクラスは通常のクラスと同じ機能を持ちますが、追加のメンバー関数が自動的に付属します。これらのメンバー関数により、インスタンスを読みやすい形式で出力したり、クラスのインスタンス同士を比較したり、インスタンスをコピーしたりすることが簡単にできます。これらの関数は自動的に利用可能になるため、各クラスごとに同じボイラープレートコードを書く手間が省けます。
データクラスを宣言するには、data キーワードを使用します:
data class User(val name: String, val id: Int)Kotlinコンパイラは、メンバー関数を生成する際にプライマリコンストラクターの内部で定義されたプロパティのみを使用します。データクラスの本体でプロパティを宣言した場合、それらは生成される関数の出力には含まれません。
データクラスの最も有用な定義済みメンバー関数は次のとおりです:
| 関数 | 説明 |
|---|---|
toString() | クラスインスタンスとそのプロパティを人間が読みやすい文字列として出力します。 |
equals() または == | クラスのインスタンス同士を比較します。 |
copy() | 別のインスタンスをコピーして、場合によっては一部のプロパティを変更したクラスインスタンスを作成します。 |
各関数の使用例については、次のセクションを参照してください:
文字列として出力
クラスインスタンスの読みやすい文字列を出力するには、明示的に toString() 関数を呼び出すか、自動的に toString() を呼び出してくれる出力関数(println() や print())を使用します:
data class User(val name: String, val id: Int)
fun main() {
val user = User("Alex", 1)
// 出力が読みやすくなるよう、自動的に toString() 関数を使用する
println(user)
// User(name=Alex, id=1)
}これはデバッグ時やログ作成時に特に役立ちます。
インスタンスの比較
データクラスのインスタンスを比較するには、等値演算子 == を使用します:
data class User(val name: String, val id: Int)
fun main() {
val user = User("Alex", 1)
val secondUser = User("Alex", 1)
val thirdUser = User("Max", 2)
// user と secondUser を比較
println("user == secondUser: ${user == secondUser}")
// user == secondUser: true
// user と thirdUser を比較
println("user == thirdUser: ${user == thirdUser}")
// user == thirdUser: false
}インスタンスのコピー
データクラスのインスタンスの正確なコピーを作成するには、そのインスタンスで copy() 関数を呼び出します。
データクラスのインスタンスのコピーを作成し、かつ一部のプロパティを変更するには、インスタンスで copy() 関数を呼び出し、関数のパラメーターとして変更したいプロパティの置換値を渡します。
例:
data class User(val name: String, val id: Int)
fun main() {
val user = User("Alex", 1)
// user の正確なコピーを作成
println(user.copy())
// User(name=Alex, id=1)
// name を "Max" に変更した user のコピーを作成
println(user.copy("Max"))
// User(name=Max, id=1)
// id を 3 に変更した user のコピーを作成
println(user.copy(id = 3))
// User(name=Alex, id=3)
}インスタンスのコピーを作成する方が、元のインスタンスを変更するよりも安全です。元のインスタンスに依存している他のコードが、コピーやその変更による影響を受けないためです。
データクラスの詳細については、データクラスを参照してください。
このツアーの最後の章では、KotlinのNull安全(null safety)について扱います。
演習
データクラスの宣言
名前用と給与用の2つのプロパティを持つデータクラス Employee を定義してください。給与用のプロパティは変更可能(mutable)にしておかないと、年末に昇給できなくなります!main 関数はこのデータクラスをどのように使用できるかを示しています。
// ここにコードを書いてください
fun main() {
val emp = Employee("Mary", 20)
println(emp)
emp.salary += 10
println(emp)
}解答例 {...}
data class Employee(val name: String, var salary: Int)
fun main() {
val emp = Employee("Mary", 20)
println(emp)
emp.salary += 10
println(emp)
}ネストされたデータクラスの宣言
このコードをコンパイルするために必要な追加のデータクラスを宣言してください。
data class Person(val name: Name, val address: Address, val ownsAPet: Boolean = true)
// ここにコードを書いてください
// data class Name(...)
fun main() {
val person = Person(
Name("John", "Smith"),
Address("123 Fake Street", City("Springfield", "US")),
ownsAPet = false
)
println(person)
}解答例 {...}
data class Person(val name: Name, val address: Address, val ownsAPet: Boolean = true)
data class Name(val first: String, val last: String)
data class Address(val street: String, val city: City)
data class City(val name: String, val countryCode: String)
fun main() {
val person = Person(
Name("John", "Smith"),
Address("123 Fake Street", City("Springfield", "US")),
ownsAPet = false
)
println(person)
}クラスを使用してランダムな従業員を生成する
コードをテストするために、ランダムに従業員を作成できるジェネレーターが必要です。名前の候補となる固定リスト(クラス本体内)を持つ RandomEmployeeGenerator クラスを定義してください。最小給与と最大給与(クラスヘッダー内)でクラスを設定できるようにします。クラス本体では、generateEmployee() 関数を定義してください。ここでも、main 関数はこのクラスの使用方法を示しています。
この演習では、Random.nextInt() 関数を使用できるようにパッケージをインポートしています。 パッケージのインポートについて詳しくは、パッケージとインポートを参照してください。
ヒント 1
.random() という拡張関数があります。 ヒント 2
Random.nextInt(from = ..., until = ...) は、指定された範囲内のランダムな Int の数値を返します。 import kotlin.random.Random
data class Employee(val name: String, var salary: Int)
// ここにコードを書いてください
fun main() {
val empGen = RandomEmployeeGenerator(10, 30)
println(empGen.generateEmployee())
println(empGen.generateEmployee())
println(empGen.generateEmployee())
empGen.minSalary = 50
empGen.maxSalary = 100
println(empGen.generateEmployee())
}解答例 {...}
import kotlin.random.Random
data class Employee(val name: String, var salary: Int)
class RandomEmployeeGenerator(var minSalary: Int, var maxSalary: Int) {
val names = listOf("John", "Mary", "Ann", "Paul", "Jack", "Elizabeth")
fun generateEmployee() =
Employee(names.random(),
Random.nextInt(from = minSalary, until = maxSalary))
}
fun main() {
val empGen = RandomEmployeeGenerator(10, 30)
println(empGen.generateEmployee())
println(empGen.generateEmployee())
println(empGen.generateEmployee())
empGen.minSalary = 50
empGen.maxSalary = 100
println(empGen.generateEmployee())
}