JavaScript

【APIサーバー】データ1件を新規作成する機能の実装【Model実装】

どうも、つよぽんです!

今回は「APIサーバーを実装するシリーズ」の第5回目の記事となります。

以前、Modelを作成した時の記事「【APIサーバー】データ一覧取得する機能の追加【Model実装】」をまだ読んでいない方は、先にそちらの記事から読むことをオススメします。

第5回目の今回は、以前作成したModelに「データ1件を新規作成する機能」の実装を行います。

今回の記事内容は、以下のリンク先で使っているスライドの一部を補足した記事になります。

実際に手を動かしながら覚えたい方は、以下のスライドも参考にすると良いでしょう。

あわせて読みたい
【Model実装】Todo1件を新規作成する機能を実装【テスト含む】今回はTodo1件を新規作成するための機能をModelに実装します。また、機能実装だけでなく、実装した機能のテストコードの実装方法も学習します。機能実装と一緒にテストコードの実装も一緒に行うクセをつけていきましょう!...

今回の記事は次のような方に向けて書きました。

想定読者
  1. Modelに機能を追加実装する流れを理解したい方
  2. Modelに追加実装した機能のテストコードを追加したい方

この記事を読み終えた後のあなたは次のことがわかるようになっています。

この記事を読み終えた後のあなた
  • Modelに機能を追加実装できるようになる
  • Modelに追加実装した機能のテストコードを書けるようになる

それでは以下の内容で話を進めていきます。

今回の内容
  1. Modelのデータ一覧取得メソッド「findAll」を修正する
  2. Modelにデータ1件を新規作成するメソッド「create」を実装する
  3. データ1件を新規作成する機能のテストコードを作成する

Modelのデータ一覧取得メソッド「findAll」を修正する

以前の書いた記事「【APIサーバー】データ一覧取得する機能の追加【Model実装】」でデータ一覧取得の機能として「findAll」メソッドをModelに実装しました。

しかし、前回実装したfindAllメソッドには問題があります。

以下の画像の左側が前回実装したfindAllメソッド、右側が今回の修正後のfindAllメソッドとなります。(※画像をクリックする別タブで画像が開きます)

配列のコピーを返すように修正配列のコピーを返すように修正

違いが何かわかるでしょうか?

結論から言うと以下のとおりです。

  • 前回実装したfindAllメソッド(画像の左側のコード)は、配列の参照を返している
  • 今回修正したfindAllメソッド(画像の右側のコード)は、配列のコピーを返している

参照の挙動に関しては、以前書いた記事「JavaScriptの参照に注意【オブジェクト型の特有な動き】」に書いてあるので詳しくはそちらを参考にしていただけたらと思います。

後ほど、テスト実装の際にも説明しますが、参照を返すようにすると、findAllメソッドで取得した値が勝手に更新されてしまうので、勝手な更新を防ぐために「配列のコピー」を返すようにしました。

Modelにデータ1件を新規作成するメソッド「create」を実装する

createメソッドの全体像

以下の画像の右側にある赤枠で囲った部分が、今回実装する「createメソッド」の全体像となります。(※画像をクリックする別タブで画像が開きます)

今回実装するcreateメソッドの全体像今回実装するcreateメソッドの全体像

ModelのfindAllメソッドの下の方に、上のコードを追加していただけたらと思います。

それでは、createメソッド内で実装している内容を1つずつ説明していきます。

createメソッドの引数

以下の画像の赤枠で囲った部分を見るとわかる通り、createメソッドは引数に1つのオブジェクトを受け取り、プロパティに「title」「body」を持ちます。(※画像をクリックする別タブで画像が開きます)

createメソッドは引数に「body」「title」プロパティを含むオブジェクトを受け取るcreateメソッドは引数に「body」「title」プロパティを含むオブジェクトを受け取る

つまり、Model(=Todo.js)のcreateメソッドを実行するときは以下のように実装します。

必要なデータが無かったらエラーを投げる

以下の画像の赤枠で囲った部分では、引数で受け取る「title」「body」に値が入っていない場合、エラーを投げて処理を中断しています。(※画像をクリックする別タブで画像が開きます)

必要なデータが無かったらエラーを投げる必要なデータが無かったらエラーを投げる

処理を中断することによって、不正なデータが、ダミーのDB(今回は配列)に含まれるのを防ぐことができます。

引数で受け取ったtitle, bodyを元にデータ1件を新規作成する

以下の画像の赤枠で囲った部分では、引数で受け取った「title」「body」を使って「新しいTodo1件を作成して、ダミーのDB(=配列)に保存」を行っています。(※画像をクリックする別タブで画像が開きます)

引数で受け取ったtitle, bodyを元に新しいTodo1件を新規作成する引数で受け取ったtitle, bodyを元に新しいTodo1件を新規作成する

作成したデータを呼び出し元に返す

以下の画像の赤枠で囲った部分では、「新しく作成したTodoを呼び出し元に返す」ことを行っています。(※画像をクリックする別タブで画像が開きます)

