Å kjenne til og følge bransjestandarder og beste praksis er ganske viktig på alle felt, og spesielt innen programmering med dens komplekse og noen ganger kaotiske blanding av kodespråk, verktøy, tilnærminger og teknologier. Det er derfor en profesjonell Java-programmerer bør være godt kjent med Java Coding Conventions, som er det vi skal snakke om i dag.
Hva er kodekonvensjoner?
Kodekonvensjoner er sett med retningslinjer for hvert spesifikke programmeringsspråk med anbefalinger om ulike aspekter ved programvareutvikling på dette språket, inkludert kodestil, beste praksis og metoder. Kodekonvensjoner er ment å følges av programvareprogrammerere som koder på dette språket som kvalitetsguider for å sikre at koden deres er lesbar og at andre mennesker kan vedlikeholde programvaren på riktig måte. Kodekonvensjoner dekker normalt alle essensielle komponenter ved å lage programvare i dette programmeringsspråket, inkludert filorganisering, innrykk, kommentarer, erklæringer, erklæringer, mellomrom, navnekonvensjoner, programmeringspraksis, programmeringsprinsipper, tommelfingerregler for programmering, arkitektonisk beste praksis og mer .
Hva er hensikten med å kode konvensjoner?
Det er en rekke grunner til at kodekonvensjoner spiller en viktig rolle i programvareutvikling.
Opprettholde enhetlig kodestil
Ved å følge en kodingskonvensjon kan programvareprosjektet skrives i en enkelt enhetlig stil, noe som er fordelaktig på flere forskjellige måter, for eksempel følgende.
Minimere vedlikeholdskostnader for programvare
En av de viktigste er å gjøre det enklere å vedlikeholde og støtte programvareproduktet, siden det ofte ikke er de opprinnelige forfatterne av programmet som støtter det. Dette er viktig ettersom 80 % av levetidskostnadene til et stykke programvare går til vedlikehold.
Forbedring av programvarelesbarhet
Forbedringen av programvarelesbarheten er en annen stor fordel, som også har flere implikasjoner som å forenkle introduksjonen av nye utviklere til prosjektet og øke effektiviteten i samarbeidet mellom utviklingsteammedlemmene.
Fremskynde arbeidet
Til slutt er det nødvendig å ha riktig skrevet og strukturert kode for at programvareutviklingsprosessen skal gå så raskt som mulig.
Oracles kodekonvensjon er anerkjent som den viktigste av en rekke åpenbare grunner: Oracles konvensjon er den offisielle siden Oracle er eieren av Java, så vel som en av de eldste (siste revisjon av dette dokumentet ble gjort 20. april, 1999). Noen av de viktige delene av Oracles Java Code-konvensjon vil være anbefalingen om å bruke camel case når du definerer klasser, metoder eller variabler, for å starte klasser med stor bokstav og bruke substantiv for å navngi dem, mens du bruker verb i imperativform og starter fra en liten bokstav for metoder, og så videre.
Googles Java Style Guide
Java-kodekonvensjoner fra Google anses å være viktige på grunn av Googles status som det lærende Internett- og teknologiselskapet med enorm erfaring i å utvikle alle slags Java-applikasjoner. En annen viktig årsak er det faktum at Googles Java-kodekonvensjon ble oppdatert 22. mai 2018, noe som gjør den mer relevant enn kodekonvensjonen fra Oracle, spesielt når det gjelder å beskrive relativt nye funksjoner i Java som kun ble utgitt som del Java 8 i 2014, som lambdaer og streams. Slik beskriver forfatterne av Googles Java Style Guide innholdet i denne kodekonvensjonen: «Dette dokumentet fungerer som den fullstendige definisjonen av Googles kodestandarder for kildekode i Java. Som andre programmeringsstilguider, spenner problemene som dekkes ikke bare av estetiske problemer med formatering, men også andre typer konvensjoner eller kodestandarder. Dette dokumentet fokuserer imidlertid først og fremst på de harde og raske reglene som vi følger universelt, og unngår å gi råd som ikke klart kan håndheves (enten av mennesker eller verktøy).» "Google Java Style Guide er en god referanse for det meste, men den er litt ettergivende på noen emner. På den annen side, som Java-programmerer må du være vant til 4 mellomrom for kodeinnrykk, blant annet," sa David Rios, en programvarearkitekt og erfaren Java-programmerer, i en LinkedIn men det er litt ettergivende på noen emner. På den annen side, som Java-programmerer må du være vant til 4 mellomrom for kodeinnrykk, blant annet," sa David Rios, en programvarearkitekt og erfaren Java-programmerer, i en LinkedIn men det er litt ettergivende på noen emner. På den annen side, som Java-programmerer må du være vant til 4 mellomrom for kodeinnrykk, blant annet," sa David Rios, en programvarearkitekt og erfaren Java-programmerer, i en LinkedIninnlegg med noen foreslåtte tilpasninger til sin egen Google Java Style Guide.
Mest brukte Java-kodingsstandarder
Her er noen av de mest brukte Java-kodestandardene som finnes i de ovennevnte kodekonvensjonene fra Oracle og Google, samt andre dokumenter av denne typen.
Følg riktig navnekonvensjon;
Legg til kommentarer;
Identifikator betyr et symbolsk navn som refererer til navnet på klasser, pakker, metoder og variabler i et Java-program;
Variabelnavnet skal være relatert til formålet;
Navnet på metoden skal relatere til metodens funksjonalitet;
Metoden bør ikke inneholde mer enn 50 linjer;
Det skal ikke være noen duplikatkode i samme klasse eller annen klasse;
Erklær globale variabler bare hvis det er nødvendig å bruke i de andre metodene;
Dobbeltsjekk oppretting av statiske variabler i en klasse;
Unngå tilgang til variabler direkte fra andre klasser, bruk i stedet getter- og settermetoder;
All forretningslogikk skal kun håndteres i tjenesteklassen;
All DB-relatert kode skal bare være i DAO-klassene;
Bruk gettere og settere;
Erklær forekomstvariabel som privat;
Hold omfanget av variabler minimalt;
Tilordne meningsfulle navn til variabler;
Unngå minnelekkasjer ved å frigjøre databaseforbindelser når spørringen er fullført;
Prøv å bruke Til slutt blokker så ofte som mulig;
Bruk Executor-rammeverket for flertrådsprogrammering.
GO TO FULL VERSION