{"id":231804,"date":"2022-12-29T18:06:00","date_gmt":"2022-12-29T15:06:00","guid":{"rendered":"https:\/\/wordpress.mediadoma.com\/?p=231804"},"modified":"2022-12-29T18:06:40","modified_gmt":"2022-12-29T15:06:40","slug":"paremman-wordpress-koodin-kirjoittaminen-phpstan","status":"publish","type":"post","link":"https:\/\/wordpress.mediadoma.com\/fi\/paremman-wordpress-koodin-kirjoittaminen-phpstan\/","title":{"rendered":"Paremman WordPress-koodin kirjoittaminen: PHPStan"},"content":{"rendered":"\n

T\u00e4m\u00e4n sarjan viimeisimm\u00e4ss\u00e4 viestiss\u00e4 (joka on tosin jonkin aikaa sitten), puhuin pitk\u00e4\u00e4n Composerista<\/a> ja sen lukkotiedostosta.<\/a><\/p>\n

Suosittelen lukemaan kaksi edellist\u00e4 artikkelia, koska Composer tulee lopulta n\u00e4yttelem\u00e4\u00e4n roolia t\u00e4ss\u00e4 materiaalissa, jota t\u00e4m\u00e4 ja tulevat viestit jakavat. Mutta jos et halua seurata niit\u00e4 (tai olet jo perehtynyt Composeriin), aiempien viestien ydin on vastaavasti seuraava:<\/p>\n

\n

En suosittele toimittajahakemiston tarkistamista arkistoon. Siit\u00e4 voi my\u00f6hemmin tulla valtava hakemisto, ja se voi heikent\u00e4\u00e4 Composerin koko tarkoitusta.<\/p>\n

S\u00e4velt\u00e4j\u00e4<\/a><\/p>\n

Tavoitteena on varmistaa, ett\u00e4 jokaisella on k\u00e4yt\u00f6ss\u00e4 sama versio projektin riippuvuuksista \u2013 ei vanhempia tai uudempia versioita \u2013 mutta sama versio.<\/p>\n

S\u00e4velt\u00e4j\u00e4n lukitustiedosto<\/a><\/p>\n<\/blockquote>\n

T\u00e4st\u00e4 huolimatta voimme asentaa lukuisia riippuvuuksia tai paketteja, jotka auttavat meit\u00e4 varmistamaan, ett\u00e4 kirjoitamme mahdollisimman korkealaatuista koodia.<\/p>\n

Toki jotkut n\u00e4ist\u00e4 voivat olla koodausstandardien kaltaisia, mutta ne ovat todellakin enemm\u00e4n s\u00e4\u00e4nt\u00f6j\u00e4 kuin elementtej\u00e4 korkealaatuisen koodin kirjoittamiseen (vaikka niit\u00e4 ei mielest\u00e4ni pit\u00e4isi j\u00e4tt\u00e4\u00e4 keskustelun ulkopuolelle – vain j\u00e4tt\u00e4\u00e4 pois t\u00e4h\u00e4n aikaan \ud83d\ude43).<\/p>\n

Takaisin kyseisiin ty\u00f6kaluihin: Mitk\u00e4 ty\u00f6kalut auttavat kirjoittamaan korkealaatuista WordPress-koodia? Aion jakaa muutaman suosikkini, ja aion puhua niist\u00e4 siit\u00e4, kuinka voimme k\u00e4ytt\u00e4\u00e4 niit\u00e4 kaikkia koodipohjaa vastaan.<\/p>\n

Katsotaanpa ensin staattista analyysi\u00e4 PHPStanilla<\/a>.<\/p>\n

Parempi WordPress-koodi PHPStanilla<\/h2>\n

Mit\u00e4 staattinen analyysi muuten on?<\/h3>\n

Ensinn\u00e4kin muutama sana staattisesta analyysist\u00e4. Nimitt\u00e4in mik\u00e4 se on? Se on suupala ensinn\u00e4kin:<\/p>\n

\n

Staattinen koodianalyysi (tunnetaan my\u00f6s nimell\u00e4 l\u00e4hdekoodianalyysi) suoritetaan yleens\u00e4 osana koodin tarkistusta (tunnetaan my\u00f6s nimell\u00e4 white-box -testaus) ja se suoritetaan Security Development Lifecyclen (SDL) k\u00e4ytt\u00f6\u00f6nottovaiheessa.<\/p>\n

Staattinen koodianalyysi viittaa tavallisesti staattisen koodin analyysity\u00f6kalujen k\u00e4ytt\u00f6\u00f6n, jotka yritt\u00e4v\u00e4t tuoda esiin mahdollisia haavoittuvuuksia "staattisessa" (ei-suorituskykyisess\u00e4) l\u00e4hdekoodissa k\u00e4ytt\u00e4m\u00e4ll\u00e4 tekniikoita, kuten Taint Analysis ja Data Flow Analysis.<\/p>\n

Staattinen koodianalyysi OWASP:n kautta<\/a><\/p>\n<\/blockquote>\n

Ajattele asiaa n\u00e4in: Se on tapa analysoida ohjelma mahdollisten virheiden varalta, joita et ehk\u00e4 n\u00e4e, kun ty\u00f6skentelet koodipohjan parissa.<\/p>\n

Toisin sanoen on olemassa ongelmia, bugeja, tietoturvaongelmia, joita voi esiinty\u00e4, mutta et voi havaita useista syist\u00e4 (joista v\u00e4hin on, ett\u00e4 olet liian l\u00e4hell\u00e4 koodia).<\/p>\n

Ajan mittaan kehitysyhteis\u00f6 on kuitenkin oppinut tapoja analysoida koodia, luoda s\u00e4\u00e4nt\u00f6joukkoja ja rakentaa ty\u00f6kaluja, jotka auttavat l\u00f6yt\u00e4m\u00e4\u00e4n t\u00e4sm\u00e4lleen kaikki edell\u00e4 mainitut.<\/p>\n

WordPress-keskeisen koodin staattinen analyysi<\/h3>\n

Ja t\u00e4ss\u00e4 PHPStan tulee peliin.<\/p>\n

\"Paremman<\/a><\/p>\n

Kuten mainittiin, paketin tavoitteena on tunnistaa koodissasi olevat virheet ennen kuin joku muu kuin kehitt\u00e4j\u00e4t k\u00e4ytt\u00e4v\u00e4t koodiasi, korostaa niit\u00e4 ja antaa sinulle mahdollisuus korjata ne.<\/p>\n

Koska t\u00e4m\u00e4nkaltaiset ty\u00f6kalut tutkivat koodipohjaa (verrattuna koodin suorittamiseen), ei aina ole mahdollista saada selke\u00e4\u00e4 kuvaa. T\u00e4m\u00e4 tarkoittaa, ett\u00e4 voimme saada v\u00e4\u00e4ri\u00e4 positiivisia tuloksia.<\/p>\n

T\u00e4st\u00e4 kuitenkin lis\u00e4\u00e4 hetken kuluttua.<\/p>\n

Jos olet kiinnostunut aloittamaan PHPStanin k\u00e4ytt\u00e4misen koodipohjaasi vastaan, se on helppoa. Asennuksen j\u00e4lkeen muista vain m\u00e4\u00e4ritt\u00e4\u00e4 se niin, ett\u00e4 se ei n\u00e4y vendor<\/code>hakemistossa tai vaikkapa WordPress-ytimess\u00e4.<\/p>\n

Sen sijaan pyyd\u00e4 sit\u00e4 tutkimaan koodisi.<\/p>\n

PHPStanin asennus<\/h3>\n

Lis\u00e4\u00e4 ensin composer.json<\/code>tiedostosi osioon seuraava rivi require-dev<\/code>:<\/p>\n

\"phpstan\/phpstan\": \"^0.11.12\"<\/code><\/p>\n

Suorita composer update<\/code>sitten terminaalissasi.<\/p>\n

Kun se on asennettu, voit k\u00e4ytt\u00e4\u00e4 sit\u00e4 yksitt\u00e4ist\u00e4 tiedostoa, hakemistoa tai hakemistojoukkoa vastaan. Jos olet lukenut aiemmat kirjoitukseni koodin organisoinnista, tied\u00e4t, ett\u00e4 pid\u00e4n suurimman osan projektin l\u00e4hdekoodista src<\/code>mukanasi, saatat ajaa jotain t\u00e4llaista:<\/p>\n

$ vendor\/bin\/phpstan analyse src<\/code><\/p>\n

T\u00e4m\u00e4 tuottaa tulosteen sen perusteella, mit\u00e4 apuohjelma l\u00f6yt\u00e4\u00e4.<\/p>\n

Muistatko aiemmin, kun sanoin, ett\u00e4 se voi l\u00f6yt\u00e4\u00e4 asioita, kuten v\u00e4\u00e4ri\u00e4 positiivisia? T\u00e4ss\u00e4 on tarkempi yhteenveto siit\u00e4, mit\u00e4 saatat n\u00e4hd\u00e4:<\/p>\n