Obsługa błędów za pomocą sealed class

Obsługa błędów za pomocą sealed class
AngryProgrammer
AP
AngryProgrammer
AP
  • Rejestracja:około 6 lat
  • Ostatnio:około miesiąc
  • Postów:164
1

Piszę nowy projekt w Kotlinie i zastanawiam się jak zamodelować jego architekturę i obsługę błędów. Po pierwsze, na pewno chciałbym skorzystać z sealed class do obsługi błędów, zamiast Javowego podejścia z rzucaniem "biznesowych" RuntimeException.
No i mam powiedzmy dwie klasy które wykonują jakąś akcję, np. zapytanie do innego API, walidacje jakiś parametrów, czy zapis do bazy danych, nie ma to znaczenia, w każdym razie zwracają one jakiś sealed class który może oznaczać poprawne wykonanie operacji, albo jakiś błąd

Kopiuj
sealed class FirstServiceResult {
    object Success: FirstServiceResult()
    object YNotFound: FirstServiceResult()
}

sealed class SecondServiceResult {
    object Success: SecondServiceResult()
    object InvalidArgumentX: SecondServiceResult()
}

No i te dwie operacje są składową jednej większej operacji, czyli np. FirstService wyszukuje coś korzystając z zewnętrznego API, a SecondService waliduje wynik wyszukiwania. Całość jest jednak wołana z jakiegoś MainService, który musi zawołać najpierw jeden a potem drugi serwis i zmapować to na swoj rezultat, czyli np.

Kopiuj
sealed class MainServiceResult {
    object Success: MainServiceResult()
    object YNotFound: MainServiceResult()
    object InvalidArgumentX: MainServiceResult()
}

Co potem w warstwie wyżej controllera, mogę mapować na odpowiednie kody HTTP, np. 200, 404, 400

Tyle że jak widać na powyższym przykładzie, MainServiceResult musi duplikować wszystkie wartości z FirstServiceResult i SecondServiceResult, gdzie w realnym przykładzie jest dużo więcej wartości które trzeba powielić.

Jest jakiś sprytny sposób jak to rozwiązać? Myślałem by ewentualnie FirstService i SecondService, które tak naprawdę obsługują wyjątki rzucone z warstwy infra (DB, API), po prostu propagowały te wyjątki wyżej i wtedy MainService mapowałby te wyjątki na odpowiedni sealed class, jednak wydaje mi się to brzydkie z dwóch powodów - po pierwsze, wolałbym te wyjątki obsłużyć jak najniżej się da i nie propagować ich wyżej, a po drugie to troche mieszanie dwóch podejść. Z drugiej jednak strony, sealed class poniekąd wymusza duplikacje różnych rezultatów w dwóch różnych miejscach. Dlatego pytanie, jak inaczej podejść do rozwiązania tego problemu?

edytowany 1x, ostatnio: AngryProgrammer
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
VeloxDigitis
VD
VeloxDigitis
VD
  • Rejestracja:ponad 10 lat
  • Ostatnio:9 miesięcy
  • Postów:72
0

Jak zawsze, mając bardzo abstrakcyjny przykład ciężko na jego temat debatować. Wydaje mi się, że duplikacja, którą przedstawiłeś nie jest z zasady zła. Błędy MainServiceResult mogą być czymś zupełnie innym niż FirstServiceResult, bo np. NotFound może zostać obsłużone przez jakiegoś rodzaju fallback.
Jeśli Ci to przeszkadza nie widzę też problemu, żeby serwisy zwracały od razu błędy MainServiceResult, bo nadal mamy zachowaną komunikację jednostronną (jeśli rzeczywiście idą one wyżej 1:1). Musisz się zastanowić czy te błędy powinny zostać rozdzielone czy nie, bo np. MainService jest jakimś serwisem aplikacyjnym, a FirstService warstwą infrastruktury - wtedy pewnie chcemy mówić na różnych poziomach różnymi językami. Np. wyżej będziemy mówić o błędzie Nie znaleziono danego użytkownika, a niżej Brak dokumentu User w bazie.

Tak jak napisałeś łapanie wyjątków jak najniżej (ponieważ zewnętrzne biblioteki je rzucają) jest dobrym podejściem - zwiększa opisowość Twojego API, lepiej się testuje i zmniejsza ilość błędów.

edytowany 1x, ostatnio: VeloxDigitis
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
scibi_92
S9
scibi_92
S9
  • Rejestracja:około 4 lata
  • Ostatnio:około 2 lata
  • Lokalizacja:Warszawa
  • Postów:1092
1

Ale warstwa wyżej nie powinna znać wyjątków z warstwy niższej! Co więcej, to warstwa domeny definiuje kontrakt, a w warstwie infrastruktury jest on po prostu zaimplementowany.
Inaczej umująć, CurenncyExchangeRateProvider jest w domenenie, a CurrencyExchangeRestRateProvider w infrastrukturze.

Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
AngryProgrammer
AP
AngryProgrammer
AP
  • Rejestracja:około 6 lat
  • Ostatnio:około miesiąc
  • Postów:164
0

Dobra, to może nieco bardziej konkretnie.
Mamy InvoiceUploader, który jest odpowiedzialny za połączenie z jakimś legacy systemem przez libkę napisaną w Javie (pod spodem lecą jakieś zwykłe RESTy) i zapisanie faktury.
Mamy też InvoiceValidator, który odpowiada za sprawdzenie poprawności faktury wedlug jakiś zasad biznesowych.
No i jest to wołane z powiedzmy InvoiceService, który jest wołany z InvoiceController, którego zadanie to po pierwsze:

  • walidacja faktury, co może zwrócić X powodów dla którego faktura nie jest poprawna
  • upload faktury, tutaj błędy tak naprawdę wracaja z zewnętrznej biblioteki, która rzuca wyjątki zarówno typu: 503 Service Unavailable jak i jakieś 400 Bad Request

Jak widać, mamy dwa różne sealed class, jeden opisuje że np. NIP na fakturze nie istnieje w systemie, a drugi że zerwało połączenie, albo użytkownik nie podał jakiś wymaganych danych do działania libki. Tutaj już rodzi się pytanie, skoro to input użytkownika, to może warto go walidować już na wejściu do naszego systemu? Tyle że, po to mamy biblioteke która za to odpowiada, żeby tego nie robić ręcznie, więc prościej wydaje się po prostu zrobić prostę walidacje za pomocą biblioteki i owrappować rezultat w postaci wyjątku w sealed class.

Tyle że, tym co trafi do kontrollera u nas, ma być InvoiceServiceResult, który będzie zmapowany na odpowiedni kod i wiadomosć błędu. Tyle że tak naprawdę, jest to InvoiceUploaderResult || InvoiceValidatorResult.

W każdym razie, widzę chyba ewentualne rozwiązanie. Zakłada ona że serwisy infra posługują się tak jakby kontraktem domeny, no ale chyba nic lepszego nie wymyślę

Kopiuj
sealed class InvoiceServiceResult

sealed class InvoiceValidatorResult: InvoiceServiceResult {
//...
}

sealed class InvoiceUploaderResult: InvoiceServiceResult {
//...
}
edytowany 1x, ostatnio: AngryProgrammer
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Treść
Podgląd
Kliknij, aby dodać treść...
Kliknij, aby dodać załącznik lub wklej ze schowka.
Instrukcja obsługi Markdown
Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)