Spring clean architecture

Spring clean architecture
AP
  • Rejestracja:około 6 lat
  • Ostatnio:około 2 miesiące
  • Postów:164
3

Cześć,
Zacząłem ostatnio tworzyć projekt którego głównym celem jest zapoznanie się z architekturą heksagonalna, separacją logiki domenowej od frameworka (Spring) oraz poznanie biblioteki Vavr
Funkcjonalnie ma to być Internetowy dziennik treningowy, czyli układanie treningów / diety, śledzenie swoich postępów, itp. Póki co jednak nic z tego nie jest ruszone, zacząłem od modułu użytkownika który obecnie umożliwia rejestracje i potwierdzenie założenia konta.
Po stronie infrastruktury, skonfigurowane jest security na podstawie JWT oraz połączenie do MongoDB.
Obecnie siadam do frontendu (Angular) i bardzo zależałoby mi na review tego co obecnie napisałem.

https://gitlab.com/angryprogrammer01/springcleanarchitecture

Charles_Ray
  • Rejestracja:około 17 lat
  • Ostatnio:3 dni
  • Postów:1873
1

Wygląda to naprawdę nieźle! :) z plusów:

  1. klasy package scope
  2. podział na pakiety per feature
  3. zastosowanie dependency inversion principle.
  4. kod jest czytelny
  5. testy jednostkowe przez fasadę, a nie na wszędobylskich mockach

Nad czym bym się zastanowił:

  1. Brak testów integracyjnych - skąd wiesz, że Twoja aplikacja zadziała na produkcji?
  2. Klasa ResponseResolver - użyj @ControllerAdvice
  3. Jest kilka „worków”, które mogą się rozrastać - np. ten ObjectCreator w testach, czy pakiet „common” - tutaj możesz zrobić podpakiet „vavr” na extensiony stricte dotyczące Vavra
  4. Brak struktury given/when/then testów (lub arrange/act/assert), przez co są nieczytelne i sprawdzają za dużo. Brakuje mi tez testów na ścieżki alternatywne - widać, że nie robisz TDD.
  5. Kolizja nazwy klasy ObjectMapper. Wiem, że to domena i nie wie o Springu, natomiast jest to i tak mylące. Poza tym nazwa aby ogólna, proponuję UserConverter.
  6. Nie podoba mi się, że fasadę do testów tworzysz inaczej niż produkcyjną - testowa metoda powinna wołać produkcyjna, abyś testował kod, który będzie odpalany na prodzie.
  7. Jeden kontroler i fasada zarówno do pobierania zasobu Usera, jak i do jego rejestracji i linków aktywacyjnych - te ostatnie nie są raczej zasobami w rozumieniu REST oraz będą miały pewnie inne reguły security. Rozważyłbym rozwód kontrolerów, moduł może zostać jeden.

Na zakończenie powtórzę - jest nieźle! :)


”Engineering is easy. People are hard.” Bill Coughran
edytowany 3x, ostatnio: Charles_Ray
WE
  • Rejestracja:prawie 7 lat
  • Ostatnio:ponad 5 lat
  • Postów:53
0

@Charles_Ray: co do punktu 6, czyli tworzymy Fasadę tą samą metodą w Configuration, ale po prostu przekazujemy tam w parametrach nasze implementacje InMemory?

danek
  • Rejestracja:ponad 10 lat
  • Ostatnio:6 miesięcy
  • Lokalizacja:Poznań
  • Postów:797
0

@weiss: w testach możesz od razu zrobić new XFacade(cosInMemory, cosInMemory) bez potrzeby konfiguracji itp. Klasy Configuration są zazwyczaj tylko na potrzeby spięcia całości frameworkiem itp


Spring? Ja tam wole mieć kontrole nad kodem ᕙ(ꔢ)ᕗ
Haste - mała biblioteka do testów z czasem.
edytowany 1x, ostatnio: danek
WE
  • Rejestracja:prawie 7 lat
  • Ostatnio:ponad 5 lat
  • Postów:53
0

