Czy poprawnie operuje na plikach JSON

Czy poprawnie operuje na plikach JSON
Maciek_SK8
  • Rejestracja:ponad 2 lata
  • Ostatnio:około 10 godzin
  • Postów:68
0

Siema.
Ostatnio z mojego kursu na udemy nauczyłem się obsługiwać pliki JSON, co uznałem za ciekawe rozwiazanie. W ramach ćwiczeń napisałem bardzo prosty program, który z pliku pobiera dane na temat Billboard hot 100 i wypisuje podana liczbę piosenek zgodnie z miejscami w rankingu. Czy jest w nim coś, co można poprawić?

Tutaj link: https://github.com/MaciekSm19/MusicChart

Z góry dziękuję za odpowiedź!

SL
  • Rejestracja:około 7 lat
  • Ostatnio:3 minuty
  • Postów:862
2
Kopiuj
for (int i = 0; i < data.length(); i++) {
            String title = data.getJSONObject(i).getString("song");
            String artist = data.getJSONObject(i).getString("artist");
            Integer thisWeek = data.getJSONObject(i).getInt("this_week");
            Integer lastWeek;
            if (data.getJSONObject(i).get("last_week").equals(null)) lastWeek = null;
            else lastWeek = data.getJSONObject(i).getInt("last_week");

            Integer peakPosition = data.getJSONObject(i).getInt("peak_position");
            Integer weeksOnChart = data.getJSONObject(i).getInt("weeks_on_chart");
            songs.add(new Song(title, artist, thisWeek, lastWeek, peakPosition, weeksOnChart));
        }

Raczej tak się nie robi. Twoje podejście jest w pełni mechaniczne co nie jest jakąś wielką wadą, ale większość woli pół-automatyczne rozwiązania, gdzie mapowanie klucz -> pole w strukturze dzieje się automatycznie + jakieś andnotacje. Poczytaj jak działa jackson albo gson

edytowany 1x, ostatnio: slsy
opiszon
Co do samej oceny tego kodu - warunek do sprawdzania lastweek powinien być zanegowany i nie trzeba przypisywać null, bo to już jest z defaulta. Zwrócił bym też uwagę na to że if nie ma klamerek i jest de facto jednolinijkowy co jest złą praktyką. No i repetycja wyciągania data.getjsonobject(i).
Maciek_SK8
Dlaczego nie powinno się robić jednolinijkowych instrukcji if?
opiszon
Czytelność. Dodatkowo jak używasz instrukcji if/else/for/while itp bez klamr, to łatwo wprowadzić potem błąd - bo tylko 1 instrukcja jest w scope
hzmzp
  • Rejestracja:ponad 11 lat
  • Ostatnio:około 7 godzin
  • Postów:619
2

Poczytaj sobie op gson i mapowaniu obiektów.

loza_prowizoryczna
  • Rejestracja:ponad 2 lata
  • Ostatnio:2 dni
  • Postów:1592
2
Maciek_SK8 napisał(a):

Czy jest w nim coś, co można poprawić?

Tak - JSON jak sama nazwa wskazuje to powstał na potrzeby JSa a nie Javy.

W Javie używaj modeli Javowych a nie JSONa.


Przetrzyma wszystko
lion137
  • Rejestracja:około 8 lat
  • Ostatnio:3 minuty
  • Postów:4884
1

Riddle
Administrator
  • Rejestracja:prawie 15 lat
  • Ostatnio:około 4 godziny
  • Lokalizacja:Laska, z Polski
  • Postów:10051
3

Wady projektowe:

  1. Klasa DatabaseOperations wygląda jakby jej głównym zadaniem było wczytanie JSON'a z zewnętrznego serwisu - jeśli tak, to dobrze żeby zwróciła String. Chyba że powinna tez parsować treść, to powinna zwrócić Song. Zwrócenie JSONObject to najgorsze wyjście.
  2. Nie ma testów automatycznych.
  3. DatabaseOperations jest używane w taki sposób databaseOperations.getJSONObject(databaseOperations.connect()). Co nie ma specjalnego sensu. Czemu nie po prostu String json = databaseOperations.fetchJson()?
  4. Metoda getTopChartedSongs() w ogóle nie pasuje do klasy ChartOperations. Należałoby ją z tamtąd zabrać i umieścić w innym miejscu.
  5. ChartOperations wygląda jakby jego głównym zadaniem było parsowanie jsona i zbudowanie Song. Ja zmieniłbym nazwę tej klasy na SongFactory albo coś w tym stylu.

