Prinsip Kod Bersih yang digunakan untuk pembangunan Java

Gunakan penamaan yang bermakna: pembolehubah seperti Int DaysSincemodification; kaedah seperti getUserrolesByUserName () untuk menjadikan niat kod jelas; 2. Fungsi hendaklah kecil dan hanya melakukan satu perkara: contohnya, createUser () dibahagikan kepada kaedah tanggungjawab tunggal seperti validateRequest () dan maptouser (); 3. Kurangkan komen dan tulis kod tafsiran diri: Gunakan UserHasPrivileGedAccess () bukannya komen berlebihan; 4. Mengendalikan kesilapan dengan elegan: Jangan mengabaikan pengecualian, gunakan sumber-sumber cuba untuk mengurus sumber secara automatik; 5. Ikuti "Peraturan Pengakap Boy": Mengoptimumkan nama -nama yang berubah -ubah, ekstrak logik pendua, padamkan kod yang tidak berguna, dan terus meningkatkan kualiti kod.

Menulis Kod Bersih bukan sekadar membuat kerja kod Java anda - ini mengenai menjadikannya boleh dibaca, boleh dikekalkan, dan berskala supaya pemaju lain (atau masa depan anda) dapat memahaminya dengan cepat dan memperluaskannya dengan yakin. Begini bagaimana prinsip kod bersih teras diterjemahkan terus ke dalam pembangunan Java praktikal:

1. Nama Bermakna (Pembolehubah, Kaedah, Kelas)

Di Jawa, pembolehubah yang kurang bernama seperti int d; atau List a; memaksa orang lain untuk meneka apa yang dilakukannya. Sebaliknya:

• Gunakan nama-nama yang menata niat: int daysSinceModification; , List<user> activeUsers;</user>
• Elakkan nama generik seperti data , manager , atau processor kecuali konteksnya jelas.
• Nama kaedah harus dibaca seperti kata kerja: calculateTotal() , validateEmail() , bukan doStuff() atau processInput() .

? Contoh :
Bukannya:

 Senarai awam <string> get (string s) {...}

Lakukan:

 Senarai Awam <string> getUserRolesByUserName (String username) {...}

2. Fungsi harus kecil dan melakukan satu perkara

Kaedah Java sesuai dengan satu skrin dan mempunyai tanggungjawab tunggal. Jika anda melihat pelbagai tahap abstraksi (misalnya, membaca dari pembalakan respons pemformatan DB), kaedah ekstrak .

✅ Bagus:

 Pengguna awam CreateUser (permintaan CreateUserRequest) {
    validateRequest (permintaan);
    Pengguna Pengguna = MAPTOUSER (Permintaan);
    kembali userrepository.save (pengguna);
}

Setiap kaedah pembantu ( validateRequest , mapToUser ) melakukan satu perkara yang jelas - dan kaedah utama berbunyi seperti cerita.

3. Kurangkan Komen-Tulis Kod Dokumen Sendiri

Komen sering berbohong atau menjadi ketinggalan zaman. Di Java, lebih suka kod ekspresif melalui komen penjelasan:

• Ganti // Check if user is active dengan if (user.isActive())
• Gunakan kaedah peribadi untuk menjelaskan logik dan bukannya komen sebaris.

? Elakkan:

 // Sekiranya peranan pengguna adalah admin atau pengurus, biarkan akses
jika ("admin" .equals (peranan) || "pengurus" .equals (peranan)) {...}

✅ Lebih baik:

 jika (userHasPrivileGedAccess (peranan)) {...}

userHasPrivileDAccess UserHasPrivileDAccess (Peranan String) {
    kembali "admin" .equals (peranan) || "Pengurus" .equals (peranan);
}

4. Mengendalikan kesilapan dengan anggun - jangan abaikan pengecualian

Pengecualian yang diperiksa Java memaksa anda untuk memikirkan pengendalian ralat - gunakannya untuk kelebihan anda:

• Tidak pernah catch (Exception e) {} - Kegagalan senyap adalah pepijat yang menunggu untuk berlaku.
• Buang pengecualian adat yang bermakna apabila diperlukan:

   Buang New UsernotFoundException ("Pengguna dengan id" userId "tidak dijumpai");

• Gunakan Try-With-Resources untuk pembersihan automatik:

   cuba (FileInputStream fis = FileInputStream baru (fail)) {
    // Auto-closed
  }

  ---

  5. Ikuti Peraturan Pengakap Boy: Tinggalkan Kod lebih baik daripada anda menjumpainya

  Setiap kali anda menyentuh kod Java - sama ada menetapkan pepijat atau menambah ciri - meningkatkan kejelasannya:

  • Namakan semula pembolehubah yang mengelirukan
  • Ekstrak Logik Dugaan ke dalam kaedah yang boleh diguna semula
  • Keluarkan import yang tidak digunakan atau kod mati ( // TODO: itu berumur 3 tahun?)

  Ini bukan hanya kebersihan - ia menghalang hutang teknikal dari bola salji.

  ---

  Bottom line : Kod Java Bersih terasa jelas. Ia tidak mengejutkan anda. Ia menghormati masa - milik anda dan orang lain. Prinsip -prinsip ini tidak teori - mereka tabiat harian yang menjadikan pasukan anda lebih cepat dan sistem anda lebih mantap. Mulakan Kecil: Lain kali anda menulis kaedah, tanya: "Adakah dev yang lain memahami ini dalam masa 6 bulan?" Jika tidak, reflektor.

  Itulah bagaimana kod bersih menjadi budaya - bukan hanya kod.

  Atas ialah kandungan terperinci Prinsip Kod Bersih yang digunakan untuk pembangunan Java. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!