Architektura aplikacji ciekawy przypadek

Jakiś czas temu pisalem w pracy serwer gier, technologie: Java, Spring, Redis, Websocket & STOMP.
Kod, który napisałem działa, są testy jednak z perspektywy czasu uważam, że chyba źle to podzieliłem
architektonicznie.

Zacznijmy może od tego jak działa prosta architektura warstowa.

Mamy API czyli zestaw nazwijmy to kontrolerów, które przyjmują żądania.
Kontrolery powinny być jak najmniejsze, ich odpowiedzialnością jest tylko
aby przyjąć żądanie i oddelegować daną czynność do serwisu, który jest
odpowiedzialny za wykonanie logiki biznesowej i zwrócenie wyniku następnie
wynik jest zwracany do żądającego. Kontrolerem w tym przypadku nie musi
być kontroler restowy, właśnie dlatego taki podział, wydzielamy (separation of concerns)
naszą logikę biznesową, nasze funkcje systemu do serwisów, fasad aby
później mogły być one wywoływane z dowolnego api "klienckiego" rest, kolejka, konsola itd.

Serwer, który pisałem był tylko jednym z mikroserwisów całego projektu.
Podzieliłem ten serwis na moduły, omówię tylko 2 najważniejsze.

• game-server
  • entrypoint
  • storage

entrypoint

• tutaj miałem wszystkie kontrolery głównie przyjmujące eventy websocketowe
  i rzeczy zwiazane z infrastruktura, konfiguracja
• moduł ten zależy od modułu storage poprzez zależność w maven

storage

• modul ten wystawial serwisy, które tak naprawde zapisywały stan gry
  do redisa w postaci eventow
• w tym module byla tak naprawde cala logika biznesowa gry
• tutaj byl pakiet model, w ktorym byly bogate klasy nieanemiczne
  które realizowaly logike biznesową
• nad klasami z pakietu model były serwisy, które w skrócie pracowały na modelu
  i po wykonaniu akcji biznesowej zapisywały zmiany do redisa zmieniając w ten sposób stan gry
• stan gry trzeba bylo gdzies zapisywac poniewaz serwer działa na wielu instancjach

Flow servera jest takie, że przychodzi event websocketowy w entrypoint w kontrolerze
następnie ten kontroler deleguje do jakiegoś serwisu z storage, serwis zwraca jakiś
wynik następnie na podstawie tego wyniku coś jest robione np. leci event po websocketach,
że gra się rozpoczeła.

Problem w tym, że kontrolery w entrypoint rozrosły mi się,
tak naprawdę też po części wykonują logikę biznesową.
Dodatkowo zastosowałem sterowanie programem poprzez wyjątki,
w każdej metodzie kontrolera łapane są jakieś wyjątki rzucane
z storage.

Przykład (wyimaginowany):

@Controller
public class SomeGameController {

  private final SomeGameServiceFromStorage gameService;
  private final SimpMessagingTemplate template;
  
  @MessageMapping("/player/wants/do/something")
  public void playerWantsDoSomething(PlayerCommand playerCommand, Principal principal) {
       
       String playerId = principal.getPlayerId();

       try {

            gameService.doSomethingInteresting(playerId, playerCommand); 
            template.convertAndSend("/all/playerDidSomethingInteresting", new Message("Not important"));
            
            if(gameService.isWinnerForThisRound(playerId)) {
               gameService.endGameForPlayer(playerId);
            }
            
       } catch(GameNotStartedException e) {
           
           gameService.doSomethingElse(playerId);
           template.convertAndSendToUser("/error", new Error("GameNotStarted!"));  

       } catch(TooManyWrongAnswers e) {
          gameService.endGameForPlayer(playerId);
          template.convertAndSendToUser("/endGame", new GameEnded("Too many wrong answers!")); 
       }

  }


}

Chyba widać problem...

Na początku wydawało mi się, że rozdzielenie tego w taki sposób będzie
ok ponieważ tj. wcześniej wspominałem kontrolery przyjmują input i zwracają
output a między tym delegują do serwisów, które zwracają wynik. Serwisy nie powinny
wiedzieć kto i jak pyta, czy restem czy przez konsole czy jeszcze inaczej.
One po prostu zwracają wynik w postaci jakiegoś obiektu dto nie powinny też wiedzieć o tym jak zwrócić wynik
dla użytkownka.

