At kende og følge industristandarder og bedste praksis er ret vigtigt inden for ethvert felt, og især inden for programmering med dets komplekse og til tider kaotiske blanding af kodningssprog, værktøjer, tilgange og teknologier. Derfor bør en professionel Java-programmør være godt bekendt med Java Coding Conventions, hvilket er det, vi skal tale om i dag.
Hvad er kodningskonventioner?
Kodningskonventioner er sæt retningslinjer for hvert specifikt programmeringssprog med anbefalinger om forskellige aspekter af softwareudvikling på dette sprog, herunder kodningsstil, bedste praksis og metoder. Kodningskonventioner er beregnet til at blive fulgt af softwareprogrammører, der koder på dette sprog som kvalitetsguider for at sikre, at deres kode er læsbar, og at andre menneskers korrekte vedligeholdelse af softwaren er mulig. Kodningskonventioner dækker normalt alle væsentlige komponenter i at lave software i dette programmeringssprog, herunder filorganisering, indrykning, kommentarer, erklæringer, erklæringer, hvidt mellemrum, navnekonventioner, programmeringspraksis, programmeringsprincipper, programmering tommelfingerregler, arkitektonisk bedste praksis og mere .
Hvad er formålet med kodning af konventioner?
Der er en række grunde til, at kodningskonventioner spiller en vigtig rolle i softwareudvikling.
Opretholdelse af ensartet kodestil
Ved at følge en kodningskonvention kan softwareprojektet skrives i en enkelt samlet stil, hvilket er fordelagtigt på flere forskellige måder, såsom følgende.
Minimering af omkostninger til softwarevedligeholdelse
En af de vigtigste er at gøre det nemmere at vedligeholde og understøtte softwareproduktet, da de oprindelige forfattere af programmet meget ofte ikke er dem, der understøtter det. Dette er vigtigt, da 80 % af levetidsomkostningerne for et stykke software går til vedligeholdelse.
Forbedring af softwarelæsbarhed
Forbedringen af softwarelæsbarheden er en anden stor fordel, som også har flere implikationer, såsom at forenkle introduktionen af nye udviklere til projektet og øge effektiviteten af samarbejdet mellem udviklingsteamets medlemmer.
Fremskynde arbejdet
Endelig er det nødvendigt at have korrekt skrevet og struktureret kode for at softwareudviklingsprocessen kan gå så hurtigt som muligt.
Oracles kodekonvention er anerkendt som den vigtigste af en række åbenlyse grunde: Oracles konvention er den officielle, da Oracle er ejeren af Java, såvel som en af de ældste (den sidste revision af dette dokument blev lavet den 20. april, 1999). Nogle af de vigtige dele af Oracle's Java Code Convention ville være anbefalingen om at bruge kamel-case, når man definerer klasser, metoder eller variabler, at starte klasser med et stort bogstav og bruge navneord til at navngive dem, mens man bruger verber i imperativ form og starter fra et lille bogstav til metoder og så videre.
Googles Java Style Guide
Java-kodningskonventioner fra Google anses for at være vigtige på grund af Googles status som den lærende internet- og teknologivirksomhed med enorm erfaring i at udvikle alle slags Java-applikationer. En anden vigtig årsag er det faktum, at Googles Java-kodekonvention blev opdateret den 22. maj 2018, hvilket gør den mere relevant end kodekonventionen fra Oracle, især når det kommer til at beskrive relativt nye funktioner i Java, der kun blev udgivet som del Java 8 i 2014, såsom lambdaer og streams. Sådan beskriver forfatterne af Googles Java Style Guide indholdet af denne kodningskonvention: “Dette dokument tjener som den komplette definition af Googles kodningsstandarder for kildekode i Java. Ligesom andre programmeringsstilguider spænder de dækkede spørgsmål ikke kun over æstetiske problemer med formatering, men også andre typer konventioner eller kodningsstandarder. Dette dokument fokuserer dog primært på de hårde og hurtige regler, som vi følger universelt, og undgår at give råd, der ikke klart kan håndhæves (enten af mennesker eller værktøj). "Google Java Style Guide er for det meste en god reference, men den er lidt eftergivende på nogle emner. På den anden side skal du som Java-programmør være vant til blandt andet 4 mellemrum til kodeindrykning,” sagde David Rios, softwarearkitekt og erfaren Java-programmør, i en LinkedIn men det er lidt eftergivende på nogle emner. På den anden side skal du som Java-programmør være vant til blandt andet 4 mellemrum til kodeindrykning,” sagde David Rios, softwarearkitekt og erfaren Java-programmør, i en LinkedIn men det er lidt eftergivende på nogle emner. På den anden side skal du som Java-programmør være vant til blandt andet 4 mellemrum til kodeindrykning,” sagde David Rios, softwarearkitekt og erfaren Java-programmør, i en LinkedInindlæg med nogle foreslåede tilpasninger til sin egen Google Java Style Guide.
Mest brugte Java-kodningsstandarder
Her er nogle af de mest brugte Java-kodningsstandarder, der kan findes i de ovennævnte kodningskonventioner fra Oracle og Google, samt andre dokumenter af denne art.
Følg den korrekte navnekonvention;
Tilføj kommentarer;
Identifikator betyder et symbolsk navn, der refererer til navnet på klasser, pakker, metoder og variabler i et Java-program;
Variabelnavnet skal være relateret til dets formål;
Navnet på metoden skal relatere til metodens funktionalitet;
Metoden bør ikke indeholde mere end 50 linjer;
Der bør ikke være nogen duplikatkode i samme klasse eller anden klasse;
Erklær kun globale variabler, hvis det er nødvendigt at bruge i de andre metoder;
Dobbelttjek oprettelse af statiske variable i en klasse;
Undgå at få adgang til variabler direkte fra andre klasser, brug i stedet getter og setter metoder;
Al forretningslogik bør kun håndteres i serviceklassen;
Al DB-relateret kode bør kun være i DAO-klasserne;
Brug getters og settere;
Erklær instansvariabel som privat;
Hold omfanget af variabler minimalt;
Tildel betydningsfulde navne til variabler;
Undgå hukommelseslækager ved at frigive databaseforbindelser, når forespørgslen er fuldført;
GO TO FULL VERSION