GASでセッターを使ってプロパティの入力に制限をかける

2020.05.242021.10.09

photo credit: Ivan Radic Gameboy made with a Raspberry Pie single-board computer set by Conrad via photopin (license)

みなさん、こんにちは！
タカハシ(@ntakahashi0505)です。

「初心者でもわかるGoogle Apps Scriptのクラス」についてシリーズでお伝えしています。

前回の記事はこちら。

GASでゲッターを使って簡単なプロパティを作成する方法

「初心者でもわかるGoogle Apps Scriptのクラス」についてシリーズでお伝えしています。今回は、GASでget構文によるゲッターを使って簡単なプロパティを作成する方法をお伝えします。

「ゲッター」を使って簡単なプロパティを作成する方法をお伝えしました。

さて、今回は「セッター」というものを使って、上書きを禁止するプロパティを作ってみたいと思います。

ということで、GASでセッターを使って上書き禁止のプロパティを作る方法です。

では、行ってみましょう！

前回のおさらい
「id」を上書きできないようにしたい
set構文でセッターを定義する
まとめ
連載目次：初心者向けGoogle Apps Scriptでクラスを作ろう

前回のおさらい

まずは、おさらいからです。

スプレッドシートのデータを使っていましたが、そのスプレッドシートはこちらです。

このデータをもとに、以下のようなクラスPersonを作りました。

function myFunction() {
  
  class Person {
    constructor(record) {
      [this.id, this.name, this.gender, this.birthday] = record;
    }
    
    get isMale() {
      return this.gender === 'male';
    }
  }
  
  const values = SpreadsheetApp.getActiveSheet().getDataRange().getValues();
  const p = new Person(values[1]);
  console.log(p.gender, p.isMale);
  p.gender = 'female';
  console.log(p.gender, p.isMale);  
  
}

前回は、get構文で、他のプロパティの値を使って算出するisMaleプロパティを作ったということですね。

「id」を上書きできないようにしたい

さて、このクラスPerson。

constructorメソッドの呼び出しで、id、name、gender、birthdayと4つのプロパティが作成されます。

これらのプロパティは、インスタンス生成後は参照することはもちろん、代入文で上書きも可能となっています。

しかし、例えばidのように、一度格納した値を上書きしたくないという性質のプロパティもありますよね。

このような場合に「セッター」を使って、上書き禁止のプロパティを作ることができます。

set構文でセッターを定義する

セッターというのは、プロパティに値の代入が行われたときに関数を呼び出すことができるというものです。

セッターを作るためには、以下のset構文を使います。

set プロパティ名(仮引数){
　//処理
}

プロパティ名で示すプロパティに代入が行われるときに、この関数が呼び出されて実行されるのです。

なお、仮引数には、代入をしようとした値が渡されます。

セッターによる上書き禁止プロパティ

例えば、以下のようにしてみましょう。

function myFunction() {
  
  class Person {
    constructor(record) {
      [this.id, this.name, this.gender, this.birthday] = record;
    }
    
    set id(newId) {
      if(this.id) throw 'idは上書きできません';
      this._id = newId;        
    }
        
    get id() {
      return this._id;
    }
  }
  
  const values = SpreadsheetApp.getActiveSheet().getDataRange().getValues();
  const p = new Person(values[1]);
  console.log(p.id);
  p.id = 'hoge';
}

実行すると、以下のようにエラー「idは上書きできません」が発生します。