Konvensyen Pengekodan Java. Mana Yang Perlu Diikuti dan Mengapa

Mengetahui dan mengikuti piawaian industri dan amalan terbaik adalah agak penting dalam apa jua bidang, dan terutamanya dalam pengaturcaraan dengan gabungan bahasa pengekodan, alatan, pendekatan dan teknologi yang kompleks dan kadangkala huru-hara. Itulah sebabnya seorang pengaturcara Java profesional harus mahir dengan Konvensyen Pengekodan Java, itulah yang akan kita bincangkan hari ini.

Apakah konvensyen pengekodan?

Konvensyen pengekodan ialah set garis panduan untuk setiap bahasa pengaturcaraan khusus dengan pengesyoran tentang aspek pembangunan perisian yang berbeza dalam bahasa ini, termasuk gaya pengekodan, amalan terbaik dan kaedah. Konvensyen pengekodan dimaksudkan untuk diikuti oleh pengaturcara perisian yang mengekod dalam bahasa ini sebagai panduan kualiti untuk memastikan kod mereka boleh dibaca dan penyelenggaraan perisian yang betul oleh orang lain adalah mungkin. Konvensyen pengekodan biasanya merangkumi setiap komponen penting untuk membuat perisian dalam bahasa pengaturcaraan ini, termasuk organisasi fail, lekukan, ulasan, pengisytiharan, penyataan, ruang kosong, konvensyen penamaan, amalan pengaturcaraan, prinsip pengaturcaraan, peraturan asas pengaturcaraan, amalan terbaik seni bina dan banyak lagi .

Apakah tujuan konvensyen pengekodan?

Terdapat beberapa sebab mengapa konvensyen pengekodan memainkan peranan penting dalam pembangunan perisian.

• Mengekalkan gaya kod bersatu

Mengikuti konvensyen pengekodan membolehkan projek perisian ditulis dalam gaya bersatu tunggal, yang bermanfaat dalam beberapa cara berbeza seperti berikut.

• Meminimumkan kos penyelenggaraan perisian

Salah satu yang paling penting ialah menjadikannya lebih mudah untuk menyelenggara dan menyokong produk perisian, kerana selalunya pengarang asal program tersebut bukanlah mereka yang menyokongnya. Ini penting kerana 80% daripada kos seumur hidup sekeping perisian pergi ke penyelenggaraan.

• Meningkatkan kebolehbacaan perisian

Peningkatan kebolehbacaan perisian adalah satu lagi faedah utama, yang juga mempunyai pelbagai implikasi seperti memudahkan pengenalan pembangun baharu kepada projek dan meningkatkan kecekapan kerjasama ahli pasukan pembangunan.

• Mempercepatkan kerja

Akhir sekali, mempunyai kod bertulis dan berstruktur dengan betul adalah perlu untuk proses pembangunan perisian berjalan secepat mungkin.

Konvensyen Pengekodan Java

Apabila bercakap tentang Java, terdapat dua konvensyen pengekodan yang paling biasa dan terkenal: Konvensyen Kod Java Oracle dan konvensyen pengekodan Panduan Gaya Java Google .

• Konvensyen Kod Java Oracle

Konvensyen Kod Oracle diiktiraf sebagai yang paling penting atas beberapa sebab yang jelas: Konvensyen Oracle ialah konvensyen rasmi kerana Oracle ialah pemilik Java, serta salah satu yang tertua (semakan terakhir dokumen ini dibuat pada 20 April, 1999). Beberapa bahagian penting dalam Konvensyen Kod Java Oracle ialah cadangan untuk menggunakan kes unta apabila mentakrifkan kelas, kaedah atau pembolehubah, untuk memulakan kelas dengan huruf besar dan menggunakan kata nama untuk menamakannya, sambil menggunakan kata kerja dalam bentuk imperatif dan permulaan. daripada huruf kecil untuk kaedah, dan sebagainya.

• Panduan Gaya Java Google