Tak myślałem do tej pory ale to chyba się sprawdza tylko w rest i ogolnie webie.
W rest mamy prostsze flow gdzie serwis wykonuje logikę biznesową i zwraca wynik i tyle.
W moim serwerze gier na websocketach gdy jakiś event przyjdzie do systemu to wykonuje się jakaś
logika i chyba w tej logice "pomiędzy wierszami" powinienem komunikować się protokołem websocket
i wysyłać jakieś dane co się zadziało w grze. Teraz tj. możecie zobaczyć na przykładzie
gdy użytkownik coś chce zrobić to ja wykonuje jakąś logikę biznesową na serwisie
a pózniej pytam co ta logika spowodowała i na tej podstawie wysyłam coś do klienta/ów i jakoś reaguje
na to co się zdarzyło w grze.

Dzięki temu osiągnąłem niby to, że serwis nic nie wie, nie jest związany
z danym protokołem. Ale teraz myśle, że to jest średnie rozwiązanie, i jeszcze te wyjątki, które sterują
przebiegiem programu...

Jestem ciekaw co myślicie na ten temat.

Postaw sobie komunikację za fasadą i przez nią wołaj w serwisach.
Jak użyjesz innego protokołu, to zwyczajnie wykorzystasz wspólny interfejs, a konkretna implementacja obsługi będzie za "murem" i nie będziesz musiał jej wyrywać.

Spokojnie wtedy sobie poradzisz z wywaleniem tych wyjątków.

Możesz wpakować wysyłanie wiadomości w fasadę, którą wstrzykujesz do game service, tak jak napisał @Klojtex . By to osiągnąć:

1. Zrób np: interface GameEventListener { void onEvent(GameEvent event); }
2. Wstrzyknij go do SomeGameServiceFromStorage i odpalaj w tym serwisie metodę onEvent podczas konkretnych zdarzeń zamiast rzucać wyjątek.
3. Sama implementacja GameEventListenera może zajmować się tylko tłumaczeniem z GameEvent na wiadomość do wyłania i wysyłać ją używając wstrzykniętego do tej implementacji SimpMessagingTemplate.

Nie wiem czy to będzie najlepsze rozwiązanie, ale raczej będzie lepsze niż przepływ sterowania oparty o wyjątki.

Dobrze byłoby gdyby implementacja metody onEvent działała możliwie szybko i bez wykrzaczania się. Można to osiągnąć jeśli w onEvent wydelegujesz np wysyłanie wiadomości do jakiegoś ExecutorService zamiast wykonywać go bezpośrednio w wątku GameService.

@Wibowit:

Mam w systemie właśnie klasę GameEvent jenak nwm czy mógłbym ją
wykorzystać w taki sposób. Jest ona abstrakcyjna i po niej dziedziczą
konkretne eventy np.

GameStartedEvent extends GameEvent
PlayerDidSomethingEvent extends GameEvent
GameEndedEvent extends GameEvent

U mnie SomeGameServiceFromStorage nie rzuca wyjatkow,
on tylko tworzy event, aplikuje go na obiekcie Game
i zapisuje do bazy. Potem z tych eventow stan gry
jest odtwarzany.
Tj. wspominałem Game jest jedną z klas z pakietu
model jest nieanemiczna większość metod w niej to metody
applyEvent(? extends GameEvent) które zmieniają stan
obiektu, przechodzą z jednego stanu w drugi na podstawie
eventow, rzucaja wyjatki jesli cos jest nie tak.

Przykład:

public class SomeGameServiceFromStorage {

  private final RedisTemplate<String, Object> redisTemplate;
  private final GameFactory gameFactory;

  public void startGame(String gameId) {
    Objects.requireNonNull(gameId, "Param gameId must not be null");
    Game gameObject = reconstructGameObject(gameId);
    gameObject.applyEvent(event);
    redisTemplate.opsForSet().add("game." + gameId, event);
  }

  public void playerAction(String gameId, String playerId) {
    Objects.requireNonNull(gameId, "Param gameId must not be null");
    Objects.requireNonNull(playerId, "Param playerId must not be null");
    Game gameObject = reconstructGameObject(gameId);
    PlayerDidSomethingEvent event = new PlayerDidSomethingEvent(playerId);
    gameObject.applyEvent(event);
    redisTemplate.opsForSet().add("game." + gameId, event);

    // tutaj wywołanie gameEventListener.onEvent(event); ?
    // tylko w gameObject.applyEvent moga byc rzucane wyjatki
    // to moze tam trzeba to wywolac zamiast rzucac wyjatek ?
    // z drugiej strony zamiast wyjatkow bede musial stworzyc 
    // kolejne eventy informujace o niepowodzeniu generowane w metodach
    // klasy Game i tez je jakos zapisywac do bazy... 
  }

