Angular2のサービスの概要、サービスを使ったサンプル作成

wp-admin

7年前

Angular2のサービスの概要、サービス使用時に関係するDI（Dependency Injection）、プロバイダ、インジェクタについてまとめ、サービスを使ったサンプルコードを作成しました。
※Angular2の2.0.0版、TypeScriptを使って確認したものです。（デモはv4.4.3、v2.0.0で動作確認）

※目次をクリックすると目次の下部にコンテンツが表示されます。

１．サービス、DI、プロバイダ、インジェクタの関係
２．コンポーネントからサービスを利用
３．サービス内で他の別のサービスを利用
４．デモ

サービス、DI、プロバイダ、インジェクタの関係

１）DI（Dependency Injection）
　
・DIは、サービスなど依存する対象を指定して、クラスの新しいインスタンスを提供する方法。依存する対象の大半はサービス。
　
２）プロバイダをインジェクタに登録
　
・利用するサービスは、事前にサービスのプロバイダをインジェクタに登録しなければならない。
　
・インジェクタは、プロバイダを使って新しいサービスインスタンスを生成することができる。
　
プロバイダは、サービスを生成またはリターンできる。サービスを生成するレシピ。サービスのクラスそれ自身の場合もある。
　
①プロバイダをrootに登録する方法
　
・アプリケーション開始時にプロバイダをインジェクタに登録すると、そのサービスの同一のインスタンスをアプリ全体から利用する事ができる。
　
・@NgModuleのproviders属性で指定する。
例）

@NgModule({
  imports: [
    BrowserModule
  ],
  declarations: [
    AppComponent
  ],
  providers: [ BackendService, HeroService, Logger ],
  bootstrap: [ AppComponent ]
})
export class AppModule { }

　
②コンポーネントレベルで登録する方法
　
・そのコンポーネントの新しいインスタンス毎にサービスの新しいインスタンスが取得される。
　
・@Componentデコレーターの”providers”属性で配列で指定する。
　
例）
@Component({
　providers: [HeroService]
})
export class HeroesComponent { … }

コンポーネントからサービスを利用

コンポーネントがどのサービスを必要とするかをコンストラクタパラメータとしてサービスを指定する事によって行うことができる。
　
例）
constructor(private _service: HeroService){ }
　
●コンポーネントからサービスを利用する方法の例
　
例）ファイル名”hero.service.ts”の以下のサービスを使用する場合
export class HeroService {
・・・
　getHeroes() {
　　return this.heroes;
　}
}
①サービスファイルをインポート
import {HeroService} from ‘./hero.service.ts’;
　
②DIでサービスを指定
@NgModule({
　：
　providers: [HeroService]
})
又は
@Component({
　providers: [HeroService]
})
　
③コンストラクタでサービスからデータを取得
constructor(heroService: HeroService) {
　this.heroes = heroService.getHeroes();
}

サービス内で他の別のサービスを利用

・@Injectable()を記述する。
　
TypeScriptは、デコレーターを持つクラスのみメタデータを生成するので@Injectable()のデコレーターを記述する。
　
TypeScriptのコンパイラがこのクラスを評価するとき、デコレーターがあるとクラスメタデータを生成するJavaScriptコードに追加する。
　
・コンポーネントから依存するサービスを使用する場合は@Injectable()を記述していないが、これはすでに@Componentのデコレーターを記述しているので必要ない。
　
※オンラインガイドを見ると、記述漏れや一貫性のため、他のサービスを使用するしないに関わらず、@Injectable()を記述されている模様。
　
例）上記例の”HeroService”からlogger.tsファイルのLoggerサービスを利用する場合

export class Logger {
  log(msg) {
    console.log(msg);
  }
}

import {Injectable} from '@angular/core';
import {Logger} from './logger.ts';

@Injectable()
export class HeroService {
  constructor(private _logger: Logger) {
・・・・
  }
  getHeroes() {
    this._logger.log('Getting heroes ...')
・・・・
  }
}

デモ

以下の記事のサンプルコードをサービスを使う形に修正したものです。
Angular2でinputs、@Inputを使ってディレクティブ間で値を受け渡し
　
上記サンプルでは複数のコンポーネント間でログ記録をやり取りしていたので、二つのタブのコンポーネント間でログが共有されず、各コンポーネント毎にログを記録していました。
　
サービスを使ってログ記録する事によって二つのコンポーネントでログ記録を共有するようにしています。
　
●デモ
Angular : 4.4.3（2.0.0でも動作確認済み）
Bootstrap : 3.x

Loading…

<html>
  <head>
    <title>Angular 2 Demo</title>
    <script src="https://npmcdn.com/core-js/client/shim.min.js"></script>
    <script src="https://unpkg.com/zone.js@0.7.4?main=browser"></script>
    <script src="https://npmcdn.com/systemjs@0.19.39/dist/system.src.js"></script>
    <script src="./js/systemjs.config.js"></script>
    <script>
      System.import('./ts/app.ts').catch(function(err){ console.error(err);  });    </script>
    <link rel="stylesheet" href="./css/bootstrap.min.css">
    <link rel="stylesheet" href="./css/styles.css">
  </head>
  <body>
    <div class="container">
      <my-app>Loading...</my-app>
    </div>
  </body>
</html>

