若手フロントエンドエンジニアのためのバックエンド入門（後編） – ICS MEDIA

Uncategorized

フロントエンド開発ではfetch()メソッドなどを使ってREST APIにリクエストを送る処理を書くことがあります。リクエストを送られた先で動くのがバックエンドです。この記事ではバックエンドの仕組みをよく知らない若手フロントエンドエンジニア向けに、前後編に分けてハンズオン形式で仕組みを解説します。

前編では簡単なREST APIを作成してフロントエンドから呼び出すところまで実装しました。後編である今回はメモアプリを作りながら、データベースへの保存・更新・取得・削除を実装します。前編と比べると少し難しくなりますが、その分バックエンドの基本的な流れを学べます。

完成したアプリのデモは以下から確認できます。このアプリは全体に公開されています。個人情報や誹謗中傷など、不適切な内容は書き込まないでください。 アプリの起動には時間がかかる場合があります。読み込み中の表示になる場合は1分ほど待ってから再度アクセスしてください。

メモアプリ

バックエンドの技術構成

バックエンドはNestJS + TypeORM + SQLiteという構成で作ります。バックエンドとフロントエンドの通信にはREST APIを採用します。これらは近年のGraphQLやNoSQLといった選択肢と比べてシンプルで学習コストが低く、基礎の理解に適しています。とくに以下のようなメリットがあります。

  • 安定していて基本的な技術のため多くのプロジェクトで使われていて、知っておく価値が高い。
  • データベースとやり取りする流れを理解しやすい。
  • 情報が豊富なので詰まったときに解決しやすい。

それぞれの役割

  • NestJS: Node.jsでバックエンドのアプリケーションを作るためのフレームワークです。フロントエンドからのリクエストを受け取り、処理を行い、レスポンスを返す一連の処理を行います。
  • SQLite: 軽量のデータベースで、1つのファイルにデータを保存します。今回作るメモアプリのような小さなアプリに便利です。
  • TypeORM: データベースを操作する際は通常SQLという言語を使いますが、TypeORMを使うとTypeScriptで記述できます。

バックエンドの概念

実装に入る前に、バックエンドとREST APIの基本概念を簡単におさえておきましょう。

CRUD

CRUD（クラッド）とは「Create」、「Read」、「Update」、「Delete」の頭文字をとった言葉です。バックエンドの処理はほとんどこの4つの組み合わせです。

  • Create: データを新しく作る
  • Read: データを取得する
  • Update: データを更新する
  • Delete: データを削除する

HTTPメソッド

フロントエンドからバックエンドにリクエストを送信するときはHTTPメソッドを使います。よく使用するのは「GET」、「POST」、「PUT」、「PATCH」、「DELETE」の5つで、これらを使い分けてバックエンドにどんな処理をしてほしいかを伝えます。

  • GET: データを取得する
  • POST: 新しいデータを作る
  • PUT: データ全体を更新する
  • PATCH: データの一部を更新する
  • DELETE: データを削除する

RESTful API

RESTful APIは、REST形式のAPI設計の思想のひとつです。長くなってしまうのでこの記事では説明しません。興味のある方は技術ブログや技術書を読むことをオススメします。

この考え方をもとにメモアプリのREST APIを設計すると以下のようになります。

  • メモの作成: POST /memos
  • メモの取得:
    • 一覧: GET /memos
    • 特定のメモ: GET /memos/{メモのID}
  • メモの更新: PATCH /memos/{メモのID}
  • メモの削除: DELETE /memos/{メモのID}

ポイントは、HTTPメソッドを使っていることと、どのメモのデータ（リソース）にアクセスするかをURLで表していることです（メモ全体であればmemos、全体の中の1つのメモであればmemos/{メモのID}）。

準備

環境構築ずみのファイルを用意してあるので、これを変更しながら進めていきます。

  1. 「ファイルをダウンロードする」リンクからGitHubのページを開きます。
  2. GitHubの「Code」→「Download ZIP」からダウンロードします。
  3. ダウンロードしたファイルのルートディレクトリでnpm installします。

ダウンロード手順

完成後のファイルも用意しています。わからないことがあればこちらも参照してください。

1. データベースを作る

SQLiteとTypeORMを使ってデータベースを作りましょう。

①データベースを定義する

  1. backend配下にdbディレクトリを作成します。ここにデータを保存するファイル（memo.sqlite）が自動的に作成されます。
    • 後述するMemoModuleで設定を行います。
  2. 同じdbディレクトリにmemo.entity.tsというファイルを作成します。ここに保存するデータの詳細を定義します。
    • アプリではメモのID、タイトル、内容、作成日時、更新日時を保存します。これらの項目とデータ型を記載します。