Ja bym to napisał jakoś tak:

Kopiuj
public class Main {
    public static void main(String[] args) {
        SongsResponse allSongs = new SongsProvider().fetch();

        System.out.println("The chart was last updated on " + allSongs.publishDate());
        System.out.print("How many top charted songs would you like to see? ");

        int amountOfSongs = new Scanner(System.in).nextInt();

        response.songs()
            .stream()
            .limit(amountOfSongs)
            .map(Main::formatSongListItem)
            .forEach(System.out::println);
    }

    private static String formatSongListItem(Song song) {
        return song.thisWeek() + ". " + song.title() + " - " + song.artist();
    }
}

record SongsResponse(
    String publishDate,
    List<Song> songs) {}

record Song(
    String title,
    String artist,
    Integer thisWeek,
    Integer lastWeek,
    Integer peakPosition,
    Integer weeksOnChart) {}

class SongsProvider {
    private final HttpClient client;

    public SongsProvider() {
        this.client = new HttpClient("https://raw.githubusercontent.com/mhollingshead/billboard-hot-100/main/recent.json");
    }

    public SongsResponse fetch() {
        return createResponse(new JSONObject(this.client.fetchJson()));
    }

    private SongsResponse createResponse(JSONObject jsonObject) {
        return new SongsResponse(
            jsonObject.getString("date"),
            parseSongs(jsonObject.getJSONArray("data")));
    }

    private List<Song> parseSongs(JSONArray jsonSongs) {
        List<Song> songs = new ArrayList<>();
        for (int i = 0; i < jsonSongs.length(); i++) {
            songs.add(createSong(jsonSongs.getJSONObject(i)));
        }
        return songs;
    }

    private Song createSong(JSONObject song) {
        return new Song(
            song.getString("song"),
            song.getString("artist"),
            song.getInt("this_week"),
            getIntOrNull(song, "last_week"),
            song.getInt("peak_position"),
            song.getInt("weeks_on_chart"));
    }

    private Integer getIntOrNull(JSONObject object, String fieldName) {
        if (object.isNull(fieldName)) {
            return null;
        }
        return object.getInt(fieldName);
    }
}

public class HttpClient {
    private final String url;

    public HttpClient(String url) {
        this.url = url;
    }

    String fetchJson() {
        try {
            return readInputStream(connect().getInputStream());
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    private static String readInputStream(InputStream inputStream) throws IOException {
        BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream));
        String line;
        StringBuilder stringBuilder = new StringBuilder();
        while ((line = reader.readLine()) != null) stringBuilder.append(line);
        reader.close();
        return stringBuilder.toString();
    }

    private HttpURLConnection connect() {
        try {
            URI uri = new URI(this.url);
            HttpURLConnection connection = (HttpURLConnection) uri.toURL().openConnection();
            if (connection.getResponseCode() != 200) {
                throw new RuntimeException();
            }
            return connection;
        } catch (IOException | URISyntaxException exception) {
            throw new RuntimeException(exception);
        }
    }
}
edytowany 2x, ostatnio: Riddle
Maciek_SK8
  • Rejestracja:ponad 2 lata
  • Ostatnio:około 10 godzin
  • Postów:68
0

Poprawiłem ten program poprzez użycie Jacksona do importu plików i znacznie zredukowało to ilość linijek kodu 😄 Kod, który napisałem podzieliłem na klasy i metody. Czy taki podział jest odpowiedni?

Jeszcze raz wrzucam link: https://github.com/MaciekSm19/MusicChart

Riddle
Administrator
  • Rejestracja:prawie 15 lat
  • Ostatnio:około 4 godziny
  • Lokalizacja:Laska, z Polski
  • Postów:10051
