プロジェクト計画: 2 回測定し、1 回カット - 「A から Z までの Java プロジェクト」

同僚の皆さん、こんにちは。今日は、コーディングを本格的に開始する前に行う必要がある準備作業について説明します。より具体的には、アプリケーション アーキテクチャの計画と作成についてです。 しかし、どこから始めればよいでしょうか? このアーキテクチャを構築するにはどうすればよいでしょうか? すべてのことと同様、最初から始める必要があります。つまり、アイデアを使って。私たちのプロジェクトのアイデアは、基本的な機能を備えた便利な電報ボットを作成することでした。正確に繰り返してみましょう。 「ユーザーとして、興味のある JavaRush 上のグループで新しい記事が公開されたときに通知を受信できるようにしたいと考えています。」 YAGNI 原則に従って、アプリケーションを構築します。これは、必要なものだけを摂取することを意味します。いつか実際に役立つかもしれないという理由だけで、事前に予約して機能を作成することはありません。はい、読み取り可能で拡張可能なアプリケーションを作成しますが、これは「成長のための」データベース スキーマを作成するという意味ではありません。この「成長」をサポートしないためには、それを完全に放棄した方が良いと判断しました。これにより、開発中の不必要なサポートや不必要なテストを回避できます。後で、私たちのプロジェクトが実稼働に入ると (これもイギリス主義で、略称 prod - Production から来ています)、さらに何かできるようになります。アイデアを決めたら、少しいたずらして絵を描く必要があります。何を描こうか？さまざまなユーザーのグループへのサブスクリプションに関するデータを保存する機能が必要になります。Telegram ではユーザー ID をチャット ID の形で使用できることを知っています。そして、新しい記事の検索が実際にどのように行われるかというアイデアがあります。新しい記事を購読しているすべてのグループを検索し、チャットに送信します。これに基づいて、最初の近似値として次のことが得られます (これは装飾なしの展開図です):私の手書きの文字が理解されることを望みません: 展開がどこからどのように始まるかを正確に示したいと考えています。最初の段階は完了しました。何が起こるかはなんとなく決まりました。データベース内のモデル/テーブルについては上で説明しました。しかし、これは草案です。洗練されて、より読みやすい形式に修正することは可能ですし、そうすべきです。磨きをかけているときに、ボットの動作に関する統計も取得したいことを思い出しました。これを追加しました。この図では、何がどのように配置されるかが明確です。つまり、どのようなテーブルとフィールドがそこに含まれるか、テーブルのエンティティ名は何かということです。そのうちのいくつかが存在することが決定されました。

• ユーザー - ボットを使用する電報ユーザーに関する情報。ご覧のとおり、チャット ID と、ユーザーがアクティブかどうかのフラグのみが保存されます。なぜ？なぜなら、私たちの目標はユーザーに関する情報を収集することではなく、ユーザーに利益をもたらすことだからです。
• GroupSub - ここには、購読しているグループに関する情報と、購読者に送信された最新の記事が表示されます。
• 統計 - スキーマを作成していません - 後で作成します。これはプロジェクトの MVP の主な目標ではありません。

その後、新しい記事を検索する方法をさらに詳しく説明したいと思いました。これを行うために、BPMN 図を使用しました。これを画像に変換すると、次のようになります。ここにあるものはすべて、より読みやすく、理解しやすくなっています。探索ではこのスキームに従って作業します。プログラマーだけでなく理解できるため、マネージャーはこのスキームを非常に気に入っています :D 一般的には、スタートが切れました。

作業用のリポジトリを作成する

最後に、電報ボットを操作するためのリポジトリを作成できます。

1. リポジトリの名前とその簡単な説明など、すでによく知っている項目を入力します。
2. ライセンスを追加します - Apache 2.0 (ライセンスは自由に選択できます)。
3. 私たちのプロジェクトは現在利用可能です - ここにそのプロジェクトへのリンクがあります: JavaRush Telegrambot。

リポジトリにプロジェクトを作成する

プロジェクトを操作するには、project などの GitHub ツールを使用するとよいでしょう。それは何ですか？ここでは、タスクを作成し、その完了を追跡し、タスクのステータスを保存できます。誰がそれらを実行するかを決定します。これを行うには、作成したプロジェクトで[プロジェクト]ボタンを見つけ、そこで新しいプロジェクトを作成します。ご覧のとおり、ここではプロジェクトの名前を指定し、説明し、作業するテンプレートを選択しました -自動カンバン。今の私たちにとって、これが何を意味するかはそれほど重要ではありません。重要なことは、タスクを列に分けたボードを用意し、各列がタスクのステータスになることです。

