はじめに
この記事は高校生である自分がただ成功して失敗したという「わりと武勇伝に近い」記事になると思います。
恐らくあなたが求めているような有益な情報はありません
時間を無駄にできる暇な人だけ見てね♡
自己紹介
某広域通信制高校に在籍している高校3年生。趣味はプログラミングで主にJavaScriptを書く
特にプログラミング以外の取柄はないです。
なぜアプリを開発したか?
自分が普段通うキャンパスには一応図書室があり、図書管理アプリも購入していますが、
なぜか使われていないというのが現状。どうやら先生曰く、
「使い方が良くわからない( ゚Д゚) ポカーン」らしく、特に購入したアプリのライセンス関係が良く分かっていないらしいです。
そこでアプリを導入する最初からアプリを使い終わる最後まで、サルでもわかるような図書管理アプリを作ることにしました。ちなみにアプリの名前は、本を 「貸し出す」 から Kashidasu と命名しました。
アプリの概要
アプリ自体はwebアプリケーションにしました。理由は単純にwebアプリケーションが専門分野であるのと、詳細は後述しますが、アプリの保守開発やメンテナンスなどを考慮したという理由もあります。
プログラミング言語: JavaScript (Node.js)
ライブラリ Quagga.js, Express
テンプレートエンジン EJS
データベース MySQL
その他 Docker
技術スタック
- JavaScript(Node.js)
- Express
- JavaScriptでサーバーサイドの処理をするときに使用しています
- pdflib
- javascriptでPDFファイルを出力するライブラリ。Kashidasuではユーザーが使用するカードを発行するときに使用しています
- jsbarcode
- javascriptでバーコードを生成するときに使用しているライブラリ。同じくカード発行に使用しています
- Quagga.js
- javascriptでバーコードを読み取るのに使用するライブラリ。本のISBNコードを読み取るのに使用しています
- docker
- git
-
シンプルさを追求したかった
最初から完璧を目指さず、必要な機能だけを実装し、後から追加できるようにしました。 -
飽きないように早めにリリースしたかった
最初に「完成」を意識して、まずはアプリとして動く状態を作りたかったからです。 -
ユーザーにとって簡単に始められることが重要
インストール後、すぐに使用できることを重視しました。 -
自分が卒業しても後輩が運用できるように
アプリをOSS化することで、後輩たちにソースコードを触ってもらい、保守開発・改善を自主的に行えるようにしました。 - その機能について100%必要と言い切れる機能のみ実装する。それ以外は後回しにする
- 完成しないことには動かないので、まずは完成だけを意識する
- Kashidasuにアクセスすることで最初に開くページをログインページにルーティングするようし、ライセンス認証の機能は実装しないようにする
-
- KashidasuをOSSにすることで、後輩にソースコードを触れてもらう機会を設けることで、自主的に改良・修正をしてもらうようにする
- 返却ルール変更に弱い
- 貸出期間が変更されるたびにフロント側の修正が必要になる
- 責務が直感的でない
- 業務ルールである「返却日計算」がUI側に存在してしまう
開発ツール類
- 開発・本番環境の構築を少しでも楽にするために導入したツールです。
- 言わずもがなバージョン管理ツールの中でもメジャーなツールです
補足 KashidasuのソースコードはGithubにて公開しています。
リンク: https://github.com/yukki072417/Kashidasu
現在の運用状態
学校が経費で落としてくれたRaspberry pi 5でLANに接続して動かしています
既にあるアプリの問題点
私のキャンパスで購入していた図書管理アプリには問題点があります。
冒頭で記した通り、ライセンス関係がわからないようなアプリになっているという点です。少し抽象的に解釈すると、その 「アプリの機能が多いところ」 です。ライセンス関係の機能がそのアプリの機能を多くしていると解釈しました。
これに関しては、私自身の考えですが、そのアプリの価値は、機能が多ければ多いほど良いというものではありません。むしろ、機能が少ないことで、ユーザーが機能の多さに戸惑うことなくスムーズにアプリを利用でき、アプリ開発にかかる労力やコストも大幅に減って一石二鳥です。
その考えをもとにし、このアプリのスローガン(設計思想)を 「Simple is the best」 にしました。
問題を解決するための要件
それらの問題を解決するために、アプリには以下の要件を決めました。
1.そのアプリにないと成り立たないコアな機能だけを実装する
2.それ以外の機能はリリース後の段階的な実装をする
3.dockerのコンテナ(サーバー)を立ち上げるだけですぐに使用できる
4.自分がいなくても(卒業しても)アプリが稼働できる状態にする
という4つの要件に絞りました。
要件を決めた理由
どのようにそれらの要件を達成するのか?
技術的失敗談
データベース設計の失敗 ―「最小カラム主義」の落とし穴
私はこれまで
「データベースのカラムは必要最低限であるべき」
という思想を持っていました。
データの正規化や冗長性を避けるという観点では、決して間違った考えではありません。
しかし今回の実装では、「何を最小とするか」の判断を誤った ことで、設計上の問題を引き起こしてしまいました。
その問題を、以下の図を用いて説明します。
図1:貸し出し履歴テーブル
| BOOK_ID | USER_ID | LENDING_DAY |
|---|---|---|
| ISBNコード | 学籍番号 | 貸出日 |
この設計では、返却日(返却期限)をテーブルに持たせていません。
代わりに、
「返却日は貸出日から一定日数後だから、プログラム側で計算すればよくね?」
と思いデータベースを設計しました ←アホ
図2:当時のディレクトリ構成(抜粋)
src
├─ model
│ ├─ lendBook.js
│ └─ etc...
└─ public
└─ js
├─ BookList.js
└─ etc...
問題点:責任範囲が分断された設計
この設計の最大の問題は、
「貸出・返却に関する責務の所在が曖昧になったこと」 です。
実際の実装(v1.2.0時点)
src
├─ model
│ ├─ lendBook.js
│ │ └ 本の貸出日をDBに保存する処理
│
└─ public
├─ js
│ ├─ BookList.js
│ │ └ 貸出日を元に返却日を計算し、画面表示用に加工
└─ views
└─ BookList.ejs
└ 貸出状態を描画
model:データベースにクエリを送信するディレクトリ
public/js: 返却日を計算, DOMでフロントエンドに表示
view:"public/js"を元に表示
つまり、
「貸出・返却」という1つのドメインロジックが、複数のファイルに分散してしまっていたという状態でした。
なぜこれが問題なのか
この設計には、以下のような問題がありました。
結果として、
「カラムを減らしてシンプルにしたつもりが、設計の複雑さを増やしてしまった」
状態になっていました。本末転倒である
理想的な設計
src
├─ model
│ ├─ lendBook.js
│ │ └ 貸出日・返却日をDBに保存
│
└─ public
├─ js
│ ├─ BookList.js
│ │ └ DBから取得した値をそのまま表示
└─ views
└─ BookList.ejs
└ 貸出状態を描画
model層が「貸出・返却」という業務ルールを一元的に管理することで
フロントエンドは表示に専念すべきであった
学び
今回の失敗から得た学びは、
「データベースのカラムは最小であるべき」 ではなく、
「ドメインの責務が明確になる最小構成であるべき」
ということでした。
冗長性を恐れて情報を削りすぎると、
かえってロジックが分散し、保守性が低下してしまうので、
「そのデータはどこで意味を持つのか」
を基準に設計する重要性を、改めて再認識しました。