1. 概要
- これまでRDBに触れてはきていたが、実際にシステム開発の初期フェーズで行うような
エンティティの抽出
やエンティティの定義
、正規化
といった経験をすることがなかった。 - 今回ポートフォリオを作成するにあたり、場当たり的に考えてテーブルを作成するのではなく、各フェーズで検討することや思考法を経験者のものを真似ながらやってみる。
2. この記事を参照するにあたっての前提知識
特に前提知識がなくていいようにはなっていますが、非エンジニアの方にとっては聴き馴染みのない言葉が出てくるかもしれません。
ここでの話は、最後まで実装非依存な内容になるため、特に何らかのフレームワークを使うこともありません。
ただし、RDBの基礎知識くらいはあったほうがいいかもしれません。
RDBの基礎ってなんぞやという方は下記の書籍がおすすめです。
3. 早速実装と行きたいけど。。。その前に【題材の紹介】
今回説明するために使用するのは、私がポートフォリオとして作成している「ShareFitTube」(ネーミングセンスのなさよ。。。)のテーブルです。
自分で最初から実装するのは初なので、どうせなら自分の作品にしようと思いました。
また、フェーズごとに章立てて説明していく予定です。
解説部分はかなり参考URLの内容とかぶる部分が多いため、解説に関してはURLの内容を参照するほうが早いかもです。
各章末に自分のアプリではどう実装したのかを記載しています。
また、以降では私のポートフォリオのことは「PF」と呼称することとします。
参考資料
以下のサイトですが、控えめに言ってめっちゃいいです。
テーブル設計の論理設計では
- エンティティの抽出
- エンティティの定義
- 正規化
- ER図の作成
という流れになるのですが、この中でも特に1.
と2.
は書籍などでも語られることの少ないところで実装は個人によりけりなところがあるような気がします。
ですがここで十分に検討できていないと結局ER図を作成したとにエンティティが足りておらず、再度設計からやり直し。。。のようなことになりかねません。
そのような大事ではあるけど書籍などでうまく言語化されていないことに対して以下のサイトで言及されているので、一読の価値ありです。 1
4. フェーズ1 エンティティの抽出
4.1. エンティティとは
- ある共通項をもったデータの集合体のこと
- 大別すると物理的なエンティティ(ユーザー、商品など)と概念的なエンティティ(購入履歴、プロフィールなど)の二つがある
テーブル設計を行うに際して、最初からER図やテーブルの項目から考えるのではなく、開発するサービスにでてくるエンティティを抽出することが最初の一歩となる。
4.2. ポイント
4.2.1. エンティティは大きいものから抽出すること
最初はサービスにでてくる登場人物や主要な概念を大きな粒度のエンティティとして抽出する。
この前にエンティティの中の項目まで細かく検討すると、それが不要になった時のサンクコストがでてきてしまう。
まずは粒度を揃えるために粗い(粒度の多い)エンティティを抽出すること。
この段階でのPF
物理的なエンティティ
・動画、ユーザー
のみです。正直PFのサービス対象領域が狭いので最初に登場する物理的なエンティティはこんなもんです。
4.2.2. エンティティ同士でどのような状態変化、やりとりがなされるか考える
粒度の揃ったエンティティを抽出した後は、それらが互いにどのように作用し合うかを検討していくことになる。
この時、ただ考えるとなると手がつかないので、一つの思考法として以下を思考してみる。
システムがどう使われるのかを脳内でシミュレートする
最初に開発するにあたって、サービスを考える背景でなんとなく
- ユーザーはこういう場面、こういう事象に「痛み」2を感じている
- それにたいしてこういうアプローチをしたら解決できる
などということを施行していたと思うので、ある程度サービスのユースケース等は頭にあると思う。
それを書き出して、それを実現するために必要なデータを考えていけばいいことになる。
この段階でのPF
・ユーザーは任意の動画を特定の条件の中から自由に選択して登録できる。
→「条件」テーブルが必要。この中には動画をカテゴライズする条件を表す項目が含まれる。
・ユーザーは動画を評価できる必要がある。
→「評価」テーブルが必要。このテーブルはユーザーIDと動画IDを含んだ単一動画に対する単一ユーザーの評価を行うテーブルとなる。
・ユーザーは動画をお気に入りに登録できる
→「お気に入り」テーブル何必要。このテーブルは上記同様にユーザーIDと動画IDを含んだ単一動画に対する単一ユーザーのお気に入りを管理する。
・ユーザーはログインをすることができる
→ログイン状態を管理する項目が必要(ユーザーテーブルに入れるかどうかは別で検討)
・ユーザーはプロフィールを編集することができる
→「プロフィール」テーブル、またはユーザーテーブル内にプロフィール項目を追加する必要がある
物理的なエンティティ
・動画、ユーザー
概念的なエンティティ
・動画カテゴライズ条件、ユーザーの動画評価、ユーザーのお気に入り動画、ユーザープロフィール
簡易的にサービスのユースケースから必要なデータなどがぼんやりと見えてきている。実際にどういうテーブルにどういう項目を持つかなどについてはここで検討することではないので検討していない。
5. エンティティの定義
エンティティに必要なカラムを洗い出していく作業。
RDBにおいてエンティティはテーブルとして表現し、必要な項目=カラムとして定義することになる。
この時も必要なポイントの中には
ユースケースのシミュレーション
になる。
また、
画面にどんな内容が表示されている必要があるのか
というアプローチも有効になる。
システムの中で、画面に表示されている内容はある程度DBに保存されているテーブルのカラムの内容になるので、画面に必要な項目をテーブルのカラムとして考えるもあり。
この段階でのPF
ユーザーテーブルに必要な項目
・ユーザーID、メールアドレス、パスワード(暗号化後)、プロフィール画像パス、自己紹介文
動画テーブルに必要な項目
・動画ID、動画名、動画時間、動画URI、運動強度、使用目的、部位、広告種別
動画評価に必要な項目
・評価レート、評価文
それぞれのエンティティ(=テーブル)で必要になる情報を大体で分析している。
この時、正規化等には触れていない点がポイント。
正規化はそれ自体が目的ではなく、データの整合性や不整合を防ぐために行う手段である点に注意する。
6. 正規化
DML言語を使用して、テーブルのレコードに対して処理を行う際に、データの不整合が起こってしまうようなデータに対しては原則正規化を行うべき、
例えばPFで言うと、
・動画テーブルとカテゴリテーブルを一纏めにしてしまうと、動画とカテゴリという本来独立して存在しておかないといけないエンティティが纏まっていることになる。
これによって、例えば特定の動画が削除された時、削除されるレコードのカテゴリが一つしかなければ、それも削除されることになり、動画削除という本来は関連のないレコードの操作でカテゴリの情報も一緒に失われてしまうことになる。
だからと言って整合性のみを重視して正規化をしすぎると、テーブル間のリレーションが増えすぎることで複雑になってしまいます。
そこは、作成するサービスの成長性や規模にあわせて設計するのが必要です。
最終的な成果物
エンティティの定義で行なっていたエンティティから何個か増えてますがw
SNS機能を実装する際に必要なテーブルを追加しています。
後は基本的にエンティティの定義で行なっている内容をER図で示しているような感じです。
ER図の書き方や、正規化の手順はこの記事では詳しくは解説しませんので各自で調べてみてください。
7. まとめ
今回は自分のPFを題材にして、実際にサービスの構想段階からテーブル定義、正規化までを一つの記事を参考にしながら実装する工程を記事にしてみました。
参考サイトの内容が良質すぎて公開するか迷うくらいなのですがw
RDBに慣れ親しんでいないとここの実装ベースの話については理解が追いつかないと思いますし、私も実際にサービスをイチから開発するのは初なのでこの経験は貴重でした。
今後も作成するPFのテーブル定義などは変化していくことになるとは思いますが、とりあえずの叩き台を作ることができたのでこれにて終わりにしようと思います。
長文になってすみません。
ご覧いただきありがとうございました。