▼memo.entity.ts

import { Entity, Column, PrimaryGeneratedColumn } from "typeorm";


@Entity()
export class Memo {
  
  @PrimaryGeneratedColumn()
  id: number;

  
  @Column()
  title: string;

  
  @Column()
  content: string;

  
  @Column()
  createdAt: Date;

  
  @Column()
  updatedAt: Date;
}

@Entityや@Columnはデコレーターと呼ばれます。デコレーターには、TypeScriptのもの（旧仕様）とECMAScript標準のものがあり、それぞれ別物です。この記事では前者（TypeScriptの旧仕様のデコレーター）で説明します。

デコレーターを付与することで機能の追加や変更を行えます。1つ1つの説明は割愛しますが、なんとなくそれぞれの項目がどんな型で定義されているのかわかると思います。これでデータベースの定義は完了です。

2. REST APIを作る

前編でも触れましたが、バックエンドは主に「コントローラー（リクエストを受け取る）」と「サービス（データの処理を行う）」2つの種類のファイルがありました。今回もこの2つを作成します。

①MemoServiceを作る

  1. src/memo.service.tsを開きます。
  2. コンストラクターで、先ほどのエンティティをinject（注入）してmemoRepositoryを作ります。
    • このmemoRepositoryを使ってデータベースへの保存、削除などの処理を行います。

▼memo.service.ts

import { Injectable } from "@nestjs/common";
import { InjectRepository } from "@nestjs/typeorm";
import { Repository } from "typeorm";
import { Memo } from "../db/memo.entity";


@Injectable()
export class MemoService {

   
  constructor(
    @InjectRepository(Memo)
    private memoRepository: Repository<Memo>,
  ) {}
}

②MemoServiceにメモを登録する処理を書く

メモを1件登録する処理を書いてみましょう。

  1. MemoServiceにcreate()というメソッドを作ります。
  2. memoRepositoryを使って保存する処理を書きます。

▼memo.service.ts

export class MemoService {
  

  
  async create(memo: { title: string; content: string }): Promise<Memo> {
    const newMemo = this.memoRepository.create({
      title: memo.title,
      content: memo.content,
      createdAt: new Date(),
      updatedAt: new Date(),
    });
    return this.memoRepository.save(newMemo);
  }
}

memoRepository.create()やsave()はTypeORMのビルトインメソッドです。やっていることは単純で、memoRepository.create()でnewMemoを作り、memoRepository.save()でデータベースに登録しています。

③残りの処理を書く

残りの処理を書いていきます。完成後のMemoServiceがあるので、こちらをコピペしましょう。もちろん自力で書いてもOKです！

  1. メモ全件を取得
  2. メモを1件取得
  3. メモの更新
  4. メモの削除

これでサービスの作成は完了しました。

④MemoControllerを作る

次はコントローラーの処理です。フロントエンドから送ったリクエストはコントローラーに渡り、サービスの処理を呼び出します。

  1. src/memo.controller.tsを開きます。
  2. 冒頭の@Controller()の()の中に"/memos"を追記します。これはコントローラーのベースURLに当たります。
    • たとえば、フロントエンドからhttps://localhost:3000/memosに送られたリクエストはMemoControllerが受け取ります。

▼memo.controller.ts


@Controller("/memos") 
export class MemoController {
  constructor(private readonly memoService: MemoService) {}

  
}

⑤MemoControllerにメモを更新する処理を書く

冒頭でメモアプリのREST APIを以下のように設計しました。コントローラーでは、それぞれの定義に対して1つの関数を書いていきます。

  • メモの作成: POST /memos
  • メモの取得:
    • 一覧: GET /memos
    • 特定のメモ: GET /memos/{メモのID}
  • メモの更新: PATCH /memos/{メモのID}
  • メモの削除: DELETE /memos/{メモのID}

最初に「メモの更新」処理を作成します。ポイントは3つです。

  1. 関数の頭に対応させたいリクエストのHTTPメソッドを指定します。（@Patch()）
  2. ()の中にベースURLに続くURLを指定します。
    • /memos/{メモのID}のメモのIDの部分はパスパラメーターと呼びます。パスパラメーターは:idのように記載します。
    • 更新したいメモのIDがこの:id部分に渡ってきます。
  3. パスパラメーター、リクエストボディを引数で受け取ります。（@Paramや@Bodyの部分）

@Controllerなどのデコレーターの説明は前編で軽く触れているので、気になる方はご確認ください。