作成したデータを呼び出し元に返す作成したデータを呼び出し元に返す

データ1件を新規作成する機能のテストコードを作成する

テストファイルの作成

以下の画像の赤枠で囲った部分では、今回実装した「create」メソッドに対応するファイルとして「create.test.js」を「test/models/Todo」ディレクトリ内に作成します。(※画像をクリックする別タブで画像が開きます)

テストファイルを作成するテストファイルを作成する

Todo.createがメソッドであることをテストする

以下の画像の赤枠で囲った部分は、「Todo.create」がメソッドであるかどうかをテストするコードです。(※画像をクリックする別タブで画像が開きます)

Todo.createがメソッドであることをテストするTodo.createがメソッドであることをテストする

titleプロパティに値がない時にエラーになることをテストする

以下の画像の赤枠で囲った部分は、「Todo.create」メソッド実行時、「title」プロパティに値がないときにエラーになることをテストしているコードです。(※画像をクリックする別タブで画像が開きます)

createメソッド実行時、titleプロパティが無いとエラーになることをテストするcreateメソッド実行時、titleプロパティが無いとエラーになることをテストする

bodyプロパティに値がない時にエラーになることをテストする

以下の画像は、「Todo.create」メソッド実行時、「body」プロパティに値がないときにエラーになることをテストしているコードです。(※画像をクリックする別タブで画像が開きます)

createメソッド実行時、bodyプロパティが無いとエラーになることをテストするcreateメソッド実行時、bodyプロパティが無いとエラーになることをテストする

createメソッドの戻り値の確認と、craeteメソッド実行前後でデータが1件増えていることをテストする

以下の画像の赤枠で囲った部分は、「Todo.create」メソッド実行して成功した時のテストコードです。(※画像をクリックする別タブで画像が開きます)

成功するcraeteメソッド実行前と実行後で、全体のデータ件数が1件増えていることをテストする成功するcraeteメソッド実行前と実行後で、全体のデータ件数が1件増えていることをテストする

この記事の最初のほうで、findAllメソッドを修正したことを覚えてますでしょうか?

修正前はデータ一覧を保存している「配列の参照」を返していて、修正後は「配列のコピー」を返すようにしました。

もし、配列の参照を返すようにしていたら、このテストは失敗します。

理由は、1つ目の赤枠にかかれている「oldTodos」と、2つ目の赤枠の「currrentTodos」は同じ参照値を持った配列となります。

つまり、currentTodosの配列を変更すると、oldTodosもcurrentTodosと同じように配列に変更が入り、常に「oldTodosの中身とcurrentTodosの中身」が同じ状態になります。

しかし、実際には、oldTodosとcurrentTodosはそれぞれ独立した配列が望ましいです。

例えば、データを1件追加する前の状態を保存しておきたい場合に、同じ参照を持っていると、データを1件追加する前の状態を保持できません。

そのため、findAllメソッドを修正して、配列の参照ではなくコピーを返すようにしました。

配列の参照とコピーの挙動の違いに関しては以下の記事をまとめているので、そちらを参考にしていただけたらと思います。

JavaScriptの参照に注意【オブジェクト型の特有な動き】

実装したテストが成功するか確認する

以下の画像は、これまで実装してきた「create」メソッドのテストコードを実行したようすになります。(※画像をクリックする別タブで画像が開きます)

テストを実行して成功することを確認するテストを実行して成功することを確認する

下の赤枠のように全てのテストが通ることが確認できたら、createメソッドの実装と、createメソッドのテストコードの実装は完了となります。

まとめ

今回の話をまとめると次のとおりです。

今回のまとめ
  • findAllメソッドを修正して、配列の参照はなく、コピーを返すようにした
  • Modelにcreateメソッドを追加実装した
  • Modelに追加実装したcreateメソッドのテストコードを実装した

今回の内容は以下の記事内のスライドでも学習できます。

あわせて読みたい
【Model実装】Todo1件を新規作成する機能を実装【テスト含む】今回はTodo1件を新規作成するための機能をModelに実装します。また、機能実装だけでなく、実装した機能のテストコードの実装方法も学習します。機能実装と一緒にテストコードの実装も一緒に行うクセをつけていきましょう!...
【やる気満々な方向け】学習サポートとオンライン講義やってます!

Webエンジニアになりたい人向けに、MENTA にて『【やる気満々な方向け】未経験からのWebエンジニア育成コース』というプランを用意しております。

このプランでは、主に「【学習コンテンツ】Web開発」を使って学習を進めていただきます。

あわせて読みたい
Web開発Webエンジニアになるために必要な知識・スキルを学習できるコンテンツを用意しました。未経験者でも、①開発環境の準備、②Webの基本的な仕組み、③HTML、④CSS、⑤JavaScriptと順を追って学習することでスキルが身につくことを目的に教材を作成しています。...

誰向けのプラン?

