spring boot api project seed

導入

Spring Boot API プロジェクト シードは、Spring Boot と MyBatis をベースにしたシード プロジェクトであり、小規模および中規模の API および RESTful API プロジェクトを迅速に構築するために使用されます。このシード プロジェクトは、多くの実際のプロジェクトで実践されています。高速なので、反復的なタスクを取り除くことができ、ビジネスコードの作成に集中して残業を減らすことができます。以下は、このプロジェクトに基づいて簡単な API をわずか数十秒で実装し、実行してサービスを提供する方法を示す簡単な使用デモです。

機能と特典

• ベスト プラクティスのプロジェクト構造、構成ファイル、合理化された POM (プロジェクト構造図を表示)
• 統合応答結果のパッケージ化および生成ツール
• 統合された例外処理
• シンプルなインターフェース署名認証
• よく使用される基本メソッドの抽象カプセル化
• Druid Spring Boot Starter を使用して Druid データベース接続プールと監視を統合する
• FastJsonHttpMessageConverter を使用して JSON シリアル化速度を向上させる
• MyBatis、ユニバーサル Mapper プラグイン、および PageHelper ページング プラグインを統合して、単一テーブル ビジネス向けにゼロ SQL を実現します。
• テーブル名に基づいて、Model、Mapper、MapperXML、Service、ServiceImpl、Controller などの対応する基本コードを生成するコード ジェネレーターが提供されています。Controller テンプレートには、デフォルトで 2 つの POST と RESTful のセットが用意されており、ニーズに応じて選択できます。 CodeGenerator.genController(tableName)メソッドでは、デフォルトで POST テンプレートが使用されます。コード テンプレートは、実際のプロジェクトのニーズに応じて拡張できます。実際のプロジェクトでの繰り返しのコード作成を減らすためのアイデアを提供することを主な目的としています。 I 実際に使用されているテンプレートは、会社のビジネスの抽象化に基づいて作成されています。さらに、テンプレートを使用すると、チームのコーディング スタイルを統一するのにも役立ちます。
• イースターエッグもあなたを待っています

クイックスタート

1. クローンプロジェクト
2. コードはテーブル名に基づいて生成される必要があるため、 testパッケージ (主に JDBC) でコード ジェネレーターCodeGenerator構成します。
3. 上記のデモンストレーションに基づいて自分で試してみたいだけの場合は、 test resourcesディレクトリのdemo-user.sqlを使用できます。それ以外の場合は、この手順を無視してください。
4. テーブル名を入力し、 CodeGenerator.main()メソッドを実行して基本コードを生成します (表示するにはプロジェクト ディレクトリを更新する必要がある場合があります)
5. 業務に応じて基本コードを拡張
6. 開発環境設定ファイルapplication-dev.propertiesを設定し、プロジェクトを開始します。楽しんでください。

開発提案

• テーブル名には、複数の単語を結合するために小文字を使用することをお勧めします。
• モデル内のメンバー変数がテーブル フィールドの数に対応することをお勧めします。メンバー変数を拡張する必要がある場合 (テーブル クエリの接続など)、それ以外の場合は@Transient追加する必要があります。拡張メンバー変数への@Transientアノテーション 詳細については、一般的な Mapper プラグインのドキュメントを参照してください。
• サービスの失敗はServiceException("message")を使用して直接スローすることをお勧めします。また、統合例外プロセッサは ビジネスの失敗の応答結果をカプセル化します (例: throw new ServiceException("该手机号已被注册") 。 {"code":400,"message":"该手机号已被注册"}返されるように直接カプセル化されます。自分で処理する必要はなく、好きなだけ投げるだけです。
• ツール クラスが必要な場合は、最初にapache-commons-*とguavaから見つけることをお勧めします。プロジェクトを合理化するために、車輪を再発明したり、クラス ライブラリを導入したりする必要はありません。
• 開発仕様は、Alibaba Java 開発マニュアルに従うことをお勧めします (最新バージョンをダウンロード)
• API ドキュメントを作成および管理するには、ShowDoc、SpringFox-Swagger2、RAP、および社内のその他のオープン ソース プロジェクトを使用することをお勧めします。

テクノロジーの選択とドキュメント

• Spring Boot (Spring Boot の学習と使用ガイドを参照)
• MyBatis (中国語の公式ドキュメントを参照)
• MyBatisb ユニバーサル Mapper プラグイン (中国語の公式ドキュメントを参照)
• MyBatis PageHelper ページング プラグイン (中国語の公式ドキュメントを参照)
• Druid Spring Boot Starter (中国語の公式ドキュメントを参照)
• Fastjson (中国語の公式ドキュメントを参照)
• その他若干

ライセンス

なし。純粋にオープンソースの共有です。Star & Fork の皆様のサポートに感謝します。