Hello semua, komuniti JavaRush! Hari ini kita akan bercakap tentang kualiti kod. Ya, ya, kawan-kawan yang dikasihi. Tiada sesiapa yang sempurna. Setiap orang suatu hari nanti akan memahami bahawa kod itu boleh menjadi lebih baik... Tetapi apakah yang perlu dilakukan dalam situasi ini? Sekurang-kurangnya, mula meneliti isu ini. Memandangkan anda berada di sini, ini bermakna topik itu menarik untuk anda, jadi mari pergi. Hari ini kami akan menerangkan cara anda boleh menjadikan kod anda lebih baik dan lebih bersih. Supaya pada masa hadapan anda tidak akan malu dengan kod semasa anda!..)) Semua kaedah ini akan membantu pengaturcara menjadi pengaturcara yang baik.
1. Jika anda ingin menambah baik kod anda, baca kod orang lain
Jika anda ingin meningkatkan kemahiran pengaturcaraan anda secara mendadak, anda perlu... membaca kod yang ditulis oleh pengaturcara lain. Anda boleh percaya padanya, anda tidak boleh percaya. Tetapi jika anda mengambil risiko, saya berjanji akan ada ganjaran untuk masa anda. Sebagai contoh, jangan baca di Habré bagaimana HashMap, ArrayList, LinkedList dan sebagainya berfungsi, tetapi baca kod mereka dan fikirkan sendiri. Berikut adalah senarai kelas untuk dibaca:
HashMap ialah soalan yang paling kerap ditanya dalam temu bual. Anda boleh membunuh beberapa burung dengan satu batu: fahami kod dan dapatkan pengetahuan yang diperlukan.
ArrayList adalah kes yang sama seperti HashMap. Tidak ada perkara yang rumit di sana, tetapi ia benar-benar berbaloi untuk dibaca dan difahami.
String adalah contoh yang bagus. Fahami mengapa ia tidak berubah.
AtomicInteger ialah kelas yang hebat: ia menerangkan proses cara melaksanakan operasi secara atom pada objek Integer.
Dan kemudian - sekurang-kurangnya semua kelas berturut-turut...)
Jika kita bercakap tentang sesuatu yang lebih serius, sudah tentu, ia patut membaca kod daripada Pivotal. Mereka ini menulis ekosistem yang paling dicari di dunia Jawa. Kod mereka pasti bernilai dibaca. Oleh itu, saya menasihati anda untuk bermula dengan Spring Core . Membaca kod sumber yang tidak dikenali adalah kerja yang mencabar tetapi sangat bermanfaat.)
2. Ikuti Konvensyen Kod - konvensyen untuk menulis kod
Konvensyen pengekodan ialah satu set garis panduan yang dibangunkan oleh pasukan pembangunan yang merangkumi garis panduan untuk gaya dan teknik pengaturcaraan untuk setiap aspek kod yang ditulis dalam syarikat atau projek tertentu. Konvensyen ini biasanya khusus untuk setiap bahasa pengaturcaraan dan meliputi organisasi fail, lekukan, ulasan, pengisytiharan, pengendali, ruang kosong, konvensyen penamaan, teknik dan prinsip pengaturcaraan, peraturan pengaturcaraan, amalan terbaik seni bina, dll. Faedah utama piawaian tertentu ialah bahawa kod itu kelihatan sama dan ditulis dalam gaya yang sama. Ini menjadikannya lebih mudah dibaca dan membantu pengaturcara memahami kod yang ditulis oleh pengaturcara lain. Jika piawaian pengekodan diikuti dan digunakan secara konsisten sepanjang proses pembangunan, adalah lebih mudah untuk mengekalkan dan melanjutkan kod, memfaktorkannya semula dan menyelesaikan konflik penyepaduan pada masa hadapan. Konvensyen pengekodan adalah penting kepada pengaturcara atas beberapa sebab:
40%-80% daripada kos perisian dibelanjakan untuk penyelenggaraannya;
hampir tidak ada perisian yang diselenggarakan oleh pengarang sepanjang hayatnya;
Konvensyen kod meningkatkan kebolehbacaan perisian, membolehkan pengaturcara memahami kod baharu dengan lebih cepat.
Sejujurnya, saya peminat tegar piawaian pengekodan. Bagi saya, masuk akal untuk meluangkan masa berbincang dan berhujah tentang mereka, kerana ia adalah aktiviti berharga yang akan menjimatkan masa dan usaha anda pada masa hadapan. Kod Konvensyen harus disemak dengan kerap. Peraturan boleh diterjemahkan daripada "wajib" kepada "pilihan" dan sebaliknya. Jika sesetengah daripada mereka tidak berfungsi dengan betul, mereka perlu direka bentuk semula atau dialih keluar daripada garis panduan.
3. Gunakan Semakan Kod - semakan kod oleh orang lain
Semakan kod ialah salah satu alat yang paling berkuasa untuk menambah baik kod. kenapa? Kerana kod itu akan dilihat oleh pakar yang tidak menulisnya. Dan penampilan yang segar sangat berguna. Dan selalunya Semakan Kod yang membantu menghalang penulisan kod yang benar-benar mengerikan. Saya tahu bahawa ini tidak selalu mungkin kerana anda perlu mencari orang lain yang mahu melakukan ini. Tetapi ini tidak bermakna alat ini tidak berbaloi untuk digunakan. Sebaliknya: ini adalah sebab untuk mencari orang yang berfikiran sama yang juga penting untuk meningkatkan kualiti kod. Ngomong-ngomong, siapa yang melarang anda mencari mereka di sini di JavaRush? Di tempat di mana semua orang mahu menjadi seorang pengaturcara.
4. Tulis Ujian Unit – ujian unit
Setakat ini kaedah kegemaran saya untuk menambah baik kod ialah menulis ujian unit. Lebih-lebih lagi, lebih banyak anda menulisnya, lebih baik. Dalam pengaturcaraan komputer, ujian unit ialah proses pembangunan perisian di mana bahagian kod sumber yang boleh diuji terkecil, dipanggil unit, diuji secara individu dan bebas untuk memeriksa sama ada ia berfungsi seperti yang diharapkan. Ini akan membantu anda mengenal pasti kegagalan dalam algoritma dan/atau logik sebelum mengeluarkan kod. Memandangkan ujian unit memerlukan struktur kod anda yang sesuai, ini bermakna kod mesti dibahagikan kepada fungsi yang lebih kecil dan lebih fokus. Setiap daripadanya bertanggungjawab untuk operasi tunggal pada set data, dan bukannya fungsi besar yang melaksanakan beberapa operasi yang berbeza. (Seperti yang mereka katakan, helo dari Prinsip Tanggungjawab Tunggal ...) Faedah kedua menulis kod yang diuji dengan baik ialah anda boleh menghalang kegagalan masa hadapan pada perubahan kecil pada fungsi pecah kod sedia ada. Apabila kegagalan berlaku, ujian unit akan memberitahu anda bahawa sesuatu telah ditulis dengan tidak betul. Pada pandangan pertama, menghabiskan masa menulis ujian unit semasa pembangunan kelihatan seperti perbelanjaan tambahan. Walau bagaimanapun, ini akan menjimatkan masa pada masa hadapan, yang perlu dibelanjakan untuk penyahpepijatan. Ini sepatutnya menjadi proses langkah demi langkah. Oleh itu, teruskan dan nyanyi - tulis ujian untuk semua kaedah dan kelas :D
5. Gunakan alatan untuk meningkatkan kualiti kod
Tidak ada pembangun yang tidak pernah melakukan kesilapan. Biasanya pengkompil akan menangkap masalah sintaks dan aritmetik dan mengeluarkan jejak tindanan. Tetapi mungkin masih terdapat beberapa masalah yang tidak dapat ditangkap oleh pengkompil. Contohnya, keperluan yang tidak dilaksanakan dengan betul, algoritma yang salah, struktur kod yang salah atau beberapa masalah yang mungkin diketahui oleh komuniti daripada pengalaman. Satu-satunya cara untuk menangkap ralat tersebut adalah dengan meminta beberapa pembangun kanan menyemak kod anda. Pendekatan ini bukanlah ubat penawar dan sedikit perubahan. Dengan setiap pembangun baharu dalam pasukan, anda sepatutnya mempunyai sepasang mata tambahan untuk melihat kodnya. Tetapi mujurlah, terdapat banyak alat yang boleh membantu anda mengawal kualiti kod anda. Saya menggunakan Checkstyle, PMD, FindBugs, SonarQube dalam kerja saya pada pelbagai projek. Ada yang lain juga. Kesemuanya biasanya digunakan untuk analisis kualiti dan menghasilkan beberapa laporan yang berguna. Selalunya laporan ini diterbitkan oleh pelayan penyepaduan berterusan seperti Jenkins.
6. Tulis kod yang mudah dan jelas
Sentiasa tulis kod yang mudah, jelas dan logik. Orang ramai cenderung untuk menulis kod kompleks untuk membuktikan keupayaan mereka melakukannya. Kod yang ringkas tetapi logik sentiasa berfungsi dengan baik, menghasilkan lebih sedikit masalah dan lebih boleh diperluaskan. Kod yang baik bermakna dokumentasi yang lebih baik. Jika anda berfikir untuk menambah ulasan, tanya diri anda: “ Bagaimanakah saya boleh menambah baik kod supaya ulasan ini tidak diperlukan? " ~Steve McConnell.
7. Baca dokumentasi
Salah satu tabiat penting pengaturcara yang baik ialah membaca banyak dokumentasi. Biarkan ia menjadi spesifikasi, JSR, dokumen API, tutorial, dsb. Membaca dokumen membantu anda membina asas yang kukuh di mana anda memprogramkan dengan terbaik. Akhir sekali, jangan bandingkan diri anda dengan orang lain.Membandingkan diri anda dengan orang lain hanya akan membawa kepada perasaan negatif dan persaingan yang tidak sihat. Setiap orang ada kekuatan dan kelemahan masing-masing. Oleh itu, adalah penting untuk mengenali mereka dan bekerjasama dengan mereka. Analisis diri anda, senaraikan kekuatan anda dan usahakannya. Pengaturcaraan sangat menyeronokkan: nikmatinya.
"Pemalar seorang lelaki adalah pembolehubah lelaki lain."
8. Ikuti blogger yang menarik
Terdapat beribu-ribu peminat di seluruh dunia bekerja dan menulis tentang teknologi yang sama. Blog selalunya ditulis oleh pengaturcara sendiri, dan kebanyakannya berkongsi pendapat dan pengalaman peribadi. Anda boleh melihat perspektif berbeza teknologi yang sama pada blog. Anda boleh melihat teknologi baik dan buruk di blog. Sekurang-kurangnya, baca artikel tentang Habré JavaRush :D, termasuk saya. Ikuti blog yang bagus dan komen pada siaran, kongsi pendapat anda.
9. Baca buku khusus
Tiada apa yang boleh menggantikan buku yang bagus. Buku yang bagus akan mengajar konsep asas dengan cara yang lebih mudah dan digunakan pada objek dunia sebenar. Pengarang mereka sendiri adalah pengaturcara yang hebat. Dengan membaca buku, anda boleh belajar daripada pengalaman orang lain. Saya cadangkan membaca “Java. Pengaturcaraan Berkesan oleh Joshua Bloch. Buku ini membentangkan tujuh puluh lapan peraturan praktikal pengaturcara yang tidak boleh diganti: bekerja, penyelesaian terbaik untuk masalah pengaturcaraan yang anda hadapi setiap hari. Ia mengandungi garis panduan paling praktikal dan berwibawa yang boleh anda gunakan untuk menulis program yang berkesan dan direka bentuk dengan baik. Jika anda baru bermula dengan Java dan tidak mempunyai pengalaman pengaturcaraan, anda mungkin mahu membaca Sams Teach Yourself Java 2 dalam 24 Jam. Dan untuk menulis kod bersih, terdapat buku yang sangat baik "Kod Bersih oleh Robert Martin". Selepas itu, "perasaan cantik" akan muncul berhubung dengan kod tersebut.
10. Kod! Kod! Kod!
Anda tidak boleh menjadi seorang pengaturcara yang baik hanya dengan menghafal buku. Mudah untuk bercakap tentang konsep teori. Tetapi anda hanya boleh mempelajari had bahasa atau membangunkan amalan terbaik apabila anda menulis kod. Oleh itu, untuk menjadi seorang pengaturcara yang baik, anda perlu menulis banyak kod. Jika anda seorang pemula, mulakan dengan menulis program untuk masalah mudah seperti siri Fibonacci, palindrom, segitiga Pascal, dll. dan kemudian beralih kepada masalah yang lebih besar seperti pepohon carian binari, dll. Jika anda sedang mencari platform dalam talian untuk mempraktikkan program Java, lihat di Coding Ground . Lebih-lebih lagi, anda boleh mengikuti kursus CS50 , terjemahan yang diberikan kepada kami oleh "anda tahu siapa" :D
Mari kita ringkaskan
Orang yang tidak melakukan apa-apa tidak melakukan kesilapan. Oleh itu, kita mesti bersabar dan, seperti orang Jepun yang rajin, kita mengasah kemahiran pengekodan kita. Untuk ini, jangan lupa:
Jika anda ingin meningkatkan kemahiran pengaturcaraan anda secara mendadak, anda perlu... membaca kod yang ditulis oleh pengaturcara lain. Anda boleh percaya padanya, anda tidak boleh percaya. Tetapi jika anda mengambil risiko, saya berjanji akan ada ganjaran untuk masa anda. Sebagai contoh, jangan baca di Habré bagaimana HashMap, ArrayList, LinkedList dan sebagainya berfungsi, tetapi baca kod mereka dan fikirkan sendiri. Berikut adalah senarai kelas untuk dibaca:
Konvensyen pengekodan ialah satu set garis panduan yang dibangunkan oleh pasukan pembangunan yang merangkumi garis panduan untuk gaya dan teknik pengaturcaraan untuk setiap aspek kod yang ditulis dalam syarikat atau projek tertentu. Konvensyen ini biasanya khusus untuk setiap bahasa pengaturcaraan dan meliputi organisasi fail, lekukan, ulasan, pengisytiharan, pengendali, ruang kosong, konvensyen penamaan, teknik dan prinsip pengaturcaraan, peraturan pengaturcaraan, amalan terbaik seni bina, dll. Faedah utama piawaian tertentu ialah bahawa kod itu kelihatan sama dan ditulis dalam gaya yang sama. Ini menjadikannya lebih mudah dibaca dan membantu pengaturcara memahami kod yang ditulis oleh pengaturcara lain. Jika piawaian pengekodan diikuti dan digunakan secara konsisten sepanjang proses pembangunan, adalah lebih mudah untuk mengekalkan dan melanjutkan kod, memfaktorkannya semula dan menyelesaikan konflik penyepaduan pada masa hadapan. Konvensyen pengekodan adalah penting kepada pengaturcara atas beberapa sebab:
kenapa? Kerana kod itu akan dilihat oleh pakar yang tidak menulisnya. Dan penampilan yang segar sangat berguna. Dan selalunya Semakan Kod yang membantu menghalang penulisan kod yang benar-benar mengerikan. Saya tahu bahawa ini tidak selalu mungkin kerana anda perlu mencari orang lain yang mahu melakukan ini. Tetapi ini tidak bermakna alat ini tidak berbaloi untuk digunakan. Sebaliknya: ini adalah sebab untuk mencari orang yang berfikiran sama yang juga penting untuk meningkatkan kualiti kod. Ngomong-ngomong, siapa yang melarang anda mencari mereka di sini di JavaRush? Di tempat di mana semua orang mahu menjadi seorang pengaturcara.
Setakat ini kaedah kegemaran saya untuk menambah baik kod ialah menulis ujian unit. Lebih-lebih lagi, lebih banyak anda menulisnya, lebih baik. Dalam pengaturcaraan komputer, ujian unit ialah proses pembangunan perisian di mana bahagian kod sumber yang boleh diuji terkecil, dipanggil unit, diuji secara individu dan bebas untuk memeriksa sama ada ia berfungsi seperti yang diharapkan. Ini akan membantu anda mengenal pasti kegagalan dalam algoritma dan/atau logik sebelum mengeluarkan kod. Memandangkan ujian unit memerlukan struktur kod anda yang sesuai, ini bermakna kod mesti dibahagikan kepada fungsi yang lebih kecil dan lebih fokus. Setiap daripadanya bertanggungjawab untuk operasi tunggal pada set data, dan bukannya fungsi besar yang melaksanakan beberapa operasi yang berbeza. (Seperti yang mereka katakan, helo dari Prinsip Tanggungjawab Tunggal ...) Faedah kedua menulis kod yang diuji dengan baik ialah anda boleh menghalang kegagalan masa hadapan pada perubahan kecil pada fungsi pecah kod sedia ada. Apabila kegagalan berlaku, ujian unit akan memberitahu anda bahawa sesuatu telah ditulis dengan tidak betul. Pada pandangan pertama, menghabiskan masa menulis ujian unit semasa pembangunan kelihatan seperti perbelanjaan tambahan. Walau bagaimanapun, ini akan menjimatkan masa pada masa hadapan, yang perlu dibelanjakan untuk penyahpepijatan. Ini sepatutnya menjadi proses langkah demi langkah. Oleh itu, teruskan dan nyanyi - tulis ujian untuk semua kaedah dan kelas :D
Tidak ada pembangun yang tidak pernah melakukan kesilapan. Biasanya pengkompil akan menangkap masalah sintaks dan aritmetik dan mengeluarkan jejak tindanan. Tetapi mungkin masih terdapat beberapa masalah yang tidak dapat ditangkap oleh pengkompil. Contohnya, keperluan yang tidak dilaksanakan dengan betul, algoritma yang salah, struktur kod yang salah atau beberapa masalah yang mungkin diketahui oleh komuniti daripada pengalaman. Satu-satunya cara untuk menangkap ralat tersebut adalah dengan meminta beberapa pembangun kanan menyemak kod anda. Pendekatan ini bukanlah ubat penawar dan sedikit perubahan. Dengan setiap pembangun baharu dalam pasukan, anda sepatutnya mempunyai sepasang mata tambahan untuk melihat kodnya. Tetapi mujurlah, terdapat banyak alat yang boleh membantu anda mengawal kualiti kod anda. Saya menggunakan Checkstyle, PMD, FindBugs, SonarQube dalam kerja saya pada pelbagai projek. Ada yang lain juga. Kesemuanya biasanya digunakan untuk analisis kualiti dan menghasilkan beberapa laporan yang berguna. Selalunya laporan ini diterbitkan oleh pelayan penyepaduan berterusan seperti Jenkins.
Sentiasa tulis kod yang mudah, jelas dan logik. Orang ramai cenderung untuk menulis kod kompleks untuk membuktikan keupayaan mereka melakukannya. Kod yang ringkas tetapi logik sentiasa berfungsi dengan baik, menghasilkan lebih sedikit masalah dan lebih boleh diperluaskan. Kod yang baik bermakna dokumentasi yang lebih baik. Jika anda berfikir untuk menambah ulasan, tanya diri anda: “ Bagaimanakah saya boleh menambah baik kod supaya ulasan ini tidak diperlukan? " ~Steve McConnell.
Salah satu tabiat penting pengaturcara yang baik ialah membaca banyak dokumentasi. Biarkan ia menjadi spesifikasi, JSR, dokumen API, tutorial, dsb. Membaca dokumen membantu anda membina asas yang kukuh di mana anda memprogramkan dengan terbaik. Akhir sekali, jangan bandingkan diri anda dengan orang lain.Membandingkan diri anda dengan orang lain hanya akan membawa kepada perasaan negatif dan persaingan yang tidak sihat. Setiap orang ada kekuatan dan kelemahan masing-masing. Oleh itu, adalah penting untuk mengenali mereka dan bekerjasama dengan mereka. Analisis diri anda, senaraikan kekuatan anda dan usahakannya. Pengaturcaraan sangat menyeronokkan: nikmatinya.
Terdapat beribu-ribu peminat di seluruh dunia bekerja dan menulis tentang teknologi yang sama. Blog selalunya ditulis oleh pengaturcara sendiri, dan kebanyakannya berkongsi pendapat dan pengalaman peribadi. Anda boleh melihat perspektif berbeza teknologi yang sama pada blog. Anda boleh melihat teknologi baik dan buruk di blog. Sekurang-kurangnya, baca artikel tentang 
Tiada apa yang boleh menggantikan buku yang bagus. Buku yang bagus akan mengajar konsep asas dengan cara yang lebih mudah dan digunakan pada objek dunia sebenar. Pengarang mereka sendiri adalah pengaturcara yang hebat. Dengan membaca buku, anda boleh belajar daripada pengalaman orang lain. Saya cadangkan membaca “Java. Pengaturcaraan Berkesan oleh Joshua Bloch. Buku ini membentangkan tujuh puluh lapan peraturan praktikal pengaturcara yang tidak boleh diganti: bekerja, penyelesaian terbaik untuk masalah pengaturcaraan yang anda hadapi setiap hari. Ia mengandungi garis panduan paling praktikal dan berwibawa yang boleh anda gunakan untuk menulis program yang berkesan dan direka bentuk dengan baik. Jika anda baru bermula dengan Java dan tidak mempunyai pengalaman pengaturcaraan, anda mungkin mahu membaca Sams Teach Yourself Java 2 dalam 24 Jam. Dan untuk menulis kod bersih, terdapat buku yang sangat baik "Kod Bersih oleh Robert Martin". Selepas itu, "perasaan cantik" akan muncul berhubung dengan kod tersebut.
Mudah untuk bercakap tentang konsep teori. Tetapi anda hanya boleh mempelajari had bahasa atau membangunkan amalan terbaik apabila anda menulis kod. Oleh itu, untuk menjadi seorang pengaturcara yang baik, anda perlu menulis banyak kod. Jika anda seorang pemula, mulakan dengan menulis program untuk masalah mudah seperti siri Fibonacci, palindrom, segitiga Pascal, dll. dan kemudian beralih kepada masalah yang lebih besar seperti pepohon carian binari, dll. Jika anda sedang mencari platform dalam talian untuk mempraktikkan program Java, lihat di Coding Ground . Lebih-lebih lagi, anda boleh mengikuti kursus CS50 , terjemahan yang diberikan kepada kami oleh "anda tahu siapa" :D
GO TO FULL VERSION