こちらのプランは次のような方に向けて作られています。

プラン対象者
  1. Progateやドットインストールで一通り学習したけど、次に何をすればよいかわからない
  2. Webエンジニアになるまでの学習プランがあると助かる
  3. 学習していてわからないところが出てきたときに質問したい
  4. コードレビューして欲しい
  5. オンライン講義に参加したい
  6. 学習した内容をアウトプットした際に、フィードバックがもらえたら嬉しい
  7. おすすめの学習教材を知りたい
  8. Webフロントエンド・バックエンドを学習したい
  9. フルスタックエンジニアになりたい
  10. 文系出身で今までプログラミングをしてこなかったけど、将来Webエンジニアになりたい
  11. 将来フリーランスになることを目指している

プラン内容は?

【やる気満々な方向け】未経験からのWebエンジニア育成コース』では次のことを行っております。

プラン内容
  1. Web白熱教室の学習コンテンツをメインに、指定した教材を使って学習する (学習プランに沿って学習を進めていただきます。)
  2. 学習コンテンツの課題をこなしたあとは、僕にコードレビュー依頼を投げていただくことで、コードを添削する(課題クリア後は、引き続き学習プランの内容を続けていただきます。)
  3. プラン契約者が参加するSlackグループにて質問し放題
  4. Slack内にある「アウトプットの場」チャンネルにて、学習したことをアウトプットをしていただくことで、それに対しフィードバックをする (学習内容のアウトプットは復習にもなるため、アウトプットすることを強く推奨します。)
  5. 画面共有を使ったオンライン講義 (オンライン講義は録画して、いつでもふり返れるようにしています。(オンライン講義動画(ウェビナー動画)))
  6. 学習プラン以外の内容に対しての質疑応答 (内容によっては回答できないものもありますが、まずは気軽に質問していただけたらと思います。)
  7. 不定期で行うオフラインでの勉強会に参加(僕自身が東京住みのため、東京・もしくは東京近郊で開催します)

1日1回カフェでコーヒー1杯頼むくらいの金額で参加できます

1日1回、カフェでコーヒー1杯分くらいの値段(約330円)」で以下の環境が手に入るとイメージして頂けたらと思います。

  1. コードを添削してもらえる
  2. 学習したことのアウトプットに対してフィードバックしてもらえる
  3. いつでも質問出来る
  4. 週1のオンライン講義に参加できる
  5. 過去のオンライン講義動画を好きな時間に復習できる(いつでも閲覧可能)
  6. 不定期で行うオフラインでの勉強会に参加できる(僕自身が東京住みのため、東京・もしくは東京近郊で開催します)
  7. 自分の住まいの近場のメンティーさん同士で集まって、オフラインで勉強会を開くのも可能(初めて開催する場合は事前に僕に連絡をいただけたらと思います)

学習教材には、このサイトで用意している「【学習コンテンツ】Web開発」を使います。

【学習コンテンツ】Web開発」を使って学習を進めることで、Webのフロントエンドとバックエンドのスキルを身につけていくことができます。

プログラミングスクールとの比較

プログラミングスクールに通う場合は1ヶ月で10万円以上するところも多いですし、3ヶ月で50万円、更には100万円するところもあります。

プログラミングスクールの値段が高い理由は、「プログラミングスクールで働いている人の人件費」「就職のサポート」なども含まれているからです。

10万円50万円100万円」のいずれの場合も、自己投資とはいえ、支払うのにはだいぶ勇気がいる金額かと思います。

オススメの学習方法

個人的にオススメするのは、プログラミングのできるメンター(師匠)を見つけて、まずは1ヶ月プログラミング学習をしてみて、自分にプログラミングが向いているかどうか確かめてみることです。

10万円50万円100万円」を払って、学習していく中で「やっぱり自分にはプログラミングは向いてない」と判断した場合、その金額はかなりの痛手となります。

そのため、まずは「これくらいの金額なら最悪失っても痛くないな」の値段で教えてくれるメンターを見つけて、そのメンターに色々と質問をしてみましょう。

それで、「良さそうだな」と思ったら教えてもらうといった流れで学習を始めると、金額もだいぶ節約できます。

注意点

ただし、参加者が増えてきたら、1人1人へのサポートの質を維持するのが難しくなるので、値上げする可能性もあります。

値上げする理由は次の以下の理由となります。

  • 値段を上げて参加ハードルをあげることで、自己解決スキルも身につけたいと考えている学習意欲の高い人だけが参加するようになる
    • 調べたらすぐにわかることを、自分で調べずに何でもかんでも質問すると、自己解決スキルも身につかない
    • 更に、他のメンティーさんの対応する時間が取れなくなりサポートの質の低下にも繋がる

詳しく話を聞いてみたい方は

以下のいずれかでメッセージをいただけたらと思います^^

 

プラン内容については以下のリンク先からも確認することが出来ます^^

【やる気満々な方向け】未経験からのWebエンジニア育成コース

COMMENT

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です