（systemjs.config.js）
(function (global) {
  var ngVer = '@4.4.3';
  System.config({
    transpiler: 'ts',
    typescriptOptions: {
      "target": "es5",
      "module": "commonjs",
      "moduleResolution": "node",
      "sourceMap": true,
      "emitDecoratorMetadata": true,
      "experimentalDecorators": true,
      "lib": ["es2015", "dom"],
      "noImplicitAny": true,
      "suppressImplicitAnyIndexErrors": true,
      "strict": true
    },
    meta: {
      'typescript': {
        "exports": "ts"
      }
    },
    paths: {
      'npm:': 'https://unpkg.com/'
    },
    map: {
      'app': 'app',
      '@angular/animations': 'npm:@angular/animations' + ngVer + '/bundles/animations.umd.js',
      '@angular/animations/browser': 'npm:@angular/animations' + ngVer + '/bundles/animations-browser.umd.js',
      '@angular/core': 'npm:@angular/core' + ngVer + '/bundles/core.umd.js',
      '@angular/common': 'npm:@angular/common' + ngVer + '/bundles/common.umd.js',
      '@angular/common/http': 'npm:@angular/common' + ngVer + '/bundles/common-http.umd.js',
      '@angular/compiler': 'npm:@angular/compiler' + ngVer + '/bundles/compiler.umd.js',
      '@angular/platform-browser': 'npm:@angular/platform-browser' + ngVer + '/bundles/platform-browser.umd.js',
      '@angular/platform-browser/animations': 'npm:@angular/platform-browser' + ngVer + '/bundles/platform-browser-animations.umd.js',
      '@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic' + ngVer + '/bundles/platform-browser-dynamic.umd.js',
      '@angular/http': 'npm:@angular/http' + ngVer + '/bundles/http.umd.js',
      '@angular/router': 'npm:@angular/router' + ngVer + '/bundles/router.umd.js',
      '@angular/router/upgrade': 'npm:@angular/router' + ngVer + '/bundles/router-upgrade.umd.js',
      '@angular/forms': 'npm:@angular/forms' + ngVer + '/bundles/forms.umd.js',
      '@angular/upgrade': 'npm:@angular/upgrade' + ngVer + '/bundles/upgrade.umd.js',
      '@angular/upgrade/static': 'npm:@angular/upgrade' + ngVer + '/bundles/upgrade-static.umd.js',

      // other libraries
      'rxjs':                      'npm:rxjs@5.0.1',
      'tslib':                     'npm:tslib/tslib.js',
      'angular-in-memory-web-api': 'npm:angular-in-memory-web-api/bundles/in-memory-web-api.umd.js',
      'ts':                        'npm:plugin-typescript@5.2.7/lib/plugin.js',
      'typescript':                'npm:typescript@2.3.2/lib/typescript.js',

    },
    // packages tells the System loader how to load when no filename and/or no extension
    packages: {
      app: {
        main: './main.ts',
        defaultExtension: 'ts',
        meta: {
          './*.ts': {
            loader: 'systemjs-angular-loader.js'
          }
        }
      },
      rxjs: {
        defaultExtension: 'js'
      }
    }
  });

})(this);

（メインコンポーネント）

　
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { NgModule } from '@angular/core';
import { BrowserModule }  from '@angular/platform-browser';
import { Component,Input } from '@angular/core';
import { LogService } from './log.service.ts';

@Component({
  selector: 'my-sub',
  template: `
<h4>{{sub_name}}</h4>
<ul>
  <li *ngFor="let item of logs">
    {{item.id}}=>{{item.msg}}
  </li>
</ul>
<button (click)="addlog(sub_name + 'のテストログ')">ログ記録</button>
  `,
  inputs: ['sub_name'],
})
class MySub {
  public sub_name: string;
  public log: {id: number; msg: string;};
  public logs: log[] = [];
  constructor(private _logService: LogService) {
    this.logs = _logService.listlogs();
  };
  addlog(msg: string) {
    this._logService.addlog(msg);
  };
}

@Component({
  selector: 'my-app',
  template: `
<button (click)="open('Sub-A')">Sub-A</button>
<button (click)="open('Sub-B')">Sub-B</button>
<div [ngSwitch]="tab">
  <div *ngSwitchCase="'Sub-A'">
    <my-sub [sub_name]="'Sub-A'"></my-sub>
  </div>
  <div *ngSwitchCase="'Sub-B'">
    <my-sub [sub_name]="'Sub-B'"></my-sub>
  </div>
</div>
  `,
  directives: [MySub]
})
export class AppComponent {
  public tab = 'Sub-A';
  open(tab: string) {
    this.tab = tab;
  }
}

@NgModule({
  imports: [
    BrowserModule
  ],
  declarations: [
    AppComponent,
    MySub
  ],
  providers: [ LogService ],
  bootstrap: [ AppComponent ]
})
export class AppModule { }

platformBrowserDynamic().bootstrapModule(AppModule);

（log.service.ts）


import {Injectable} from '@angular/core';

@Injectable()
export class LogService {
  private _log: {id: number; msg: string;};
  private _logs: log[] = [];
  private _logCount: number = 0;
  constructor() {
    this._logs[0] = {"id": 0, "msg": '初期値'};
  }
  listlogs() {
    return this._logs;
  }
  addlog(msg: string) {
    this._logs.push({
      id: ++this._logCount,
      msg: msg
    });
  };
}

モバイルバージョンを終了