Review kodu.

FR
  • Rejestracja:prawie 7 lat
  • Ostatnio:prawie 7 lat
  • Postów:3
0

Hej, po długim okresie nic nie robienia, uznałem że czas napisać cokolwiek przydatnego, z potencjałem do rozbudowy. Napisałem proste api do stron typu wiki. Nigdy nie pisałem web api (zazwyczaj moje projekty to były zwykłe aplikacje webowe), prosił bym o rady typu co robię źle itp. Najbardziej liczę na porady związane z projektowaniem api, tak aby było wygodne w użytkowaniu i logiczne. Z góry dziękuję za pomoc.
https://github.com/FeRuOs/WikiApi

edytowany 1x, ostatnio: FeRuOs
neves
a kod to gdzie jest?
ŁF
Moderator
  • Rejestracja:ponad 22 lata
  • Ostatnio:5 dni
1

Po co Ci bin i obj w git?


katelx
  • Rejestracja:prawie 10 lat
  • Ostatnio:4 miesiące
  • Lokalizacja:Hong Kong
0

nie wiem jak sie dzisiaj w webie robi, ale modele bez zadnej logiki wydaja sie dosc bezuzyteczne, jak to jest @somekind ? ;)

edytowany 1x, ostatnio: katelx
Aventus
  • Rejestracja:prawie 9 lat
  • Ostatnio:ponad 2 lata
  • Lokalizacja:UK
  • Postów:2235
0

A co jest nie tak z tymi modelami (byc moze poza nazwa namespace'a)? Przeciez musi jakos to wyciagnac z bazy i zwrocic do klienta. W przypadku tak prostego API to spelnia swoja role. Najlepiej ladujmy wszedzie DDD i za wszelka cene unikajmy anemicznych modeli bo wiecie... to modne i tak sie powinno robic.


Na każdy złożony problem istnieje rozwiązanie które jest proste, szybkie i błędne.
katelx
  • Rejestracja:prawie 10 lat
  • Ostatnio:4 miesiące
  • Lokalizacja:Hong Kong
0
Aventus napisał(a):

A co jest nie tak z tymi modelami (byc moze poza nazwa namespace'a)?

tak jak napisalam - nie maja zadnej logiki tylko gettery i settery, w wielu przypadkach to wstep do programowania proceduralnego i zwiazanych z tym zlych praktyk.

Przeciez musi jakos to wyciagnac z bazy i zwrocic do klienta.

przeciez zeby wyslac to do klienta to jakis view-model i tak bylby potrzebny, nie?

W przypadku tak prostego API to spelnia swoja role.

moze i tak. przy czym jesli stosujemy zle praktyki przy prostym api (ktore raczej powinno byc dopieszczone) to co bedzie przy bardziej skomplikowanym projekcie ;)

Najlepiej ladujmy wszedzie DDD i za wszelka cene unikajmy anemicznych modeli bo wiecie... to modne i tak sie powinno robic.

nic takiego nie napisalam.

0

A co zlego widzicie w tych modelach bez logiki?

Aventus
  • Rejestracja:prawie 9 lat
  • Ostatnio:ponad 2 lata
  • Lokalizacja:UK
  • Postów:2235
0

@katelx ale gdzie tu złe praktyki? Co najwyżej widzę kwestie nazewnictwa - klasy służące za encje umieszczone w namespace Models.


Na każdy złożony problem istnieje rozwiązanie które jest proste, szybkie i błędne.
ŁF
Moderator
  • Rejestracja:ponad 22 lata
  • Ostatnio:5 dni
0

Modele, a szczególnie ViewModele bez logiki to standardowa sprawa, służą jako opakowanie danych i warstwa abstrakcji względem klas ORM.

@FeRuOs dlaczego usunąłeś repo?


edytowany 1x, ostatnio: ŁF
katelx
  • Rejestracja:prawie 10 lat
  • Ostatnio:4 miesiące
  • Lokalizacja:Hong Kong
0
Aventus napisał(a):

@katelx ale gdzie tu złe praktyki? Co najwyżej widzę kwestie nazewnictwa - klasy służące za encje umieszczone w namespace Models.

jak juz napisalam - nie wiem jakie sa standardy w web developerce.
z mojej perspektywy pisanie klasy bez logiki, za to z samymi gettero-setterami to proszenie sie o klopoty bo:

  • lamie to enkapsulacje
  • pozwala na mutowanie wszystkiego
  • robi z klasy glupi kontener na dane i prowokuje do duplikowania kodu operujacego na tych danych (lub stworow w stylu xxxUtils)'
  • wydaje mi sie dosc nudnym klepac takie puste klasy bez realnego zastosowania ;)
ŁF
Modele wprowadzają warstwę abstrakcji, dzięki czemu możesz się oddzielić od np. modeli ORM. Z takimi modelami jest trochę jak z interfejsami ;-)
katelx
@ŁF wierze na slowo, po prostu zdziwilo mnie to i tyle, jakos zawsze mi sie wydawalo ze modele == logika aplikacji a nie wylacznie mapping from/to orm
somekind
Moderator
  • Rejestracja:około 17 lat
  • Ostatnio:około 13 godzin
  • Lokalizacja:Wrocław
3

@katelx: to zależy od sytuacji. Jeśli to tylko CRUD bez żadnych transformacji danych, to nie ma jak utworzyć modelu z operacjami, potrzebne są po prostu kontenery na dane. I to dwa ich rodzaje: jeden między GUI a aplikacją (odzwierciedlający to, co użytkownik widzi albo wprowadza w jakimś formularzu - viewmodele), a drugi między aplikacją a bazą (opisujący to, jak dane są przechowywane w bazie - persistence modele).
Głównym problemem tutaj jest to, że wielu tzw. programistów próbuje umieścić te dwa modele w jednej klasie i wychodzi z tego jakiś mutant, który potem jest źródłem różnych problemów z lazy loading, select n+1, przesyłaniem nadmiarowych danych, wyświetlaniem zbędnych wartości w GUI, przypadkowym updatowaniem jakiś wartości w bazie (a czasem tworzeniem kolumn niechcący), itd. To podejście nazywa się "encja na twarz i pchasz".
A z drugiej strony, w sytuacjach, gdy jakaś logika już jest potrzebna, to zamiast stworzyć normalną logikę umieszczoną w modelu domeny, po prostu używają swoich uniwersalnych persistence-viewmodelowych klas i operują na nich strukturalnie. Co jest złe, ale moim zdaniem nie przez samą strukturalność tylko przez łamanie SRP przez te modele.

W przypadku prostej logiki (np. trzeba wyliczyć wartość jakiegoś pola) sam często stosuję "podejście strukturalne" operujące na persistence modelach. Uważam, że tworzenie dodatkowej warstwy domain modelu dla prostych przypadków byłoby po prostu przeinżynierowaniem, a wytworzenie i utrzymanie dodatkowego kodu to przecież koszt.


Po dopracowaniu rozwiązania każdy będzie mógł założyć własny drzewiasty wątek.
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)