E-Dobavki - Java および Spring Boot で食品添加物を検索するための Web サービス。私の生徒が作成しました。

導入

偶然にも、ここ XNUMX 年近く、私はキエフにある IT 学校の XNUMX つでプログラミングを教えてきました。 私はただ楽しむためにこれを始めました。 一度プログラミングのブログを書いたことがあるのですが、やめてしまいました。 しかし、興味のある人に有益なことを伝えたいという欲求は消えていません。

私の主な言語は Java です。 携帯電話用ゲームや無線通信用ソフトウェア、各種Webサービスなどを書きました。 そして私はJavaを教えています。

ここで私の最後のグループのトレーニングの話をしたいと思います。 彼らがトレーニングを開始してから実際に動作する Web サービスを作成するまでの過程を説明します。 栄養補助食品を探すのに便利なウェブサービス。 無料、広告、登録、SMS はありません。

サービス自体はここにあります - E-Dobavki.com.

このプロジェクトは教育的なものであり、広告は含まれていません。 からわかるように この出版物、そのようなプロジェクトへのリンクを提供できます。

プロジェクト自体を説明する前に、グループの学習プロセスについて少し説明します。これがないと全体像が不完全になってしまいます。

9ヶ月の研修

私が教えている学校では、Java コースは 2 つのパートに分かれています。 コースにはすべての休憩（年末年始、中間プロジェクトの執筆時間）を含めて、合計で約 9 か月かかります。

最初の部分では、言語の基本概念を生徒に紹介します。 変数、メソッド、OOP の基本などすべて。

コースの XNUMX 番目の部分では、学生はすでに Java での書き方を多かれ少なかれ理解しているため、「大人向け」のテクノロジ スタックを与えることができます。 すべては SQL から始まり、次に JDBC、Hibernate です。 次にHTTP、サーブレット。 次は Spring で、git と maven について少し説明します。 そして学生たちは最終的なプロジェクトを書きます。

すべてのトレーニングはモジュールに分かれています。 週にXNUMX回授業を行っていました。 XNUMX回のレッスン時間はXNUMX時間です。

私の学習へのアプローチ

5グループをリリースしました。 2年間というのは大変なように思えますが、ほぼ常にXNUMXつのグループを並行して率いていました。

さまざまなアプローチを試してみました。

最初のオプションは、理論を含むプレゼンテーションに XNUMX ペアが割り当てられることです。 XNUMX 番目のペアは純粋な練習です。 このアプローチは何とか機能しましたが、私の意見では、あまり効果的ではありませんでした。

私が思いつき、現在取り組んでいる 5 番目の選択肢は、理論に丸々 10 つを費やさないことです。 代わりに、理論の短いセクションを XNUMX ～ XNUMX 分間混ぜ合わせ、すぐに実際の例で補強します。 このアプローチはより効果的です。

十分な時間があれば、私は学生たちを私の場所に呼び、ラップトップの前に座らせ、彼ら自身が実際的な例を実行します。 とてもうまくいきますが、残念ながら時間がかかります。

誰もが最後までやり遂げられるわけではない

私にとっての啓示は、グループ全員がコースの最後まで到達するわけではないという事実でした。

私の観察によると、最終プロジェクトを書くのは学生の半分だけです。 それらのほとんどはコースの最初の部分で排除されます。 そして、第二部に到達した人は、通常は落ちません。

彼らはさまざまな理由で去ります。

XNUMXつ目は複雑さです。 彼らが何と言おうと、Java は最も単純な言語ではありません。 最も単純なプログラムを作成するには、クラス、メソッドの概念を理解する必要があります。 そして、なぜ書く必要があるのか​​を理解するには、 public static void main(String[] arg) 理解すべき概念がさらにいくつかあります。

これを、私を含む多くの人が始めた Turbo Pascal と比較してください。

begin
    writeln("Первая программа");
end.

私の知る限り、学校は追加テストを導入することでこの問題を解決するでしょう。 今では誰もが Java を勉強できるわけではありません。 これはまだ構想段階ですが、このステップは明らかに正しいものです。

XNUMX 番目の理由は次の図のようなものです。

プログラミングとは、大量のテキストを入力して、その対価として多額のお金を稼ぐことだと思われがちです。 コピーライターのように、お金が増えるだけです。

現実は少し異なります。 大量の日常的なコード、目に見えないバグ、絶え間ない学習プロセス。 興味深いですが、万人向けではありません。

これらは統計です。 最初は動揺して、もしかしたら自分が何か間違ったことをしているのではないかと思いました。 統計はほとんどのコースでほぼ同じであることがわかりました。 今は気にしていませんが、興味のある人には教えてください。

サービスアイデア

学生がコース全体を完了したら、最終プロジェクトを作成するときが来ました。 さまざまなアイデアがありました。 彼らは ToDo シート、プロジェクト管理プロジェクトなどを提供していました。

