{"id":617,"date":"2020-04-25T08:37:25","date_gmt":"2020-04-25T08:37:25","guid":{"rendered":"https:\/\/www.juniorjavadeveloper.pl\/?p=617"},"modified":"2023-12-12T14:50:34","modified_gmt":"2023-12-12T14:50:34","slug":"pierwsza-klasa-jako-serwis-crud-kod-java-intellij-krok-po-kroku","status":"publish","type":"post","link":"https:\/\/www.juniorjavadeveloper.pl\/en\/2020\/04\/25\/pierwsza-klasa-jako-serwis-crud-kod-java-intellij-krok-po-kroku\/","title":{"rendered":"Pierwsza klasa jako serwis CRUD – kod Java, IntelliJ, krok po kroku"},"content":{"rendered":"

Przyszed\u0142 czas na po\u0142\u0105czenie ca\u0142ej zdobytej wiedzy i stworzenie pierwszego serwisu opartego na CRUD<\/a>. Pisz\u0105c serwis nie mam namy\u015bli serwisu www, chodzi o klas\u0119, kt\u00f3ra ma specjalne przeznaczenie i zawiera operacje CRUD – Create, Read, Update, Delete. <\/p>\n\n\n\n

Bardzo wiele aplikacji jest tzw. CRUD’ami, czyli udost\u0119pnia podstawowe operacje tworzenia (create), odczytu (read), modyfikacji (update) oraz usuwania (delete) obiekt\u00f3w jakiej\u015b klasy. Dla przyk\u0142adu we\u017amy katalog samochod\u00f3w, gdzie mamy klas\u0119 Car.<\/p>\n\n\n\n

Poni\u017cej operacje CRUD dla klasy Car:
– CREATE – dodawanie samochodu do katalogu,
– READ – odczytanie szczeg\u00f3\u0142\u00f3w samochodu z katalogu,
– UPDATE – zmiana, modyfikacja informacji o samochodzie w katalogu,
– DELETE – usuni\u0119cie samochodu z katalogu.<\/p>\n\n\n\n

Dodatkowo z CRUD’em zwi\u0105zana jest metoda list(), zwracaj\u0105ca list\u0119 wszystkich obiekt\u00f3w, na kt\u00f3rych operuje CRUD, czyli w naszym przypadku metoda list() zwr\u00f3ci list\u0119 wszystkich samochod\u00f3w w katalogu.<\/p>\n\n\n\n

W poprzednich artyku\u0142ach opisa\u0142em teori\u0119 i pokaza\u0142em przyk\u0142ady kodu dotycz\u0105ce tworzenia pierwszej klasy w j\u0119zyku Java<\/a>, jak i gdzie zapisa\u0107 warto\u015bci w klasie<\/a>, jak wykonywa\u0107 dzia\u0142ania na klasie<\/a>, jak ukry\u0107 kod klasy<\/a> przed niepowo\u0142anym dost\u0119pem oraz przedstawi\u0142em tablice i listy<\/a> w j\u0119zyku Java. Te pi\u0119\u0107 artyku\u0142\u00f3w jest niezb\u0119dne do stworzenia serwisu z operacjami CRUD.<\/p>\n\n\n\n

Zanim zaczn\u0119 pisa\u0107 dlaczego w og\u00f3le stosowa\u0107 CRUD i dlaczego jest on tak wa\u017cny poni\u017cej przedstawi\u0119 klas\u0119 Java, kt\u00f3ra jest CRUD’em, pos\u0142u\u017cy nam jako szablon dla innych klas b\u0119d\u0105cych CRUD’ami. Oczywi\u015bcie poni\u017csza klasa nic nie robi, zawiera tylko metody, kt\u00f3re nie przyjmuj\u0105 \u017cadnych parametr\u00f3w, ani nie zwracaj\u0105 \u017cadnej warto\u015bci.<\/p>\n\n\n\n

\/\/ CRUD - template class\npublic class CrudServiceTemplate {\n    \/\/ C - create\n    public void create() {\n    }\n    \/\/ R - read\n    public void read() {\n    }\n    \/\/ U - update\n    public void update() {\n    }\n    \/\/ D - delete\n    public void delete() {\n    }\n    \/\/ L - list\n    public void list() {\n    }\n}<\/pre>\n\n\n\n
CRUD jest nierozerwalnie zwi\u0105zany z klas\u0105, dla kt\u00f3rej wykonywane s\u0105 operacje, \u017ceby mie\u0107 poprawny i funkcjonalny CRUD potrzebujemy jeszcze jednej klasy. Klasy, na kt\u00f3rych operuje CRUD s\u0105 po prostu zwyk\u0142ymi POJO<\/a>, czyli klasami, kt\u00f3re maj\u0105 atrybuty\/zmienne\/pola do tego konstruktory i metody get\/set. Takie klasy cz\u0119sto s\u0105 okre\u015blane mianem: model, encja, DTO<\/a>, VO<\/a>.<\/p>\n\n\n\n
Poni\u017cej przyk\u0142ad klasy, z kt\u00f3rej b\u0119dzie korzysta\u0142 CRUD.<\/p>\n\n\n\n
public class Car {\n    private int year;\n    private String model;\n    private String manufacturer;\n    private BigDecimal price;\n\n    \/\/ constructors\n    \/\/ getters\/setters\n    \/\/ toString()\n}<\/pre>\n\n\n\n
Maj\u0105c powy\u017csz\u0105 klas\u0119 Car oraz szablon dla klas z CRUD (CrudServiceTemplate) stworzymy klas\u0119 b\u0119d\u0105c\u0105 serwisem, czyli zawieraj\u0105c\u0105 logik\u0119 odno\u015bnie CRUD’a dla klasy Car. Nale\u017cy zauwa\u017cy\u0107, \u017ce nie ma ju\u017c potrzeby dodawania w nazwie klasy s\u0142owa Crud. Poni\u017cej wspomniana klasa, na razie zwraca ona warto\u015bci null dla czytelno\u015bci kodu.<\/p>\n\n\n\n
\/\/ CRUD Service dla klasy Car\npublic class CarService {\n\n    \/\/ lista przechowuj\u0105ca wszystkie samochody\n    \/\/ tylko i wy\u0142\u0105cznie dla uproszczenia kodu aplikacji\n    \/\/ docelowo dane powinny by\u0107 przechowywane w bazie danych\n    private List<Car> carsCatalog = new ArrayList<>();\n\n    \/\/ C - create\n    public Car create(Car car) {\n        return null;\n    }\n    \/\/ R - read\n    public Car read(Integer id) {\n        return null;\n    }\n    \/\/ U - update\n    public Car update(Integer id, Car car) {\n        return null;\n    }\n    \/\/ D - delete\n    public void delete(Integer id) {\n    }\n    \/\/ L - list\n    public List<Car> list() {\n        return null;\n    }\n}<\/pre>\n\n\n\n
CRUD jest wa\u017cny poniewa\u017c systematyzuje i grupuje w jednym miejscu operacje, kt\u00f3re mo\u017cna wykona\u0107 na klasie b\u0119d\u0105cej, np. modelem. CRUD mo\u017cna zastosowa\u0107 dla wielu klas w tym samym projekcie. Dzi\u0119ki zastosowaniu CRUD w kontek\u015bcie serwisu, klasy Service separujemy dane zawarte w np. modelu od logiki aplikacji, kt\u00f3ra u\u017cywa tego modelu.<\/p>\n\n\n\n
Poni\u017cej opisz\u0119 oddzielnie ka\u017cd\u0105 metod\u0119 z CRUD dla klasy CarService, a na koniec przedstawi\u0119 ca\u0142\u0105 klas\u0119 z pe\u0142n\u0105 implementacj\u0105 logiki biznesowej wraz z u\u017cyciem klasy CarService.<\/p>\n\n\n\n
Nale\u017cy zauwa\u017cy\u0107, \u017ce CarService jest uproszczon\u0105 wersj\u0105, kt\u00f3ra zak\u0142ada przechowywanie wynik\u00f3w operacji metod CRUD na li\u015bcie obiekt\u00f3w private List<Car> carsCatalog;<\/strong> – katalogu samochod\u00f3w – docelowo dane powinny by\u0107 przechowywane w bazie danych. Na potrzeby tego przyk\u0142adu private List<Car> carsCatalog;<\/strong> b\u0119dzie symulowa\u0107 baz\u0119 danych.<\/p>\n\n\n\n
Symuluj\u0105c baz\u0119 danych za pomoc\u0105 private List<Car> carsCatalog;<\/strong> musimy pami\u0119ta\u0107 o tym, \u017ce w bazie danych ka\u017cdy wiersz powinien mie\u0107 unikalny identyfikator, osi\u0105gniemy, to za pomoc\u0105 private Random randomCarId;<\/strong>. <\/p>\n\n\n\n
Dlaczego operujemy na unikalnych identyfikatorach? Poniewa\u017c mo\u017ce by\u0107 wiele takich samych samochod\u00f3w, tzn. ich marka, model, rok produkcji b\u0119d\u0105 identyczne. Dlatego musimy wprowadzi\u0107 unikalny identyfikator, taki identyfikator jest standardow\u0105 praktyk\u0105.<\/p>\n\n\n\n
Poni\u017cej przyk\u0142ad listy samochod\u00f3w – katalogu samochod\u00f3w – z unikalnymi identyfikatorami.<\/p>\n\n\n\n
id<\/th>year<\/th>model<\/th>manufacturer<\/th>price<\/th><\/tr><\/thead>
1<\/td>2016<\/td>Model X<\/td>Tesla<\/td>340 000 z\u0142<\/td><\/tr>
4<\/td>2009<\/td>Corolla<\/td>Toyota<\/td>33 000 z\u0142<\/td><\/tr>
99<\/td>2020<\/td>XC 90<\/td>Volvo<\/td>300 000 z\u0142<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
 <\/p>\n\n\n\n
Poni\u017cej szczeg\u00f3\u0142owy opis ka\u017cdej z metod z CRUD. Nale\u017cy zauwa\u017cy\u0107, \u017ce nad ka\u017cd\u0105 metod\u0105 jest specjalny komentarz w postaci \/** Tre\u015b\u0107 komentarza *\/<\/strong> jest, to Javadoc<\/a>, specjalna forma komentarza, kt\u00f3ra jest rozpoznawana przez IDE takie jak IntelliJ i wy\u015bwietlane w postaci Tooltip oraz s\u0142u\u017cy do tworzenia dokumentacji do projektu. Dla przyk\u0142adu dokumentacja klasy Object<\/a> jest wygenerowana z Javadoc.<\/p>\n\n\n\n
\"Javadoc<\/a>
Javadoc Tooltip – Pierwsza klasa jako serwis CRUD \u2013 kod Java, IntelliJ, krok po kroku<\/figcaption><\/figure><\/div>\n<\/body><\/html>\n\n\n\n
C – Create – tworzenie samochodu za pomoc\u0105 serwisu.<\/strong><\/p>\n\n\n\n
\/**\n * C - create - tworzy\/zapisuje samoch\u00f3d do katalogu\n * @param car Dane samochodu do utworzenia\/zapisania w katalogu\n * @return Utworzony samoch\u00f3d z unikalnym identyfikatorem\n *\/\npublic Car create(Car car) {\n    \/\/ generowanie unikalnego identyfikatora samochodu\n    int id = randomCarId.nextInt(100_000);\n    \/\/ ustawienie unikalnego identyfikatora dla samochodu\n    car.setId(id);\n\n    \/\/ dodanie nowego samochodu do katalogu\n    carsCatalog.add(car);\n    \/\/ zwr\u00f3cenie utworzonego samochodu z unikalnym identyfikatorem\n    return car;\n}<\/pre>\n\n\n\n
R – Read – odczytywanie samochodu za pomoc\u0105 serwisu.<\/strong><\/p>\n\n\n\n
\/**\n * R - read - odczytuje\/wyszukuje samoch\u00f3d z katalogu\n * @param id Unikalny identyfikator samochodu w katalogu\n * @return Odczytany z katalogu samoch\u00f3d\n *\/\npublic Car read(Integer id) {\n    \/\/ iterujemy po li\u015bcie\/katlogu samachod\u00f3w\n    for (Car car : carsCatalog) {\n        \/\/ dla ka\u017cdego samochodu w katalogu ...\n        \/\/ ... sprawdzamy czy identyfiktory zgadzaj\u0105 si\u0119\n        if (car.getId().equals(id)) {\n            \/\/ je\u017celi identyfikatory s\u0105 zgodne, to ...\n            \/\/ ... zwracamy wyszukany\/odczytany samoch\u00f3d\n            return car;\n        }\n    }\n    \/\/ je\u017celi nie znaleziono szukanego samochodu zwracamy null\n    return null;\n}<\/pre>\n\n\n\n
U – Update – modyfikacja danych samochodu za pomoc\u0105 serwisu.<\/strong><\/p>\n\n\n\n
\/**\n * U - update - modyfikuje dane samochodu w katalogu.\n * @param id Identyfikator samochodu do modyfikacji danych\n * @param carUpdate Aktualne\/nowe dane samochodu\n * @return Zmodyfikowany samoch\u00f3d w katalogu\n *\/\npublic Car update(Integer id, Car carUpdate) {\n    \/\/ iterujemy po li\u015bcie\/katlogu samachod\u00f3w\n    for (Car car : carsCatalog) {\n        \/\/ dla ka\u017cdego samochodu w katalogu ...\n        \/\/ ... sprawdzamy czy identyfiktory zgadzaj\u0105 si\u0119\n        if (car.getId().equals(id)) {\n            \/\/ je\u017celi identyfikatory s\u0105 zgodne, to ...\n            \/\/ ... modyfikujemy dane samochodu ...\n            car.setYear(carUpdate.getYear());\n            car.setModel(carUpdate.getModel());\n            car.setManufacturer(carUpdate.getManufacturer());\n            car.setPrice(carUpdate.getPrice());\n            \n            \/\/ ... zwracamy zmodyfikowany samoch\u00f3d \n            return car;\n        }\n    }\n    \/\/ je\u017celi nie znaleziono szukanego samochodu zwracamy null\n    return null;\n}<\/pre>\n\n\n\n
D – Delete – usuwanie samochodu za pomoc\u0105 serwisu.<\/strong><\/p>\n\n\n\n
\/**\n * D - delete - usuwa samoch\u00f3d z katalogu.\n * @param id Identyfikator samochodu do usuni\u0119cia z katalogu.\n *\/\npublic void delete(Integer id) {\n    \/\/ tworzymy Iterator dla naszej listy,\n    \/\/ aby unikn\u0105\u0107 wyj\u0105tku ConcurrentModificationException \n    \/\/ podczas jednoczesnego iterowania po li\u015bcie\n    \/\/ i usuwania z niej element\u00f3w\n    Iterator<Car> iterator = carsCatalog.iterator();\n    \/\/ wykonujemy operacje dop\u00f3ki Iterator ma kolejne elementy\n    while (iterator.hasNext()) {\n        \/\/ pobieramy kolejny element\n        Car car = iterator.next();\n        \/\/ je\u017celi identyfikatory s\u0105 zgodne, to ...\n        if (car.getId().equals(id)) {\n            \/\/ ... usuwamy samoch\u00f3d z listy\n            iterator.remove();\n        }\n    }\n}<\/pre>\n\n\n\n
Przyszed\u0142 czas na u\u017cycie powy\u017cszych metod, tak jak wida\u0107 powsta\u0142o bardzo du\u017co kodu, kt\u00f3ry jeszcze nie zosta\u0142 u\u017cyty i nie wiadomo czy spe\u0142nia nasze oczekiwania i czy w og\u00f3le dzia\u0142a. Oczywi\u015bcie w prawdziwym projekcie powsta\u0142yby najpierw testy jednostkowe zgodnie z TDD<\/a>. Na potrzeby przyk\u0142ad\u00f3w dla os\u00f3b dopiero zaczynaj\u0105cych przygod\u0119 z j\u0119zykiem Java powy\u017cszy kod jest wystarczaj\u0105cy.<\/p>\n\n\n\n
    public static void main(String[] args) {\n        System.out.println(\"Katalog samochod\u00f3w z wykorzystaniem CarService - CRUD'a\");\n\n        \/\/ stworzenie obiektu b\u0119d\u0105cego CRUD'em\n        CarService carService = new CarService();\n\n        System.out.println(\"Zawarto\u015b\u0107 katalogu samochod\u00f3w przed dodanie zawarto\u015bci\");\n        List<Car> carsCatalog = carService.list();\n        System.out.println(carsCatalog + \"\\n\");\n\n        System.out.println(\"Dodanie jednego samochodu do katalogu\");\n        Car toyotaCorollaCar = new Car(2009, \"Corolla\", \"Toyota\", BigDecimal.valueOf(33_000.00));\n        System.out.println(\"Samoch\u00f3d poza katalogie nie posiada unikalnego identyfikatora\");\n        System.out.println(toyotaCorollaCar);\n        Car createdToyotaCorollaCar = carService.create(toyotaCorollaCar);\n        System.out.println(\"Utworzony\/dodany samoch\u00f3d w katalogu posiada unikalny identyfikator\");\n        System.out.println(createdToyotaCorollaCar + \"\\n\");\n\n        System.out.println(\"Zawarto\u015b\u0107 katalogu samochod\u00f3w po dodaniu jednego samochodu\");\n        System.out.println(carService.list() + \"\\n\");\n\n        System.out.println(\"Dodanie kolejnego samochodu do katalogu\");\n        Car teslaModelXCar = new Car(2016, \"Model X\", \"Tesla\", BigDecimal.valueOf(340_000.00));\n        carService.create(teslaModelXCar);\n\n        System.out.println(\"Zawarto\u015b\u0107 katalogu samochod\u00f3w po dodaniu kolejnego samochodu\");\n        System.out.println(carService.list() + \"\\n\");\n\n        System.out.println(\"Modyfikacja danych samochodu z katalogu\");\n        \/\/ ... najpierw pobieramy katalog samochod\u00f3w, aby zna\u0107 identyfikatory samochod\u00f3w ...\n        List<Car> carsCatalogUpdate = carService.list();\n        \/\/ ... wybieramy pierwszy samoch\u00f3d do modyfikacji danych ...\n        Integer firstCarId = carsCatalogUpdate.get(0).getId();\n        Car firstCar = carService.read(firstCarId);\n        System.out.println(\"Dane samochodu do modyfikacji: \" + firstCar);\n        \/\/ ... podajemy nowe dane samochodu ...\n        Car firstCarUpdate = new Car();\n        firstCarUpdate.setId(firstCar.getId());\n        firstCarUpdate.setYear(firstCar.getYear());\n        firstCarUpdate.setModel(\"Corolla Sport\");\n        firstCarUpdate.setManufacturer(firstCar.getManufacturer());\n        firstCarUpdate.setPrice(BigDecimal.valueOf(35_000.00));\n        System.out.println(\"Dane samochodu po modyfikacji: \" + firstCarUpdate);\n        System.out.println(\"W katlogu jeszcze s\u0105 stare dane\");\n        System.out.println(carsCatalog + \"\\n\");\n        \/\/ ... identyfikator samochodu jest przekazywany do metody update() ...\n        Integer firstCarToUpdateId = firstCar.getId();\n        \/\/ ... aktulizujemy dane samochodu w katalogu za pomoc\u0105 serwisu ...\n        Car update = carService.update(firstCarToUpdateId, firstCarUpdate);\n\n        System.out.println(\"W katlogu s\u0105 ju\u017c nowe dane\");\n        System.out.println(carsCatalog + \"\\n\");\n\n        \/\/ ... usuwamy jedne samoch\u00f3d z katalogu ...\n        \/\/ ... najpierw pobieramy katalog samochod\u00f3w, aby zna\u0107 identyfikatory samochod\u00f3w ...\n        List<Car> carsCatalogDelete = carService.list();\n        \/\/ .. usuwamy samoch\u00f3d za pomoc\u0105 serwisu ...\n        Car firstCarToDelete = carsCatalogDelete.get(0);\n        Integer firstCarToDeleteId = firstCarToDelete.getId();\n        carService.delete(firstCarToDeleteId);\n\n        System.out.println(\"Samoch\u00f3d zosta\u0142 usuni\u0119ty z katalogu\");\n        System.out.println(carsCatalog + \"\\n\");\n    }\n}<\/pre>\n\n\n\n
\"Wynik<\/a>
Wynik dzia\u0142ania klasy CarServiceMain – Pierwsza klasa jako serwis CRUD \u2013 kod Java, IntelliJ, krok po kroku<\/figcaption><\/figure><\/div>\n<\/body><\/html>\n\n\n\n
Ca\u0142o\u015b\u0107 kodu mo\u017cna znale\u017a\u0107 na:<\/p>\n\n\n
\n
        \t\t\t\t\t\t\tThis project shows how the CRUD works in Java, and how to use it as a service.\t\t\t<\/strong>\t\t<\/a>\t\t
        https:\/\/github.com\/juniorjavadeveloper-pl\/java-first-class-crud-service<\/a>
        1<\/a> forks.
        0<\/a> stars.
        0<\/a> open issues.        <\/p>\n
\nRecent commits:<\/summary>\n