Spring HATEOAS

JSUG勉強会 2019その10 SpringOne Platform 2019報告会

Transcript

1. 4QSJOH
   )"5&0"4 %BJ
   :BNBTBLJ
   5BHCBOHFST
   *OD
2. Who am I •Dai Yamasaki •Born to develop •I k6o
 dislike Tokyo
3. r
   ,BNFIBNFIB
   ***
   Χ΢ΠέΞΦ΢Ϧ l6B
   .BV
   LF
   &B
   P
   LB
   b⒖JOB
   J
   LB
   1POP
 ʢʮ౔஍ͷੜ໋ʢ㲈ओݖʣ͸ਖ਼ٛʹΑͬͯӬଓ͢Δʯʣz
4. Spring HATEOAS - Hypermedia APIs with Spring https://www.youtube.com/watch?v=o4cc6KzNrpI&list=PLAdzTan_eSPRlQ8t4TU5c-AB4SHV939M6&index=46
5. Who use HATEOAS
6. Migration script 0.x $ ./migrate-to-1.0.sh Migrating Spring HATEOAS references to 1.0 for files : *.java Adapting ./src/main/java/… … Done! https://github.com/spring-projects/spring-hateoas/tree/master/etc
7. Hypermedia -JOL -JOL -JOL -JOL
8. REST ੒ख़౓ • Level 0
 ҰͭͷURLͱҰͭͷHTTPϝιου • Level 1
 ҟͳΔURLͱҰͭͷHTTPϝιου • Level 2
 ҟͳΔURLͱҟͳΔHTTPϝιου • Level 3
 APIͷϨεϙϯεʹϋΠύʔϦϯΫ৘ใΛ࣋ͭ
9. Hypermedia + REST { "orderID":…, "productID”:…, "quantity":…, "orderValue":…, "_links":[ { "rel":"customer", "href":"...", }, { "rel":"self", "href":"...", }] }
10. Hypermedia
 As
 The
 Engine
 Of
 Application
 State H
 A
 T
 E
 O
 A
 S HATEOAS
11. Hypermedia + REST { "orderID":…, "productID”:…, "quantity":…, "orderValue":…, "_links":[ { “rel":"cancel", "href":"...", }, { "rel":"self", "href":"...", }] }
12. Why HATEOAS • ϦϯΫ͕Θ͔Ε͹ CRUD ͕Ͱ͖Δ • ϏδωεϩδοΫͷྲྀग़Λආ͚Δ
 ΫϥΠΞϯτ͸ϦϯΫͷ༗ແͰ൑அ • ϖʔδϯάͷදݱʹ໎Θͳ͍ { "orderID":…, "productID”:…, "quantity":…, "orderValue":…, "_links":[ { “rel":"cancel", "href":"...", }, { "rel":"self", "href":"...", }] }
13. Spring HATEOAS
14. Representation Model
15. Representation Model
16. Links & Affordance
17. ΞϑΥʔμϯεʢaffordanceʣͱ͸ɺ ؀ڥ͕ಈ෺ʹରͯ͠༩͑Δʮҙຯʯͷ͜ͱͰ͋Δɻ ΞϝϦΧͷ஌֮৺ཧֶऀδΣʔϜζɾJɾΪϒιϯʹΑΔ଄ޠͰ͋Γɺ ੜଶޫֶɺੜଶ৺ཧֶͷجఈత֓೦Ͱ͋Δɻ ʮ༩͑Δɺఏڙ͢Δʯͱ͍͏ҙຯͷӳޠ afford ͔Β଄ΒΕͨɻ Affordances
18. Affordance https://www.amazon.co.jp/%E3%82%B5%E3%83%B3%E3%82%A2%E3%83%BC%E3%83%88-%E3%81%8A%E3%82%82%E3%81%97%E3%82%8D%E9%A3%9F%E5%99%A8-4%E6%96%87%E5%AD%97%E3%83%9D%E3%83%AA%E3%82%B7%E3%83%BC- %E3%83%9E%E3%82%B0%E3%82%AB%E3%83%83%E3%83%97-SAN1858/dp/B003NEPOTW
19. Links & Affordances { "name": "Dai Yamasaki", "role": "Developer", "_links": { "self": { "href": “/employees/0" }, "employees": { "href": "/employees" } }, "_templates": { "default": { "method": "put", "properties": [ { "name": "name", "required": true }, { "name": "role" } ] }, "partiallyUpdateEmployee": { "method": "patch", "properties": [ { "name": "name" }, { "name": "role" } …
20. Links & Affordances @GetMapping("/employees/{id}") public EntityModel<Employee> findOne(@PathVariable Integer id) { Employee employee = employeeRepository.findOneById(id); // ࣗ෼ࣗ਎ "self" ͷϦϯΫΛ࡞੒ WebMvcEmployeeController controller = methodOn(WebMvcEmployeeController.class); Link findOneLink = linkTo(controller.findOne(id)).withSelfRel(); // Affordance ΛؚΊͨ৘ใΛฦ͢ return new EntityModel<>( employee, findOneLink .andAffordance( afford(controller.updateEmployee(null, id))) .andAffordance( afford(controller.partiallyUpdateEmployee(null, id)))); }
21. 4FQBSBUF
    SFTPVSDF Links & Affordances { "_links": { "my-app:payment": {...}, "curies": [ { "name": "my-app", "href": "http://hoge.com/docs/{rel}", "templated": true }] } } IUUQNZBQQDPNEPDTQBZNFOU
22. *OMJOF
    SFTPVSDF { ... "_templates": { "default": { "method": "put", "properties": [{ "name": "number", "regex": "[0-9]{16}" }] } } } Links & Affordances
23. .FEJB
    5ZQFT
24. 5SBWFSTPO @Test void traverson() { Traverson traverson = new Traverson(baseUri, MediaTypes.HAL_JSON); ParameterizedTypeReference<EntityModel<Actor>> typeReference = new ParameterizedTypeReference<EntityModel<Actor>>() {}; EntityModel<Actor> result = traverson.follow("movies", "movie", “actor") .toObject(typeReference); assertThat(result.getContent().name) .isEqualTo("Dwayne Douglas Johnson"); }
25. 5SBWFSTPO { "_links": { "movie": { "href": "http://localhost:8080/movies/63e0c973-1606-4fe7-b4e3-0de03d2e0c06" } } } { "title": "Fast & Furious Presents: Hobbs & Shaw", "_links": { "actor": { "href": "http://localhost:8080/actors/f58ebb17-abd8-48fb-b06c-5a912251631c" } } } { "name": "Dwayne Douglas Johnson" } NPWJFT EntityModel<Actor> result = traverson.follow("movies", "movie", “actor") .toObject(typeReference); NPWJF BDUPS
26. 0UIFS • RepresentationModelAssembler • I18N support • LinkRelationProvider
27. 5IBOLT