シンプルだけど役に立つものを作りたいと思っていました。 私の基準は単純で、友人や私がそれを使えるかどうかでした。 食品添加物を検索するための Web サービスは、これらの要件を満たしていました。

考え方はシンプルです。 店で製品を購入すると、その組成にある種の E-添加剤が含まれているのがわかります。 それがどれほど危険であるかは、コードからは明らかではありません（また、多くの国で禁止されている危険な添加物もあります）。

Web サイトを開き、サプリメントの名前 (番号、代替名のいずれか) を入力すると、サプリメントの概要が表示されます。

同様のプロジェクトもあります。 Google に単に添加剤を入力することもできますが、情報が常に正しく表示されるわけではありません。

しかし、このプロジェクトは教育的なものであるため、上記の困難は私たちを妨げませんでした:)

具現化

誰もが Java で書きました。 Github 上のプロジェクトのソースコード.

私を含めて7人でした。 全員がプル リクエストを作成し、私またはグループの別の人がこのプル リクエストを受け入れました。

プロジェクトの実装には、アイデアを表明してから現在の状態になるまで、約 XNUMX か月かかりました。

解析添加物

学生の XNUMX 人が最初に行ったのは、データベース (エンティティ、リポジトリなど) に関するフレームワークの基本的な作成のほかに、既存の情報サイトからのアドオンを解析することでした。

これは残りのポイントをテストするために必要でした。 データベースにデータを入力するために追加のコードは必要ありません。 いくつかの添加剤をすばやく解析したので、UI、並べ替え、およびフィルター処理をさらにテストできます。

Spring Boot を使用すると、複数のプロファイルを作成できます。 プロファイルは設定が含まれたファイルです。

開発環境では、ローカル H2 DBMS とデフォルトの HTTP ポート (8080) を備えたプロファイルを使用しました。 したがって、アプリケーションが起動されるたびに、データベースがクリアされます。 この場合、パーサーが私たちを救ってくれました。

検索とフィルタリング

重要な点は検索とフィルタリングです。 店内にいる人は、サプリメントのコードまたは名前の XNUMX つをすばやくクリックして、結果を取得する必要があります。

したがって、Additive エンティティには複数のフィールドがあります。 これは追加コード、代替名、説明です。 検索は、すべてのフィールドで同時に Like を使用して実行されます。 [123] または [amaranth] と入力しても、同じ結果が得られます。

これらすべてを仕様に基づいて実行しました。 これは Spring の一部であり、基本的な検索条件 (たとえば、フィールドなど) を記述し、これらの条件を結合 (OR または AND) できるようにします。

十数の仕様書を作成したら、「説明に [赤] という単語が含まれるすべての危険な着色添加剤」などの複雑な質問をすることができます。

Spring データベースを操作するという点では、非常に便利だと思います。 これは、複雑なクエリを操作する場合に特に当てはまります。 これには独自のオーバーヘッドがあり、手動で作成して最適化した SQL クエリの方が高速に実行されることを理解しています。

しかし、私はすべてを事前に最適化する必要はないという観点にも固執しています。 最初のバージョンは起動して動作し、個々のパーツを交換できるようにする必要があります。 そして、負荷がかかると、これらの個々の部分を書き直す必要があります。

セキュリティ

それは簡単です。 ADMIN ロールを持つユーザーがおり、追加の編集、削除、新しい追加を行うことができます。

そして、他のユーザーもいます（登録しているかどうかにかかわらず）。 彼らは添加物のリストを参照し、必要なものを検索することしかできません。

Spring Security は権利を分離するために使用されました。 ユーザーデータはデータベースに保存されます。

ユーザーは登録できます。 今では何も与えられません。 学生がサービスの開発を続けて、パーソナライズされた機能を導入する場合は、登録が便利です。

応答性とブートストラップ

次のポイントは適応力です。 私たちのサービスの場合（少なくとも私たちが見た限りでは）、ユーザーの大部分は携帯電話を使用しているでしょう。 そして、携帯電話からサプリメントをすぐに見る必要があります。

CSS で苦労しないように、Bootstrap を採用しました。 安くて、陽気で、見た目もまともです。

インターフェースは理想的とは言えません。 トップページはなおさらで、添加物の詳しい説明ページは狭いので、携帯電話ではもっと広くする必要がある。

できるだけ仕事に干渉しないようにしたとしか言えません。 これはまだ学生プロジェクトです。 そしてもちろん、彼らは後でそのような瞬間を修正することができます。

SEO の最適化についての XNUMX 分間

私は XNUMX 年以上、Web サイトや SEO に関連するあらゆることに密接に関わってきたため、少なくとも基本的な SEO の最適化がなければプロジェクトをリリースすることはできませんでした。

実際に、各アドオンのタイトルと説明のテンプレート生成を作成しました。 URL はほぼ CNC ですが、短くすることもできます。

