An cód foinseach a thuiscint

Is éard atá sa doiciméad seo ná turas treoraithe trí bhonn cóid Terminologue. Tá sé i gceist aige cabhrú leat tuiscint a fháil ar an gcaoi a n-oibríonn Terminologue ar an taobh istigh le gur féidir leat fadhbanna a aithint, fabhtanna a réiteach agus tuilleadh forbartha a dhéanamh ar Terminologue.

A bhfuil laistigh de Terminologue

Mar is eol duit faoin am seo, is dócha, scríobhtar cúl Terminologue in Node.js. Ciallaíonn sé seo gur JavaScript taobh freastalaí ar fad atá i gceist. Chomh maith le Node.js, baineann Terminologue úsáid as an gcreat Express. Is creat beag é Express a chabhraíonn linn críochphointí éagsúla URL a chumrú ar an bhfreastalaí agus a insíonn do Node.js na rudaí ba chóir dó a dhéanamh nuair a aimsíonn úsáideoir ceann de na críochphointí seo. Má tá cur amach agat ar Node.js agus ar Express, beidh sé seo an-sothuigthe. Mura bhfuil cur amach agat orthu ach má tá eolas agat ar theicneolaíocht forbartha gréasáin eile, ba chóir go mbeifeá in ann na prionsabail a bhaineann lena bhfuil i gceist sa doiciméad seo a leanúint.

Nuair a sheolann Terminologue leathanaigh ghréasáin chuig an gcliant, déanann sé formáidiú orthu ach úsáid a bhaint as inneall formáidithe ar a dtugtar EJS. Tá comhréir EJS cosúil le ASP agus le ASP.NET: cuirtear <% agus %> timpeall ar chód taoibh freastalaí agus scríobhtar an chuid eile i ngnáth-HTML.

Scríobhtar codanna taoibh freastalaí Terminologue in HTML, JavaScript agus CSS atá “beagnach glan”. Is éard atá i gceist le “beagnach glan” ná nach n-úsáidimid creat “uilechuimsitheach” ar bith agus nach n-úsáidimid aon rud óna dteastódh iarphróiseáil nó tiomsú sula gcuirtear ar fáil don chliant é. Úsáidimid scripteanna agus stílbhileoga taoibh freastalaí ar a dtugtar Screenful, áfach, agus cuireann siad seo go leor den fheidhmiúlacht taoibh freastalaí ar fáil dúinn. Is feidhmchláir aon leathanaigh iad an chuid is mó de na leathanaigh ghréasáin a fheiceann an t-úsáideoir in Terminologue. Cuirtear an leathanach gréasáin ar fáil don bhrabhsálaí agus de réir mar a idirghníomhaíonn an t-úsáideoir le giuirléidí éagsúla ar scáileán, seolann Screenful iarratais AJAX chuig an bhfreastalaí agus faigheann sé freagairtí uaidh. Scríobhtar na sonraí ar fad a shreabhann idir an cliant agus an freastalaí i bhformáid JSON.

Is i bhformáid JSON a stóráiltear sonraí go hinmheánach i mbunachair sonraí ar an bhfreastalaí. Maidir le stóras cúil, úsáideann Terminologue SQLite, atá ina inneall bunachair sonraí comhadbhunaithe. Is ionann gach bunachar sonraí in Terminologue agus comhad sa chóras comhad a bhíonn á oscailt agus á dhúnadh ag SQLite de réir mar is gá.

terminologue.js

Is féidir cúl Terminologue a thosú (i measc bealaí eile) ach node terminologue.js a rith ón teirminéal nó ón leid ordaithe. Léirmhíníonn agus ritheann Node.js inneachar an chomhaid JavaScript. Insíonn an comhad do Node.js cúpla rud a dhéanamh:

  1. Cruthaíonn sé oibiacht feidhmchláir Express ar a dtugtar app.

  2. Úsáideann sé modhanna ar nós app.post() agus app.get() chun an oibiacht seo a chur le líon mór láimhseálaithe le haghaidh na gcríochphointí éagsúla URL a d’fhéadfadh an t-úsáideoir a aimsiú. Is feidhm de chuid JavaScript é láimhseálaí agus ritheann Node.js é nuair a bhaineann iarratas HTTP an freastalaí amach. De ghnáth, próiseálann láimhseálaí na sonraí a tháinig leis an iarratas agus seolann sé rud éigin ar ais, mar shampla leathanach gréasáin nó oibiacht JSON.

  3. Ag deireadh an chomhaid mar sin, glaonn sé app.listen(). Insíonn sé seo do Node.js éisteacht le haghaidh iarratais HTTP a thagann isteach. Ón bpointe seo, ritheann Node.js a láimhseálaí gach uair a fhaigheann an freastalaí iarratas HTTP a mheaitseálann ceann de na críochphointí a cruthaíodh i gcéim 2 thuas. Leanann Node.js air ag éisteacht leis agus ag rith láimhseálaithe go gcríochnófar an feidhmchlár.