1
Maciek_SK8 napisał(a):

Poprawiłem ten program poprzez użycie Jacksona do importu plików i znacznie zredukowało to ilość linijek kodu 😄

Tylko weź pod uwagę co to znaczy. Owszem, linijek jest mniej, ale to dlatego że niejawnie nazwy pól i struktura formatu wejściowego musi być zbieżna z modelem Song. To się fachowo nazywa ciasne przywiązanie (tight-coupling), i ogólnie sprawia że aplikacja jest cięższa do zmiany. Nie jest to oczywiście jakaś tragedia, ale mimo wszystko pod względem elastyczności i jakości kodu to raczej krok wstecz. Prosty refaktor klasy Song może zepsuć działanie aplikacji, a zmiana formatu json'a w API które korzystasz wymusi albo przywrócenie poprzedniego kodu z czytaniem pól albo zmianę pól w klasie Song. Wiadomo, że mniej linijek wygląda czadersko, ale to raczej nie jest dobry kod.

Maciek_SK8 napisał(a):

Kod, który napisałem podzieliłem na klasy i metody. Czy taki podział jest odpowiedni?

Jeszcze raz wrzucam link: https://github.com/MaciekSm19/MusicChart

Klasa JsonDataImporter przyjmuje na wejściu adres URL a na wyjściu wystawia datę publikacji i listę piosenek. Nic w jej interfejsie nie mówi o JSON - JSON to szczegół implementacyjny. Skoro tak to w jej nazwie nie powinno być słowa JSON. Należałoby ją nazwać DataImporter, albo po prostu SongsImporter.

Wyjątek JsonProcessingException to szczegół implementacyjny, nie powinien być częścią sygnatury metody. Należałoby go złapać i rzucić runtime wyjątek catch (JsonProcessingException) { throw new RuntimeException(); }.

Klasa SongResponseFactory zasadzie nic nie robi - możnaby ją spokojnie usunąć.

Niepoprawne wczytanie danych widać że nie jest poprawnie obsłużone, bo nic nie robisz z wyjątkiem tylko System.out.prinln() - to nie jest dobry pomysł, bo zauważ ze jeśli poleci wyjątek, to jsonRoot pozostanie null, i obiekt będzie w niepoprawnym stanie. Późniejsze zawołanie getPublishDate() najpewniej poskutkuje NullPointerException, właśnie dlatego że konstruktor pozostawił obiekt w niepoprawnie zbudowanym stanie. Lepszym wyjściem byłoby po prostu rzucić wyjątek.

Zastanów się - jak program powinien się zachować, jeśli uruchomisz go nie mając połączenia z internetem? 🤔 Nie powinien się wywalić, powinien sprezentować odpowiedni wynik w interfejsie użytkownika, np. napisać tekst "Nie udało się wczytać listy piosenek".

edytowany 1x, ostatnio: Riddle
Maciek_SK8
  • Rejestracja:ponad 2 lata
  • Ostatnio:około 10 godzin
  • Postów:68
0

Tylko weź pod uwagę co to znaczy. Owszem, linijek jest mniej, ale to dlatego że niejawnie nazwy pól i struktura formatu wejściowego musi być zbieżna z modelem Song. To się fachowo nazywa ciasne przywiązanie (tight-coupling), i ogólnie sprawia że aplikacja jest cięższa do zmiany. Nie jest to oczywiście jakaś tragedia, ale mimo wszystko pod względem elastyczności i jakości kodu to raczej krok wstecz. Prosty refaktor klasy Song może zepsuć działanie aplikacji, a zmiana formatu json'a w API które korzystasz wymusi albo przywrócenie poprzedniego kodu z czytaniem pól albo zmianę pól w klasie Song. Wiadomo, że mniej linijek wygląda czadersko, ale to raczej nie jest dobry kod.

To znaczy Song jest rekordem, który bazuje na nazwach z pliku JSON. Rekord ten mógłby być zmieniany według mnie tylko w okoliczności, kiedy nazwy pól w JSON się zmienią.

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)