利用したい場面#

アクセスレベルコントロールの種類にどのようなものがあるかを解説したうえで、次に実際に必要になる場面を考えてみましょう。

class Walltet {
  var amount: Int

  func add(_ value: Int) {
  }

  func sub(_ value: Int) throws {
  }
}

例えば上のような財布クラスが存在したとします。

財布クラスは金額を増やしたり減らしたりするメソッドを持ち、内部的に財布の中にいくら入っているかを保持しています。

このクラスを利用する理由としては、所持金は財布クラスだけが管理しており、全ての金銭の流れは財布クラスが把握すべきだからです。

家計簿をキチンとつけることができるのは財布の中身と領収書を全て管理している人がいるからです。

もし、誰かが勝手に財布からお金を抜いたり増やしたりすれば帳簿をつけたときに金額が合わずに困ってしまいますね。

よって、財布の中身であるamountは他の人が操作できないようにしたいわけです。

ここで、単に外部から変更できないようにすれば　

class Walltet {
  // プライベートに変更
  // amountにアクセスできるのはこのクラス内のメソッドのみ
  private var amount: Int 

  func add(_ value: Int) {
  }

  func sub(_ value: Int) throws {
  }
}

とすればよいのですが、これでは外部からWalletクラスがamountというプロパティを持っている事自体もわからなくなってしまい、財布にいくら入っているかを知る術がなくなってしまいます。

よって「読み取りはできるが書き込みは捺せたくない」という状況が発生します。

これは単純なアクセスレベルコントロールだけでは実現できません。

class Walltet {
  // プライベートに変更
  // amountにアクセスできるのはこのクラス内のメソッドのみ
  private var _amount: Int 

  func add(_ value: Int) {
  }

  func sub(_ value: Int) throws {
  }

  func amount() -> Int {
    return _amount
  }
}

解決策の一つとして上のようなコードを書く人が一定数いるのですが、個人的にはこの書き方はコードを無意味に冗長にするだけなのでNGです。

こんなことをしなくてもこの要求を満たすための書き方がプログラミング言語には存在します。

読み取り専用#

Swiftの場合はそれにprivate(set)が該当します。

こうすることで値をSetすることは外部からのアクセスを拒むことができます。

class Walltet {
  // setterだけはprivate
  private(set) var amount: Int 

  func add(_ value: Int) {
  }

  func sub(_ value: Int) throws {
  }
}

じゃあTypeScriptではどう書くんですかとなるんですが、実はTypeScriptにはそのような単純な仕組みはありません。

class Walltet {
  private _amount: number

  add(value: number) {
  }

  sub(value: number) { 
  }

  // _amountの値を返すgetter
  get amount() {
    return _amount
  }
}

よって、めんどくさいのですが上のように_amountを定義してあげる必要があります。

これでprivate(set)と同様の効果が期待できます。

内部的にも変更不可#

では、内部的にも変更ができないようにしたければどうすればよいでしょうか？

例えば、財布の所有者のIDというものを財布クラスに追加したとしましょう。

所有者のIDは外部からも見えていいですが、変更はできず、更に内部的にも変更ができないようにしたいです。

class Walltet {
  private(set) var id: Int
  private(set) var amount: Int 

  func add(_ value: Int) {
  }

  func sub(_ value: Int) throws {
  }
}

こう書けば外部からは読み込みしかできませんが、内部から書き換えることができてしまいます。

内部からも書き込みを許したくない場合はどうするのでしょうか。

はい、これはvarではなくletを使えばよいのです。

Swiftにおけるletは定数なので初期化時に一度値を決めたら二度と返ることはできません。

class Walltet {
  // 外部からも内部からも読み込み専用
  let id: Int
  // 外部からは読み込み専用
  private(set) var amount: Int 

  func add(_ value: Int) {
  }

  func sub(_ value: Int) throws {
  }
}

ちなみにですがprivate(set) letは意味のないアクセスレベルコントロールです。

letな時点で参照しかできないので「外部からは参照しかできない」を意味するprivate(set)は付ける意味がありません。

では同様の機能はTypeScriptにはあるのでしょうか？

class Walltet {
  private _amount: number
  private readonly id: number

  add(value: number) {
  }

  sub(value: number) { 
  }

  // _amountの値を返すgetter
  get amount() {
    return _amount
  }
}

はい、実は読み込み専用にするための仕組みは存在しています。

それがreadonlyなのですがこれは内部的にも外部的にも読み込み専用にしてしまいます。

要するに、Swiftにおけるletと同じ効果を持ちます。

Swiftの場合#

するとSwiftは全パターンを列挙していることがわかります。

TypeScriptの場合#

それと比較するとTypeScriptは外部からの書き込みだけを制限するアクセスレベルコントロールを実現するためにprivate + getterという少々めんどくさい仕組みを導入しなければいけないことがわかります。

外部からは参照だけにしたい、っていうのは結構求められる状況が多い気がするのですが、需要がないのでしょうか？

記事は以上。