Ar ndóigh, bíonn gach láimhseálaí difriúil, ach déanann siad rudaí cosúil leis na nithe seo a leanas de ghnáth:

  • Roinnt sonraí ón iarratas HTTP a léamh ach airíonna na hoibiachta req a scrúdú.

  • Nasc le bunachar téarmaíochta (is ionann bunachar téarmaíochta in Terminologue agus bunachar sonraí SQLite) a oscailt ach ops.getDB() a ghlaoch.

  • Fáil amach an bhfuil an cliant logáilte isteach agus an bhfuil rochtain aige/aici ar an mbunachar téarmaíochta nó nach bhfuil, ach ops.verifyLoginAndTermbaseAccess(), nó rud éigin cosúil leis sin, a ghlaoch.

  • Roinnt sonraí a léamh nó a scríobh ó/i mbunachar téarmaíochta (= bunachar sonraí SQLite) ach modhanna amhail ops.entryRead(), ops.entrySave() agus go leor modhanna eile a ghlaoch.

  • An nasc le bunachar sonraí SQLite a dhúnadh ach db.close() a ghlaoch.

  • Freagairt a sheoladh chuig an gcliant, mar oibiacht JSON (ach res.json() a ghlaoch) nó mar leathanach HTML. Má tá leathanach HTML á sheoladh ag an láimhseálaí, glaonn sé res.render(). Tugann sé seo smacht d’inneall formáidithe EJS a bheireann ar cheann de na teimpléid HTML sa chomhadlann views (bíonn an iarmhír .ejs leis na comhaid), a ritheann aon chód taoibh freastalaí sa teimpléad (= aon rud idir <% agus %>) agus a sheolann na torthaí chuig an gcliant.

ops.js

Glaonn an chuid is mó de láimhseálaithe in terminologue.js feidhmeanna ón oibiacht ops, ar a dtugtar sainmhíniú sa chomhad ops.js. Sa chomhad seo, faightear an chuid is mó den chód íseal-leibhéil a dhéanann ionramháil ar rónna agus ar cholúin. Dá mbeadh freastalaí bunachar sonraí ar leith á úsáid againn seachas SQLite, gheofaí an chuid is mó den chód seo i ngnásanna stóráilte. Tá SQLite á úsáid againn, áfach, agus ní ann do ghnásanna stóráilte in SQLite, agus tá ops.js againn dá bharr.

Cuireann an comhad ops.js líon mór feidhmeanna ar fáil. Bíonn beagnach gach feidhm aisioncronach, ní chuireann siad aon luach ar ais. Ina áit sin, tógann siad feidhm aisghlaoite mar cheann dá n-argóintí agus, nuair a chuireann siad a gcuid oibre i gcrích, ritheann siad an t-aisghlao chun smacht a thabhairt ar ais don láimhseálaí HTTP in terminologue.js. I dtaca le Node.js, cuirtear aisghlaonna thart ann (seachas luachanna a chur ar ais).

Nuair a léann feidhm ó bhunachar sonraí SQLite nó nuair a scríobhann sé ann, léiríonn oibiacht ar a dtugtar db an bunachar sonraí. D'eascair an oibiacht seo as argóint i láimhseálaí terminologue.js. Baineann modhanna léi ar nós db.run() agus db.get() a thógann ráitis SQL agus a ritheann ar an mbunachar sonraí iad. Bíonn na modhanna seo aisioncronach freisin agus cuirimid ar ais trí aisghlaonna iad. Mar sin, baineann leibhéil éagsúla leis an gcód taoibh freastalaí in Terminologue ina leabaítear aisghlaonna in aisghlaonna, agus leabaítear na haisghlaonna sin in aisghlaonna eile. Is mar seo a dhéantar rudaí in Node.js.

Tá deireadh na treorach achoimre seo ar chód taoibh freastalaí Terminologue buailte linn. Táimid chun súil a chaitheamh ar an gcód taoibh cliaint anois.

Screenful

Aimsítear na leathanaigh HTML ar fad a chuirtear ar fáil don chliant sa chomhadlann website/views. Nuair a bhaineann an leathanach gréasáin ríomhaire an chliaint amach agus nuair a lódáiltear ar bhrabhsálaí gréasáin an chliaint é, dáilimid an chuid is mó den fheidhmiúlacht taoibh cliaint ar an leabharlann Screenful.

