0Pricing
Dart Academy · Lekcja

Struktura biblioteki gotowej do publikacji

Rozplanowanie katalogów lib, src i publicznego API

Struktura biblioteki gotowej do publikacji to bezpłatna lekcja Dart Academy na CoddyKit. To lekcja 1 z 4. Możesz przeczytać całą lekcję poniżej za darmo — a potem ćwiczyć ją interaktywnie w przeglądarce z wbudowanym edytorem kodu i tutorem AI dostępnym 24/7. To część ścieżki edukacyjnej Dart Academy, a Twój postęp synchronizuje się między webem a aplikacją CoddyKit. Kurs Dart Academy zawiera 4 lekcji w sumie.

Pakiet to po prostu folder

Publikowalny pakiet Dart to po prostu folder z plikiem pubspec.yaml w katalogu głównym. Ten jeden plik zmienia zwykły kod w coś, co może być hostowane przez pub.dev. 📦

Folder lib to publiczna część pakietu

Wszystko, co użytkownicy mają importować, znajduje się w folderze lib. Pliki umieszczone bezpośrednio w lib należą do publicznego interfejsu pakietu, dlatego należy je rozmieszczać rozważnie.

Ukrywanie elementów wewnętrznych w lib/src

Kod, który nie powinien być udostępniany, należy umieścić w lib/src. Zgodnie z konwencją pliki te zawierają prywatne szczegóły implementacji i nie są przeznaczone do bezpośredniego importowania przez użytkowników.

lib/
  my_package.dart
  src/
    helper.dart

Plik wejściowy

Większość pakietów zawiera jeden główny plik w folderze lib, nazwany tak jak pakiet. Ten punkt wejścia użytkownicy importują, aby za jednym razem uzyskać dostęp do całej biblioteki.

import 'package:my_package/my_package.dart';

Ponowne eksportowanie za pomocą słowa kluczowego export

Punkt wejścia używa słowa kluczowego export, aby udostępnić elementy z lib/src, których użytkownicy rzeczywiście potrzebują. W ten sposób tworzy Pan/Pani jeden przejrzysty i przemyślany publiczny interfejs API.

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

Świadome projektowanie publicznego interfejsu API

Zestaw eksportowanych nazw to publiczne API. Należy utrzymywać je w niewielkim i stabilnym zakresie, ponieważ każdy eksportowany symbol jest obietnicą złożoną użytkownikom.

Podkreślenia oznaczają prywatność

Nazwy zaczynające się od podkreślenia są w Dart prywatne dla biblioteki. Nawet w lib/src należy poprzedzać jednym podkreśleniem funkcje pomocnicze, które nigdy nie powinny zostać udostępnione.

int _internalCount = 0;

Folder example

Należy dodać folder example z małym programem, który można uruchomić. Pokazuje on użytkownikom, jak działa pakiet, i zapewnia punkty w pub.dev. ✨

Testy należą do folderu test

Testy automatyczne znajdują się w folderze test, poza lib. Nie są dostarczane użytkownikom, ale potwierdzają, że pakiet działa zgodnie z obietnicą.

Pliki w katalogu głównym mają znaczenie

W katalogu głównym dobrego pakietu powinny znajdować się także pliki README, CHANGELOG i LICENSE. To właśnie te trzy pliki pub.dev pokazuje odwiedzającym jako pierwsze.

Przejrzysta struktura na pierwszy rzut oka

Po złożeniu wszystkiego w całość struktura przypomina mapę: lib zawiera API, src elementy wewnętrzne, a dodatkowo mamy example, test i pliki metadanych.

my_package/
  lib/
  example/
  test/
  pubspec.yaml

Szybkie sprawdzenie

Gdzie należy umieścić kod, który powinien pozostać wewnętrznym szczegółem implementacji?

Podsumowanie: uporządkowana biblioteka

Poznał(a) Pan/Pani strukturę: lib zawiera publiczne API, lib/src ukrywa elementy wewnętrzne, a export określa to, co widzą użytkownicy. Najpierw struktura, potem publikacja. 🚀

Często zadawane pytania

Czy lekcja „Struktura biblioteki gotowej do publikacji” jest bezpłatna?

Tak — pełny tekst „Struktura biblioteki gotowej do publikacji” jest dostępny za darmo tutaj w sieci. Aby ćwiczyć ją interaktywnie (wbudowany edytor kodu i tutor AI dostępny 24/7) i odblokować resztę kursu Dart Academy, przejdź na CoddyKit PRO. Kurs Dart Academy zawiera 4 lekcji w sumie.

Co nauczysz się w „Struktura biblioteki gotowej do publikacji”?

Rozplanowanie katalogów lib, src i publicznego API Ćwiczysz Dart Academy z praktycznym kodem, który uruchamiasz bezpośrednio w przeglądarce, a tutor AI dostępny 24/7 odpowiada na Twoje pytania podczas pracy nad lekcją.

Czy potrzebuję doświadczenia, aby zacząć Dart Academy?

Nie wymagamy żadnego doświadczenia. Dart Academy w CoddyKit jest strukturyzowany dla początkujących i zaawansowanych użytkowników, więc możesz zacząć tutaj lub od początku i uczyć się w swoim tempie. To lekcja 1 z 4.

Ile czasu zajmuje lekcja „Struktura biblioteki gotowej do publikacji”?

Większość lekcji CoddyKit trwa około 5–10 minut. Każda lekcja to mały, interaktywny krok, dzięki czemu robisz systematyczne postępy i zawsze wracasz dokładnie do tego samego miejsca — na webie i w aplikacji.

Czy mogę pisać i uruchamiać kod w tej lekcji Dart Academy?

Tak. Każda lekcja Dart Academy zawiera wbudowany edytor kodu, więc piszesz i uruchamiasz prawdziwy kod bezpośrednio w przeglądarce i od razu otrzymujesz sprzężenie zwrotne od AI — bez konfiguracji na komputerze.

Wszystkie lekcje w tym kursie

  1. Struktura biblioteki gotowej do publikacji
  2. Dokumentowanie za pomocą komentarzy dartdoc
  3. Linting, formatowanie i wynik pana
  4. dart pub publish do pub.dev
← Powrót do Dart Academy