Spring data-rest-and-spring-cloud-contract

Spring Data REST
と
Spring Cloud Contract
Tagbangers, Inc.
#sf_25 #アンケート

© Tagbangers, Inc. 1
自己紹介
小川岳史
Spring Lover 10 years
山﨑大
わさもん

本日のメニュー
• 背景
• Spring Data REST
• HATEOAS
• Spring Cloud Contract
• CDC
• Pact

背景
• SPA 時代
• よりリッチな UI 表現のために Thymeleaf から Angular などへ
• ビジネスロジックの実装が UI 側にも必要なり…
Browser
Application • ビジネスロジック
• CRUD
Browser
Application • ビジネスロジック
• CRUD
• ビジネスロジック
DB
DB

工程やチーム構成の変化
BackendFrontend
ex. Angular ex. Spring Boot
Frontend Team Backend Team
User
repo repo
CI/CDCI/CD
code
push
code
push
artifactartifact
別々のデプロイ環境
別々のチーム
別々のレポジトリ
別々のリリースサイクル

どの URI にアクセスすれば
いいの？
どんなフォーマットでデー
タが取得できるの？
更新できる条件ってなんな
の？？
そこで発生してきた課題
開発初期段階

API の仕様が変更されて UI がバグったんだけど〜
そこで発生してきた課題
リリース後のバージョンアップで

解決策
どの URI にアクセスすればいいの？
どんなフォーマットでデータが
取得できるの？
更新できる条件ってなんなの？？
API の仕様が変更されて
UI がバグったんだけど〜
Spring Data REST
Spring エコシステムをフル活用！
標準化 + 自動生成別々に進化できる仕組み

Spring Data REST
✓ 標準化 + 自動生成

残念な実装
class ReservationService {
Reservation getReservation(long id) {
return this.reservationRepository.findById(id);
}
Reservation createReservation(Reservation reservation) {
return this.reservationRepository.save(reservation);
}
}

Spring Data REST とは
Entity
GET /items
GET /items/search
GET / items/1
POST /items
PUT /items/1
PATCH /items/1
DELETE /items/1
…
Item ItemRepository
REST スタイルな API エンドポイント
URL 設計に迷わない
Repository

Spring Data REST の始め方
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

Entity
Repository
@Entity
public class Order {
private Long id;
private Location location;
private LocalDateTime orderedDate;
private Status status;
}
public interface OrderRepository
extends PagingAndSortingRepository<Order, Long> {
}

. ____ _ __ _ _
/ / ___'_ __ _ _(_)_ __ __ _
( ( )___ | '_ | '_| | '_ / _` |
/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |___, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.0.6.RELEASE)
...
Mapped "{[/ || ],methods=[HEAD],produces=[application/hal+json || application/json]}" ...
Mapped "{[/ || ],methods=[GET],produces=[application/hal+json || application/json]}" ...
Mapped "{[/ || ],methods=[OPTIONS],produces=[application/hal+json || application/json]}" ...
Mapped "{[/{repository}],methods=[OPTIONS],produces=[application/hal+json || application/json]}" ...
Mapped "{[/{repository}],methods=[HEAD],produces=[application/hal+json || application/json]}" ...
Mapped "{[/{repository}],methods=[GET],produces=[application/hal+json || application/json]}" ...
Mapped "{[/{repository}],methods=[GET],produces=[application/x-spring-data-compact+json || text/uri-list]}" ...
Mapped "{[/{repository}],methods=[POST],produces=[application/hal+json || application/json]}" ...
Mapped "{[/{repository}/{id}],methods=[OPTIONS],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/{id}],methods=[HEAD],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/{id}],methods=[GET],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/{id}],methods=[PUT],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/{id}],methods=[PATCH],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/{id}],methods=[DELETE],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/{id}/{property}],methods=[GET],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/{id}/{property}/{propertyId}],methods=[GET],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/{id}/{property}],methods=[DELETE],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/{id}/{property}],methods=[GET],produces=[application/x-spring-data-compact+json || text/uri-list]}"
Mapped "{[/{repository}/{id}/{property}],methods=[PATCH || PUT || POST],consumes=[application/json || application/x-spring-data-compact+json || text/uri-list], ...
Mapped "{[/{repository}/{id}/{property}/{propertyId}],methods=[DELETE],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/search],methods=[OPTIONS],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/search],methods=[HEAD],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/search],methods=[GET],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/search/{search}],methods=[GET],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/search/{search}],methods=[GET],produces=[application/x-spring-data-compact+json]}"
Mapped "{[/{repository}/search/{search}],methods=[OPTIONS],produces=[application/hal+json || application/json]}"
Mapped "{[/{repository}/search/{search}],methods=[HEAD],produces=[application/hal+json || application/json]}"
Mapped "{[/profile],methods=[OPTIONS]}"
Mapped "{[/profile],methods=[GET]}"
Mapped "{[/profile/{repository}],methods=[GET],produces=[application/alps+json || */*]}"
Mapped "{[/profile/{repository}],methods=[OPTIONS],produces=[application/alps+json]}"
Mapped "{[/profile/{repository}],methods=[GET],produces=[application/schema+json]}"
Mapped "{[/ || ],methods=[GET],produces=[text/html]}"
Mapped "{[/browser],methods=[GET]}"
自動的にエンドポイントが登録されている
/repository…

