プログラミングマガジン

プログラミングを中心にIT技術をできるだけわかりやすくまとめます。

  • ホーム
  • JavaScript
  • 【JavaScript】「シンボル」、「イテレーター」、「ジェネレータ」について
 
 
     
  • サーバー言語  
    • Python
    • Ruby
    • PHP
    • SQL
  •  
  • インフラ  
       
    • AWS
    •  
    • 基本
    • Git
  • Web
       
    • Web開発
    • JavaScript
    • Vue.js
    • React
  •  
  • 設計  
       
    • 実装設計
    • DB設計
  • 問い合わせ
  

【JavaScript】「シンボル」、「イテレーター」、「ジェネレータ」について

04.29

  • miyabisan2
  • コメントを書く

この記事は2分で読めます

Symbolオブジェクト

新しく追加されたSymbolというオブジェクトです。

用途

通常の開発ではあまり使う機会はないかもしれません。JavaScriptは歴史のある言語なので膨大なライブラリがあり変数が競合してしまう可能性があるのでシンボルを使って競合を減らすという目的で使われていたりします。

基本

1
const symbol = Symbol();

シンボルは一度作った場合は必ず別オブジェクトになり一致はしません。

1
2
3
const symbol = Symbol();
const symbol2 = Symbol();
console.log(symbol === symbol2); //false

オブジェクトのプロパティにもできる。

シンボルはオブジェクトのプロパティにもできますが、通常のプロパティと異なりドット(.)を使ってアクセスするわけではないです。

1
2
3
4
5
6
7
let obj = {
  name: "太郎",
  age: 25,
  [symbol]: 2
}
console.log(obj.name);      //太郎
console.log(obj[symbol]); //2

オブジェクトの中のシンボルを取得する。

オブジェクト内のシンボルにアクセスするには「getOwnPropertySymbols」というメソッドを使用します。

1
2
console.log(Object.getOwnPropertyNames(obj));    //これではアクセスできない。
console.log(Object.getOwnPropertySymbols(obj)); //アクセスできる。

戻り値は配列なので、下記のようにすればシンボルそのものにアクセスが可能です。

1
console.log(Object.getOwnPropertySymbols(obj)[0]);

イテレーターとは?

順番に処理できるデータのことです。

構文

Symbolに対してiteratorという関数を実行する事でイテレーターを取得する事ができます。

1
2
3
let a = "a";
let iterator = a[Symbol.iterator]();
iterator;

イテレーターとして定義できるデータ型

デフォルトでイテレーターとして定義できるデータ型は決まっています。

  • string
  • 配列

next関数

next関数を使うとイテレータから一つずつ値を取り出す事が可能です。一度取り出した場所は記録されるので取り出す度に値が変わることになります。

1
2
3
4
5
6
7
8
9
10
let a = "abc";
let iterator = a[Symbol.iterator]();
let b = iterator.next();
b; //{ value: 'a', done: false}
let c = iterator.next();
c; //{ value: 'b', done: false}
let d = iterator.next();
d; //{ value: 'c', done: false}
let e = iterator.next();
e; //{ value: undefined, done: true}

value

イテレータで取り出せた値です。もう値を取り出せない場合はundefinedが返ります。

done

取り出しが完了していない場合はfalse、取り出しが完了した場合はtrueが返ります。

イテレーターの自作

データ型がstringや配列の場合は自動でイテレーターとして値を取り出す事が可能ですが、自分でイテレータを自作することも可能です。next関数を用意してその中でvalueとdoneを返すような関数を作れば自作する事が可能です。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
let a = {
  [Symbol.iterator]() {
    let data = [1, 2, 3]
    let num = 0;
    return {
      next() {
        return {
          value: data[num],
          done: num++ > 2
        }
      }
    }
  }
}
let iterator = a[Symbol.iterator]();
let b = iterator.next();
b; //{ value: 1,done: false }
let c = iterator.next();
c; //{ value: 2,done: false }
let d = iterator.next();
d; //{ value: 3,done: false }
let e = iterator.next();
e; //{ value: undefined,done: true }

ジェネレータとは?

ECMAScript2015から追加された関数に似た機能です。

用途

戻り値としてiterator(値を保持してくれる)を返すので、呼び出す度に値を更新してその値を保持する処理を作る際に使います。

基本構文

下記のように記述します。

