konvensyen penamaan

1. [Mandatori] Nama dalam kod tidak boleh bermula dengan garis bawah atau tanda dolar, dan juga tidak boleh diakhiri dengan garis bawah atau tanda dolar.

Contoh pembilang: _name / __name / $Object / name_ / name$ / Object$

2 [Mandatori] Dilarang sama sekali menggunakan campuran Pinyin dan Inggeris untuk penamaan dalam kod, dan ia. tidak dibenarkan menggunakan bahasa Cina secara langsung.

Arahan: Ejaan dan tatabahasa Bahasa Inggeris yang betul boleh memudahkan pembaca memahami dan mengelakkan kekaburan. Ambil perhatian bahawa walaupun kaedah penamaan pinyin tulen harus dielakkan.

Contoh kaunter: DaZhePromotion [Diskaun] / getPingfenByName() [Rating] / int A pembolehubah = 3

Contoh positif: nama alibaba / taos/hangbao yang lain dan anda boleh dihormati sama seperti bahasa Inggeris.

3 [Mandatori] Nama kelas mesti menggunakan gaya UpperCamelCase dan mesti mengikut kes unta, dengan pengecualian berikut: (penamaan berkaitan model domain) DO / BO / DTO / VO, dsb.

Contoh positif: Pembolehubah MarcoPolo / UserDO / ahli, pembolehubah setempat Mereka semua menggunakan gaya lowerCamelCase secara seragam dan mesti mengikut format sarung unta. . tidak berpuas hati dengan nama panjang.

Contoh positif: MAX _ STOCK _ COUNT

Contoh pembilang: MAX _ COUNT

6 Nama kelas abstrak bermula dengan Abstrak atau Nama kelas pengecualian; dinamakan dengannya Bermula dengan nama kelas untuk diuji dan berakhir dengan Ujian. .

8. [Mandatori] Jangan tambah adalah pada pembolehubah jenis Boolean dalam kelas POJO, jika tidak, beberapa penghuraian rangka kerja akan menyebabkan ralat bersiri.

Contoh pembilang: ditakrifkan sebagai atribut jenis data asas boolean isSuccess; dan kaedahnya juga isSuccess() Apabila rangka kerja RPC menghuraikan secara terbalik, nama atribut yang sepadan dengan "untuk" ialah kejayaan, menghasilkan atribut tidak diperolehi Kemudian buang pengecualian

biasa.

9. [Mandatori] Nama pakej mesti menggunakan huruf kecil, dan mesti ada satu dan hanya satu perkataan Inggeris dengan semantik semula jadi antara pemisah titik. Nama pakej sentiasa menggunakan bentuk tunggal, tetapi jika nama kelas mempunyai makna jamak, nama kelas boleh menggunakan bentuk jamak.

Contoh Positif: Pakej Kelas Alat Aplikasi Dinamakan. singkatan yang tidak teratur sama sekali, untuk mengelakkan kehilangan makna teks. Contoh pembilang:

"Singkatan" AbstractClass dinamakan AbsClass; "singkatan" syarat dinamakan condi

Singkatan sewenang-wenangnya mengurangkan kebolehbacaan kod.

11 [Cadangan] Jika corak reka bentuk digunakan, adalah disyorkan untuk menggambarkan corak tertentu dalam nama kelas. Penjelasan:

Mencerminkan corak reka bentuk dalam nama akan membantu pembaca memahami idea reka bentuk seni bina dengan cepat.

Contoh positif: OrderFactory kelas awam

Proxy Masuk kelas awam

ResourceObserver kelas awam

12 ), simpan Kod ini ringkas dan digabungkan dengan ulasan Javadoc yang berkesan. Cuba untuk tidak menentukan pembolehubah dalam antara muka Jika anda mesti menentukan pembolehubah, ia mesti berkaitan dengan kaedah antara muka dan merupakan pemalar asas untuk keseluruhan aplikasi. . ;

Penjelasan:

Antara muka dalam JDK 8 membenarkan pelaksanaan lalai, jadi kaedah lalai ini ialah pelaksanaan lalai yang berharga untuk semua kelas pelaksanaan. 13 Terdapat dua set peraturan untuk menamakan antara muka dan kelas pelaksanaan:

1) [Mandatori] Untuk kelas Perkhidmatan dan DAO, berdasarkan konsep SOA, perkhidmatan yang terdedah mestilah antara muka, dan kelas pelaksanaan dalaman. gunakan Impl. Perbezaan antara akhiran dan antara muka.

Contoh positif:

CacheServiceImpl melaksanakan antara muka CacheService.

2) [Cadangan] Jika ia adalah nama antara muka yang menerangkan keupayaan, gunakan kata sifat yang sepadan sebagai nama antara muka (biasanya dalam bentuk – mampu).

Contoh positif: Penterjemah Abstrak melaksanakan Terjemahan.

14 [Rujukan] Adalah disyorkan untuk menambah akhiran Enum pada nama kelas enumerasi Nama ahli enumerasi perlu dalam semua huruf besar, dan perkataan hendaklah dipisahkan dengan garis bawah.

Penjelasan: Enumerasi sebenarnya ialah kelas pemalar khas, dan pembina dipaksa untuk menjadi peribadi secara lalai.

Contoh positif: Nama enumerasi: DealStatusEnum, nama ahli: SUCCESS / UNKOWN _ REASON.

15. [Rujukan] Konvensyen penamaan setiap lapisan:

A) Konvensyen penamaan kaedah lapisan Perkhidmatan / DAO

1) Kaedah untuk mendapatkan objek tunggal diawali dengan get.

2) Kaedah untuk mendapatkan berbilang objek diawali dengan senarai.

3) Kaedah mendapatkan nilai statistik didahulukan dengan kiraan.

4) Kaedah sisipan diawali dengan simpan (disyorkan) atau sisipan.

5) Kaedah pemadaman diawali dengan keluarkan (disyorkan) atau padam.

6) Kaedah pengubahsuaian diawali dengan kemas kini.

B) Konvensyen penamaan model domain

1) Objek data: xxxDO, xxx ialah nama jadual data.

2) Objek pemindahan data: xxxDTO, xxx ialah nama yang berkaitan dengan bidang perniagaan.

3) Objek paparan: xxxVO, xxx secara amnya ialah nama halaman web.

4) POJO ialah nama kolektif DO / DTO / BO / VO, dan dilarang menamakannya sebagai xxxPOJO.