Czyli klasa Configuration przyda się nam jeśli będziemy z Fasady musieli zrobić Bean żeby mógł on tam podpiąć swoje adnotacje potrzebne do działania. Czyli np. przekazujemy Springowej DAO?

danek
mniej więcej
SN
  • Rejestracja:ponad 11 lat
  • Ostatnio:ponad 5 lat
  • Postów:4
0

Bardzo fajny kod. Mi też się podoba :).
Tylko, mam pytanie: Czy na pewno dobrym pomysłem jest transformacja z Dto -> Obiekt domenowy -> Dto -> encja? Czy to nie jest już trochę overengineering? :)

danek
  • Rejestracja:ponad 10 lat
  • Ostatnio:6 miesięcy
  • Lokalizacja:Poznań
  • Postów:797
0

Czyżbym widział pewną inspiracje? ;) Z rzeczy które teraz na szybko znalazłem

Kopiuj
User userToEntity(UserDto user) {
        if(user == null) return null;
//uciete
    }

Nie ładnie zwracać nulle ;)

Kopiuj
   private Success deactivate(ActivationTokenDto tokenDto) throws RuntimeException {
        var deactivatedToken = ActivationTokenDto.builder()
                .tokenID(tokenDto.getTokenID())
                .username(tokenDto.getUsername())
                .activated(true)
                .expirationDateTime(LocalDateTime.now())
                .build();
        tokenRepository.updateToken(deactivatedToken);
        return new Success();
    }

Czemu RuntimeException?

Kopiuj
private Either<Error, Success> activateUser(UserDto userDto) {
        var user = mapper.userToEntity(userDto);
        user.activate();
        return Try.of(() -> activate(mapper.userToDto(user)))
                .onFailure(e -> log.severe(e.getMessage()))
                .toEither(UserError.PERSISTENCE_FAILED);
    }

Jeśli activate(mapper.userToDto(user)) sie wysypie to nie jest problem ze user.activate() się wykonało?

@Charles_Ray: ResponseResolver jest po to, żeby nie używać wyjątków ;)


Spring? Ja tam wole mieć kontrole nad kodem ᕙ(ꔢ)ᕗ
Haste - mała biblioteka do testów z czasem.
edytowany 5x, ostatnio: danek
AP
  • Rejestracja:około 6 lat
  • Ostatnio:około 2 miesiące
  • Postów:164
0

Tylko, mam pytanie: Czy na pewno dobrym pomysłem jest transformacja z Dto -> Obiekt domenowy -> Dto -> encja? Czy to nie jest już trochę overengineering? :)

Doszedłem do wniosku że nie, przynajmniej nie w projekcie tego kalibru. Pozbyłem się obiektów domenowych, model==dto jest teraz publiczny, a cała logika przeniesiona jest do serwisów realizujących use case.

Nie ładnie zwracać nulle ;)

To już poprawione ;)

Czemu RuntimeException?

Zastanawiam się właśnie co robić w przypadku błędów jakie mogą lecieć z bazy?

Jeśli activate(mapper.userToDto(user)) sie wysypie to nie jest problem ze user.activate() się wykonało?

@Transactional po stronie repozytorium?

danek
  • Rejestracja:ponad 10 lat
  • Ostatnio:6 miesięcy
  • Lokalizacja:Poznań
  • Postów:797
0

Zastanawiam się właśnie co robić w przypadku błędów jakie mogą lecieć z bazy?

Zazwyczaj wtedy connector do bazy rzuca wyjątkiem (i nawet wtedy powinien)


Spring? Ja tam wole mieć kontrole nad kodem ᕙ(ꔢ)ᕗ
Haste - mała biblioteka do testów z czasem.
szopn
  • Rejestracja:ponad 5 lat
  • Ostatnio:10 miesięcy
  • Postów:11
2

Dlaczego plik UserConfiguration znajduje się z w katalogu z domeną? Z tego co widzę ma on adnotacje ze Springa (@Configuration, @Configuration), czy nie lepiej byłoby go przenieść do jakiegoś innego pakietu, w którym konfigurujesz sobie rzeczy związane ze Springiem? Np. pakiet configuration.

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)