出席カウンターも追加しました。 検索エンジンからの警告を監視するために、サイトを Yandex ウェブマスターと Google Search Console に追加しました。

それは十分ではありません。 完全なインデックスを作成するには、robots.txt と sitemap.xml を追加する必要もあります。 しかし、繰り返しになりますが、これは学生のプロジェクトです。 私は彼らに何をしなければならないかを伝え、彼らが望むならそれを実行します。

SSL証明書を添付する必要があります。 無料の Let's Encrypt も機能します。 Spring Boot用にこれを行いました。 難しいことはなく、PSからの信頼も高まります。

プロジェクトの次のステップは何でしょうか?

実際、選択は彼ら次第です。 プロジェクトの当初のアイデアには、添加剤へのリンクを含む製品のデータベースも含まれていました。

「スニッカーズ」と入力して、どのような栄養添加物が含まれているかを確認してください。

プロジェクトの開始時点でさえ、製品が何もないことはわかっていました:) したがって、添加剤のみから始めました。

これで、製品を追加して追加の製品を紹介できるようになります。 バンズ。 大規模なデータベースであれば、ユーザーが存在します。

配備

プロジェクトは VPS、Aruba Cloud にデプロイされました。 これは私たちが見つけた中で最も安い VPS です。 私は自分のプロジェクトでこのプロバイダーを XNUMX 年以上使用していますが、非常に満足しています。

VPSの特徴: 1 GB RAM、1 CPU (周波数はわかりません)、20 GB SSD。 私たちのプロジェクトではこれで十分です。

プロジェクトは通常の mvn clean パッケージを使用してビルドされます。 結果は、すべての依存関係を含む実行可能ファイルである fat jar です。

これらすべてを少し自動化するために、いくつかの bash スクリプトを作成しました。

最初のスクリプトは古い jar ファイルを削除し、新しい jar ファイルを構築します。

XNUMX 番目のスクリプトは、組み立てられた jar を起動し、必要なプロファイルの名前を渡します。 このプロファイルにはデータベース接続情報が含まれています。

DB - 同じ VPS 上の MySQL。

プロジェクトの総再開には次のものが含まれます。

• SSH経由でVPSにログイン
• 最新の git 変更をダウンロードする
• local-jar.shを実行します
• 実行中のアプリケーションを強制終了する
• launch-production.sh を実行します

この手順には XNUMX 分かかります。 これは、このような小さなプロジェクトにとっては賢明な選択のように思えます。

難しさ

プロジェクトを立ち上げる際の主な困難は、組織的な性質のものでした。

プログラミングの仕方を知っているように見えるが、あまり上手ではない人のグループがいます。 彼らは何かを知っていますが、それを実際に応用することはできません。 そして今、彼らは XNUMX か月以内にプロジェクトを完了する必要があります。

私はこのグループの条件付きチームリーダーを特定しました。 彼はタスクのリストが記載された Google ドキュメントを保管し、タスクを配布し、それらの受け入れを管理しました。 彼はプルリクエストも受け入れました。

また、私は学生たちに、プロジェクトで行った作業について毎晩短いレポートを書くように依頼しました。 何もしなかった場合は、「何もしなかった」とだけ書いてください。 これは素晴らしい練習であり、少し緊張します。 残念ながら、誰もがこのルールに従ったわけではありません。

このすべての運動の目的は単純でした。 たとえ短期間であっても、チームを組んで一緒に働きましょう。

私は彼らに自分の仕事が重要であると感じてほしかった。 彼らは何もない状態で球形のコードを書いているわけではないことを理解してください。 そして、彼らが一緒にやっていることは、その後人々が利用するプロジェクトになります。

最初の XNUMX ～ XNUMX 週間は積み重ねでした。 エンティティと小さなコミットの実行が遅くなりました。 少しずつかき混ぜていき、作業が楽しくなっていきました。 チャットでのコミュニケーションはより活発になり、学生たちは追加の意見を出しました。

目標は達成されたと思います。 プロジェクトは完了し、彼らはチームで働く経験を少し得ました。 目に見える具体的な結果があり、それを友人に見せてさらに発展させることができます。

所見

学ぶことは面白いです。

授業が終わるたびに、私は感情的に動揺して帰ってきました。 私は各ペアをユニークなものにし、できるだけ多くの知識を伝えるように努めています。

私が教えているグループが決勝に進むと嬉しいです。 男性が「仕事が決まりました、すべて順調です、ありがとう」と書くときは特にクールです。 たとえそれがジュニアであっても、最初は大金ではなかったとしても。 しかし、最も重要なことは、彼らが自分たちの願望に向かって一歩を踏み出し、成功したということです。

かなりボリュームのある記事になりましたが、すべてのポイントを網羅することは不可能でした。 したがって、質問をコメントに書き込んでください。

出所： habr.com