Att känna till och följa branschstandarder och bästa praxis är ganska viktigt inom alla områden, och särskilt inom programmering med dess komplexa och ibland kaotiska blandning av kodningsspråk, verktyg, tillvägagångssätt och teknologier. Det är därför en professionell Java-programmerare bör vara väl förtrogen med Java Coding Conventions, vilket är vad vi ska prata om idag.
Vad är kodningskonventioner?
Kodkonventioner är uppsättningar av riktlinjer för varje specifikt programmeringsspråk med rekommendationer om olika aspekter av mjukvaruutveckling på detta språk, inklusive kodningsstil, bästa praxis och metoder. Kodningskonventioner är avsedda att följas av programvaruprogrammerare som kodar på detta språk som kvalitetsguider för att säkerställa att deras kod är läsbar och att andra personer kan underhålla programvaran på rätt sätt. Kodkonventioner täcker normalt alla väsentliga komponenter för att göra programvara i detta programmeringsspråk, inklusive filorganisation, indrag, kommentarer, deklarationer, uttalanden, blanksteg, namnkonventioner, programmeringsmetoder, programmeringsprinciper, programmeringsregler, arkitektoniska bästa praxis och mer .
Vad är syftet med att koda konventioner?
Det finns ett antal anledningar till varför kodningskonventioner spelar en viktig roll i mjukvaruutveckling.
Upprätthålla enhetlig kodstil
Genom att följa en kodningskonvention kan programvaruprojektet skrivas i en enda enhetlig stil, vilket är fördelaktigt på flera olika sätt, såsom följande.
Minimera underhållskostnader för programvara
En av de viktigaste är att göra det lättare att underhålla och stödja mjukvaruprodukten, eftersom det ofta inte är de ursprungliga författarna till programmet som stödjer det. Detta är viktigt eftersom 80 % av livstidskostnaden för en mjukvara går till underhåll.
Förbättra mjukvarans läsbarhet
Förbättringen av mjukvarans läsbarhet är en annan stor fördel, som också har flera implikationer som att förenkla introduktionen av nya utvecklare till projektet och öka effektiviteten i samarbetet mellan utvecklingsteammedlemmarna.
Påskyndar arbetet
Slutligen är det nödvändigt att ha korrekt skriven och strukturerad kod för att mjukvaruutvecklingsprocessen ska gå så snabbt som möjligt.
Oracles kodkonvention är erkänd som den viktigaste av ett antal uppenbara skäl: Oracles konvention är den officiella eftersom Oracle är ägare till Java, samt en av de äldsta (den senaste revideringen av detta dokument gjordes den 20 april, 1999). Några av de viktiga delarna av Oracles Java Code Convention skulle vara rekommendationen att använda kamel skiftläge när man definierar klasser, metoder eller variabler, för att starta klasser med stor bokstav och använda substantiv för att namnge dem, samtidigt som man använder verb i imperativform och börjar från en liten bokstav för metoder och så vidare.
Googles Java Style Guide
Java-kodningskonventioner från Google anses vara viktiga på grund av Googles status som det lärande internet- och teknikföretaget med enorm erfarenhet av att utveckla alla typer av Java-applikationer. En annan viktig anledning är det faktum att Googles Java-kodkonvention uppdaterades den 22 maj 2018, vilket gör den mer relevant än kodkonventionen från Oracle, särskilt när det kommer till att beskriva relativt nya funktioner i Java som bara släpptes som del av Java 8 år 2014, såsom lambdas och streams. Så här beskriver författarna till Googles Java Style Guide innehållet i denna kodningskonvention: “Detta dokument fungerar som den fullständiga definitionen av Googles kodningsstandarder för källkod i Java. Liksom andra programmeringsstilsguider sträcker sig de frågor som behandlas inte bara estetiska frågor om formatering, men även andra typer av konventioner eller kodningsstandarder. Det här dokumentet fokuserar dock främst på de hårda och snabba reglerna som vi följer universellt och undviker att ge råd som inte är tydligt verkställbara (vare sig av människa eller verktyg). "Google Java Style Guide är en bra referens för det mesta, men den är lite tillåtande i vissa ämnen. Å andra sidan måste du som Java-programmerare vara van vid 4 utrymmen för kodindrag, bland annat”, sa David Rios, en mjukvaruarkitekt och erfaren Java-programmerare, i en LinkedIn men det är lite tillåtande i vissa ämnen. Å andra sidan måste du som Java-programmerare vara van vid 4 utrymmen för kodindrag, bland annat”, sa David Rios, en mjukvaruarkitekt och erfaren Java-programmerare, i en LinkedIn men det är lite tillåtande i vissa ämnen. Å andra sidan måste du som Java-programmerare vara van vid 4 utrymmen för kodindrag, bland annat”, sa David Rios, en mjukvaruarkitekt och erfaren Java-programmerare, i en LinkedIninlägg med några föreslagna anpassningar till sin egen Google Java Style Guide.
Mest använda Java-kodningsstandarder
Här är några av de mest använda Java-kodningsstandarderna som kan hittas i ovan nämnda kodningskonventioner från Oracle och Google, såväl som andra dokument av detta slag.
Följ korrekt namnkonvention;
Lägg till kommentarer;
Identifierare betyder ett symboliskt namn som hänvisar till namnet på klasser, paket, metoder och variabler i ett Java-program;
Variabelnamnet ska vara relaterat till dess syfte;
Namnet på metoden bör relatera till metodens funktionalitet;
Metoden bör inte innehålla mer än 50 rader;
Det ska inte finnas någon dubblettkod i samma klass eller annan klass;
Deklarera globala variabler endast om det är nödvändigt att använda i de andra metoderna;
Dubbelkolla skapandet av statiska variabler i en klass;
Undvik att komma åt variabler direkt från andra klasser använd istället getter- och settermetoder;
All affärslogik bör endast hanteras i tjänsteklassen;
All DB-relaterad kod bör endast finnas i DAO-klasserna;
Använd getters och setters;
Deklarera instansvariabel som privat;
Håll omfattningen av variabler minimal;
Tilldela betydelsefulla namn till variabler;
Undvik minnesläckor genom att släppa databasanslutningar när sökningen är klar;
Försök att använda Slutligen blockera så ofta som möjligt;
Använd Executor-ramverket för flertrådsprogrammering.
GO TO FULL VERSION