Ocena projektu i umiejętności - Java

Ocena projektu i umiejętności - Java
szopn
  • Rejestracja:ponad 5 lat
  • Ostatnio:10 miesięcy
  • Postów:11
0

Cześć, jakiś czas temu napisałem aplikację umożliwiająca identyfikacje inteligentnych kontraktów tworzonych na platformę Ethereum. Aplikacja polega na tym, ze po wrzuceniu kodu bajtowego, użytkownik otrzyma listę najbardziej prawdopodobnych implementacji na podstawie zgromadzonej bazie danych implementacji. Wspomniany kod bajtowy jest uruchamiany przez Ethereum Virtual Machine.

Prosiłbym o ocenę moich umiejętności Javy, Clean Codu itd. w skali 1-6. Bardzo liczę na wszelkie uwagi dotyczące kodu.
https://github.com/peterjot/EthereumSmartContractIdentifier

V-2
  • Rejestracja:prawie 8 lat
  • Ostatnio:9 miesięcy
  • Postów:671
1

Nie znam się na Springu ani na Ethereum, ale z punktu widzenia Clean Code razi mnie choroba niepotrzebnych else'ów :)

Kopiuj
if (functions.size() > 1) {
    throw new IllegalStateException("Expected only one function, but found :" + functions.size());
} else if (functions.size() == 1) {
    return functions.listIterator().next();
}

Czy rzucenie wyjątku nie wyrzuci nas z metody? Ostrożny else sugeruje, że autor woli się zabezpieczyć przed takim egzotycznym wypadkiem, że po throw kod wykonałby się dzielnie dalej.

Podobnie tutaj:

Kopiuj
if (nonNull(canonicalType)) {
    return canonicalType;
} else {
    return s;
}

Czy możliwe jest, że wykonałyby się OBIE klauzule return? Jeżeli nie, to pisałbym:

Kopiuj
if (nonNull(canonicalType)) {
    return canonicalType;
} 
return s;

Mniej linii i mniej zagnieżdżeń, które niczemu nie służą.

Oczywiście żadnej praktycznej szkody w tym nie ma. Tak samo jak można np. wszędzie stawiać dwa średniki zamiast jednego, i niczego to w funkcjonowaniu kodu nie zmieni. Będzie tylko niepotrzebne :)


Nie ma najmniejszego powodu, aby w CV pisać "email" przed swoim adresem mailowym, "imię i nazwisko" przed imieniem i nazwiskiem, ani "zdjęcie mojej głowy od przedniej strony" obok ewentualnego zdjęcia. W drugiej firmie której już pracuję mam palących marihuanę programistów [...] piszą kod "leniwie", często nie wysilając się, rozwlekając ten kod, unikając np. programowania funkcyjnego (mówię tutaj o lambdach w javie).
edytowany 1x, ostatnio: V-2
Shalom
  • Rejestracja:około 21 lat
  • Ostatnio:prawie 3 lata
  • Lokalizacja:Space: the final frontier
  • Postów:26433
2
Kopiuj
if (nonNull(canonicalType)) {
    return canonicalType;
} else {
    return s;
}

To raczej się dziś robi jakimś Optional.ofNullable(canonicalType).orElse(s); albo w ogóle nie dopuszcza się że przyjdzie skądś null, tylko wrzuca Optionale.

  1. Test disasma jest mocno słaby, bo w sumie nie mówi "co nie działa". To trzeba by testować jakioś "losowo" albo każdą instrukcje z osobna.
  2. https://github.com/peterjot/EthereumSmartContractIdentifier/blob/master/src/main/java/com/smartcontract/solidity/SolidityPattern.java nie pasuje się języków programowania regexpami. Teraz masz tam takie cuda "write-only" bo jak coś się zacznie źle matchować to szansa że poprawisz wynosi 0%
  3. Tutaj https://github.com/peterjot/EthereumSmartContractIdentifier/blob/master/src/main/java/com/smartcontract/solidity/SolidityParser.java chyba trochę zby złożone metody.

Ale tak ogólnie to na pierwszy rzut oka wygląda spoko.


"Nie brookliński most, ale przemienić w jasny, nowy dzień najsmutniejszą noc - to jest dopiero coś!"
edytowany 3x, ostatnio: Shalom
V-2
  • Rejestracja:prawie 8 lat
  • Ostatnio:9 miesięcy
  • Postów:671
1

W Pair pola mogłyby być final.

Wątpliwości budzi też u mnie nazewnictwo klas: SolidityController, SolidityFile, SolidityParser, SolidityPattern, SolidityService etc. ad mortem usrandum.

Jeśli praktycznie wszystkie klasy w danym package'u mają jeden i ten sam prefiks, warto siebie zapytać, czy tego wspólnego mianownika nie powinien załatwiać sam package.

Ten często spotykany antywzorzec (modny w środowisku "Java enterprise") jest szerzej znany jako "smurf naming convention" - vide https://devcards.io/smurf-naming-convention

Ogólnie są to sprawy kosmetyczne, bo kod jest dobrej jakości, a na tle arcydzieł przeważnie wrzucanych tu do "Oceny i recenzji", w zasadzie wzorowy.


Nie ma najmniejszego powodu, aby w CV pisać "email" przed swoim adresem mailowym, "imię i nazwisko" przed imieniem i nazwiskiem, ani "zdjęcie mojej głowy od przedniej strony" obok ewentualnego zdjęcia. W drugiej firmie której już pracuję mam palących marihuanę programistów [...] piszą kod "leniwie", często nie wysilając się, rozwlekając ten kod, unikając np. programowania funkcyjnego (mówię tutaj o lambdach w javie).
edytowany 1x, ostatnio: V-2
szopn
  • Rejestracja:ponad 5 lat
  • Ostatnio:10 miesięcy
  • Postów:11
