Pierwszą rzeczą którą musimy zrobić, to dodanie odpowiedniej biblioteki z pakietu spring boot, dzięki której będziemy mogli korzystać z mapowania oraz umożliwi nam wystawienie naszej usługi na zewnątrz.
w pliku pom.xml dodajemy następującą zależność:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>
* Zależnością nazywamy bibliotekę z którą będziemy korzystać i od której de facto jesteśmy zależni:)
nasz kompletny plik pom.xml powinien wyglądać teraz tak:
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.example</groupId> <artifactId>tutorial</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>MyFirstSpringBootApp</name> <description>Demo project for Spring Boot</description> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.3.0.RELEASE</version> <relativePath /> <!-- lookup parent from repository --> </parent> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>com.h2database</groupId> <artifactId>h2</artifactId> </dependency> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-io</artifactId> <version>1.3.2</version> </dependency> <dependency> <groupId>joda-time</groupId> <artifactId>joda-time</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
Przechodzimy teraz do utworzenia pakietu com.example.rest a w nim klasy LottoRestController o takiej postaci:
package com.example.rest; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import com.example.model.LottoResultModel; import com.example.repository.LottoResultRepository; @RestController @RequestMapping("/rest/api/lotto") public class LottoRestController { @Autowired private LottoResultRepository lottoResultRepository; @RequestMapping() public Iterable<LottoResultModel> getAllLottoResults(){ return lottoResultRepository.findAll(); } @RequestMapping("/{id}") public LottoResultModel getLottoResult(@PathVariable("id") Long id){ return lottoResultRepository.findOne(id); } }
Przeanalizujmy jej elementy...
Adnotacja
@RestController
Oznacza że dana klasa jest kontrolerem Spring`a, czyli według wzorca MVC służy do powiązania danych z widokiem. W naszym wypadku jest to REST, przez co na początku mamy suffix Rest.
Pod nią znajduje się kolejna adnotacja:
@RequestMapping("/rest/api/lotto")
oznacza ona ustawione mapowanie względem URI naszej apliakcji. Tzn jeśli adres root naszej witryny to http://localhost:8080/myApp, to aby pobrać nasze dane będziemy musieli podać taki adres: http://localhost:8080/myApp/rest/api/lotto@Autowired private LottoResultRepository lottoResultRepository;W naszej klasie korzystamy z repozytorium utworzonego w poprzednim rozdziale. Udostępnia on nam dane dotyczące wszystkich losowań dużego lotka od jego początków. Przy jego deklaracji użyliśmy adnotacji
@Autowired
Która wykorzystuje wbudowane w Springa zarządzanie komponentami DI. Stworzy ono za nas potrzebną reprezentacje interfejsu LottoResultRepository, tak jak przy inicjializacji naszej bazy danych.Dalej deklarujemy już metody służące do przekazywania danych dla klienta, pierwsza z nich:
@RequestMapping() public Iterable<LottoResultModel> getAllLottoResults(){ return lottoResultRepository.findAll(); }zwraca nam wszystkie możliwe wyniki. Pusty @RequestMapping oznacza że dane metoda jest domyślną metodą wykonywaną dla klasowego mappingu. Czyli wpisując w przeglądarkę http://localhost:8080/myApp/rest/api/lotto domyślnie nasz kontroler zwróci nam wszystkie wyniki.
Iterable<NaszModel>
Jest uniwersalnym interfejsem reprezentującym kolekcje danych, które możemy zwrócić.Meotda findAll() w lini:
return lottoResultRepository.findAll();Umożliwia nam pobranie wszystkich rekordów z bazy danych.
W drugiej metodzie, mamy nieco zmodyfikowaną wersję @RequestMapping:
@RequestMapping("/{id}") public LottoResultModel getLottoResult(@PathVariable("id") Long id){ return lottoResultRepository.findOne(id); }przyjmuje tu ona wartość /{id}. Ponieważ znajduje się ona w klamrze, oznacza to że jest to wartość, która może się dynamicznie zmieniać i możemy ją pobrać poprzez parametr z adnotacją @PathVariable:
@PathVariable("id") Long idOprócz PathVariable do dyspozycji mamy jeszcze kilka innych adnotacji dzięki którym możemy uploadować pliki, pobierać parametry z zapytań POST, PUT i czytać nagłówki:
@PathVariable służy do pobierania zmiennych z URL.
@RequestParam służy do pobierania zmiennych z wysłanego żądania.
@RequestHeader daje nam dostęp do zmiennych w nagłówku wysyłanego żądania.
Aby przetestować naszą aplikację możemy ją uruchomić i wejść na stronę:
http://localhost:8080/rest/api/lotto
w odpowiedzi powinniśmy dostać JSON`a zawierającą obiekty losowań.
