spring boot api project seed

مقدمة

Spring Boot API Project Seed هو مشروع أولي يعتمد على Spring Boot & MyBatis، ويتم استخدامه لبناء مشاريع API الصغيرة والمتوسطة الحجم وRESTful API بسرعة بسرعة، مما يسمح لنا بالتخلص من تلك المهام المتكررة، والتركيز على كتابة كود العمل وتقليل العمل الإضافي. فيما يلي عرض توضيحي بسيط للاستخدام لمعرفة كيفية تنفيذ واجهة برمجة تطبيقات بسيطة في بضع عشرات من الثواني فقط بناءً على هذا المشروع وتشغيلها لتقديم الخدمات.

الميزات والعروض

• أفضل الممارسات في هيكل المشروع، وملفات التكوين، وPOM المبسط (عرض مخطط هيكل المشروع)
• أدوات تعبئة وتوليد نتائج الاستجابة الموحدة
• معالجة الاستثناءات الموحدة
• مصادقة توقيع واجهة بسيطة
• تغليف مجردة للطرق الأساسية شائعة الاستخدام
• استخدم Druid Spring Boot Starter لدمج تجمع اتصال قاعدة بيانات Druid ومراقبته
• استخدم FastJsonHttpMessageConverter لتحسين سرعة تسلسل JSON
• قم بدمج MyBatis والمكون الإضافي Universal Mapper والمكون الإضافي للترحيل PageHelper للحصول على صفر SQL للأعمال ذات الجدول الواحد
• يتم توفير منشئ الأكواد لإنشاء الأكواد الأساسية المقابلة مثل Model و Mapper و MapperXML و Service و ServiceImpl و Controller بناءً على اسم الجدول. يوفر قالب وحدة التحكم مجموعتين من POST و RESTful بشكل افتراضي في طريقة CodeGenerator.genController(tableName) يتم استخدام قالب POST بشكل افتراضي. يمكن توسيع قوالب التعليمات البرمجية وفقًا لاحتياجات المشاريع الفعلية. نظرًا لاختلاف أعمال كل شركة، فإننا نقدم فقط بعض القوالب الأساسية والمشتركة نسبيًا، والغرض الرئيسي هو تقديم فكرة لتقليل كتابة التعليمات البرمجية المتكررة في المشاريع الفعلية. في الاستخدام، يتم كتابة عدد كبير من القوالب فعليًا بناءً على فكرة أعمال الشركة. بالإضافة إلى ذلك، يمكن أن يساعد استخدام القوالب أيضًا في الحفاظ على توحيد أسلوب البرمجة الخاص بالفريق.
• هناك أيضًا بيض عيد الفصح في انتظارك لاستكشافه

بداية سريعة

1. مشروع استنساخ
2. قم بتكوين منشئ الكود CodeGenerator في حزمة test ، وخاصة JDBC، لأنه يجب إنشاء الكود بناءً على اسم الجدول
3. إذا كنت تريد فقط تجربة ذلك بنفسك استنادًا إلى العرض التوضيحي أعلاه، فيمكنك استخدام demo-user.sql في دليل test resources ، وإلا فتجاهل هذه الخطوة
4. أدخل اسم الجدول وقم بتشغيل طريقة CodeGenerator.main() لإنشاء التعليمات البرمجية الأساسية (قد تحتاج إلى تحديث دليل المشروع للخروج)
5. قم بتوسيع الكود الأساسي وفقًا للأعمال
6. قم بتكوين ملف تكوين بيئة التطوير application-dev.properties ، وابدأ المشروع، واستمتع!

اقتراحات التطوير

• بالنسبة لأسماء الجداول، يوصى باستخدام الأحرف الصغيرة واستخدام الشرطة السفلية لضم كلمات متعددة معًا.
• من المستحسن أن تتوافق متغيرات الأعضاء في النموذج مع عدد حقول الجدول. إذا كنت بحاجة إلى توسيع متغيرات الأعضاء (مثل استعلامات الجدول المتصلة)، فمن المستحسن إنشاء DTO. وإلا، فستحتاج إلى إضافة @Transient تعليق توضيحي @Transient لمتغيرات الأعضاء الموسعة للحصول على التفاصيل، راجع الوثائق العامة للمكونات الإضافية لـ Mapper.
• يوصى بطرح فشل الخدمة مباشرة باستخدام ServiceException("message") ، وسيقوم معالج الاستثناء الموحد بتغليف نتيجة الاستجابة لفشل العمل، مثل throw new ServiceException("该手机号已被注册") ، والذي سيتم يتم تغليفه مباشرة كـ {"code":400,"message":"该手机号已被注册"} ، لا حاجة للتعامل معه بنفسك، فقط قم برميه بقدر ما تريد
• إذا كنت بحاجة إلى فئات أدوات، فمن المستحسن العثور عليها من apache-commons-* و guava أولاً. ليست هناك حاجة حقًا إلى إعادة اختراع العجلة أو تقديم مكتبات الفئات، ومحاولة تبسيط المشروع قدر الإمكان.
• يوصى بمواصفات التطوير لمتابعة دليل تطوير Java Java (تنزيل أحدث إصدار)
• يوصى باستخدام ShowDoc وSpringFox-Swagger2 وRAP وغيرها من المشاريع مفتوحة المصدر داخل الشركة لكتابة وإدارة مستندات API

اختيار التكنولوجيا والتوثيق

• Spring Boot (عرض دليل تعلم واستخدام Spring Boot)
• MyBatis (عرض الوثائق الصينية الرسمية)
• المكون الإضافي MyBatisb Universal Mapper (راجع الوثائق الصينية الرسمية)
• المكون الإضافي للترحيل MyBatis PageHelper (راجع الوثائق الصينية الرسمية)
• Druid Spring Boot Starter (انظر الوثائق الصينية الرسمية)
• Fastjson (انظر الوثائق الصينية الرسمية)
• البعض الآخر قليلا

رخصة

لا شيء، مشاركة مفتوحة المصدر تمامًا، شكرًا لكم جميعًا في Star & Fork على دعمكم.