Ciao a tutti, comunità JavaRush! Oggi parleremo della qualità del codice. Sì, sì, cari amici. Nessuno è perfetto. Tutti prima o poi si rendono conto che il codice potrebbe essere migliore... Ma cosa fare in questa situazione? Per lo meno, inizia a fare ricerche su questo problema. Dato che sei qui, significa che l'argomento ti interessa, quindi andiamo. Oggi descriveremo i modi in cui puoi rendere il tuo codice migliore e più pulito. In modo che in futuro non ti vergogni del tuo codice attuale!..)) Tutti questi metodi aiuteranno il programmatore a diventare un buon programmatore.
1. Se vuoi migliorare il tuo codice, leggi il codice di qualcun altro
Se vuoi migliorare notevolmente le tue capacità di programmazione, devi... leggere il codice scritto da altri programmatori. Puoi crederci, non puoi crederci. Ma se corri il rischio, ti prometto che ci sarà una ricompensa per il tuo tempo. Ad esempio, non leggere su Habré come funzionano HashMap, ArrayList, LinkedList e così via, ma leggi il loro codice e capiscilo da solo. Ecco un elenco di lezioni da leggere:
HashMap è la domanda più frequente nelle interviste. Puoi prendere più piccioni con una fava: comprendere il codice e acquisire le conoscenze necessarie.
ArrayList è lo stesso caso di HashMap. Non ci sono cose complicate lì, ma vale davvero la pena leggerlo e comprenderlo.
String è un ottimo esempio. Comprendi perché è immutabile.
AtomicInteger è una classe interessante: descrive il processo su come eseguire operazioni atomicamente su oggetti Integer.
E poi - almeno tutte le lezioni di seguito...)
Se parliamo di qualcosa di più serio, ovviamente, vale la pena leggere il codice di Pivotal. Questi ragazzi hanno scritto l'ecosistema più ricercato nel mondo Java. Vale sicuramente la pena leggere il loro codice. Pertanto, ti consiglio di iniziare con Spring Core . Leggere un codice sorgente sconosciuto è un lavoro impegnativo ma molto gratificante.)
2. Seguire le convenzioni del codice: convenzioni per la scrittura del codice
Le convenzioni di codifica sono un insieme di linee guida sviluppate dai team di sviluppo che includono linee guida per lo stile e le tecniche di programmazione per ogni aspetto del codice scritto all'interno di un'azienda o di un progetto specifico. Queste convenzioni sono tipicamente specifiche per ciascun linguaggio di programmazione e riguardano l'organizzazione dei file, i rientri, i commenti, le dichiarazioni, gli operatori, gli spazi bianchi, le convenzioni di denominazione, le tecniche e i principi di programmazione, le regole di programmazione, le migliori pratiche architetturali, ecc. Il vantaggio principale di alcuni standard è che il codice sembra lo stesso ed è scritto nello stesso stile. Ciò lo rende più leggibile e aiuta i programmatori a comprendere il codice scritto da un altro programmatore. Se gli standard di codifica vengono seguiti e applicati in modo coerente durante tutto il processo di sviluppo, sarà più semplice mantenere ed estendere il codice, rifattorizzarlo e risolvere i conflitti di integrazione in futuro. Le convenzioni di codifica sono importanti per i programmatori per una serie di motivi:
Il 40%-80% del costo del software viene speso per la sua manutenzione;
quasi nessun software viene mantenuto dall'autore per tutta la sua vita;
Le convenzioni del codice migliorano la leggibilità del software, consentendo ai programmatori di comprendere il nuovo codice più rapidamente.
Ad essere sincero, sono un grande fan degli standard di codifica. Per me ha senso dedicare del tempo a discuterne e discutere su di essi, poiché è un’attività preziosa che ti farà risparmiare tempo e fatica in futuro. Le convenzioni del codice dovrebbero essere riviste frequentemente. Le regole possono essere tradotte da “obbligatorie” a “facoltative” e viceversa. Se alcuni di essi non funzionano correttamente, devono essere riprogettati o rimossi dalle linee guida.
3. Utilizzare Code Review: revisione del codice da parte di altri
La revisione del codice è uno degli strumenti più potenti per migliorare il codice. Perché? Perché il codice verrà esaminato da quegli specialisti che non lo hanno scritto. E un aspetto fresco è molto utile. E spesso è Code Review che aiuta a prevenire la scrittura di codice francamente terribile. So che questo non è sempre possibile, perché devi trovare un'altra persona che vorrebbe farlo. Ma ciò non significa che non valga la pena utilizzare questo strumento. Al contrario: questo è un motivo per trovare persone che la pensano allo stesso modo per le quali è importante anche migliorare la qualità del codice. A proposito, chi ti vieta di trovarli qui su JavaRush? In un posto dove tutti vogliono diventare programmatori.
4. Scrivi unit test: test unitari
Di gran lunga il mio metodo preferito per migliorare il codice è scrivere unit test. Inoltre, più li scrivi, meglio è. Nella programmazione informatica, il test unitario è un processo di sviluppo software in cui la più piccola parte testabile del codice sorgente, chiamata unità, viene testata individualmente e indipendentemente per verificare se funziona come previsto. Ciò ti aiuterà a identificare gli errori negli algoritmi e/o nella logica prima di rilasciare il codice. Poiché il test unitario richiede la struttura appropriata del codice, significa che il codice deve essere suddiviso in funzioni più piccole e più mirate. Ognuno dei quali è responsabile di una singola operazione su un insieme di dati, piuttosto che di grandi funzioni che eseguono una serie di operazioni diverse (come si suol dire, ciao dal principio di responsabilità unica ...) Il secondo vantaggio di scrivere codice ben testato è che puoi prevenire futuri errori su piccole modifiche alla funzionalità di interruzione del codice esistente. Quando si verifica un errore, i test unitari ti diranno che qualcosa è stato scritto in modo errato. A prima vista, dedicare tempo alla scrittura di unit test durante lo sviluppo sembra una spesa aggiuntiva. Tuttavia, ciò consentirà di risparmiare tempo in futuro, che dovrà essere dedicato al debug. Questo dovrebbe essere un processo graduale. Pertanto, vai avanti e canta: scrivi test per tutti i metodi e le classi: D
5. Utilizza strumenti per migliorare la qualità del codice
Non esiste uno sviluppatore che non commetta mai errori. In genere il compilatore rileva problemi di sintassi e aritmetici e genera un'analisi dello stack. Ma potrebbero esserci ancora alcuni problemi che il compilatore non rileva. Ad esempio, requisiti implementati in modo improprio, algoritmi errati, struttura del codice errata o alcuni potenziali problemi noti alla comunità per esperienza. L'unico modo per individuare tali errori è chiedere ad uno sviluppatore senior di rivedere il tuo codice. Questo approccio non è una panacea e cambia poco. Con ogni nuovo sviluppatore nel team, dovresti avere un paio di occhi in più che guardano il suo codice. Fortunatamente, esistono molti strumenti che possono aiutarti a controllare la qualità del tuo codice. Ho usato Checkstyle, PMD, FindBugs, SonarQube nel mio lavoro su vari progetti. Ce ne sono anche altri. Tutti sono comunemente utilizzati per l'analisi della qualità e per generare alcuni report utili. Molto spesso questi report vengono pubblicati da server di integrazione continua come Jenkins.
6. Scrivi un codice semplice e chiaro
Scrivi sempre un codice semplice, chiaro e logico. Le persone tendono a scrivere codici complessi per dimostrare la propria capacità di farlo. Il codice semplice ma logico funziona sempre bene, comporta meno problemi ed è più estensibile. Un buon codice significa una migliore documentazione. Se stai pensando di aggiungere un commento, chiediti: “ Come posso migliorare il codice in modo che questo commento non sia necessario? "~Steve McConnell.
7. Leggi la documentazione
Una delle abitudini importanti dei bravi programmatori è leggere molta documentazione. Lascia che si tratti di specifiche, JSR, documenti API, tutorial, ecc. Leggere i documenti ti aiuta a costruire quelle solide basi su cui programmare meglio. Ultimo ma non meno importante, non paragonarti agli altri: il confronto con gli altri porterà solo a sentimenti negativi e ad una competizione malsana. Ognuno ha i propri punti di forza e di debolezza. Pertanto è importante conoscerli e lavorare con loro. Analizza te stesso, elenca i tuoi punti di forza e lavora su di essi. Programmare è davvero divertente: divertiti.
“La costante di un uomo è la variabile di un altro uomo.”
8. Segui blogger interessanti
Ci sono migliaia di appassionati in tutto il mondo che lavorano e scrivono sulle stesse tecnologie. I blog sono spesso scritti dagli stessi programmatori e la maggior parte di essi condivide opinioni ed esperienze personali. Puoi vedere diverse prospettive della stessa tecnologia sui blog. Sui blog puoi vedere sia la tecnologia buona che quella cattiva. Come minimo, leggi articoli su Habré JavaRush :D, compreso il mio. Segui buoni blog e commenta i post, condividi la tua opinione.
9. Leggi libri specializzati
Niente può sostituire un buon libro. Un buon libro insegnerà i concetti di base in un modo molto più semplice e si applicherà agli oggetti del mondo reale. I loro autori sono essi stessi grandi programmatori. Leggendo libri puoi imparare dalle esperienze degli altri. Suggerisco di leggere “Java. Programmazione efficace di Joshua Bloch. Questo libro presenta settantotto regole empiriche insostituibili per i programmatori: soluzioni efficaci e migliori per i problemi di programmazione che affronti ogni giorno. Contiene le linee guida più pratiche e autorevoli che puoi utilizzare per scrivere programmi efficaci e ben progettati. Se hai appena iniziato con Java e non hai esperienza di programmazione, puoi leggere il libro "Sams Teach Yourself Java 2 in 24 Hours". E per scrivere codice pulito, c'è un ottimo libro “Clean Code by Robert Martin”. Successivamente apparirà una “sensazione di bellezza” in relazione al codice.
10. Codice! Codice! Codice!
Non puoi diventare un buon programmatore semplicemente memorizzando un libro. È facile parlare di concetti teorici. Ma puoi apprendere i limiti del linguaggio o sviluppare best practice solo quando scrivi codice. Pertanto, per diventare un buon programmatore, devi scrivere molto codice. Se sei un principiante, inizia scrivendo programmi per problemi semplici come la serie di Fibonacci, il palindromo, il triangolo di Pascal, ecc. e poi passa a problemi più grandi come l'albero di ricerca binario, ecc. Se stai cercando una piattaforma online per esercitarti con i programmi Java, dai un'occhiata a Coding Ground . Inoltre, puoi seguire il corso CS50 , la cui traduzione ci è stata fornita da “tu sai chi” :D
Riassumiamo
Chi non fa nulla non commette errori. Pertanto, dobbiamo essere pazienti e, come un giapponese laborioso, affinare le nostre capacità di programmazione. Per questo, non dimenticare:
Se vuoi migliorare notevolmente le tue capacità di programmazione, devi... leggere il codice scritto da altri programmatori. Puoi crederci, non puoi crederci. Ma se corri il rischio, ti prometto che ci sarà una ricompensa per il tuo tempo. Ad esempio, non leggere su Habré come funzionano HashMap, ArrayList, LinkedList e così via, ma leggi il loro codice e capiscilo da solo. Ecco un elenco di lezioni da leggere:
Le convenzioni di codifica sono un insieme di linee guida sviluppate dai team di sviluppo che includono linee guida per lo stile e le tecniche di programmazione per ogni aspetto del codice scritto all'interno di un'azienda o di un progetto specifico. Queste convenzioni sono tipicamente specifiche per ciascun linguaggio di programmazione e riguardano l'organizzazione dei file, i rientri, i commenti, le dichiarazioni, gli operatori, gli spazi bianchi, le convenzioni di denominazione, le tecniche e i principi di programmazione, le regole di programmazione, le migliori pratiche architetturali, ecc. Il vantaggio principale di alcuni standard è che il codice sembra lo stesso ed è scritto nello stesso stile. Ciò lo rende più leggibile e aiuta i programmatori a comprendere il codice scritto da un altro programmatore. Se gli standard di codifica vengono seguiti e applicati in modo coerente durante tutto il processo di sviluppo, sarà più semplice mantenere ed estendere il codice, rifattorizzarlo e risolvere i conflitti di integrazione in futuro. Le convenzioni di codifica sono importanti per i programmatori per una serie di motivi:
Perché? Perché il codice verrà esaminato da quegli specialisti che non lo hanno scritto. E un aspetto fresco è molto utile. E spesso è Code Review che aiuta a prevenire la scrittura di codice francamente terribile. So che questo non è sempre possibile, perché devi trovare un'altra persona che vorrebbe farlo. Ma ciò non significa che non valga la pena utilizzare questo strumento. Al contrario: questo è un motivo per trovare persone che la pensano allo stesso modo per le quali è importante anche migliorare la qualità del codice. A proposito, chi ti vieta di trovarli qui su JavaRush? In un posto dove tutti vogliono diventare programmatori.
Di gran lunga il mio metodo preferito per migliorare il codice è scrivere unit test. Inoltre, più li scrivi, meglio è. Nella programmazione informatica, il test unitario è un processo di sviluppo software in cui la più piccola parte testabile del codice sorgente, chiamata unità, viene testata individualmente e indipendentemente per verificare se funziona come previsto. Ciò ti aiuterà a identificare gli errori negli algoritmi e/o nella logica prima di rilasciare il codice. Poiché il test unitario richiede la struttura appropriata del codice, significa che il codice deve essere suddiviso in funzioni più piccole e più mirate. Ognuno dei quali è responsabile di una singola operazione su un insieme di dati, piuttosto che di grandi funzioni che eseguono una serie di operazioni diverse (come si suol dire, ciao dal principio di responsabilità unica ...) Il secondo vantaggio di scrivere codice ben testato è che puoi prevenire futuri errori su piccole modifiche alla funzionalità di interruzione del codice esistente. Quando si verifica un errore, i test unitari ti diranno che qualcosa è stato scritto in modo errato. A prima vista, dedicare tempo alla scrittura di unit test durante lo sviluppo sembra una spesa aggiuntiva. Tuttavia, ciò consentirà di risparmiare tempo in futuro, che dovrà essere dedicato al debug. Questo dovrebbe essere un processo graduale. Pertanto, vai avanti e canta: scrivi test per tutti i metodi e le classi: D
Non esiste uno sviluppatore che non commetta mai errori. In genere il compilatore rileva problemi di sintassi e aritmetici e genera un'analisi dello stack. Ma potrebbero esserci ancora alcuni problemi che il compilatore non rileva. Ad esempio, requisiti implementati in modo improprio, algoritmi errati, struttura del codice errata o alcuni potenziali problemi noti alla comunità per esperienza. L'unico modo per individuare tali errori è chiedere ad uno sviluppatore senior di rivedere il tuo codice. Questo approccio non è una panacea e cambia poco. Con ogni nuovo sviluppatore nel team, dovresti avere un paio di occhi in più che guardano il suo codice. Fortunatamente, esistono molti strumenti che possono aiutarti a controllare la qualità del tuo codice. Ho usato Checkstyle, PMD, FindBugs, SonarQube nel mio lavoro su vari progetti. Ce ne sono anche altri. Tutti sono comunemente utilizzati per l'analisi della qualità e per generare alcuni report utili. Molto spesso questi report vengono pubblicati da server di integrazione continua come Jenkins.
Scrivi sempre un codice semplice, chiaro e logico. Le persone tendono a scrivere codici complessi per dimostrare la propria capacità di farlo. Il codice semplice ma logico funziona sempre bene, comporta meno problemi ed è più estensibile. Un buon codice significa una migliore documentazione. Se stai pensando di aggiungere un commento, chiediti: “ Come posso migliorare il codice in modo che questo commento non sia necessario? "~Steve McConnell.
Una delle abitudini importanti dei bravi programmatori è leggere molta documentazione. Lascia che si tratti di specifiche, JSR, documenti API, tutorial, ecc. Leggere i documenti ti aiuta a costruire quelle solide basi su cui programmare meglio. Ultimo ma non meno importante, non paragonarti agli altri: il confronto con gli altri porterà solo a sentimenti negativi e ad una competizione malsana. Ognuno ha i propri punti di forza e di debolezza. Pertanto è importante conoscerli e lavorare con loro. Analizza te stesso, elenca i tuoi punti di forza e lavora su di essi. Programmare è davvero divertente: divertiti.
Ci sono migliaia di appassionati in tutto il mondo che lavorano e scrivono sulle stesse tecnologie. I blog sono spesso scritti dagli stessi programmatori e la maggior parte di essi condivide opinioni ed esperienze personali. Puoi vedere diverse prospettive della stessa tecnologia sui blog. Sui blog puoi vedere sia la tecnologia buona che quella cattiva. Come minimo, leggi articoli su 
Niente può sostituire un buon libro. Un buon libro insegnerà i concetti di base in un modo molto più semplice e si applicherà agli oggetti del mondo reale. I loro autori sono essi stessi grandi programmatori. Leggendo libri puoi imparare dalle esperienze degli altri. Suggerisco di leggere “Java. Programmazione efficace di Joshua Bloch. Questo libro presenta settantotto regole empiriche insostituibili per i programmatori: soluzioni efficaci e migliori per i problemi di programmazione che affronti ogni giorno. Contiene le linee guida più pratiche e autorevoli che puoi utilizzare per scrivere programmi efficaci e ben progettati. Se hai appena iniziato con Java e non hai esperienza di programmazione, puoi leggere il libro "Sams Teach Yourself Java 2 in 24 Hours". E per scrivere codice pulito, c'è un ottimo libro “Clean Code by Robert Martin”. Successivamente apparirà una “sensazione di bellezza” in relazione al codice.
È facile parlare di concetti teorici. Ma puoi apprendere i limiti del linguaggio o sviluppare best practice solo quando scrivi codice. Pertanto, per diventare un buon programmatore, devi scrivere molto codice. Se sei un principiante, inizia scrivendo programmi per problemi semplici come la serie di Fibonacci, il palindromo, il triangolo di Pascal, ecc. e poi passa a problemi più grandi come l'albero di ricerca binario, ecc. Se stai cercando una piattaforma online per esercitarti con i programmi Java, dai un'occhiata a Coding Ground . Inoltre, puoi seguire il corso CS50 , la cui traduzione ci è stata fornita da “tu sai chi” :D
GO TO FULL VERSION