Dart Academy · Oppitunti

Julkaistavan kirjaston rakenne

Jäsennä lib, src ja julkinen API

Oppitunti 1/413 vaihetta

Julkaistavan kirjaston rakenne on ilmainen Dart Academy-oppitunti CoddyKitissä. Tämä on oppitunti 1/4. Voit lukea koko oppitunnin alta ilmaiseksi ja harjoitella sen jälkeen käytännössä selaimessa sisäänrakennetulla koodieditorilla ja ympäri vuorokauden käytettävissä olevan tekoälytuutorin avulla. Oppitunti kuuluu Dart Academy-oppimispolkuun, ja edistymisesi synkronoituu verkon ja CoddyKit-sovelluksen välillä. Dart Academy-kurssilla on yhteensä 4 oppituntia.

Paketti on vain kansio

Julkaistava Dart-package on yksinkertaisesti kansio, jonka juuressa on pubspec.yaml-tiedosto. Tämä yksi tiedosto muuttaa tavallisen koodin sisällöksi, jota pub.dev voi ylläpitää. 📦

lib-kansio on julkinen koti

Kaikki käyttäjille importattavaksi tarkoitetut tiedostot sijaitsevat lib-kansion alla. Suoraan lib-kansiossa olevat tiedostot kuuluvat pakettinne julkiseen rajapintaan, joten sijoittakaa ne harkiten.

Piilottakaa sisäiset osat kansioon lib/src

Koodi, jota ette halua paljastaa, sijoitetaan kansioon lib/src. Käytännön mukaan nämä tiedostot ovat yksityisiä toteutuksen yksityiskohtia, eikä niitä ole tarkoitettu käyttäjien suoraan importattaviksi.

lib/
  my_package.dart
  src/
    helper.dart

Sisääntulotiedosto

Useimmissa paketeissa on lib-kansiossa yksi paketin mukaan nimetty päätiedosto. Tämä entry point on tiedosto, jonka käyttäjät importtaavat saadakseen koko kirjastonne käyttöön kerralla.

import 'package:my_package/my_package.dart';

Viekää osat uudelleen export-avainsanalla

Sisääntulotiedostonne käyttää export-avainsanaa tuodakseen lib/src-kansiosta esiin ne osat, joita käyttäjät todella tarvitsevat. Näin määrittelette yhden selkeän ja harkitun julkisen rajapinnan.

export 'src/calculator.dart';
export 'src/parser.dart';

Päättäkää julkisesta rajapinnasta harkiten

Viemienne nimien joukko muodostaa public API-rajapintanne. Pitäkää se suppeana ja vakaana, sillä jokainen viety symboli on lupaus käyttäjillenne.

Alaviivat merkitsevät yksityisyyttä

Alaviivalla alkavat nimet ovat Dartissa library-private-nimiä. Myös lib/src-kansion sisällä voitte merkitä piiloon tarkoitetut apufunktiot yhdellä alaviivalla.

int _internalCount = 0;

example-kansio

Lisätkää example-kansio, jossa on pieni suoritettava ohjelma. Se näyttää käyttäjille, miten pakettinne toimii, ja tuo teille pisteitä pub.devissä. ✨

Testit kuuluvat test-kansioon

Automaattiset testit sijaitsevat test-kansiossa lib-kansion ulkopuolella. Niitä ei toimiteta käyttäjille, mutta ne osoittavat, että pakettinne toimii lupausten mukaisesti.

Juuritason tiedostot ovat tärkeitä

Hyvän paketin juuressa ovat myös README, CHANGELOG ja LICENSE. Nämä kolme tiedostoa pub.dev näyttää kävijöille ensimmäisenä.

Selkeä rakenne yhdellä silmäyksellä

Kun kokoatte rakenteen yhteen, structure toimii karttana: lib sisältää rajapinnan, src sisäiset osat sekä example- ja test-kansiot ja metatietotiedostot.

my_package/
  lib/
  example/
  test/
  pubspec.yaml

Pikatarkistus

Minne sijoitatte koodin, jonka tulee säilyä sisäisenä toteutuksen yksityiskohtana?

Vastaa interaktiivisessa oppitunnissa

Kertaus: siisti kirjasto

Opitte paketin layout-rakenteen: lib sisältää julkisen rajapinnan, lib/src piilottaa sisäiset osat ja export määrittää, mitä käyttäjät näkevät. Ensin rakenne kuntoon, sitten julkaisu. 🚀

Aloita maksutta

Opi Dart tekoälytuutorin avulla — ilmaiseksi

Kirjoita ja suorita oikeaa koodia selaimessa, saa välitöntä apua tekoälytuutorilta ympäri vuorokauden ja jatka siitä, mihin jäit, verkossa tai sovelluksessa.

Kurssit: 30
Oppitunnit: 120

Aloita opiskelu maksutta Näytä koko kurssi

Usein kysytyt kysymykset

Onko oppitunti ”Julkaistavan kirjaston rakenne” ilmainen?

Kyllä – oppitunnin ”Julkaistavan kirjaston rakenne” koko tekstin voi lukea täällä verkossa ilmaiseksi. Jos haluat harjoitella interaktiivisesti sisäänrakennetulla koodieditorilla ja ympäri vuorokauden käytettävissä olevan tekoälytuutorin avulla sekä avata koko Dart Academy-kurssin, päivitä CoddyKit PROhon. Dart Academy-kurssilla on yhteensä 4 oppituntia.

Mitä opin oppitunnilla ”Julkaistavan kirjaston rakenne”?

Jäsennä lib, src ja julkinen API Harjoittelet Dart Academy-aihetta koodilla, jonka suoritat suoraan selaimessa. Ympäri vuorokauden käytettävissä oleva tekoälytuutori vastaa kysymyksiisi oppitunnin aikana.

Tarvitsenko kokemusta aloittaakseni Dart Academy-opiskelun?

Aiempi kokemus ei ole tarpeen. CoddyKitin Dart Academy-oppimispolku sopii vasta-alkajista edistyneisiin, joten voit aloittaa tästä tai alusta ja edetä omaan tahtiisi. Tämä on oppitunti 1/4.

Kuinka kauan ”Julkaistavan kirjaston rakenne”-oppitunnin suorittaminen kestää?

Useimmat CoddyKitin oppitunnit kestävät noin 5–10 minuuttia. Jokainen oppitunti on lyhyt ja interaktiivinen, joten edistyt tasaisesti ja voit jatkaa siitä, mihin jäit – sekä verkossa että sovelluksessa.

Voinko kirjoittaa ja suorittaa koodia tällä Dart Academy-oppitunnilla?

Kyllä. Jokainen Dart Academy-oppitunti sisältää sisäänrakennetun koodieditorin, joten voit kirjoittaa ja suorittaa oikeaa koodia suoraan selaimessa ja saada välitöntä palautetta tekoälyltä – paikallista asennusta ei tarvita.

Kaikki tämän kurssin oppitunnit

← Takaisin: Dart Academy