-
Notifications
You must be signed in to change notification settings - Fork 0
/
jaxrs-getting-started-and-practice.html
1830 lines (1289 loc) · 42.7 KB
/
jaxrs-getting-started-and-practice.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<title>JAX-RS入門および実践</title>
<meta charset="utf-8">
<style>
@import url(https://fonts.googleapis.com/css?family=Ubuntu+Mono:400,700,400italic);
@font-face {
font-family: 'mplus';
src: url('assets/mplus-1c-regular.ttf');
}
h1, h2, h3, h4, h5, h6 {
font-family: 'mplus';
}
p, li {
font-family: 'mplus';
font-size: 1.2em;
}
strong {
text-decoration: underline;
}
li p, li li {
font-size: 1em;
}
code.remark-inline-code {
font-family: 'Ubuntu Mono';
}
code.remark-code {
font-family: 'Ubuntu Mono';
font-size: 1.2em;
}
table {
border-right: thin solid silver;
border-bottom: thin solid silver;
}
th, td {
border-left: thin solid silver;
border-top: thin solid silver;
}
</style>
</head>
<body>
<textarea id="source">
class: center, middle
# JAX-RS入門<br/>および実践
---
## 自己紹介
* うらがみ
* 大阪のSIer
* プログラマ歴9年弱(ほとんどJava)
* JAX-RSでのお仕事歴は4年ぐらい
---
## 本日の発表内容
* JAX-RSの概要
* JAX-RSの入門的な解説
* 実践の話をいくつか
---
class: center, middle
## JAX-RSの概要
---
## JAX-RSとは
* Java EE 6から登場したWebフレームワーク
* [JSR 339](https://jcp.org/en/jsr/detail?id=339)、参照実装は[Jersey](https://jersey.java.net/)
* アノテーションを使用してHTTPリクエスト・レスポンスをJavaコードにマッピングする
* RESTful APIを作るのに特化している
---
### JAX-RS/Servlet/JSF比較
<table>
<tr>
<th></th>
<th>JAX-RS</th>
<th>Servlet</th>
<th>JSF</th>
</tr>
<tr>
<th>APIのレベル感</th>
<td>高レベル</td>
<td>低レベル</td>
<td>高レベル</td>
</tr>
<tr>
<th>特徴</th>
<td>HTTPを宣言的にマッピング</td>
<td>際立った特徴は無い</td>
<td>デスクトップGUIのような感覚で作れる</td>
</tr>
<tr>
<th>向いているもの</th>
<td>RESTful API</td>
<td>他のフレームワークのベース</td>
<td>画面有りのWebアプリケーション</td>
</tr>
<tr>
<th>Servlet API</th>
<td>Servlet APIに依存しない</td>
<td>-</td>
<td>Servlet API上に構築されている</td>
</tr>
</table>
---
### 簡単な例
* ServletとJAX-RSで足し算してみてコードの違いを確認
* `/addition?a=1&b=2` にアクセスすると `3` が返ってくるといった仕様
※JSFは方向性が違いすぎるので割愛します
---
### Servletで足し算
```java
@WebServlet(urlPatterns = "addition")
public class Addition extends HttpServlet {
protected void doGet(HttpServletRequest req,
HttpServletResponse resp)
throws ServletException, IOException {
int a = Integer.parseInt(req.getParameter("a"));
int b = Integer.parseInt(req.getParameter("b"));
resp.setContentType("text/plain");
try (PrintWriter out = resp.getWriter()) {
out.print(a + b);
}
}
}
```
---
### JAX-RSで足し算
```java
@Path("addition")
public class Addition {
@GET
@Produces("text/plain")
public int calculate(@QueryParam("a") int a,
@QueryParam("b") int b) {
return a + b;
}
}
```
---
### 宣言だけ抜粋
* Servletは `/addition` にGETメソッドでアクセスする、としか読み取れないのに対して……
```java
@WebServlet(urlPatterns = "addition")
public class Addition extends HttpServlet {
protected void doGet(HttpServletRequest req,
HttpServletResponse resp)
throws ServletException, IOException { ... }
```
---
### 宣言だけ抜粋
* JAX-RSは `/addition` にクエリパラメータ `a` と `b` を付与してGETメソッドでアクセスすると `text/plain` なエンティティが返ってくる、と読み取れる
```java
@Path("addition")
public class Addition {
@GET
@Produces("text/plain")
public int calculate(@QueryParam("a") int a,
@QueryParam("b") int b) { ... }
```
---
### 宣言から読み取れるということは
* パスや`Content-Type`、パラメータの名前はコンパイル時に解決できる
* ドキュメントの生成やモックの自動生成が行いやすい
---
### JAX-RS/Servlet/JSFまとめ
* それぞれ向いている用途が異なる
* Servletはより高レイヤーなフレームワークの基礎部分
* JSFは画面(管理画面や業務アプリに向いていると思う)
* JAX-RSはRESTful APIに向いている
* JAX-RSはHTTPをJavaコードに宣言的にマッピングする
---
class: center, middle
## JAX-RSの仕様について
---
### JAX-RSアプリケーションの構成要素
* リソースクラス
* フィルター・インターセプター
* エンティティボディの読み込み・書き出し
* 例外ハンドラー
* アプリケーションの定義
* クライアントAPI
---
### JAX-RSアプリケーションの構成要素
* **リソースクラス**
* フィルター・インターセプター
* エンティティボディの読み込み・書き出し
* 例外ハンドラー
* アプリケーションの定義
* クライアントAPI
---
## リソースクラス
* HTTPリクエストを受け取るエンドポイントとなるクラス
* `@Path` で注釈し、少なくとも1つのリソースメソッドを持つ
* リソースメソッドは `@GET` や `@POST` などHTTPメソッドを表すアノテーションで注釈したメソッド
* 他にもアノテーションを利用して受け取るパラメータや`Content-Type`などを設定できる
---
### Additionクラス再掲
```java
@Path("addition")
public class Addition {
@GET
@Produces("text/plain")
public int calculate(@QueryParam("a") int a,
@QueryParam("b") int b) {
return a + b;
}
}
```
* `@Path` でパスを設定する
* `@GET` でGETメソッドを受け付ける事を設定する
* `@Produces` でレスポンスのエンティティのContent-Typeを設定する
* `@QueryParam` でクエリパラメータを受け取る事を設定する
---
### HTTPリクエストとの対比
```java
@Path("addition")
public class Addition {
@GET
@Produces("text/plain")
public int calculate(@QueryParam("a") int a,
@QueryParam("b") int b) {
return a + b;
}
}
```
* この `Addition.calculate` は次のようなHTTPリクエストを処理する
```
GET /addition?a=1&b=2 HTTP/1.1
Accept: text/plain
```
---
### パスのマッピング
`@Path` はメソッドにも付けて階層を表せられる
```java
@Path("hello")
public class Hello {
@GET
public String say() { ... }
@Path("world")
@GET
public String world() { ... }
}
```
この場合 `/hello` へのリクエストは `say` メソッドに、
`/hello/world` へのリクエストは `world` メソッドにマッピングされる
---
### パスのマッピング
また、パスは `{` と `}` で囲む事で変数として使える
```java
@GET
@Path("hello/{name}")
public String sayHello(
@PathParam("name") String name) {
...
```
変数に取れる文字は正規表現で制限できる
次の例だと変数 `userId` は数字のみで構成される
```java
@Path("users/{userId:\\d+}")
```
---
### パラメータのマッピング
HTTPリクエストに含まれる次の項目をパラメータにできる
* クエリパラメータ
* パスの一部
* Matrix URI
* リクエストヘッダ
* Cookie
* フォームコントロールの値
---
### クエリパラメータとパスの一部
すでに紹介している機能
```java
@Path("foo/{foo}")
public class Foo {
@GET
public String bar(
@PathParam("foo") String foo,
@QueryParam("bar") String bar) {
...
```
これは次のようなリクエストパスに対応する
```
/foo/xxx?bar=yyy
```
---
## Matrix URI
```java
@Path("addition")
public class Addition {
@GET
public String calculate(
@MatrixParam("left") int left,
@MatrixParam("right") int right) {
...
```
これは次のようなリクエストパスに対応する
```
/addition;left=2;right=3
```
---
### リクエストヘッダ、Cookie
```java
@GET
public String get(
@HeaderParam("foo") String foo,
@CookieParam("bar") String bar) {
...
```
これは次のようなHTTPリクエストヘッダに対応する
```
GET /hoge HTTP/1.1
Foo: xxx
Cookie: bar=yyy
```
---
### フォームコントロールの値
HTMLのform要素から送信される値をマッピングする
```java
@POST
@Produces("application/x-www-form-urlencoded")
public String sayHello(
@FormParam("yourName") String name) {
...
```
これは次のようなフォームコントロールに対応する
```html
<form method="POST" action="hello">
<input type="text" name="yourName">
...
```
---
### バリューオブジェクトで受け取る
また、これまで紹介したアノテーションを使ったパラメータのマッピングではバリューオブジェクトを利用できる
```java
public class ValueObject {
private final String value;
public ValueObject(String value) {
this.value = value;
}
public String getValue() { return value; }
}
```
```java
@GET
public String get(
//引数にバリューオブジェクトを使用できる
@QueryParam("value") ValueObject vo) { ... }
```
---
### 引数に使えるバリューオブジェクト
* Stringの引数をひとつだけ受け取るpublicなコンストラクタを持つクラス
* Stringの引数をひとつだけ受け取る `valueOf` という名前のstaticファクトリメソッドを持つクラス
* Stringの引数をひとつだけ受け取る `fromString` という名前のstaticファクトリメソッドを持つクラス
---
### 既存のクラスを引数に使いたい場合
* ライブラリに含まれているクラスなど、コンストラクタや `valueOf`・`fromString`の追加ができない場合
* `ParamConverter` インターフェースを実装したクラスを用意すればどんなクラスもパラメータとして使える
---
### 例：LocalDateのParamConverter
```java
public class LocalDateConverter
implements ParamConverter<LocalDate> {
public LocalDate fromString(String value) {
//※nullが渡される事があるので注意！
return Optional.ofNullable(value)
.map(LocalDate::parse)
.orElse(null);
}
public String toString(LocalDate value) { ... }
}
```
---
### エンティティボディを受け取る
引数にアノテーションを付けずエンティティボディをそのまま受け取る事もできる
```java
@Path("echo")
public static class Echo {
@POST
@Consumes("text/plain")
public String echo(String text) {
return text;
}
}
```
`@Consumes` ではこのリソースメソッドが受け付けるエンティティのContent-Typeを指定できる
---
### 対応するHTTPリクエスト
これは次のようなHTTPリクエストに対応する
```
POST /echo HTTP/1.1
Content-Type: text/plain
...(略)...
HelloWorld
```
この場合は引数 `text` には `"HelloWorld"` が渡される
---
### XMLをPOJOで受け取る
エンティティボディがXMLの場合、JAXBでPOJOに変換して受け取る機能が標準装備されている
```java
@XmlRootElement
public static class Person {
private String name;
private int age;
//...(アクセサ省略)...
}
```
```java
@Path("person")
public class PersonApi {
@POST
@Consumes("application/xml")
public void post(Person person) {
...
```
---
### 対応するHTTPリクエスト
これは次のようなエンティティボディにXMLを含むHTTPリクエストに対応する
```
POST /person HTTP/1.1
Content-Type: application/xml
...(略)...
<person>
<name>うらがみ</name>
<age>32</age>
</person>
```
---
## JSONをPOJOで受け取る
`@Consumes` の中身を `"application/json"` に変えればJSONを受け取る事もできる
```java
@Path("person")
public class PersonApi {
@POST
@Consumes("application/json")
public void post(Person person) {
...
```
---
### 対応するHTTPリクエスト
これは次のようなエンティティボディにJSONを含むHTTPリクエストに対応する
```
POST /person HTTP/1.1
Content-Type: application/json
...(略)...
{"name":"うらがみ","age":32}
```
*※ただしJSONをPOJOで受け取る機能はJAX-RSの仕様ではなくGlassFishが対応してくれているだけ*
---
### JAX-RSアプリケーションの構成要素
* リソースクラス
* **フィルター・インターセプター**
* **エンティティボディの読み込み・書き出し**
* 例外ハンドラー
* アプリケーションの定義
* クライアントAPI
---
### リクエストを処理する流れ
* 参考：JSR 339 - Appendix C Processing Pipeline
---
### 1. リクエストを受け付ける
---
### 2. フィルタリング(マッチング前)
* 実行されるリソースメソッドが決定される前
* `@PreMatching` が付いた `ContainerRequestFilter` の実行
* HTTPメソッドやリクエストURLの上書きが可能
---
### 例：HTTPメソッドを上書きするContainerRequestFilter
```java
@Provider
@PreMatching
public class PseudoHttpMethodFilter
implements ContainerRequestFilter {
public void filter(ContainerRequestContext rc) throws IOException {
String method = rc.getHeaderString(
"X-Http-Method-Override");
if (method != null) {
rc.setMethod(method);
}
}
}
```
---
### 3. リソースメソッドの決定
* HTTPメソッドやリクエストパスでリソースメソッドとマッチング
---
### 4. フィルタリング(マッチング後)
* ( `@PreMatching` が付いていない)残りの `ContainerRequestFilter` でリクエストをフィルタリング
---
### 5. エンティティボディを加工
* `ReaderInterceptor` でエンティティボディをJavaのオブジェクトに加工する前に加工できる
* 例えば暗号化されたデータの複号化
---
### 例：複号化するReaderInterceptor
```java
@Provider
public class Decrypter implements ReaderInterceptor {
public Object aroundReadFrom(
ReaderInterceptorContext context)
throws IOException, WebApplicationException {
try {
InputStream in = context.getInputStream();
Cipher c = ...(略)...
context.setInputStream(
new CipherInputStream(in, c));
return context.proceed();
} catch (GeneralSecurityException e) {
throw new InternalServerErrorException(e);
}
}
}
```
---
### 6. エンティティボディの変換
* `MessageBodyReader` でエンティティボディをJavaのオブジェクトに変換
* 先に説明をしたXMLやJSONをPOJOで受け取る仕組みの正体
---
### 例：エンティティボディをPropertiesに変換するMessageBodyReader
```java
@Provider
public class PropertiesReader
implements MessageBodyReader<Properties> {
public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return true;
}
public Properties readFrom(Class<Properties> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String, String> httpHeaders,
InputStream entityStream) throws IOException, WebApplicationException {
Properties props = new Properties();
props.load(entityStream);
return props;
}
}
```
---
### 7. リソースメソッドを実行
---
### 8. レスポンスのフィルタリング
* `ContainerResponseFilter` を実行
* リソースメソッドの戻り値などを見てステータスコードやエンティティボディを変更できる
---
### 例：空のリストだったら204 No Contentを返すContainerResponseFilter
```java
@Provider
public class EmptyListToNoContentProvider
implements ContainerResponseFilter {
public void filter(ContainerRequestContext requestContext,
ContainerResponseContext responseContext) throws IOException {
Object entity = responseContext.getEntity();
if (entity instanceof List
&& ((List<?>) entity).isEmpty()) {
responseContext.setStatus(204);
}
}
}
```
---
### 9. 戻り値の変換
* `WriterInterceptor` でリソースメソッドの戻り値がエンティティボディに書き出される前にレスポンスを加工できる
---
### 例：暗号化するWriterInterceptor
```java
@Provider
public class Encripter implements WriterInterceptor {
public void aroundWriteTo(
WriterInterceptorContext context)
throws IOException, WebApplicationException {
try {
OutputStream out = context.getOutputStream();
Cipher c = ...(省略)...
context.setOutputStream(
new CipherOutputStream(out, c));
context.proceed();
} catch (GeneralSecurityException e) {
throw new InternalServerErrorException(e);
}
}
}
```
---
### 10. エンティティボディの書き出し
* `MessageBodyWriter` でリソースメソッドの戻り値をエンティティボディに書き出す
---
### 例：Propertiesをエンティティボディに書き出すMessageBodyWriter
```java
@Provider
public class PropertiesWriter implements MessageBodyWriter<Properties> {
public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return true;
}
public long getSize(Properties t, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return -1;
}
public void writeTo(Properties t, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String, Object> httpHeaders,
OutputStream entityStream) throws IOException, WebApplicationException {
t.store(entityStream, "");
}
}
```
---
### 11. レスポンスを返す
---
### JAX-RSアプリケーションの構成要素
* リソースクラス
* フィルター・インターセプター
* エンティティボディの読み込み・書き出し
* **例外ハンドラー**
* アプリケーションの定義
* クライアントAPI
---
### ExceptionMapper
* リソースメソッドで投げられた例外をハンドリングする
* ハンドリング対象の例外クラスは型変数で指定する
```java
@Provider
public class SQLExceptionMapper implements
ExceptionMapper<SQLException> {
public Response toResponse(SQLException e) {
...(省略)...
return Response.serverError().build();
}
}
```
---
### JAX-RSアプリケーションの構成要素
* リソースクラス
* フィルター・インターセプター
* エンティティボディの読み込み・書き出し
* 例外ハンドラー
* **アプリケーションの定義**
* クライアントAPI
---
### Application
* JAX-RSアプリケーションの構成を表す
* `Application` クラスのサブクラスを作ってリソースクラスや各種プロバイダーを返すメソッドをオーバーライドする
* `@ApplicationPath` で注釈してルートとなるパスを設定する
---
### 例：Applicationサブクラス
```java
@ApplicationPath("api")
public class MyApplication extends Application {
private final Set<Class<?>> classes = new HashSet<>();
public MyApplication() {
classes.add(Addition.class);
classes.add(BasicAuthProvider.class);
classes.add(PropertiesReader.class);
}
public Set<Class<?>> getClasses() {
return classes;
}
}
```
---
### Java EE環境でのApplicationサブクラス
* Java EE環境下では `@Path` で注釈されたクラスをリソースクラス、 `@Provider` で注釈されたクラスをプロバイダーと認識して自動で登録してくれる
* メソッドをオーバーライドしてリソースクラス・プロバイダーを登録する必要が無い
```java
@ApplicationPath("api")
public class MyApplication extends Application {
}
```
---
### JAX-RSアプリケーションの構成要素
* リソースクラス
* フィルター・インターセプター
* エンティティボディの読み込み・書き出し
* 例外ハンドラー
* アプリケーションの定義
* **クライアントAPI**
---
## クライアントAPI
* ビルダーパターンで書けるHTTPクライアント
```java
Client client = ClientBuilder.newClient();
String result = client.target("http://localhost:8080/account")
//クエリパラメータを設定
.queryParam("id", "backpaper0").request()
//リクエストヘッダを設定
.header("X-Client-ID", clientId)
//リクエストボディをJSONで送って、
//レスポンスボディをStringで受け取る
.post(Entity.json(account), String.class);
```
---
class: center, middle
## ここから実践の話
---
## ※おことわり
* 私の経験をお話するので、すべての人にとって良い方法というわけではありません
* Jersey、GlassFishに特化したお話もあります
---
### 経験したJAX-RS案件たち
* JAX-RS1, GlassFish3, HTML, Knockout
* JAX-RS1, GlassFish3, Android
* JAX-RS2, Tomcat7, Jersey MVC, JSP
* JAX-RS2, Payara, Android
---
## 実践の話
* 認証
* バリデーション
* 宣言的トランザクション
* 大量データのダウンロード
* MVCと状態の持ち方
* テストコード
---
## 実践の話
* **認証**
* バリデーション
* 宣言的トランザクション
* 大量データのダウンロード
* MVCと状態の持ち方
* テストコード
---
class: center, middle