Conoscere e seguire gli standard e le migliori pratiche del settore è molto importante in qualsiasi campo, e specialmente nella programmazione con il suo mix complesso e talvolta caotico di linguaggi di programmazione, strumenti, approcci e tecnologie. Ecco perché un programmatore Java professionista dovrebbe avere familiarità con le convenzioni di codifica Java, di cui parleremo oggi.
Cosa sono le convenzioni di codifica?
Le convenzioni di codifica sono insiemi di linee guida per ogni specifico linguaggio di programmazione con raccomandazioni su diversi aspetti dello sviluppo del software in questo linguaggio, inclusi lo stile di codifica, le migliori pratiche e i metodi. Le convenzioni di codifica devono essere seguite dai programmatori di software che codificano in questo linguaggio come guide di qualità per garantire che il loro codice sia leggibile e che sia possibile la corretta manutenzione del software da parte di altre persone. Le convenzioni di codifica normalmente coprono ogni componente essenziale della creazione di software in questo linguaggio di programmazione, inclusi organizzazione dei file, indentazione, commenti, dichiarazioni, dichiarazioni, spazi bianchi, convenzioni di denominazione, pratiche di programmazione, principi di programmazione, regole empiriche di programmazione, best practice architettoniche e altro .
Qual è lo scopo delle convenzioni di codifica?
Ci sono una serie di ragioni per cui le convenzioni di codifica svolgono un ruolo importante nello sviluppo del software.
Mantenere uno stile di codice unificato
Seguire una convenzione di codifica consente di scrivere il progetto software in un unico stile unificato, il che è vantaggioso in molti modi diversi come il seguente.
Ridurre al minimo i costi di manutenzione del software
Uno dei più importanti è semplificare la manutenzione e il supporto del prodotto software, poiché molto spesso gli autori originali del programma non sono quelli che lo supportano. Questo è importante poiché l'80% del costo a vita di un software va alla manutenzione.
Miglioramento della leggibilità del software
Il miglioramento della leggibilità del software è un altro grande vantaggio, che ha anche molteplici implicazioni come semplificare l'introduzione di nuovi sviluppatori al progetto e aumentare l'efficienza della collaborazione dei membri del team di sviluppo.
Velocizzare il lavoro
Infine, avere un codice scritto e strutturato correttamente è necessario affinché il processo di sviluppo del software proceda il più velocemente possibile.
La Code Convention di Oracle è riconosciuta come la più importante per una serie di ovvie ragioni: la convenzione di Oracle è quella ufficiale in quanto Oracle è proprietaria di Java, nonché una delle più antiche (l'ultima revisione di questo documento è stata fatta il 20 aprile, 1999). Alcune delle parti importanti della Convenzione sul codice Java di Oracle sarebbero la raccomandazione di utilizzare camel case quando si definiscono classi, metodi o variabili, di iniziare le classi con una lettera maiuscola e di utilizzare nomi per denominarle, mentre si utilizzano verbi in forma imperativa e iniziano da una lettera minuscola per i metodi e così via.
La guida di stile Java di Google
Le convenzioni di codifica Java di Google sono considerate importanti a causa dello status di Google come azienda tecnologica e Internet di apprendimento con un'enorme esperienza nello sviluppo di tutti i tipi di applicazioni Java. Un altro motivo importante è il fatto che la convenzione del codice Java di Google è stata aggiornata il 22 maggio 2018, il che la rende più rilevante della convenzione del codice di Oracle, soprattutto quando si tratta di descrivere funzionalità relativamente nuove di Java che sono state rilasciate solo come parte di Java 8 nel 2014, come lambda e stream. Ecco come gli autori della Java Style Guide di Google descrivono il contenuto di questa convenzione di codifica: “Questo documento funge da definizione completa degli standard di codifica di Google per il codice sorgente in Java. Come altre guide di stile di programmazione, le questioni trattate abbracciano non solo questioni estetiche di formattazione, ma anche altri tipi di convenzioni o standard di codifica. Tuttavia, questo documento si concentra principalmente sulle regole ferree che seguiamo universalmente ed evita di fornire consigli che non sono chiaramente applicabili (sia da parte dell'uomo che da uno strumento)." “La Google Java Style Guide è per la maggior parte un buon riferimento, ma è un po' permissiva su alcuni argomenti. D'altra parte, come programmatore Java devi essere abituato a 4 spazi per l'indentazione del codice, tra le altre cose", ha affermato David Rios, architetto del software ed esperto programmatore Java, in un LinkedIn ma è un po' permissivo su alcuni argomenti. D'altra parte, come programmatore Java devi essere abituato a 4 spazi per l'indentazione del codice, tra le altre cose", ha affermato David Rios, architetto del software ed esperto programmatore Java, in un LinkedIn ma è un po' permissivo su alcuni argomenti. D'altra parte, come programmatore Java devi essere abituato a 4 spazi per l'indentazione del codice, tra le altre cose", ha affermato David Rios, architetto del software ed esperto programmatore Java, in un LinkedInpost con alcuni adattamenti proposti alla Google Java Style Guide.
Standard di codifica Java più utilizzati
Ecco alcuni degli standard di codifica Java più utilizzati che possono essere trovati nelle convenzioni di codifica sopra menzionate di Oracle e Google, nonché altri documenti di questo tipo.
Seguire la corretta convenzione di denominazione;
Aggiungi commenti;
Identificatore indica un nome simbolico che fa riferimento al nome di classi, pacchetti, metodi e variabili in un programma Java;
Il nome della variabile dovrebbe essere correlato al suo scopo;
Il nome del metodo deve essere correlato alla funzionalità del metodo;
Il metodo non deve contenere più di 50 righe;
Non dovrebbe esserci codice duplicato nella stessa classe o in un'altra classe;
Dichiarare le variabili globali solo se necessario da usare negli altri metodi;
Ricontrolla la creazione di variabili statiche all'interno di una classe;
Evita di accedere alle variabili direttamente da altre classi, usa invece i metodi getter e setter;
Tutta la logica aziendale deve essere gestita solo nella classe di servizio;
Tutto il codice relativo al DB dovrebbe trovarsi solo nelle classi DAO;
Usa getter e setter;
Dichiara la variabile di istanza come privata;
Mantenere minimo l'ambito delle variabili;
Assegnare nomi significativi alle variabili;
Evita le perdite di memoria rilasciando le connessioni al database quando l'interrogazione è completa;
Cerca di usare il blocco Finalmente il più spesso possibile;
Usa il framework Executor per la programmazione multithread.
GO TO FULL VERSION