Google Apps ScriptでdefinePropertiesメソッドを使ってプロパティを定義する方法

GASでdefinePropertiesメソッドを使ってクラスにプロパティを定義する方法

2019.02.192019.02.20

photo credit: Triple-green Kran für die Kohlezufuhr in das Kraftwerk via photopin (license)

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

「初心者でもわかるGoogle Apps Scriptでクラスを作ろう！」をテーマとしたシリーズをお送りしています。

前回の記事はこちら。

Google Apps Scriptでプライベートプロパティを取得するメソッドを作成する方法

初心者でもわかるGoogle Apps Scriptでクラスを作るシリーズをお送りしています。今回は、GASでクラスのプライベートプロパティを取得するメソッドを作成する方法についてお伝えします。

GASのクラスでプライベートプロパティを取得するメソッドを作る方法をお伝えしました。

さて、プライベートプロパティの値を取得する方法、実は別の方法があります。

それは、Object.definePropertiesメソッドを使う方法です。

ということで、今回はGoogle Apps ScriptでdefinePropertiesメソッドを使ってプロパティを定義する方法です。

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

前回のおさらい
definePropertiesメソッドでプロパティを定義する
definePropertiesメソッドによるクラスの読み取り専用のプロパティ
まとめ
連載目次：初心者向けGoogle Apps Scriptでクラスを作ろう

前回のおさらい

題材としているのは以下のスプレッドシートの表です。

この表の各行を表すクラスPersonを作成しました。

こちらのコードです。

function myFunction() {  
  
  var Person = function(record){
    var _id = record[0];
    this.name = record[1];
    this.gender = record[2];
    this.birthday = record[3];

    this.getId = function(){
      return _id;  
    };
  };
  
  var values = SpreadsheetApp.getActiveSheet().getDataRange().getValues();
  var p = new Person(values[1]);
  Logger.log(p);
  Logger.log(p.getId());
}

ご覧の通り、idについては上書きをできないようにプライベートプロパティと、その読み取り用のメソッドで実現をしました。

ですが、もう少し凝った方法がありまして、それがdefinePropertiesメソッドを使って、オブジェクトにプロパティを直接定義してしまうという方法です。

definePropertiesメソッドでプロパティを定義する

definePropertiesメソッドは、オブジェクトに新しいプロパティを定義するメソッドです。

書式は以下の通りで、指定するオブジェクトにプロパティ名1、プロパティ名2、…と複数のプロパティを定義することができます。

Object.defineProperties(オブジェクト,
　{ プロパティ名1: 構成情報1 },
　{ プロパティ名2: 構成情報2 },
　…
)

構成情報1、構成情報2、…というのは、以下の形式で個々のプロパティに指定するものになります。

get: function() {
　//get処理
},
set: function(value) {
　//set処理
}

「get」には、そのプロパティを取得しようとした際の処理を記述します。一般的には、プライベート変数の値をreturnする処理が含まれます。

「set」には、そのプロパティに設定しようとした際の処理を記述します。一般的には、プライベート変数の値にvalueを代入する処理が含まれます。

setとgetはそれぞれ省略することができ、その場合にはそれぞれ読み取り専用、または書き込み専用のプロパティとなります。

definePropertiesメソッドによるクラスの読み取り専用のプロパティ

では、definePropertiesメソッドを使って、クラスが持つ「id」の値について、読み取り専用にするスクリプトを見ていきましょう。

こちらです。

function myFunction() {  
  
  var Person = function(record){
    var _id = record[0];
    this.name = record[1];
    this.gender = record[2];
    this.birthday = record[3];
    
    Object.defineProperties(this, {
      id: {
        get: function(){
          return _id;
        }
      }
    });
  };
  
  var values = SpreadsheetApp.getActiveSheet().getDataRange().getValues();
  var p = new Person(values[1]);
  Logger.log(p.id);
  p.id = 'a00';
  Logger.log(p.id); 
  
}

9行目~16行目が、プロパティの定義になります。

definePropertiesにより、プロパティidを定義していて、「get」のみ設定をしていますから、読み取り専用になるのです。

実行結果がこちらです。