Az iparági szabványok és a legjobb gyakorlatok ismerete és követése nagyon fontos minden területen, és különösen a programozásban a kódolási nyelvek, eszközök, megközelítések és technológiák összetett és néha kaotikus keverékével. Éppen ezért egy professzionális Java programozónak jól kell ismernie a Java kódolási egyezményeket, amiről ma beszélünk.
Mik azok a kódolási konvenciók?
A kódolási konvenciók az egyes programozási nyelvekre vonatkozó iránymutatások, amelyek ajánlásokat tartalmaznak az ezen a nyelven végzett szoftverfejlesztés különböző aspektusaira vonatkozóan, beleértve a kódolási stílust, a legjobb gyakorlatokat és módszereket. A kódolási konvenciókat azoknak a szoftverprogramozóknak kell követniük, akik ezen a nyelven kódolnak, mivel minőségi útmutatóként biztosítják kódjuk olvashatóságát és a szoftver megfelelő karbantartását mások által. A kódolási konvenciók általában lefedik a szoftverkészítés minden lényeges összetevőjét ezen a programozási nyelven, beleértve a fájlszervezést, behúzást, megjegyzéseket, deklarációkat, utasításokat, szóközöket, elnevezési konvenciókat, programozási gyakorlatokat, programozási elveket, programozási ökölszabályokat, bevált építészeti gyakorlatokat stb. .
Mi a kódolási konvenció célja?
Számos oka van annak, hogy a kódolási konvenciók miért játszanak fontos szerepet a szoftverfejlesztésben.
Egységes kódstílus fenntartása
A kódolási konvenciót követve a szoftverprojekt egyetlen egységes stílusban írható, ami több különböző módon is előnyös, például az alábbiakban.
A szoftver karbantartási költségeinek minimalizálása
Az egyik legfontosabb a szoftvertermék karbantartásának és támogatásának megkönnyítése, mivel gyakran nem a program eredeti szerzői támogatják azt. Ez azért fontos, mert egy szoftver élettartama alatti költségének 80%-a karbantartásra megy.
A szoftver olvashatóságának javítása
A szoftver olvashatóságának javulása egy másik jelentős előny, aminek több következménye is van, például leegyszerűsíti az új fejlesztők bevezetését a projektbe, és növeli a fejlesztőcsapat tagjai közötti együttműködés hatékonyságát.
A munka felgyorsítása
Végül, a megfelelően megírt és strukturált kód szükséges ahhoz, hogy a szoftverfejlesztési folyamat a lehető leggyorsabban haladjon.
Az Oracle kódegyezményét számos nyilvánvaló okból ismerik el a legfontosabbnak: az Oracle egyezménye a hivatalos, mivel az Oracle a Java tulajdonosa, valamint az egyik legrégebbi (a dokumentum legutóbbi felülvizsgálata április 20-án készült, 1999). Az Oracle Java Code Egyezményének néhány fontos része az lenne, hogy az osztályok, metódusok vagy változók meghatározásakor a teve kis- és nagybetűket használjuk, az osztályokat nagybetűvel kezdjük, és főneveket használjunk elnevezésükre, miközben az igéket felszólító formában használjuk és kezdjük. kisbetűből metódusoknál stb.
Google Java Style Guide
A Google Java kódolási konvencióit fontosnak tartják, mivel a Google tanuló internetes és technológiai vállalat, amely hatalmas tapasztalattal rendelkezik mindenféle Java-alkalmazás fejlesztésében. Egy másik fontos ok az a tény, hogy a Google Java kódkonvencióját 2018. május 22-én frissítették, ami relevánsabbá teszi, mint az Oracle kódkonvenciója, különösen, ha a Java viszonylag új funkcióinak leírásáról van szó, amelyeket csak a Java 8 részeként adtak ki. 2014-ben, mint például a lambdák és a patakok. A Google Java Style Guide szerzői így írják le ennek a kódolási egyezménynek a tartalmát: „Ez a dokumentum a Google Java forráskódra vonatkozó kódolási szabványainak teljes definíciójaként szolgál. Más programozási stílus útmutatókhoz hasonlóan a felvetett kérdések nem csak a formázás esztétikai, de más típusú egyezmények vagy kódolási szabványok is. Ez a dokumentum azonban elsősorban azokra a szigorú szabályokra összpontosít, amelyeket általánosan követünk, és kerüli az olyan tanácsok adását, amelyek (akár ember, akár eszköz által) nem egyértelműen végrehajthatók.” „A Google Java Style Guide többnyire jó referencia, de bizonyos témákban kissé megengedő. Másrészt Java-programozóként hozzá kell szoknia a 4 szóközhöz a kód behúzásához, többek között” – mondta David Rios szoftvertervező és tapasztalt Java programozó a LinkedInben. de bizonyos témákban kissé megengedő. Másrészt Java-programozóként hozzá kell szoknia a 4 szóközhöz a kód behúzásához, többek között” – mondta David Rios szoftvertervező és tapasztalt Java programozó a LinkedInben. de bizonyos témákban kissé megengedő. Másrészt Java-programozóként hozzá kell szoknia a 4 szóközhöz a kód behúzásához, többek között” – mondta David Rios szoftvertervező és tapasztalt Java programozó a LinkedInben.bejegyzést a Google Java Style Guide néhány javasolt adaptációjával .
Leggyakrabban használt Java kódolási szabványok
Íme néhány a leggyakrabban használt Java kódolási szabványok közül, amelyek megtalálhatók az Oracle és a Google fent említett kódolási konvencióiban, valamint más ilyen jellegű dokumentumokban.
Kövesse a megfelelő elnevezési konvenciót;
Megjegyzések hozzáadása;
Az azonosító egy szimbolikus név, amely a Java programban lévő osztályok, csomagok, metódusok és változók nevére utal;
A változó nevének kapcsolódnia kell a céljához;
A metódus nevének kapcsolódnia kell a módszer funkcionalitásához;
A módszer nem tartalmazhat több mint 50 sort;
Ugyanabban az osztályban vagy más osztályban nem lehet duplikált kód;
A globális változókat csak akkor deklarálja, ha a többi metódusban szükséges használni;
Ellenőrizze kétszer a statikus változók létrehozását egy osztályon belül;
Kerülje el a változók közvetlen elérését más osztályokból, inkább használjon getter és setter metódusokat;
Minden üzleti logikát csak a szolgáltatási osztályban szabad kezelni;
Minden DB-vel kapcsolatos kódnak csak a DAO osztályokban kell lennie;
Getterek és szetterek használata;
A példányváltozó privátként való deklarálása;
A változók hatóköre minimális legyen;
Rendeljen értelmes neveket a változókhoz;
Kerülje el a memóriaszivárgást az adatbázis-kapcsolatok felszabadításával, amikor a lekérdezés befejeződött;
Próbáld meg minél gyakrabban használni a Végül blokkolást;
Használja az Executor keretrendszert többszálú programozáshoz.
GO TO FULL VERSION