Chapter06

第1章 はじめてのリファクタリング - ルーティングと状態管理

lacolaco

第1章の最後は、ルーティングでユーザー詳細のページへ移動できるようにします。
アプリケーションは最終的に次のようになります。ユーザーリストから選択されたユーザーの詳細情報が表示され、URLは /users/<ユーザーのID> に変化します。ページの遷移中には、個別のユーザー情報を取得中であることを示す Fetching... の表示がおこなわれます。

完成版のアプリケーションサンプルはこちらです。

User型の拡張

ユーザー詳細ページを作るにあたって、まずは現在の User 型を拡張します。名前に加えて、メールアドレスとアバター画像をもつようになります。

user.ts
export interface User {
  id: string;
  first_name: string;
  last_name: string;
  email: string;
  avatar: string;
}

Stateの拡張

ユーザー詳細にかかわるアプリケーションの状態の定義を、 State 型に追加し、初期値を設定します。詳細を表示するユーザーのインスタンスを userDetail.user に保持すると、次のようになります。（変更部分だけを表示しています）

state.ts
import { User } from './user';

export interface State {
  // ...
  userDetail: {
    user: User | null;
  }
}

export const initialState = {
  // ...
  userDetail: {
    user: null,
  }
};

UserApiServiceの作成

さて、これまでユーザーの配列をHTTPリクエスト経由で取得するのは、 UserListUsecase の責任でした。しかし今回のアップデートでは、個別のユーザー情報をID指定で取得するAPIを呼び出す必要が生まれたので、User APIへのHTTPリクエストを責務とする UserApiService を新たに作成します。そして UserListUsecase は直接HTTPリクエストを送るのではなく、 サービス経由でレスポンスを受け取るようにリファクタリングします。

UserApiService は次のようなクラスです。すべてのユーザーを取得するAPI呼び出しと、個別のユーザーをID指定で取得するAPI呼び出しの両方をサポートします。

user-api.service.ts
import { Injectable } from "@angular/core";
import { HttpClient } from "@angular/common/http";
import { map } from "rxjs/operators";
import { User } from "../user";

const apiHost = "https://reqres.in/api";

interface ApiResponse<T> {
  data: T;
}

@Injectable({ providedIn: "root" })
export class UserApiService {
  constructor(private http: HttpClient) {}

  async getAllUsers() {
    return await this.http
      .get<ApiResponse<User[]>>(`${apiHost}/users`)
      .pipe(map(resp => resp.data))
      .toPromise();
  }

  async getUserById(id: string) {
    return await this.http
      .get<ApiResponse<User>>(`${apiHost}/users/${id}`)
      .pipe(map(resp => resp.data))
      .toPromise()
  }
}

そして UserListUsecase は次のようにリファクタリングします。 HttpClient に依存していましたが、代わりに UserApiService に依存するようになり、 fetchUsers メソッドの中で利用するようになりました。（変更部分だけを表示しています）

user-list.usecase.ts
import { Injectable } from '@angular/core';
import { filter } from 'rxjs/operators';
import { Store } from '../service/store.service';
import { UserApiService } from '../service/user-api.service';
import { User } from '../user';

@Injectable({ providedIn: 'root' })
export class UserListUsecase {

  constructor(private userApi: UserApiService, private store: Store) { }

  async fetchUsers() {
    const users = await this.userApi.getAllUsers();

    this.store.update(state => ({
      ...state,
      userList: {
        ...state.userList,
        items: users
      }
    }));
  }
}

UserDetailPageComponentの作成

これで準備が整ったので、ルーティングによって表示されるユーザー詳細のコンポーネントを UserDetailPageComponent として作成しましょう。 はじめは単純なコンポーネントで、 RouterModule のセットアップを行います。Angularのルーティングについての詳細は公式ドキュメントを参考にしてください。

ルーティングに利用されるコンポーネントは、 ActivatedRoute サービスを利用することで、ルーティングに関わる情報にアクセスできます。たとえば、 /users/:userId でルーティングされるコンポーネントから userId を取得するために、 ActivatedRoute.params を利用します。ここではサービスをインジェクトするだけにとどめ、あとで利用します。

app-routing.module.ts
import { NgModule } from '@angular/core';
import { RouterModule } from '@angular/router';
import { UserDetailPageComponent } from './view/user-detail-page/user-detail-page.component';

@NgModule({
  imports: [
    RouterModule.forRoot([
      {
        path: 'users/:userId',
        component: UserDetailPageComponent
      }
    ])
  ],
  exports: [RouterModule]
})
export class AppRoutingModule { }
user-detail-page.component.ts
import { Component } from '@angular/core';
import { ActivatedRoute } from '@angular/router';

@Component({
  templateUrl: './user-detail-page.component.html',
  styleUrls: ['./user-detail-page.component.css']
})
export class UserDetailPageComponent {
  constructor(private route: ActivatedRoute) {
  }
}