1

Dziękuję za uwagi ^_^

@V-2:

  1. Faktycznie, jeśli używam throw, czy return, wtedy else jest zbędne i zaciemnia kod.

  2. Co do smurf-nameing-convention. Jeśli pozmieniałbym klasy typu BytecodeService, SolidityService na Service ( ale w jakimś pakiecie ) to muszę potem podawać za każdym razem com.smartcontract.solidity.Service.
    Np. public Service(com.smartcontract.solidity.Service service, Disassembler disassembler) {
    Co więcej, możliwe, że musiałbym tez w ten sposób używać adnotacji ze względu na konflikty nazw np. @org.springframework.stereotype.Service. Myślę, że stąd taka konwencja.

@Shalom

  1. Powodem braków testów dla disasma jest to, że porostu nie wiedziałem jak napisać tutaj sensowne jednostkowe testy. Disassembler wyrzuca błąd tylko jeśli długość jest zła lub wprowadzono znaki inne niż szesnastkowe i tyle.

W ramach testów przepuściłem kilka tysięcy kodów bajtowych w nadziei, że będzie się wywalać i obserwowałem czy nie wykryło zbyt dużej ilości nieznanych opcodów. Jak coś się popsuło to poprawiałem i sprawdzałem ponownie. Jeśli masz wiedzę w jaki sposób mógłbym zrobić testy do tego to chętnie przeczytam.

  1. Patrzyłem jak robione są kompilatory i tam też używano regexów. W jaki sposób mógłbym zastąpić te regexy, np. pisząc zwykły kod z ifami? Myślałem ze to zajmie niepotrzebnie dużo linii kodu.

  2. Zastanawiałem się nad tym, że są zbyt złożone, ale nie bylem przekonany. W takim razie postaram się nad nimi popracować, dzięki za informacje :P

V-2
  • Rejestracja:prawie 8 lat
  • Ostatnio:9 miesięcy
  • Postów:671
1
szopn napisał(a):

Co do smurf-nameing-convention. Jeśli pozmieniałbym klasy typu BytecodeService, SolidityService na Service ( ale w jakimś pakiecie ) to muszę potem podawać za każdym razem com.smartcontract.solidity.Service.

Np. public Service(com.smartcontract.solidity.Service service, Disassembler disassembler) {
Co więcej, możliwe, że musiałbym tez w ten sposób używać adnotacji ze względu na konflikty nazw np. @org.springframework.stereotype.Service. Myślę, że stąd taka konwencja.

Jeśli zachodzą konflikty nazw, to jasne. Ale pewnie nie w każdym wypadku zachodzą. Zresztą czasem można uniknąć ich nie tyle usuwając generyczny prefiks bez śladu, co zastępując go prefiksem więcej mówiącym o rzeczywistej odpowiedzialności danej klasy. Czyli np. SolidityParser to w takim ujęciu nie Parser - ale SourceCodeParser. (W pakiecie solidity, który definiuje szerszy kontekst całej "rodziny").

Standardowe biblioteki Javy też kierują się taką ekonomiczną zasadą. Np. istnieje java.util.Formatter, ale jest i java.util.logging.Formatter. A nie LoggingFormatter.

Był po angielsku taki dowcip z brodą o sekretarce (albo o sekretarce z brodą, by iść zgodnie z duchem stulecia), co wszystkie dokumenty wpinała do folderu "T". No, bo "the invoices", "the reports" itd. ;) Podobnie wykoncypowali twórcy Windowsa z tą swoją konwencją "My Documents", "My Music", "My Pictures"...


Nie ma najmniejszego powodu, aby w CV pisać "email" przed swoim adresem mailowym, "imię i nazwisko" przed imieniem i nazwiskiem, ani "zdjęcie mojej głowy od przedniej strony" obok ewentualnego zdjęcia. W drugiej firmie której już pracuję mam palących marihuanę programistów [...] piszą kod "leniwie", często nie wysilając się, rozwlekając ten kod, unikając np. programowania funkcyjnego (mówię tutaj o lambdach w javie).
edytowany 2x, ostatnio: V-2
Shalom
  • Rejestracja:około 21 lat
  • Ostatnio:prawie 3 lata
  • Lokalizacja:Space: the final frontier
  • Postów:26433
1

Patrzyłem jak robione są kompilatory i tam też używano regexów. W jaki sposób mógłbym zastąpić te regexy, np. pisząc zwykły kod z ifami? Myślałem ze to zajmie niepotrzebnie dużo linii kodu.

To chyba też takie amatorskie "kompilatory" jak twój ;) Generalnie raczej korzysta się z jakiegoś generatora parserów, pisze sie sensowną gramatykę i na tym polega. Bo te twoje regexy już teraz są nie do przeczytania. Wyobraź sobie że składnia trochę się rozszerzy i co wtedy? ;]
Ja bym w ramach testów np. generował zestaw losowych poprawnych opkodów i sprawdził czy się dobrze disasmują a potem zrobił jeszcze testy z wrzucaniem losowych błędów i sprawdzaniem że się wywali.


"Nie brookliński most, ale przemienić w jasny, nowy dzień najsmutniejszą noc - to jest dopiero coś!"
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)