spring boot api project seed

Perkenalan

Spring Boot API Project Seed adalah proyek awal berdasarkan Spring Boot & MyBatis. Ini digunakan untuk membangun proyek API kecil dan menengah serta RESTful API dengan cepat. Proyek awal ini telah dipraktikkan di banyak proyek nyata cepat, memungkinkan kami menyingkirkan tugas-tugas berulang tersebut, fokus pada penulisan kode bisnis dan kurangi waktu lembur. Berikut ini adalah demonstrasi penggunaan sederhana untuk melihat cara mengimplementasikan API sederhana hanya dalam beberapa puluh detik berdasarkan proyek ini dan menjalankannya untuk menyediakan layanan.

Fitur & Penawaran

• Struktur proyek praktik terbaik, file konfigurasi, POM yang disederhanakan (lihat diagram struktur proyek)
• Alat pengemasan dan pembuatan hasil respons terpadu
• Penanganan pengecualian terpadu
• Otentikasi tanda tangan antarmuka sederhana
• Enkapsulasi abstrak dari metode dasar yang umum digunakan
• Gunakan Druid Spring Boot Starter untuk mengintegrasikan kumpulan koneksi dan pemantauan database Druid
• Gunakan FastJsonHttpMessageConverter untuk meningkatkan kecepatan serialisasi JSON
• Integrasikan MyBatis, plug-in Mapper universal, dan plug-in paging PageHelper untuk mencapai nol SQL untuk bisnis tabel tunggal
• Generator kode disediakan untuk menghasilkan kode dasar yang sesuai seperti Model, Mapper, MapperXML, Service, ServiceImpl, dan Controller berdasarkan nama tabel. Template Controller menyediakan dua set POST dan RESTful secara default. Anda dapat memilih sesuai dengan kebutuhan Anda dalam metode CodeGenerator.genController(tableName) Template POST digunakan secara default. Templat kode dapat diperluas sesuai dengan kebutuhan proyek sebenarnya. Karena bisnis setiap perusahaan berbeda, kami hanya menyediakan beberapa templat yang relatif mendasar dan umum. Tujuan utamanya adalah untuk memberikan ide untuk mengurangi penulisan kode yang berulang dalam proyek sebenarnya. I Saat digunakan, sejumlah besar template sebenarnya ditulis berdasarkan abstraksi bisnis perusahaan. Selain itu, penggunaan template juga dapat membantu menjaga gaya pengkodean tim tetap terpadu.
• Ada juga telur Paskah yang menunggu untuk Anda jelajahi

mulai cepat

1. Proyek klon
2. Konfigurasikan pembuat kode CodeGenerator dalam paket test , terutama JDBC, karena kode perlu dibuat berdasarkan nama tabel
3. Jika Anda hanya ingin mencobanya sendiri berdasarkan demonstrasi di atas, Anda dapat menggunakan demo-user.sql di direktori test resources , jika tidak abaikan langkah ini
4. Masukkan nama tabel, jalankan metode CodeGenerator.main() untuk menghasilkan kode dasar (Anda mungkin perlu menyegarkan direktori proyek untuk keluar)
5. Perluas kode dasar sesuai dengan bisnisnya
6. Konfigurasikan file konfigurasi lingkungan pengembangan application-dev.properties , mulai proyek, Selamat Bersenang-senang!

Saran pengembangan

• Untuk nama tabel, disarankan menggunakan huruf kecil. Gunakan garis bawah untuk menggabungkan beberapa kata.
• Disarankan agar variabel anggota dalam Model sesuai dengan jumlah bidang tabel. Jika Anda perlu memperluas variabel anggota (seperti menghubungkan kueri tabel), disarankan untuk membuat @Transient . Anotasi @Transient pada variabel anggota yang diperluas. Untuk detailnya, lihat dokumentasi plug-in Mapper umum.
• Direkomendasikan agar kegagalan layanan dilempar secara langsung menggunakan ServiceException("message") , dan pemroses pengecualian terpadu akan merangkum hasil respons dari kegagalan bisnis, seperti throw new ServiceException("该手机号已被注册") , yang akan langsung dienkapsulasi sebagai {"code":400,"message":"该手机号已被注册"} kembali, tidak perlu tangani sendiri, cukup buang sebanyak yang Anda mau
• Jika Anda memerlukan kelas alat, disarankan untuk menemukannya dari apache-commons-* dan guava terlebih dahulu. Tidak perlu menemukan kembali roda atau memperkenalkan perpustakaan kelas.
• Spesifikasi pengembangan disarankan untuk mengikuti Alibaba Java Development Manual (unduh versi terbaru)
• Disarankan untuk menggunakan ShowDoc, SpringFox-Swagger2, RAP dan proyek sumber terbuka lainnya dalam perusahaan untuk menulis dan mengelola dokumen API

Seleksi & Dokumentasi Teknologi

• Spring Boot (Lihat Panduan Pembelajaran & Penggunaan Spring Boot)
• MyBatis (lihat dokumentasi resmi berbahasa Mandarin)
• Plug-in Mapper universal MyBatisb (lihat dokumentasi resmi berbahasa Mandarin)
• Plug-in paging MyBatis PageHelper (lihat dokumentasi resmi berbahasa Mandarin)
• Druid Spring Boot Starter (lihat dokumentasi resmi berbahasa Mandarin)
• Fastjson (lihat dokumentasi resmi Tiongkok)
• Lainnya sedikit

Lisensi

Tidak ada, murni berbagi sumber terbuka, terima kasih semua Star & Fork atas dukungan Anda.