Obsługa błędów w aplikacji webowej

Obsługa błędów w aplikacji webowej
GA
  • Rejestracja:ponad 4 lata
  • Ostatnio:około rok
  • Postów:68
0

W sumie temat trochę z pogranicza designu aplikacji, więc może nie najlepszy dział wybrałem, aczkolwiek korzystam z Javy i Springa, tak więc jakieś technologiczne ograniczenia na pewno też wchodzą w grę.

Jako pracę inżynierską projektuję, implementuję i wdrażam aplikację. Z grubsza, jest to trochę przerośnięty CRUD, w środku siedzi jednak trochę dodatkowej logiki. Obecnie pracuję nad backendem, docelowo jednak powstanie również frontend, korzystający z API wystawionego przez wspomniany backend.

No i zastanawiam się jak rozwiązać obsługę błędów. Obecnie próbuje podejście, w którym wydzieliłem 3 kategorie błędów

  • constraintViolations - wszelkie błędy typu "to pole nie może być nullem", generalnie mógłbym tutaj zakończyć pracę na dodaniu adnotacji @NotNull na wejściowych DTOsach i w controllerach dorzucić @Valid @RequestBody. Spring sam ogarnie co z tym zrobić, jednak jako że chciałbym mieć jeden spójny ErrorResponse dla wszystkich przypadków, to po prostu samemu będę wołać te walidację w jakimś interceptorze i mapować to na swoje błędy.
  • domainError - wszelkie błędy, które wyszły z serwisu (ale nie wyjątki). Korzystam z vavrowego Either i każdy serwis który robi jakąś logikę ma po lewej stronie listę enumów opisujacych kolejno co poszło nie tak.
  • exception - czyli wszystko co faktycznie sypnie wyjątkiem i zmapuje się na HTTP 500, czyli jakiś błąd z bazy danych czy niedostępność zewnętrznego API które wołam w aplikacji. Łapie taki wyjątek w @ControllerAdvice i wrzucam do exception opisanego poniżej.

No i to wszystko opakowałem w coś takiego

Kopiuj
@Getter
public class ErrorResponse {
    private final List<ConstraintViolation> constraintViolations;
    private final List<DomainError> domainErrors;
    private final ExceptionWrapper exception;
 
    // static factories
}

No i zastanawiam się jak to najlepiej obsłużyć na UI

  • Http 5xx -> redirect na stronę z informacją "coś poszło nie tak, spróbuj ponownie później". Na dobrą sprawę, ten exception mi w response nie jest aż tak potrzebny z punktu widzenia klienta
  • Http 401/403 -> redirect do logowania
  • Http 400 -> czyli jakiś constraintViolation, wiem wtedy że muszę szukać w tym miejscu i jakoś to wyświetlić. Frontend jednak będzie mimo wszystko mieć walidację na formularzach, jak zostawię pustę pole email to od razu lepiej mieć o tym informację, a nie dostawać ją dopiero z backendu.
  • Http 409 -> tutaj chciałbym wrzucić wszystkie błędy z domeny, nie wiem czy jest na to lepszy status, w każdym razie, wszystko co się tu nie uda powinno jakoś zostać przedstawione użytkownikowi.

Pytanie jednak, czy jest sens bawić się w robienie jednolitego ErrorResponse? Może wystarczy, żebym zwrócił domainError który ma jakieś znaczenie na UI i nie może być tam wcześniej walidowany i do tego włączyć @Valid na requestach w controllerach i tyle, nie przejmować się tym podwójnie, skoro i tak muszę to obsłużyć na frontendzie zanim wyślę request?

edytowany 1x, ostatnio: Gazel
PI
  • Rejestracja:ponad 9 lat
  • Ostatnio:3 miesiące
  • Postów:2787
0

Napiszę swoją opinię, jak ja to widzę:

  • Czy zostawić jednolity ErrorResponse - jeśli zostawisz, to pewnie na froncie potem trzeba będzie sprawdzać które pole (constraintViolations domainErrors, exception) ma coś w sobie czy nie. Dlatego IMHO postawiłbym na zwracanie od razu ConstraintViolation, DomainError albo Exception z jakimś sensowym messegem
  • Czy "dublować" walidację, skoro na frontendzie też zachodzi - jak najbardziej. API backendowe musi być walidowane niezależnie od frontendu, ponieważ zawsze ktoś może sobie z palca http request wysłać
  • Co do kodu 409 - dość mało popularny status, ja bym błędy walidacyjne domenowe dał na 400, czyli jeśli użytkownik poda id produktu 5, no to pierwszą walidację przejdzie (bo 5 jest not null), ale np nie ma takiego produktu o takim id - to nadal jest błąd użytkownika a nie systemu, więc 400 Bad Request jest tu raczej sensowny (w przypadku akurat braku jakiegoś resource można się pokusić o 404, ale to już wyższa szkoła RESTa)
edytowany 1x, ostatnio: Pinek
GA
  • Rejestracja:ponad 4 lata
  • Ostatnio:około rok
  • Postów:68
0

@Pinek:

Co do użycia 400 i 409, chodziło mi o proste rozróżnienie sytuacji, tzn.
Przypadek 1, w requeście nie podałem wymaganego pola (w sumie mało prawdopodobna sytuacja, ze względu na sprawdzenie tego na froncie, aczkolwiek muszę to też obsłużyć).
Dodatkowo, dla ułatwienia po prostu dodaje @NotBlank czy coś podobnego w dtosie i @Valid @RequestBody, dostaje:

Kopiuj
{
    "cause": "Validation failed for argument [0] in org.springframework.http.ResponseEntity<pl.example.project.dto.result.CreateUserResult> pl.example.project.web.controllers.AuthenticationController.createUser(pl.example.project.dto.command.CreateUserCommand): [Field error in object 'createUserCommand' on field 'email': rejected value [null]; codes [NotBlank.createUserCommand.email,NotBlank.email,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [createUserCommand.email,email]; arguments []; default message [email]]; default message [nie może być odstępem]] "
}

Mało czytelne, ale działa bez dodatkowej pracy po mojej stronie.

Przypadek 2, podałem maila który jest zajęty

Kopiuj
{
    "domainErrors": [
        "EMAIL_ALREADY_IN_USE"
    ]
}

Rozbijając to na dwa kody Http chciałem uniknąć czegoś takiego po stronie Angulara

Kopiuj
 this.userService.createUser().subscribe(res => {
      // success
    }, err =>  {
        if(err.status === 400 && err.domainError) {
          err.domainError.array.forEach(element => {
            this.specificErrors.push(i18n(element));
          });
        } else {
          this.generalError = 'Something bad happend';
        }
      }
    );
edytowany 1x, ostatnio: Gazel
Kliknij, aby dodać treść...

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)