コードの1つ1つを完璧に理解する必要はありません。Controllerの各関数でどのリクエストを受け取るかを定義し、パスパラメーターやリクエストボディを受け取る流れをざっくりと把握しておきましょう。

▼memo.controller.ts

import {
  Body,
  Controller,
  Param,
  Patch,
} from "@nestjs/common";
import { MemoService } from "./memo.service";
import { Memo } from "../db/memo.entity";

@Controller("/memos")
export class MemoController {


  
  @Patch(":id")
  updateMemo(
    @Param("id") id: number,
    @Body() memo: { title: string; content: string },
  ): Promise<Memo | null> {
    return this.memoService.update(id, memo);
  }
}

⑥残りの処理を書く

コントローラーの残りの処理を書きます。完成後のMemoControllerをコピペしましょう。こちらも自力で書きたい方はぜひチャレンジしてください！

⑦MemoModuleの設定

今まで書いたコントローラー、サービス、データベースをモジュールに登録します。これはNestJS固有の設定なので詳しい説明は割愛します。src/memo.module.tsに完成後のMemoModuleの中身をコピペしましょう！

おさらい

ここまでの処理の流れをおさらいしましょう。

MemoControllerが送られてきたリクエストを受け取り、対応するメソッドを実行します。コントローラーからMemoServiceが呼ばれ、データの保存・更新などの処理を行います。データはmemo.sqliteファイルに保存されます。

バックエンドの流れ

3. フロントエンドを作る

コンポーネントは作成ずみなので、REST APIを呼び出す処理を書いていきましょう。

①メモを更新する処理を書く

  1. frontend/src/logics/handleApi.tsを開きます。
  2. メモを更新する処理updateMemo()を実装します。

updateMemo()関数は更新するメモID、タイトル、コンテンツを受け取り、バックエンドにリクエストを送ります。リクエストにはフェッチAPIを使用します。ここで注目すべきはfetch()メソッドの第2引数です。

第2引数はRequestInitオブジェクトです。フェッチリクエストを送る際のオプションを設定します。ここでHTTPメソッドや、リクエストヘッダー（今回はjsonで送るので"Content-Type": "application/json"を指定）、リクエストボディ（body: JSON.stringify(memo)）などを記載します。

▼handleApi.ts


export const updateMemo = async (
  id: number,
  memo: {
    title?: string;
    content?: string;
  },
): Promise<Memo> => {
  const response = await fetch(`${API_BASE_URL}/memos/${id}`, {
    method: "PATCH",
    headers: {
      "Content-Type": "application/json",
    },
    body: JSON.stringify(memo),
  });
  if (!response.ok) throw new Error("Failed to update memo");
  return response.json();
};

このリクエストは先ほど作ったmemo.controller.tsのupdateMemo()が受け取ります。PATCHメソッドで/memos/{メモのID}宛に送られたためです。

このようにフロントエンドとバックエンド間でデータをやり取りすることでアプリが動きます。

②残りの処理を実装する

残りの処理も書いていきましょう。

  1. メモを1件作成
  2. メモ全件の取得
  3. メモを1件取得
  4. メモの削除

完成後のhandleApi.tsはこちらです。参考にしてください。

4. アプリを動かしてみよう

作ったアプリを動かしてみましょう！　うまく動くでしょうか？


npm run dev:backend


npm run dev:frontend

CORSエラーのケアを忘れずに

残念ながらこのままだとエラーになります。前編でも発生したCORSエラーです。前編と同様に、/backend/src/main.tsに設定を追加しましょう。

▼main.ts


app.enableCors({
  origin: "http://localhost:5173", 
  methods: ["GET", "POST", "PATCH", "DELETE"],
  credentials: true,
});

完成

ついにアプリが完成しました！　メモの作成、更新、削除などの操作を実際に確かめてみましょう。

メモアプリ

まとめ

前編では簡単なREST APIを、後編はデータベースを構築してアプリを作りました。バックエンドの仕組みが理解できたでしょうか？

バックエンドを構築できると本格的なアプリを作れるようになります。実際のサービスでは認証・認可やセキュリティなど、さらに多くの知識が求められるため、まだまだ学習すべきことはたくさんあります。筆者も勉強中です。

この記事がバックエンドの学習に踏み出すはじめの一歩となれば嬉しいです。

参考サイト・書籍


Source link

【SharePoint】DisForm.aspxについて | ヘッドウォータースのフィード 前の記事 エラー通知でDevinが自動調査 - Slack連携の実装パターン | レスキューナウテックブログのフィード 次の記事

関連記事

コメント

この記事へのコメントはありません。