URLパラメータの監視と状態の接続

今回のアップデートで要求されるのは以下のステップです。

  1. ルーティングにより変化するURL中の userId を監視する
  2. userId が変化したら、そのIDをもとにAPIを呼び出す
  3. APIのレスポンスをアプリケーションの状態に反映する
  4. 変化したアプリケーションの状態をコンポーネントで描画する

まずは最初のステップを実装しましょう。 userId は ActivatedRoute.params のObservableを購読し、渡されるオブジェクトから params['userId'] のように取得できます。userId が変更したときにだけコールバック関数が呼び出されるように注意して実装すると次のようになります。 onDestroy$ はコンポーネントが破棄されたタイミングで完了するObservableです。このObservableとRxJSの takeUntil オペレーターを使った自動的な購読停止のパターンは、ルーティングに限らずコンポーネントが明示的にObservableを購読しなければならない場合にとても有用です。

user-detail-page.component.ts
import { Component, OnDestroy, EventEmitter } from '@angular/core';
import { ActivatedRoute } from '@angular/router';
import { Observable } from 'rxjs'
import { map, takeUntil, distinctUntilChanged } from 'rxjs/operators'
import { UserDetailUsecase } from '../../usecase/user-detail.usecase';
import { User } from '../../user';

@Component({
  templateUrl: './user-detail-page.component.html',
  styleUrls: ['./user-detail-page.component.css']
})
export class UserDetailPageComponent implements OnDestroy {
  private onDestroy$ = new EventEmitter();

  constructor(private route: ActivatedRoute, private userDetailUsecase: UserDetailUsecase) {
    this.route.params.pipe(
      // コンポーネントの破棄と同時に停止する
      takeUntil(this.onDestroy$),
      // paramsからuserIdを取り出す
      map(params => params['userId']),
      // userIdが変わったときだけ値を流す
      distinctUntilChanged(),
    ).subscribe(userId => {
      // ユーザーIDを使った処理を記述する
    });
  }

  ngOnDestroy() {
    this.onDestroy$.next();
  }
}

続いて、ユーザーIDを使ってAPIを呼び出すステップを実装しなければならないですが、ここまでの内容を読んでいればわかるように、明らかにこのコンポーネントに記述すべきではありませんね。さらに言えば、 ActivatedRoute をどのように監視してユーザーIDを取り出すかについても、ビューを担当するコンポーネントの責務ではありません。

このようなときの解決策は、サービスを利用することです。ユーザーリストに対して UserListUsecase サービスを作ったように、ユーザー詳細についても UserDetailUsecase を作成し、責務を分割しましょう。

UserDetailUsecase の作成

UserDetailUsecase はUserListUsecase と同じように、コンポーネントが持つべきでない責務を引き受け、柔軟に要求をこなす便利屋です。まずは、ユーザーIDに応じてユーザー情報を取得する処理を fetchUser メソッドとして実装します。ここでのポイントは、 ActivatedRoute のインジェクトと購読はコンポーネントがおこなうことです。ActivatedRoute はRouterの設定に対応した階層構造を持っており、ルーターによりアクティベートされたコンポーネント以外でインジェクトすると、うまく意図通りのイベントを購読できないことがあります。 /users/:userId のパラメーターを取得したい場合には、そのパスと対応した UserDetailPageComponent でインジェクトします。

user-detai.usecase.ts
import { Injectable } from '@angular/core';
import { ActivatedRoute } from '@angular/router';
import { Observable } from 'rxjs';
import { takeUntil, map, distinctUntilChanged } from 'rxjs/operators';

@Injectable({ providedIn: 'root' })
export class UserDetailUsecase {

  fetchUser(userId: string) {
  }
}
user-detail-page.component.ts
import { Component, OnInit, OnDestroy, EventEmitter } from "@angular/core";
import { ActivatedRoute } from "@angular/router";
import { takeUntil, map, distinctUntilChanged } from "rxjs/operators";
import { UserDetailUsecase } from "../../usecase/user-detail.usecase";

@Component({
  templateUrl: "./user-detail-page.component.html",
  styleUrls: ["./user-detail-page.component.css"]
})
export class UserDetailPageComponent implements OnInit, OnDestroy {
  user$ = this.userDetailUsecase.user$;

  private onDestroy$ = new EventEmitter();

  constructor(
    private route: ActivatedRoute,
    private userDetailUsecase: UserDetailUsecase
  ) {}

  ngOnInit() {
    this.route.params
      .pipe(
        takeUntil(this.onDestroy$),
        map(params => params["userId"]),
        distinctUntilChanged()
      )
      .subscribe(userId => this.userDetailUsecase.fetchUser(userId));
  }