Konvensyen pengekodan Java daripada Google dianggap penting kerana status Google sebagai syarikat Internet dan teknologi pembelajaran yang mempunyai pengalaman besar dalam membangunkan semua jenis aplikasi Java. Satu lagi sebab penting ialah hakikat bahawa konvensyen kod Java Google telah dikemas kini pada 22 Mei 2018, yang menjadikannya lebih relevan daripada konvensyen kod dari Oracle, terutamanya apabila ia menerangkan ciri Java yang agak baharu yang hanya dikeluarkan sebagai sebahagian Java 8 pada tahun 2014, seperti lambdas dan strim. Begini cara pengarang Panduan Gaya Java Google menerangkan kandungan konvensyen pengekodan ini: “Dokumen ini berfungsi sebagai takrifan lengkap piawaian pengekodan Google untuk kod sumber dalam Java. Seperti panduan gaya pengaturcaraan lain, isu-isu yang diliputi merangkumi bukan sahaja isu estetik pemformatan, tetapi jenis konvensyen atau piawai pengekodan lain juga. Walau bagaimanapun, dokumen ini tertumpu terutamanya pada peraturan keras dan pantas yang kami patuhi secara universal, dan mengelak daripada memberi nasihat yang tidak boleh dikuatkuasakan dengan jelas (sama ada oleh manusia atau alat).” “Panduan Gaya Java Google adalah rujukan yang baik untuk sebahagian besar, tetapi ia sedikit permisif pada beberapa topik. Sebaliknya, sebagai pengaturcara Java anda mesti digunakan dengan 4 ruang untuk lekukan kod, antara lain,” kata David Rios, seorang arkitek perisian dan pengaturcara Java berpengalaman, dalam LinkedIn tetapi ia sedikit permisif pada beberapa topik. Sebaliknya, sebagai pengaturcara Java anda mesti digunakan dengan 4 ruang untuk lekukan kod, antara lain,” kata David Rios, seorang arkitek perisian dan pengaturcara Java berpengalaman, dalam LinkedIn tetapi ia sedikit permisif pada beberapa topik. Sebaliknya, sebagai pengaturcara Java anda mesti digunakan dengan 4 ruang untuk lekukan kod, antara lain,” kata David Rios, seorang arkitek perisian dan pengaturcara Java berpengalaman, dalam LinkedInsiaran dengan beberapa cadangan penyesuaian kepada Panduan Gaya Google Java miliknya sendiri.

Piawaian pengekodan Java yang paling banyak digunakan

Berikut ialah beberapa piawaian pengekodan Java yang paling banyak digunakan yang boleh didapati dalam konvensyen pengekodan yang disebutkan di atas daripada Oracle dan Google, serta dokumen lain seperti ini.

• Ikuti konvensyen penamaan yang betul;
• Tambah komen;
• Pengecam bermaksud nama simbolik yang merujuk kepada nama kelas, pakej, kaedah dan pembolehubah dalam program Java;
• Nama pembolehubah harus berkaitan dengan tujuannya;
• Nama kaedah hendaklah berkaitan dengan kefungsian kaedah;
• Kaedah tidak boleh mengandungi lebih daripada 50 baris;
• Seharusnya tiada kod Pendua dalam kelas yang sama atau kelas lain;
• Isytiharkan pembolehubah global hanya jika perlu untuk digunakan dalam kaedah lain;
• Semak semula penciptaan pembolehubah statik di dalam kelas;
• Elakkan daripada mengakses pembolehubah terus daripada kelas lain sebaliknya gunakan kaedah pengambil dan penetap;
• Semua logik perniagaan harus dikendalikan dalam kelas perkhidmatan sahaja;
• Semua kod berkaitan DB hendaklah dalam kelas DAO sahaja;
• Gunakan getter dan setter;
• Istiharkan contoh Pembolehubah sebagai peribadi;
• Pastikan skop pembolehubah minimum;
• Berikan nama yang bermakna kepada pembolehubah;
• Elakkan kebocoran memori dengan melepaskan sambungan pangkalan data apabila pertanyaan selesai;
• Cuba gunakan Akhirnya blok sekerap mungkin;
• Gunakan rangka kerja Pelaksana untuk pengaturcaraan berbilang benang.