{
"firstName" : "Frodo",
"lastName" : "Baggins",
"_links" : {
"self" : {
"href" : "http://localhost:8080/people/1"
}
}
}
$ curl http://localhost:8080/people/1
LINK 部
DATA 部

HATEOAS
• Hypermedia as the Engine of Application State
• データ部の他にリンク情報が追加され、関連するリソースをたどることができる
• Spring Data REST のリクエスト・レスポンスボディ部のフォーマットは HATEOAS に準拠
• Spring HATEOAS は独立したライブラリでこれだけ使うこともできる

フロント側で ID を取り出して個別に
URL を組み立てる必要がない
ページング情報も
$ curl http://localhost:8080/people
{
"_links" : {
"self" : {
"href" : "http://localhost:8080/people{?page,size,sort}",
"templated" : true
},
"search" : {
"href" : "http://localhost:8080/people/search"
}
},
"_embedded" : {
"persons" : [ {
"firstName" : "Frodo",
"lastName" : "Baggins",
"_links" : {
"self" : {
"href" : "http://localhost:8080/people/1"
}
}
} ]
},
"page" : {
"size" : 20,
"totalElements" : 1,
"totalPages" : 1,
"number" : 0
}
}
HATEOAS にのっかることでボディ部の
フォーマットも悩まない

{
"description": "iPhone",
"status": "IN_PROGRESS",
"_links": {
"self": {
"href": "http://localhost:8080/orders/4"
},
"orders": {
"href": "http://localhost:8080/orders"
},
"cancel": {
"href": "http://localhost:8080/orders/4/cancel"
},
"complete": {
"href": "http://localhost:8080/orders/4/complete"
}
}

if ( order.status == PENDING || order.status == PAID ) {
showCancelButton
}
ビジネスロジックの流出を最小限
に
キャンセル判定
ロジック
ロジック
ロジック

自動生成されて簡単！とはいえ…
• とにかく簡単だけど…
• Spring Data REST だけでは完成しない
• 基本的に CRUD のみ
• ビジネスロジックが必要な場合は拡張する
Controller
Service
Repository
Database
ここは自分で書く
Spring Data RESTが
よしなに

Repository
Spring
Data
REST
@RepositoryRest
Controller
Service
@Controller
@RestController
Endpoint
Endpoint
Endpoint
Domain
Model
ビジネスロジックの実装パターン
EventHandler

JSON Schema
• JSON Schema から TypeScript のコードの自動生成
TypescriptJson schema
自動生成
curl -H 'Accept:application/schema+json' http://localhost:8080/profile/reservations
{
"title" : "Reservation",
"properties" : {
"date" : {
"title" : "Date",
"readOnly" : false,
"type" : "string",
"format" : "date-time"
},
"name" : {
"title" : "Name",
"readOnly" : false,
"type" : "string"
}
},
"definitions" : { },
"type" : "object",
"$schema" : "http://json-schema.org/draft-04/schema#"
}
export type Date = string;
export type Name = string;
export interface Reservation {
date?: Date;
name?: Name;
[k: string]: any;
}

Admin over Spring Data REST
User UI Admin UI
Spring
Data
REST
Manual
Impl
DB

全文検索 over Spring Data REST
UI
Elastic
Search
Spring
Data
REST
Hibernate
Search
DB
Custom
Repository
Impl

マルチテナント over Spring Data REST
UI
Spring
Data
REST
Repository DBHibernate
Spring
Security
Authentication
Event Listener
Filter
Tenant

ポイント
 Spring Data REST を活用してボイラープレートコードを削減する
 REST や HATEOAS の流行りの仕様を活用する
チーム間のコミュニケーションをフォーマット的なことではなく、
よりビジネス的にフォーカスしたいポイントに絞る！！

ポイント
BackendFrontend
User
repo repo
CI/CDCI/CD
code
push
code
push
artifactartifact
Spring Data REST
Spring HATEOAS

でさくっと行う
Consumer Driven Contract
with Pact
別々に進化できる仕組み

工程やチーム構成の変化
BackendFrontend
User
repo repo
CI/CDCI/CD
code
push
code
push
artifactartifact
別々のデプロイ環境
別々のチーム
別々のレポジトリ
別々のリリースサイクル

Test Pyramid
https://martinfowler.com/bliki/TestPyramid.html

モックに置き換える
HTTP

モックに置き換える
そのモック意味がありますか？
• インターフェースは正しい？？
• 連携するサービスが変更されたら？
• だれがメンテナンスするの？

Micro service architecture
Microservice MicroserviceMicroservice
UI
Microservice
モックモックモックモックモックモックモックモック

Spring Cloud Contract is an
umbrella project holding
solutions that help users in
successfully implementing
the Consumer Driven
Contracts approach.

Pact
Pact is a contract testing tool. Contract
testing is a way to ensure that services
(such as an API provider and a client) can
communicate with each other. Without
contract testing, the only way to know that
services can communicate is by using
expensive and brittle integration tests

Contract
• 契約はインターフェース定義のようなもの
• API 仕様書の内容
• Provider が契約を守ることを約束する
Contract
Consumer
Consumer and provider are
both agreed with the sentence
below.. for example we agreed with
on the basis of the Provider’s REST
API, that is created hy
Provider
Test ✔
Test ✔

Spring Cloud Contract + Pact
で
Consumer Driven Contract

CDC ステップ
1. テスト書く
2. Contract（Pact file）を自動生成
3. Pact Broker に Pact file を publish
Consumer
1. Pact Broker から Contract（Pact file）を取得
2. Test を自動生成（Spring Cloud Contract )
3. モックを自動生成（Spring Cloud Contract）
Provider
https://github.com/pact-foundation/pact_broker/wiki/Webhooks