1. To do - 実行が計画されているすべてのタスク。
2. 進行中 - 現在作業中のタスク。
3. 完了 - このプロジェクト内ですでに完了したタスク。

こうすることで、タスクのステータスを知ることができます。どれが進行中か、どれが完了したか。また、これはチームがある場合だけでなく、個人で作業する場合にも重要かつ便利です。ボードに何かを表示するには、問題を作成する必要があります。

プロジェクトのイシュー（課題）を書きます

どのようなタスクを作成するかを理解するために、プロジェクトに何を含めるかを決めましょう。データベースにアクセスし、データベース スキーマを管理および変更できるように、JavaRush で REST リクエストを実行して記事のデータを取得できるように、簡単かつ迅速に起動できるアプリケーションが必要です。これに基づいて、次のテクノロジーを選択できます。

• SpringBoot - アプリケーションのフレームワークとして、
• Spring Data - データベースを操作するため、
• Flyway - データベース移行の作業用、
• MySQL - プロジェクトのデータベースとして、
• Telegrambot StringBoot スターター - テレグラム ボットを操作するためのライブラリ
• Unirest は、REST リクエストを処理するためのライブラリです。

上記のすべてを踏まえて、タスクの作成を開始しましょう。

タスク作成テンプレート

次のテンプレートを使用してタスクを作成します。

1. タスク名はJRTB-{IssueNumber}:{IssueDescription}のようになります。ここで、:
   • {IssueNumber} は問題のシリアル番号です。前回の問題からもう 1 つ取り上げてみましょう。
   • {IssueDescription} - 問題の簡単な説明。
2. タスクの本文では、タスクのより詳細な説明を作成します (タスク名の説明と一致する場合もあります)。
3. 受け入れ基準は要件のリストであり、これを満たした後にタスクは完了したと見なされます。いわば、仕事を引き受ける基準。これらを使用すると、レビュー担当者 (英語の reviewer - reviewer - タスクの完了方法を見る人) は、タスクが完全に完了したかどうかを把握できます。

このテンプレートを使用して、最初のタスクを作成します。タスクを作成するときに、このタスクがどのプロジェクトに適しているか、誰が実行するか (担当者)、そしてこのタスクがどのラベル (ラベル) に属しているかをすぐに判断したことにも注目してください。次に、タスクの名前と簡単な説明とそれらへのリンクを簡単に示します。それらはすべてここにあります。ここで示されているのとほぼ同じ順序でタスクを実行します。

1. [機能] JRTB-0: スケルトン Spring ブート プロジェクトの作成- ここですべてが明確です。前の記事で行ったことの最初の部分を実行する必要があります。
2. [機能] JRTB-2: プロジェクトに電報ボットを追加します- 単純に応答して、生きていることを伝える空のボットを追加します。
3. [機能] JRTB-3: テレグラムボットのコマンドパターンを実装- テレグラムボットでコマンドを操作するための正しいアプローチを設定しましょう。これまでにいくつかのチームについて。
4. [機能] JRTB-1: リポジトリ レイヤーを追加します。これは最大のタスクの 1 つです。データベースを操作するために必要なすべての作業が結合されます。
5. [機能] JRTB-5: ユーザーとして、グループをサブスクリプションに追加したいと考えています。これは、アジャイルの理解における最初のユーザー ストーリーです。これはユーザーにとって大きなメリットになります。ボットにグループ サブスクリプションを追加できるようになります。
6. [機能] JRTB-12: 新しい記事に関する通知を送信するためのスケジューリングを実装します。ここでは、新しい記事がグループごとに公開され、グループに登録しているすべてのユーザーに送信される場合に、新しい記事を検索する実装になります。
7. [機能] JRTB-6: ユーザーとして、自分のグループのサブスクリプションのリストを確認したいと考えています。ここではすべてが簡単です。ユーザーがサブスクライブしているすべてのグループのリストを表示するコマンドを追加します。
8. [機能] JRTB-7: ユーザーとして、自分のサブスクリプションからグループ サブスクリプションを削除したいです。ここでは、グループ内の更新に対するユーザーのサブスクリプションの削除を実装する必要があります。
9. [機能] JRTB-8: ユーザーとしてボットを使用して非アクティブに設定したい- ボットの停止を実装します。つまり、作業を停止するためにシステム内で実行する必要があるすべてのことです。/stopコマンドを処理に追加します。
10. [機能] JRTB-9: ユーザーとして、ボットの操作を開始するか、以前にボットを使用していた場合はアクティブに設定したいと考えています- /start コマンドの処理を追加します。まさに私たちが望む通りです。
11. [機能] JRTB-10: 管理者としてボット統計を確認したい- ボット統計のコレクションを作成します。管理者機能の追加。
12. [機能] JRTB-11: ユーザーとして、この電報ボットのドキュメントを参照したいと考えています。ドキュメントの作成です。はい、はい、友達、それなしでは生きていけません、そしてこれを学ぶのが早ければ早いほど、それはあなたにとってより良いでしょう））