Cuireann Screenful roinnt cineálacha leathanaigh ar fáil dúinn a mbainimid úsáid astu in Terminologue. Mar shampla:

  • Is feidhmchlár aon leathanaigh a dhéanann bainistiú ar an bpróiseas logáil isteach é an cineál leathanaigh Screenful.Login.

  • Is feidhmchlár aon leathanaigh é an cineál leathanaigh Screenful.Make agus is féidir le húsáideoir idirghníomhú leis chun bunachar sonraí nua a chruthú. Úsáidimid ar Terminologue é chun bainistíocht a dhéanamh ar an bpróiseas a bhaineann le bunachar nua téarmaíochta a chruthú.

  • Is feidhmchlár aon leathanaigh é an cineál leathanaigh Screenful.Navigator ina bhfuil liosta iontrálacha ar thaobh na láimhe clé agus spás ar thaobh na láimhe deise le haghaidh féachaint agus eagarthóireacht a dhéanamh ar iontráil. Úsáideann Terminologue an cineál leathanaigh seo mar phríomhscáileán eagarthóireachta an bhunachair sonraí (is é seo an scáileán a gcaitheann téarmeolaithe formhór a gcuid ama ag féachaint air).

  • Is feidhmchlár aon leathanaigh é an cineál leathanaigh Screenful.Editor ina bhfuil tú in ann eagarthóireacht a dhéanamh ar iontráil ar leith. Tagann cnaipí leis le haghaidh iontrálacha a oscailt, a dhúnadh, a scriosadh agus mar sin de. Úsáidimid ar thaobh na láimhe deise de scáileán eagarthóireachta an bhunachair sonraí é (an áit a bhfuil sé leabaithe mar IFRAME), chomh maith le cúpla áit eile in Terminologue.

Fógraítear ar gach leathanach gréasáin de chuid Terminologue an cineál leathanaigh atá ann ach na comhaid ábhartha JavaScript agus CSS a iniamh. Mar shampla, fógraítear ar leathanach logáil isteach Terminologue (website/views/sitewide/login.ejs) gur leathanach den chineál Screenful.Login é mar seo a leanas:

<script type="text/javascript" src="../libs/screenful/screenful-login.js"></script>
<link type="text/css" rel="stylesheet" href="../libs/screenful/screenful-login.css" />

Cuireann sé na paraiméadair bhreise seo ar fáil ansin a insíonn do Screenful (i) an URL ar cheart dó an t-iarratas logáil isteach a sheoladh chuige, agus (ii) an áit ar cheart dó an t-úsáideoir a atreorú má éiríonn leis an logáil isteach:

<script type="text/javascript">
  Screenful.Login.loginUrl="../login.json";
  Screenful.Login.redirectUrl="<%=redirectUrl%>";
</script>

Déantar doiciméadú in Screenful ar an iarratas AJAX a sheolann Screenful ón gcliant chuig ár bhfreastalaí, agus ar an bhfreagairt a sheolann ár bhfreastalaí ar ais chuig an gcliant. Mar shampla, seolann an cliant iarratas ar nós Screenful.Login.loginUrl agus insíonn sé seo dúinn go dteastaíonn ón úsáideoir someone@example.com logáil isteach:

{
  "email": "someone@example.com",
  "password": "Hzwe86R!"
}

D’fhéadfadh ár bhfreastalaí freagairt mar seo a thabhairt, a thabharfaidh leid do Screenful an t-úsáideoir a atreorú Screenful.Login.redirectUrl.

{
  "success": true
}

Nó d’fhéadfadh ár bhfreastalaí freagairt mar seo a thabhairt, a thabharfaidh leid do Screenful a chur in iúl don úsáideoir nár éirigh leis an logáil isteach agus deis a thabhairt dó/di iarracht eile a dhéanamh:

{
  "success": false
}

Is mar seo a oibríonn Screenful agus is mar seo a mbainimid úsáid as gach áit in Terminologue, fiú ar chineálacha leathanaigh atá an-chasta, cosúil le scáileán eagarthóireachta an bhunachair sonraí. Fógraímid i gcónaí go mbaineann leathanach gréasáin ar leith le cineál áirithe leathanaigh de chuid Screenful agus cinntímid ansin go bhfuil na críochphointí againn do na ceangail éagsúla taoibh freastalaí a theastaíonn ón gcineál leathanaigh sin.

Aimsítear cóip Terminologue de Screenful in website/libs/screenful. Níor cheart duit eagarthóireacht a dhéanamh ar aon rud sa chomhadlann sin. Má theastaíonn uait athruithe a dhéanamh ar Screenful, smaoinigh ar iarratas ar tharraingt a sheoladh chuig stórlann Screenful ina áit sin.

Eagarthóireacht a dhéanamh ar na hiontrálacha: fy.js

Tá an cód a dhéanann eagarthóireacht ar iontráil téarmeolaíochta ar leith ar cheann de na smutáin is casta a bhaineann le cód taoibh freastalaí JavaScript in Terminologue. Léirítear aschur an chóid ar an bpríomhscáileán eagarthóireachta, tar éis don úsáideoir cliceáil ar an gcnaipe 'Eagarthóireacht', mar fhoirm chasta HTML ina bhfuil cluaisín ag an mbarr (DOM, TRM srl.).