1. テストを書く
beforeAll ((done) => {
provider = new PactWeb({
consumer: ‘sample-client-tenant',
provider: ‘sapmle-server-tenant',
port: 1234,
host: '127.0.0.1'
});
});
前準備 1

beforeAll((done) => {
provider.addInteraction({
uponReceiving: 'a request for hello',
withRequest: {
method: 'GET',
path: '/hello'
},
willRespondWith: {
status: 200,
headers: {
'Content-Type': 'application/hal+json;charset=UTF-8'
},
body: {
reply: 'Hello'
}
}
}).then(done, done.fail);
});
前準備 2

it('should', (done) => {
const greetingService: GreetingService =
TestBed.get(GreetingTypeService);
greetingService.hello().subscribe(response => {
expect(response).toEqual({reply: 'Hello'});
done();
}, error => {
done.fail(error);
});
});
テスト
/hello に Get リクエスト

CDC ステップ
1. テスト書く
Consumer
Provider

2. Pact file ( Contract )
Pact file
...
"interactions": [
{
"description": "a request for hello",
"request": {
"method": "GET",
"path": "/hello"
},
"response": {
"status": 200,
"headers": {
"Content-Type":
"application/hal+json;charset=UTF-8"
...

CDC ステップ
1. テスト書く
Contract を共有するためのアプリ
Consumer
Provider

Pact Broker
https://github.com/pact-foundation/pact_broker

Pact Broker

CDC ステップ
1. テスト書く
Consumer
Provider

CDC ステップ
1. テスト書く
ビルド時にテストを生成 + テスト実行
Consumer
Provider

CDC ステップ
1. テスト書く
Consumer
Provider

CDC ステップ
1. テスト書く
成果物としてWireMockの定義ファイルができる
Consumer
Provider

APIが実装されたか知りたい
Broker のステータス確認で対応状況を把握

Pact Broker

破壊的な API の実装の変更
テストが通らないので破壊的な変更だとわかる！

使用されている API がわかる！

まとめ
BackendFrontend
User
repo repo
CI/CDCI/CD
code
push
code
push
artifactartifact
Spring Data REST
Spring HATEOAS

Spring data-rest-and-spring-cloud-contract

More Related Content

What's hot (20)

Similar to Spring data-rest-and-spring-cloud-contract (20)

More from Takeshi Ogawa (6)

Recently uploaded (9)

Spring data-rest-and-spring-cloud-contract

Editor's Notes