  public void endGame(String gameId) {
    Objects.requireNonNull(gameId, "Param gameId must not be null");
    GameEndedEvent event = new GameEndedEvent();
    Game gameObject = reconstructGameObject(gameId);
    gameObject.applyEvent(event);
    redisTemplate.opsForSet().add("game." + gameId, event);
  }
  
  // stan gry jest odtwarzany na podstawie zapisanych eventow
  private Game reconstructGameObject(String gameId) {
     List<GameEvent> eventsOrderedByTimestamp = fetchGameEvents(gameId);
     Game game = gameFactory.createGame();
     for(GameEvent event: eventsOrderedByTimestamp) {
        game.applyEvent(event); // uproszczone, w rzeczywistości wywoluje mechanizmem refleksji
     }
  }


}

lookacode1 napisał(a):

@Wibowit:

Mam w systemie właśnie klasę GameEvent jenak nwm czy mógłbym ją
wykorzystać w taki sposób. Jest ona abstrakcyjna i po niej dziedziczą
konkretne eventy np.

GameStartedEvent extends GameEvent
PlayerDidSomethingEvent extends GameEvent
GameEndedEvent extends GameEvent

Jeśli te klasy to zwykłe data classes to jak najbardziej się nadają do tłumaczenia wprost na wiadomości, które mają potem być przesyłane używając SimpMessagingTemplate. W Scali użyłbym do tego sealed case classes i wsparcia od kompilatora podczas pattern matchingu (kompilator Scali sprawdza czy obsłużyłeś wszystkie możliwe przypadki w przypadku pattern matchingu na sealed class). W Javie tego jeszcze nie ma, dopiero ma dojść http://cr.openjdk.java.net/~briangoetz/amber/datum.html ale zamiast na to czekać możesz po prostu przygotować jakąś specjalną infrastrukturę testową (która daje zadowalającą gwarancję, że nie zapomnisz o jakimś przypadku).

Natomiast w podejściu obiektowym mógłbyś wstawić metodę toSimpMessagingTemplate wprost do GameEvent i wtedy odpadłby problem z poprzedniego akapitu, ale czy GameEvent powinien wiedzieć cokolwiek o SimpMessagingTemplate? Chyba nie. Pokombinuj i sprawdź jaki kod ci wyjdzie.

Jeśli te klasy to zwykłe data classes to jak najbardziej się nadają do tłumaczenia wprost na wiadomości, które mają potem być przesyłane używając SimpMessagingTemplate.

Właśnie wydaje mi się, że to nie wystarczy. Pod wpływem tych eventow stan gry się zmienia
jeśli miałyby być one obsługiwane gdzieś "wyżej" to znowu sprowadza się to do tego o czym pisałem
w pierwszym poście, że jakbym dostał taki event to przed wysłaniem czegoś do klienta/ow
pytałbym co on niżej spowodował, wyciągałbym stan (wbrew zasadzie TellDontAsk).

Te klasy to nie jest to co ma być 1:1 wysyłane do gracza. One tylko implikują jakieś zachowanie
w grze, a te zachowanie to jest logika, która gdy jakieś warunki są spełnione to informuje o czymś gracza.

Największa wiedza jest w klasach nieanemicznych z pakietu model, tam się dzieje
cały biznes - wiec moze i tam powinna byc wysylka opakowana jakims interfejsem/fasada?

Wtedy tam zamiast rzucać wyjatkiem bezposrednio bylaby wysylka do gracza lub inna
obsluga tego jako normalne flow gry. Poniewaz mysle, ze wszystkie wyjatki, ktore
zrobilem tak naprawde nie sa to sytuacje wyjatkowe tylko normalne reguly gry, ktore
trzeba obsluzyc.

Jeśli tak miałoby być (tj. wysyłka najniżej w modelu "pomiędzy wierszami" w ciałach metod applyEventtam gdzie dzieje się największy biznes)
to powstaje kolejny problem ponieważ stan gry za każdym razem jest odtwarzany z eventow z bazy wiec jakby było na obiekcie
gry robione applyEvent(? extends GameEvent) to byłby ciagle spam tego samego do graczy.
Tylko te "pierwsze" eventy powinny być "w pełni" obsługiwane tzn. włączając wysyłke do graczy, informując co w danej chwili zdarzyło się w grze.
Te eventy wyciągniete z bazy już nie powinny tego powodować (chociaż aplikowane są przez te same metody applyEvent co te "pierwsze").

Jeszcze jakieś pomysły/sugestie?