1
2
3
4
5
6
7
8
9
function* gene() {
  yield 1;
  yield 2;
}
let a = gene();
a;
console.log(a.next()); // { value:1, done: false }
console.log(a.next()); // { value:2, done: false }
console.log(a.next()); // { value:undefined, done: true }

ポイント

  • functionの末尾に*(アスタリスク)を付ける。
  • function内にyieldキーワードを使う。
  • 戻り値としてIteratorを返す。valueはyieldとして定義した値が返る。

イテレータのnextメソッドを実行した際の挙動

イテレーターのnextメソッドを実行した際はyieldが配置してある箇所まで実行されます。なので下記の例で言えば「あ」のみがコンソール出力されることになります。つまりyieldは通常の関数でいうところのreturnと似た挙動になります。

1
2
3
4
5
6
7
8
9
function* gene() {
  console.log('あ');
  yield 1;
  console.log('い');
  yield 2;
}
let a = gene();
a;
console.log(a.next()); //「あ」と「{value:1,done:false}」が出力される。

オブジェクト内でジェネレータを定義するには?

オブジェクト内でジェネレータを定義する場合はfunctionキーワードを排除して定義します。

1
2
3
4
5
6
7
8
let person = {
  name: "太郎",
  age: 25,
  * gene() {
    yield 1;
  }
}
console.log(person.gene().next()); //{ value:1, done: false }

リファクタリング

yield*の後に配列を定義することで複数行にyieldキーワードを並べる記述と同等の記述をする事ができます。yieldの間に処理は挟めませんが、単純にyieldを並べるだけの処理であれば下記のように記述する方が美しいコードと言えるでしょう。

1
2
3
4
5
6
function* gene() {
  yield* [1, 2];
}
let a = gene();
console.log(a.next()); // {value:1,done:false}
console.log(a.next()); // {value:2,done:false}

スポンサーリンク
  • 2020 04.29
  • miyabisan2
  • コメントを書く
  • JavaScript
  • Tweets Twitter
  • このエントリーをはてなブックマークに追加
  • LINEで送る

関連記事

  1. 2020 04.26

    【JavaScript】「オブジェクト」について

  2. 2018 04.10

    【jQuery】歴史、「live、bind、delegate、on、click」の違い、「$」などについて解説

  3. 2018 07.05

    【JavaScript】変数のスコープについて

  4. 2018 04.12

    【JavaScript】イベントハンドラ、イベントリスナについて

  5. 2022 09.26

    【JavaScript】「JavaScriptエンジン」、「ブラウザのWeb API」など

  6. 2021 03.21

    【Javascript】「html2canvas」、「jsPDF」について

  • コメント ( 0 )
  • トラックバック ( 0 )
  1. この記事へのコメントはありません。

  1. この記事へのトラックバックはありません。

返信をキャンセルする。

【JavaScript】「配列」、「lodash」の活…

【JavaScript】文字列クラス(String)、…

RETURN TOP

著者プロフィール

エンジニア歴10年で過去に業務系、Webデザイン、インフラ系なども経験あります。現在はWeb系でフロントエンド開発中心です。

詳細なプロフィールはこちら

スポンサーリンク

カテゴリー

  • Android
  • AngularJS
  • API
  • AWS
  • C++
  • CSS
  • cursor
  • C言語
  • DDD
  • DevOps
  • Django
  • Docker
  • Figma
  • Git
  • GitLab
  • GraphQL
  • gRPC
  • Hasura
  • Java
  • JavaScript
  • Kubernetes
  • Laravel
  • linux
  • MySQL
  • Next.js
  • nginx
  • Node.js
  • NoSQL
  • Nuxt.js
  • Oracle
  • PHP
  • Python
  • React
  • Redux
  • Rspec
  • Ruby
  • Ruby on Rails
  • Sass
  • Spring Framework
  • SQL
  • TypeScript
  • Unity
  • Vue.js
  • Webサービス開発
  • Webデザイン
  • Web技術
  • インフラ
  • オブジェクト指向
  • システム開発
  • セキュリティ
  • その他
  • データベース
  • デザインパターン
  • テスト
  • ネットワーク
  • プログラミング全般
  • マイクロサービス
  • マイクロソフト系技術
  • マルチメディア
  • リファクタリング
  • 副業
  • 未分類
  • 業務知識
  • 生成AI
  • 設計
  • 関数型言語
RETURN TOP

Copyright ©  プログラミングマガジン | プライバシーポリシー