  ngOnDestroy() {
    this.onDestroy$.complete();
  }
}

API呼び出しと状態の更新

fetchUser メソッドの中で、APIを呼び出してレスポンスをもとに状態を更新します。さきほど作成した UserApiService を利用して、ユーザーIDからユーザーを取得します。（変更部分だけを表示しています）また、UserListUsecase と同じように、user$ ゲッターは Store からユーザー詳細の描画に必要な状態を選択して公開しています。

user-detail.usecase.ts
import { Injectable } from "@angular/core";
import { ActivatedRoute } from "@angular/router";
import { Observable } from "rxjs";
import { Store } from "../service/store.service";
import { UserApiService } from "../service/user-api.service";
import { User } from "../user";

@Injectable({ providedIn: "root" })
export class UserDetailUsecase {
  get user$() {
    return this.store.select(state => state.userDetail.user);
  }

  constructor(private userApi: UserApiService, private store: Store) {}

  async fetchUser(userId: string) {
    this.store.update(state => ({
      ...state,
      userDetail: {
        ...state.userDetail,
        user: null
      }
    }));

    const user = await this.userApi.getUserById(userId);

    this.store.update(state => ({
      ...state,
      userDetail: {
        ...state.userDetail,
        user
      }
    }));
  }
}

最後に UserDetailPageComponent を次のように変更し、ユーザー情報を表示します。 ngIf と async パイプを使い、ユーザーが存在する時には情報を表示し、null のときには読み込み中である表示をおこないます。

user-detail-page.component.ts
import { Component, OnInit, OnDestroy, EventEmitter } from "@angular/core";
import { ActivatedRoute } from "@angular/router";
import { takeUntil, map, distinctUntilChanged } from "rxjs/operators";
import { UserDetailUsecase } from "../../usecase/user-detail.usecase";

@Component({
  templateUrl: "./user-detail-page.component.html",
  styleUrls: ["./user-detail-page.component.css"]
})
export class UserDetailPageComponent implements OnInit, OnDestroy {
  user$ = this.userDetailUsecase.user$;

  private onDestroy$ = new EventEmitter();

  constructor(
    private route: ActivatedRoute,
    private userDetailUsecase: UserDetailUsecase
  ) {}

  ngOnInit() {
    this.route.params
      .pipe(
        takeUntil(this.onDestroy$),
        map(params => params["userId"]),
        distinctUntilChanged()
      )
      .subscribe(userId => this.userDetailUsecase.fetchUser(userId));
  }

  ngOnDestroy() {
    this.onDestroy$.next();
  }
}
user-detail-page.component.html
<ng-container *ngIf="user$ | async as user; else userFetching">
  <h1>{{user.first_name}} {{user.last_name}}</h1>
  <dl>
    <dt>Email</dt>
    <dd>{{ user.email }}</dd>
    <dt>Avatar</dt>
    <dd><img [src]="user.avatar"></dd>
  </dl>
</ng-container>

<ng-template #userFetching>
  <div>Fetching...</div>
</ng-template>

これですべての実装がおわりました。完成したアプリケーションは以下のサンプルコードから実行できます。

さらに良くするには？

さて、このサンプルではHTTPリクエストでAPIを呼び出し、ユーザーリストを表示し、ユーザー詳細へルーティングするという、一般的なデータ駆動のアプリケーションを作成しました。
アプリケーションとしては小規模ですが、一般的なAngularアプリケーションの開発に役立ついくつかの示唆を得ることができました。

  1. コンポーネントは単一責任原則にしたがって親子関係を分割する
  2. コンポーネントがもつべきでないビューと関係のない処理はサービスに移動する
  3. コマンド・クエリ分離原則にしたがって、副作用の発生し得る箇所を限定する
  4. ビューとの結合性が高く、単独の責務として定義しづらいビジネスロジックをUsecaseに集約し、API呼び出しや状態管理などのサービスの独立性を維持する

サンプルアプリケーションにはまだリファクタリングできる場所がいくつもあります。たとえば、ユーザー詳細は UserDetailPageComponent が UserDetailUsecase を利用しているのに対して、ユーザーリストは AppComponent が UserListUsecase を利用していて、対照性に問題があります。また、ユーザー詳細で取得しようとしたユーザーが存在せず404エラーが返されたときの考慮はできていません。

これらの問題の解決も含め、はじめに書いたように設計に万能の答えはありません。
大事なことは、一貫した原則や方針に基づいて設計をすることと、はじめから完璧な設計を目指さないことです。
このサンプルで示したように、最初はAppComponentに直接あらゆる処理を書いてもかまいません。プログラムはまずは意図通りに実行できることが第一です。
機能的な要求を満たすことが確認できたら、それを壊さないように設計を見直し、リファクタリングをおこなうという、一連の流れを習慣づけるようにしましょう。