Aimsítear an comhad JavaScript seo sa chomhad website/libs/fy/fy.js agus déantar formáidiú ar an HTML a aschuireann sé de réir stílbhileoige sa chomhad website/libs/fy/fy.css. Baineann dhá phríomhaidhm leis:

  • Fy.render() a thógann iontráil téarmeolaíochta in JSON (a fuarthas ó bhunachar téarmaíochta ar an bhfreastalaí) agus léiríonn sé ar an scáileán i bhfoirm HTML í. Is féidir leis an úsáideoir idirghníomhú léi ansin. Is ionann beagnach gach cuid den HTML a fheiceann tú ar thaobh na láimhe deise den scáileán eagarthóireachta agus aschur na feidhme seo.

  • Fy.harvest() a thógann staid reatha na foirme HTML agus “bailíonn” sé mar oibiacht JSON, atá réidh le sábháil i mbunachar téarmaíochta ar an bhfreastalaí, í.

Glaonn Screenful (is é an cineál leathanaigh Screenful.Editor a dhéanann é seo) na feidhmeanna Fy.render() agus Fy.harvest() nuair a léiríonn an t-úsáideoir (ach cnaipe a chliceáil, mar shampla) go dteastaíonn uaidh/uaithi iontráil a oscailt, iontráil a shábháil agus mar sin de.

Clómhaisiú a dhéanamh ar na hiontrálacha

Gné chasta eile a bhaineann le cód JavaScript ná an cód a dhéanann formáidiú nó clómhaisiú ar na hiontrálacha téarmeolaíochta. Tá trí áit ann ina ndéantar é seo:

  • Ar thaobh na láimhe clé den scáileán eagarthóireachta san áit a liostaítear na hiontrálacha. Déantar clómhaisiú ar gach iontráil anseo i bhfoirm ghiorraithe.

  • Ar thaobh na láimhe deise den scáileán eagarthóireachta san áit a ndéantar clómhaisiú ar iontráil ar leith i bhfoirm iomlán. Cliceálann an t-úsáideoir ar an gcnaipe 'Eagarthóireacht' le féachaint ar an iontráil ar a ndearnadh clómhaisiú nó le heagarthóireacht a dhéanamh uirthi le fy.js.

  • I gcomhéadan poiblí an bhunachair téarmaíochta (má tá an bunachar téarmaíochta le feiceáil go poiblí) san áit a léirítear na hiontrálacha ina bhfoirm iomlán a mbíonn na sonraí ar fad leo. Bíonn roinnt difríochtaí beaga ann, áfach, idir é seo agus an chaoi a léirítear sa chomhéadan eagarthóireachta iad.

Aimsítear an cód seo sa chomhadlann website/widgets:

  • Úsáidtear pretty-small.js agus pretty-small.css le clómhaisiú a dhéanamh ar liosta na n-iontrálacha ar thaobh na láimhe clé den scáileán eagarthóireachta.

  • Úsáidtear pretty-large.js agus pretty-large.css le clómhaisiú a dhéanamh ar thaobh na láimhe deise den scáileán eagarthóireachta.

  • Úsáidtear pretty-public.js agus pretty-public.css le clómhaisiú a dhéanamh i gcomhéadan poiblí an bhunachair téarmaíochta.

Baineann feidhm le gach comhad JavaScript ar a dtugtar entry() a thógann iontráil téarmeolaíochta in JSON (a fuarthas ó bhunachar téarmaíochta ar an bhfreastalaí) agus a aschuireann HTML. In pretty-small.js agus pretty-large.js, ritheann Screenful an fheidhm entry() ar an taobh cliaint nuair a chaithfidh sé iontráil a léiriú ar an scáileán. In pretty-public.js, ritheann Node.js an fheidhm entry() ar an taobh cliaint agus seolann sé an t-aschur chuig ár gcliant mar chuid de leathanach HTML.

Conclúid

Is dócha gur leor sin ag an bpointe seo. Tá súil againn gur tugadh achoimre duit sa doiciméad seo ar (i) chód taoibh freastalaí Terminologue, agus ar (ii) chuid de na codanna níos casta de chód taoibh cliaint Terminologue.

Gaois

Ár leithscéal

Níl an suíomh seo comhoiriúnach leis an mbrabhsálaí gréasáin Microsoft Internet Explorer. Bain úsáid as Chrome, Edge, Firefox, Opera, nó brabhsálaí nua-aimseartha eile chun teacht ar ábhar an tsuímh.

Déan teagmháil linn ag gaois@dcu.ie sa chás go mbíonn aon cheist agat.