Ngigqugquzelwe ukuthi ngibhale lesi sihloko ngenani elikhulu lezinto ezisetshenziswayo ekuhlaziyweni okumile eza ngokuya ziqhamuka. Okokuqala, lokhu , ezithuthukisa ngenkuthalo ku-HabrΓ© ngezibuyekezo zamaphutha atholwe ithuluzi labo kumaphrojekthi womthombo ovulekile. I-PVS-studio isanda kuqaliswa , futhi, yiqiniso, abathuthukisi be-IntelliJ IDEA, umhlaziyi wakhe owakhelwe ngaphakathi cishe othuthuke kakhulu ku-Java namuhla, .
Lapho ufunda ukubuyekezwa okunjalo, umuntu uthola umuzwa wokuthi sikhuluma nge-elixir yomlingo: cindezela inkinobho, futhi nansi - uhlu lwamaphutha phambi kwamehlo akho. Kubonakala sengathi njengoba abahlaziyi bethuthuka, ngokuzenzekelayo kuzoba nezimbungulu eziningi, futhi imikhiqizo eskeniwe yilawa marobhothi izoba ngcono futhi ibe ngcono, ngaphandle komzamo wethu.
Kodwa awekho ama-elixirs omlingo. Ngingathanda ukukhuluma ngalokho ngokuvamile okungaxoxwa ngakho kokuthunyelwe okufana nokuthi βnazi izinto irobhothi lethu elingazitholaβ: lokho abahlaziyi abangakwazi ukuzenza, iyini indima yabo yangempela kanye nendawo enqubweni yokulethwa kwesofthiwe, nendlela yokuyisebenzisa ngendlela efanele.
I-Ratchet (umthombo: ).
Lokho Abahlaziyi Be-Static Abangeke Bakwenze
Kuyini, ngokombono ongokoqobo, ukuhlaziywa kwekhodi yomthombo? Sondla kweminye imithombo, futhi ngesikhathi esifushane (okufushane kakhulu kunokuqalisa ukuhlola) sithola ulwazi oluthile mayelana nesistimu yethu. Umkhawulo oyisisekelo futhi ongenakunqotshwa ngokwezibalo ukuthi singathola kuphela isigaba esincane solwazi.
Isibonelo esidume kakhulu senkinga engakwazi ukuxazululwa ngokuhlaziywa kwe-static : lena ithiyori efakazela ukuthi akunakwenzeka ukuthuthukisa i-algorithm evamile enganquma kusukela kukhodi yomthombo yohlelo ukuthi izohamba noma iphele ngesikhathi esinqunyelwe. Isandiso sale theorem si , okusho ukuthi kunoma iyiphi impahla engeyona encane yemisebenzi esebenzisekayo, ukucacisa ukuthi ingabe uhlelo olungenamthetho luhlola umsebenzi ngesakhiwo esinjalo kuyinkinga engaxazululeki nge-algorithmically. Isibonelo, akunakwenzeka ukubhala isihlaziyi esinganquma kunoma iyiphi ikhodi yomthombo ukuthi uhlelo oluhlaziywe luwukusetshenziswa kwe-algorithm ebala, ithi, i-squaring inombolo ephelele.
Ngakho-ke, ukusebenza kwabahlaziyi be-static kunemikhawulo engenakunqotshwa. Umhlaziyi omile ngeke akwazi ukunquma kuzo zonke izimo izinto ezifana, ngokwesibonelo, ukwenzeka "kokuhluka kwesikhombi esingenalutho" ezilimini ezingasebenzi, noma kuzo zonke izimo ukucacisa ukwenzeka "kwesici esingatholakali" ezilimini ukuthayipha okunamandla. Konke okungenziwa umhlaziyi we-static othuthuke kakhulu ukugqamisa amacala akhethekile, inani lawo, phakathi kwazo zonke izinkinga ezingenzeka ngekhodi yakho yomthombo, ngaphandle kokweqisa, ukwehla olwandle.
Ukuhlaziya okumile akukona ukusesha iziphazamisi
Isiphetho silandela kulokhu okungenhla: ukuhlaziya okumile akuyona indlela yokunciphisa inani lamaphutha ohlelweni. Ngingazama ukusho ukuthi uma kuqala isicelo kuphrojekthi yakho, izothola izindawo "ezihlekisayo" kukhodi, kodwa, cishe, ngeke ithole noma yimaphi amaphutha athinta ikhwalithi yohlelo lwakho.
Izibonelo zeziphambeko ezitholwe ngokuzenzakalelayo abahlaziyi ziyamangalisa, kodwa akufanele sikhohlwe ukuthi lezi zibonelo zitholwe ngokuskena isethi enkulu yama-codebases amakhulu. Ngomgomo ofanayo, ama-crackers akwazi ukuzama amagama ayimfihlo ambalwa enanini elikhulu lama-akhawunti ekugcineni bathola lawo ma-akhawunti anephasiwedi elula.
Ingabe lokhu kusho ukuthi ukuhlaziya okumile akufanele kusetshenziswe? Vele akunjalo! Futhi ngenxa yesizathu esifanayo sokuthi kungani kufanelekile ukuhlola iphasiwedi entsha ngayinye ukuze ungene ohlwini lwamaphasiwedi βalulaβ.
Ukuhlaziya okumile kungaphezu kokuthola iziphazamisi
Eqinisweni, izinkinga ezixazululwa ngokuhlaziya zibanzi kakhulu. Phela, ngokuvamile, ukuhlaziywa okumile yinoma yikuphi ukuhlola kwamakhodi omthombo okwenziwa ngaphambi kokuba kwethulwe. Nazi ezinye izinto ongazenza:
- Ihlola isitayela sokubhala amakhodi ngomqondo obanzi wegama. Lokhu kuhlanganisa kokubili ukuhlola ukufometha nokubheka ukusetshenziswa kwabakaki abangenalutho/abangeziwe, ukubeka imingcele kumamethrikhi njengenombolo yemigqa / ubunkimbinkimbi bendlela ye-cyclomatic, njll. - yonke into eyenza ikhodi ifundeke kakhudlwana futhi ilondolozeke. Ku-Java leli thuluzi yi-Checkstyle, ku-Python yi-flake8. Izinhlelo zaleli klasi zivame ukubizwa ngokuthi "linter".
- Akuyona nje ikhodi esebenzisekayo engahlaziywa. Amafayela wensiza njenge-JSON, YAML, XML, .properties angakwazi (futhi kufanele!) ahlolwe ngokuzenzakalelayo ukuze aqiniseke. Akungcono yini ukuthola ukuthi ngenxa yezingcaphuno ezithile ezingabhangqiwe isakhiwo se-JSON siphukile ekuqaleni kokuqinisekiswa kwesicelo sokudonsa okuzenzakalelayo kunalapho senza izivivinyo noma ngesikhathi sokuqalisa? Amathuluzi afanelekile ayatholakala: isibonelo, , .
- Ukuhlanganisa (noma ukuhlukanisela izilimi zokuhlela eziguqukayo) nakho kuwuhlobo lokuhlaziya olumile. Njengomthetho, abahlanganisi bayakwazi ukukhipha izexwayiso ezibonisa izinkinga ngekhwalithi yekhodi yomthombo, futhi akufanele zishaywe indiva.
- Kwesinye isikhathi ukuhlanganiswa akukhona nje ukuhlanganisa amakhodi asebenzisekayo. Isibonelo, uma unamadokhumenti ngefomethi , bese kuthi ngesikhathi sokuguqulwa kwayo ibe isibambi se-HTML/PDF i-AsciiDoctor () ingakhipha izexwayiso, isibonelo, mayelana nezixhumanisi zangaphakathi eziphukile. Futhi lesi yisizathu esihle sokungamukeli Isicelo Sokudonsa ngezinguquko zemibhalo.
- Ukuhlola ukupela nakho kuwuhlobo lokuhlaziya okumile. Isisetshenziswa iyakwazi ukuhlola isipelingi hhayi kuphela emibhalweni, kodwa futhi nasemakhodini omthombo wohlelo (amazwana kanye nemibhalo engokoqobo) ngezilimi zokuhlela ezihlukene, okuhlanganisa i-C/C++, i-Java ne-Python. Iphutha lesipelingi kusixhumi esibonakalayo somsebenzisi noma imibhalo nalo liyisici!
- Ukuhlolwa kokucushwa (ngoba kuyini, bona ΠΈ imibiko), nakuba zenziwa ngesikhathi sokusebenza sokuhlolwa kweyunithi njenge-pytest, empeleni ziwuhlobo lokuhlaziya okumile, njengoba zingawakhiphi amakhodi omthombo phakathi nokusetshenziswa kwazo.
Njengoba ubona, ukuthola izimbungulu kulolu hlu kuthatha indima ebaluleke kakhulu, futhi konke okunye kutholakala ngokusebenzisa amathuluzi omthombo ovulekile wamahhala.
Yiziphi kulezi zinhlobo zokuhlaziya okumile okufanele zisetshenziswe kuphrojekthi yakho? Yebo, kuningi, kungcono! Into esemqoka ukuwusebenzisa ngendlela efanele, okuzoxoxwa ngayo ngokuqhubekayo.
Ipayipi lokulethwa njengesihlungi esinezigaba eziningi kanye nokuhlaziya okumile njengokwehla kwaso kokuqala
Isingathekiso sakudala sokuhlanganiswa okuqhubekayo yipayipi (ipayipi) lapho izinguquko zigeleza - ukusuka ekuguquleni ikhodi yomthombo iye ekulethweni kuya ekukhiqizweni. Ukulandelana okujwayelekile kwezigaba zaleli payipi kubukeka kanje:
- ukuhlaziya okumile
- ukuhlanganisa
- ukuhlolwa kweyunithi
- ukuhlolwa kokuhlanganiswa
- Ukuhlolwa kwe-UI
- isheke mathupha
Izinguquko ezinqatshiwe esigabeni se-Nth sephayiphi azisakazwa esigabeni esingu-N+1.
Kungani ngempela ngale ndlela hhayi ngenye indlela? Engxenyeni yokuhlola yepayipi, abahloli bazobona ipiramidi yokuhlola eyaziwa kakhulu.
iphiramidi yokuhlola. Umthombo: UMartin Fowler.
Phansi kwalo mbhoshongo kukhona ukuhlola okulula ukukubhala, okugijima ngokushesha, futhi okungavamisile ekubeni namanga. Ngakho-ke, kufanele kube ngaphezulu kwabo, kufanele bahlanganise ikhodi eyengeziwe futhi babulawe kuqala. Phezulu kwephiramidi, okuphambene kuyiqiniso, ngakho-ke inani lokuhlanganiswa kanye nokuhlolwa kwe-UI kufanele kwehliswe kube ubuncane obudingekayo. Umuntu okulolu ketango uyinsiza ebiza kakhulu, ehamba kancane futhi engathembeki, ngakho usekupheleni futhi wenza umsebenzi kuphela uma izigaba ezedlule zingazange zithole noma yikuphi ukukhubazeka. Nokho, ngokwezimiso ezifanayo, ipayipi lakhiwe ezingxenyeni ezingahlobene ngokuqondile nokuhlola!
Ngingathanda ukunikeza isifaniso ngesimo sesistimu yokuhlunga amanzi enezigaba eziningi. Amanzi angcolile anikezwa okokufaka (izinguquko ezinokukhubazeka), ekuphumeni kufanele sithole amanzi ahlanzekile, lapho zonke izinto ezingcolile ezingafunwa ziqedwa.
Isihlungi sesiteji esiningi. Umthombo:
Njengoba wazi, izihlungi zokuhlanza ziklanywe ngendlela yokuthi i-cascade ngayinye elandelayo ingakwazi ukuhlunga ingxenye encane yokungcola. Ngesikhathi esifanayo, ama-cascade okuhlanza ama-coarser anokuphuma okuphezulu kanye nezindleko eziphansi. Esifanisweni sethu, lokhu kusho ukuthi amasango ekhwalithi yokufaka ayashesha, adinga umzamo omncane ukuze aqale, futhi wona ngokwawo awasebenzi ngokuzithoba - futhi lokhu kuwukulandelana kwawo kanye akhiwe kuwo. Iqhaza lokuhlaziya okungaguquki, lokho, njengoba sesiqonda manje, elikwazi ukususa kuphela iziphambeko ezimbi kakhulu, indima ye-grating-"udaka" ekuqaleni nje kwesihlungi.
Ukuhlaziya okungaguquki kukodwa akuthuthukisi izinga lomkhiqizo wokugcina, njengoba nje βnoxhaka lodakaβ lungawenzi amanzi aphuzwe. Futhi nokho, ngokufanayo nezinye izakhi zomthumeli, ukubaluleka kwayo kusobala. Nakuba kusihlungi esinezigaba eziningi, izigaba zokukhiphayo zingakwazi ukuthwebula yonke into eyenziwa yizigaba zokufaka, kuyacaca ukuthi imiphi imiphumela umzamo wokuyenza ngezigaba zokuhlunga kahle kuphela, ngaphandle kwezigaba zokufaka, ozoholela kuyo.
Inhloso "yomqoqi wodaka" iwukukhulula ama-cascade alandelayo ekubambeni amaphutha amabi kakhulu. Isibonelo, okungenani, umbuyekezi wekhodi akufanele aphazanyiswe ikhodi eyakheke ngokungalungile kanye nokwephulwa kwezinkambiso zokufaka amakhodi ezimisiwe (njengabakaki abengeziwe noma amagatsha afakwe isidleke ngokujule kakhulu). Iziphazamisi ezifana ne-NPE kufanele zibanjwe ukuhlolwa kweyunithi, kodwa uma nangaphambi kokuhlolwa isihlaziyi sisikhombisa ukuthi iphutha kufanele lenzeke nakanjani, lokhu kuzosheshisa kakhulu ukulungiswa kwayo.
Ngicabanga ukuthi manje sekuyacaca ukuthi kungani ukuhlaziya okumile kungayithuthukisi ikhwalithi yomkhiqizo uma usetshenziswa ngezikhathi ezithile, futhi kufanele kusetshenziswe njalo ukuhlunga izinguquko ezinokukhubazeka okukhulu. Ukubuza ukuthi ingabe ukusebenzisa isihlaziyi esimile kuzothuthukisa ikhwalithi yomkhiqizo wakho cishe kufana nokubuza ukuthi βIngabe izinga lokuphuza lamanzi athathwe echibini elingcolile lizothuthuka uma edluliswa ku-colander?β
Ukuqaliswa kuphrojekthi yefa
Umbuzo obalulekile osebenzayo: indlela yokwethula ukuhlaziywa okumile enqubweni yokuhlanganiswa okuqhubekayo "njengesango lekhwalithi"? Endabeni yokuhlolwa okuzenzakalelayo, konke kusobala: kukhona isethi yokuhlolwa, ukuhluleka kwanoma yimuphi wabo kuyisizathu esanele sokukholelwa ukuthi umhlangano awudlulanga isango lekhwalithi. Umzamo wokufaka isango ngendlela efanayo ngokusekelwe emiphumeleni yokuhlaziywa okumile uyehluleka: kunezixwayiso eziningi zokuhlaziya kukhodi yefa, awufuni ukuziziba ngokuphelele, kodwa futhi akunakwenzeka ukumisa ukulethwa kwe- umkhiqizo ngoba uqukethe izexwayiso zokuhlaziya.
Lapho isetshenziswa okokuqala, i-analyzer ikhiqiza inani elikhulu lezixwayiso kunoma iyiphi iphrojekthi, iningi lazo elingahlobene nokusebenza okufanele komkhiqizo. Akunakwenzeka ukulungisa wonke lawa mazwana ngesikhathi esisodwa, futhi amaningi awo akudingekile. Phela, siyazi ukuthi umkhiqizo wethu uwonke usebenza, ngisho nangaphambi kokwethulwa kokuhlaziywa okumile!
Ngenxa yalokho, abantu abaningi bazikhawulela ekusebenziseni i-episodic yokuhlaziya okumile, noma basebenzise kuphela kwimodi yokwazisa, lapho umbiko womhlaziyi ukhishwa nje ngesikhathi somhlangano. Lokhu kulingana nokungabikho kwanoma yikuphi ukuhlaziya, ngoba uma sesivele sinezixwayiso eziningi, khona-ke ukuvela kwesinye (kungakhathaliseki ukuthi kubi kangakanani) lapho ikhodi ishintsha ingabonakali.
Izindlela ezilandelayo zokwethula amasango ekhwalithi ziyaziwa:
- Imisa umkhawulo enanini eliphelele lezixwayiso, noma inombolo yezexwayiso ehlukaniswa ngenani lemigqa yekhodi. Lokhu akusebenzi kahle, ngoba isango elinjalo liyeqa ngokukhululekile izinguquko ngeziphambeko ezintsha kuze kudlule umkhawulo wabo.
- Ukulungisa, ngesinye isikhathi, zonke izixwayiso ezindala kukhodi njengokuzitshwa, nokwehluleka ukwakha lapho kuvela izixwayiso ezintsha. Lokhu kusebenza kunikezwa i-PVS-studio nezinye izinsiza eziku-inthanethi, njenge-Codacy. Angizange ngibe nethuba lokusebenza ku-PVS-studio, ngokuqondene nolwazi lwami nge-Codacy, inkinga yabo enkulu ukuthi incazelo yalokho "okudala" nokuthi yini iphutha "elisha" i-algorithm eyinkimbinkimbi engenzi. njalo isebenza ngendlela efanele, ikakhulukazi uma amafayela eshintshwe kakhulu noma eqanjwe kabusha. Enkumbulweni yami, i-Codacy ingakwazi ukweqa izixwayiso ezintsha esicelweni sokudonsa, futhi ngesikhathi esifanayo ingeqi isicelo sokudonsa ngenxa yezexwayiso ebezingahlobene nezinguquko kukhodi yale PR.
- Ngokubona kwami, ikhambi eliphumelela kakhulu lichazwe encwadini indlela "yokubamba". Umbono oyinhloko ukuthi isici sokukhishwa ngakunye inombolo yezexwayiso zokuhlaziya ezimile, futhi izinguquko ezingakhulisi inani lezixwayiso ezivunyelwe kuphela.
I-Ratchet
Isebenza kanje:
- Esigabeni sokuqala, irekhodi kumethadatha yokukhululwa yenani lezixwayiso kukhodi etholwe abahlaziyi liyasetshenziswa. Ngakho, uma wakha phezulu nomfula, umphathi wakho wekhosombe akabhalwanga nje "ukukhipha 7.0.2", kodwa "khulula u-7.0.2 oqukethe izexwayiso ze-Checkstyle ezingu-100500". Uma usebenzisa isiphathi sekhosombe esithuthukisiwe (njenge-Artifactory), kulula ukugcina imethadatha enjalo mayelana nokukhululwa kwakho.
- Manje isicelo ngasinye sokudonsa esakhiweni siqhathanisa inani lezixwayiso esizitholayo nenombolo ekukhishweni kwamanje. Uma i-PR iholela ekwandeni kwale nombolo, khona-ke ikhodi ayidluli isango lekhwalithi ekuhlaziyweni okumile. Uma inani lezixwayiso lincipha noma lingashintshi, liyadlula.
- Ekukhishweni okulandelayo, inombolo ebalwe kabusha yezexwayiso izobhalwa ibuyiselwe kumethadatha yokukhishwa.
Ngakho kancane kancane, kodwa kancane kancane (njenge-ratchet), inani lezixwayiso lizothambekela ku-zero. Yebo, uhlelo lungakhohliswa ngokwethula isexwayiso esisha, kodwa silungise esomunye umuntu. Lokhu kuvamile, ngoba ngokuhamba kwesikhathi kunikeza umphumela: izixwayiso zilungiswa, njengomthetho, hhayi ngamunye ngamunye, kodwa ngokushesha ngeqembu lohlobo oluthile, futhi zonke izixwayiso eziqedwa kalula ziqedwa ngokushesha.
Le grafu ibonisa inani lezexwayiso ze-Checkstyle zezinyanga eziyisithupha zokusebenza kwe-"ratchet" enjalo ivuliwe . Inani lezixwayiso liye lehla ngohlelo lobukhulu, futhi lokhu kwenzeka ngokwemvelo, ngokuhambisana nokuthuthukiswa komkhiqizo!
Ngisebenzisa inguqulo elungisiwe yale ndlela, ngibala izixwayiso ngokuhlukana ngemojula yephrojekthi kanye nethuluzi lokuhlaziya, okuholela kufayela le-YAML elinemethadatha yokuhlanganisa ebukeka kanjena:
celesta-sql:
checkstyle: 434
spotbugs: 45
celesta-core:
checkstyle: 206
spotbugs: 13
celesta-maven-plugin:
checkstyle: 19
spotbugs: 0
celesta-unit:
checkstyle: 0
spotbugs: 0
Kunoma yiluphi uhlelo oluthuthukisiwe lwe-CI, i-ratchet ingasetshenziswa kunoma imaphi amathuluzi okuhlaziya amile ngaphandle kokuthembela kuma-plugin nakumathuluzi ezinkampani zangaphandle. Ngamunye wabahlaziyi ukhiqiza umbiko wawo ngombhalo olula noma ifomethi ye-XML okulula ukuyihlaziya. Kusele ukubhalisa kuphela i-logic edingekayo kusikripthi se-CI. Ungabona ukuthi lokhu kwenziwa kanjani kumaphrojekthi wethu womthombo ovulekile asekelwe ku-Jenkins kanye ne-Artifactory, ungakwazi noma . Zombili izibonelo zincike emtatsheni wezincwadi : indlela countWarnings() ibala amathegi e-xml kumafayela akhiqizwe i-Checkstyle ne-Spotbugs ngendlela evamile, futhi compareWarningMaps() isebenzisa i-ratchet efanayo, iphonsa iphutha lapho inani lezixwayiso kunoma yiziphi izigaba likhuphuka.
Ukuqaliswa kwe-ratchet okuthakazelisayo kuyenzeka ekuhlaziyweni kwesipelingi samazwana, ama-text literals, kanye nemibhalo kusetshenziswa i-aspell. Njengoba wazi, uma uhlola isipelingi, akuwona wonke amagama angaziwa esichazamazwini esijwayelekile angalungile, angangezwa kusichazamazwi somsebenzisi. Uma wenza isichazamazwi somsebenzisi sibe yingxenye yekhodi yomthombo wephrojekthi, isango lekhwalithi yesipelingi lingenziwa ngendlela elandelayo: ukusetshenziswa kwe-aspell ngesichazamazwi esijwayelekile kanye nesichazamazwi somsebenzisi. ungatholi amaphutha esipelingi.
Mayelana nokubaluleka kokulungisa inguqulo ye-analyzer
Ekuphetheni, okulandelayo kufanele kuqashelwe: kungakhathaliseki ukuthi usebenzisa kanjani ukuhlaziya epayipini lakho lokulethwa, inguqulo ye-analyzer kufanele ilungiswe. Uma uvumela i-analyzer ukuthi ibuyekeze ngokuzenzakalelayo, khona-ke lapho wakha isicelo esilandelayo sokudonsa, kungase "kuvele" amaphutha amasha angahlobene nezinguquko zekhodi, kodwa ahlobene neqiniso lokuthi i-analyzer entsha ikwazi ukuthola amaphutha amaningi - futhi lokhu kuzophula inqubo yakho yokwamukela izicelo zokudonsa . Ukuthuthukisa isihlaziyi kufanele kube isenzo esiqaphelayo. Nokho, ukulungisa kanzima inguqulo yengxenye ngayinye yomhlangano kuyisidingo esidingekayo ngokujwayelekile kanye nesihloko sengxoxo ehlukile.
okutholakele
- Ukuhlaziya okuqinile ngeke kukutholele iziphazamisi futhi ngeke kuthuthukise ikhwalithi yomkhiqizo wakho njengomphumela wohlelo lokusebenza olulodwa. Umphumela omuhle kuphela wekhwalithi ukusetshenziswa kwayo okuqhubekayo phakathi nenqubo yokulethwa.
- Ukuthola izimbungulu akuwona umsebenzi oyinhloko wokuhlaziya nhlobo, iningi lemisebenzi ewusizo iyatholakala kumathuluzi omthombo ovulekile.
- Sebenzisa amasango ekhwalithi asekelwe emiphumeleni yokuhlaziya emile esigabeni sokuqala ngqa sepayipi lokulethwa, usebenzisa i-ratchet yekhodi yefa.
izithenjwa
- bika ngezindlela ezahlukene zokuhlaziya ikhodi (hhayi nje okumile!)
Source: www.habr.com