これはすでにプロジェクトの始まりのようです。いわば、私たちはプロジェクトアーキテクト兼ビジネスアナリストとして働いていました。

リポジトリに記入する

コーディングを始める前に他に何をする必要がありますか? - 著者、これらの段落をいくつ追加できますか。深淵から引き出していますか?? ――いいえ、仕事の良さは細部に表れます。そして、彼らこそが理にかなっているのです。 そこで、もう 1 つ詳細を追加しましょう。プロジェクトが人気を博し、他の開発者にとって理解できるようにするには、プロジェクトに記入する必要があります。何を追加すればよいでしょうか? 実行できることの完全なリストについては、記事「GitHub 上のプロジェクトでの作業の最適化: Github テンプレート リポジトリについて知る」で説明しました。ぜひ読んでみてください。私たちにとって、明確なバージョン管理と、私たちが何をしているのかを明確に理解することが重要です。したがって、プロジェクトへの変更が記録される RELEASE_NOTES ファイルを追加しました。例として、私のプロジェクトの RELEASE_NOTESを見てみましょう(はい、私がエネルギーと創造性を注いだものを示してみませんか)。新しいバージョンごとの変更点が記載されています。新しいタスクを作成するためのテンプレートも追加しました。これには 4 つのオプションがあります。

• バグレポートは、作業中にバグを見つけたユーザー/テスターに​​よって作成されるタスクです。これは非常に重要なことです。バグ修正の管理に役立ちます。
• 機能リクエストは、新しい機能を追加するタスクです。プロジェクトの最初のタスクはすべて機能要求タスクです。
• 改善リクエスト- アプリケーションの動作を改善するためのタスク。たとえば、ボットを操作するときにテストの回答を変更する場合などです。私はテクニカルライターではないので、完全に正しい答えを導き出すことはできません。だから、もしあなたに意欲と能力があるなら、それを提供してください:)
• 質問は、アプリケーションの動作に関する開発者への質問です。とても便利なものです。仕事を理解していないか、疑問があるとします。この方法で質問すると、直接答えを得ることができます。

Github を見ると、次のようになります。現在、グループを操作するための JavaRush API の操作に関するドキュメントもあります。

次は何ですか？

さて、これらの手順をすべて完了したら、プロジェクトは終了するのでしょうか? いいえ、まったくそうではありません。このプロジェクトは今後も存続していきます。これは私と、参加を希望するすべての JavaRush 学生/卒業生によって開発されます。あなたの将来の計画は何ですか？それらの多く。最初の計画は、JavaRush API 用の Java クライアントを作成することです。開発者は、Swagger をオープンアクセスにすることを約束しました。また、スワッガーとは何かについても見ていきます。クールでとても便利なもの。次に、JavaRush サイトを電報ボットと統合します。ユーザーをボットに接続して、サブスクリプションを同期しましょう。コース完了に関する統計を作成してみましょう。JavaRush コミュニティとして必要なものすべてが揃っています。

結論

今日はプロジェクトを作る前の裏方の仕事についてお話しました。より正確には、作業計画を作成する方法についてです。これがなければ、多くのエネルギーを無駄にする可能性があります。繰り返しますが、プロジェクトの始まりはすでにここで公開されています。いつものように、 Github で私のアカウントを購読することをお勧めします。こうすることで、記事が公開される前にプロジェクトへの変更を受け取ることができます。関係者全員が Github に登録していると想定しています。はい、プロジェクトは私たちが望んでいるほど早く進んでいません。ただし、実際のプロジェクトと同様です。次の記事では、最初のタスクの追加について説明します。読んでくれてありがとう、また会いましょう!

シリーズのすべてのマテリアルのリストは、この記事の冒頭にあります。