今こそ知りたいSpring DI x AOP #jsug

171.3K Views

January 10, 22

#java #spring #Spring #コンテナ #DI #AOP #Spring Boot

スライド概要

動画はこちら→ https://www.youtube.com/watch?v=LGtdpsmMfvI

#jsug Spring Fest 2020での発表資料です。
Springの根幹機能はDIとAOPです。しかし、普通に使っているだけだと「@Autowiredを付ければ代入されるんでしょ？」「@Transactionalを付ければ割り込みされるんでしょ？」くらいの曖昧な理解に陥りがちです。
このセッションでは、DIやAOPの重要機能や仕組みを丁寧に解説します。Springの根幹を理解して、初級者から中級者へ、中級者から上級者へステップアップしましょう！

※発表では無かった内容を[おまけ]として加えました

tada

@MasatoshiTada

スライド一覧

Java、Spring、IntelliJ IDEA

またはPlayer版

埋め込む »CMSなどでJSが使えない場合

ダウンロード

ダウンロード(pdf - 1.07MB)

関連スライド

詳解Springトランザクション -初級から上級まで- #jsug

java spring spring-boot

tada 322K

Java ORマッパー選定のポイント #jsug

java spring

tada 259.5K

プロになるためのSpring上級知識 #jsug

java spring

tada 221.7K

基礎からのOAuth 2.0とSpring Security 5.1による実装 #jsug

java spring oauth2

tada 147.9K

初めてのひとのためのSpring/Spring Boot #jjug

java spring spring-boot

tada 131K

各ページのテキスト

#jsug このセッションについて ▸ Springの基礎中の基礎である「コンテナ」「DI」「AOP」について、分かりやすく解説します ▸ 基本的に初心者向けですが、Springを利用している全ての方が対象です ▸ Spring Framework 5.3.1 / Spring Boot 2.4.0 で検証しています ▸ バージョンが異なる場合、内容も異なる可能性があります 2 (C) CASAREAL, Inc. All rights reserved.

10.

11.

#jsug Bean定義方法① コンポーネントスキャン ▸ 右記のアノテーションをクラスに付けると、 @Componentを付けたことと同じになる @Repository @Service @Controller @RestController @Configuration ▸ クラスの役割に応じて変える @ControllerAdvice @RestControllerAdvice ・・・ ※これらのアノテーションのソースコードを読むと、 @Componentが付いていることが分かります (C) CASAREAL, Inc. All rights reserved. 11

12.

#jsug Bean定義方法① コンポーネントスキャン ▸ Beanとしたいクラス package com.example; @Component public class Hoge { ... } @Componentが ▸ 設定クラス (Java Con g) 付いたクラスを探すパッケージ @Configuration @ComponentScan(basePackages = "com.example") public class AppConfig {} 12 fi (C) CASAREAL, Inc. All rights reserved.

13.

#jsug Bean定義方法① コンポーネントスキャン ▸ コンポーネントスキャン範囲は、basePackagesで指定したパッケージのサブパッケージ以下も含む @Configuration @ComponentScan( basePackages = "com.example") public class AppConfig {} com スキャン範囲 example foo bar baz 13 (C) CASAREAL, Inc. All rights reserved.

14.

#jsug Bean定義方法① コンポーネントスキャン ▸ basePackagesを指定しなかった場合、 @ComponentScanが付いたクラスのパッケージがbasePackagesとなる package com.example.config; @Configuration @ComponentScan // basePackages無し public class AppConfig {} これが basePackages になる！ 14 (C) CASAREAL, Inc. All rights reserved.

15.

#jsug Bean定義方法② Java Con g ▸ Java Con gクラスにメソッドを作成し、 @Beanを付加する → メソッドの戻り値がBeanになる // @Componentは不要 public class Hoge { ... } // @ComponentScanは不要 @Configuration public class AppConfig { @Bean public Hoge hoge() { return new Hoge(); } } 15 fi fi (C) CASAREAL, Inc. All rights reserved.

16.

#jsug コンテナを作る・Beanを取得する ▸ Java Con gクラスを指定して ApplicationContext (=コンテナ)を作成 ▸ コンポーネントスキャン・Java Con gどちらでも共通 ▸ getBean()でBeanを取得できる // コンテナの作成 ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class); // BeanをDIコンテナから取得（引数は欲しいBeanのデータ型） Hoge hoge = context.getBean(Hoge.class); 16 fi fi (C) CASAREAL, Inc. All rights reserved.

17.

#jsug コンテナ作成で行われること ▸ コンポーネントスキャンの場合 1. @Componentが付いたクラスを探す 2. 見つけたらインスタンス化 3. コンテナに保存コンテナ作成は重い処理なので、 1度コンテナを作成したらそれを使い回す！ ▸ Java Con gの場合 ※実際には、インスタンス生成のタイミングは 1. @Beanメソッドを実行スコープ（後述）によって異なります。ここで説明しているのはsingletonスコープの場合です 2. 戻り値をコンテナに保存 17 fi (C) CASAREAL, Inc. All rights reserved.

18.

[beta]

#jsug

Spring Bootの場合
これがbasePackages

@Configuration
@ComponentScan
package com.example;
@EnableAutoConfiguration
を組み合わせたアノテーション
@SpringBootApplication
public class MyApplication {
public static void main(String[] args) {
// コンテナの作成
ApplicationContext context =
SpringApplication.run(MyApplication.class);
}
}
※@EnableAutoConfigurationについては下記資料を参照
https://www.slideshare.net/masatoshitada7/spring-boot-jjug

18
(C) CASAREAL, Inc. All rights reserved.

https://www.slideshare.net/masatoshitada7/spring-boot-jjug

19.

#jsug [おまけ] Bean IDとは ▸ 各Beanを識別するためのID ▸ Bean取得などに使う（近年は滅多に使わない） Hoge hoge = (Hoge) context.getBean("Bean ID"); ▸ @ComponentでBean定義した場合、「クラス名の頭文字を小文字にしたもの」がBean ID ▸ @BeanでBean定義した場合、メソッド名がBean ID 19 (C) CASAREAL, Inc. All rights reserved.

20.

#jsug [おまけ] Bean IDとは Bean ID @Component public class FooBar { ... } fooBar @Component("foo_bar") public class FooBar { ... } foo_bar @Configuration public class FooConfig { @Bean public FooBar fooBar() { ... } fooBar } @Bean(name = "foo_bar") public FooBar fooBar2() { ... } foo_bar 20 (C) CASAREAL, Inc. All rights reserved.

21.

22.

23.

24.

25.

26.

27.

28.

#jsug アノテーション＋コンポーネントスキャンの場合 ▸ コンストラクタに@Autowiredを付加し、引数に欲しいBeanを指定 ▸ コンテナが適切なBeanを引数に代入してくれるコンテナ @Component public class Hoge { private final Fuga fuga; } @Autowired public Hoge(Fuga fuga) { this.fuga = fuga; } DI Fuga DI ※クラス内にコンストラクタが1つのみの場合、 @Autowiredは省略可能 Hoge (C) CASAREAL, Inc. All rights reserved. 28

29.

#jsug @Autowiredの省略 ▸ クラス内にコンストラクタが1つのみの場合、 @Autowiredを省略可能 @Component public class Hoge { private final Fuga fuga; @Autowired 省略可能 } public Hoge(Fuga fuga) { this.fuga = fuga; } 29 (C) CASAREAL, Inc. All rights reserved.

30.

#jsug Java Con gの場合 ▸ @Beanメソッドの引数に欲しいBeanを指定し、メソッド内に代入するコードを記述 ▸ コンテナが適切なBeanを引数に代入してくれるコンテナ @Configuration public class AppConfig { Hoge DI Fuga DI 30 (C) CASAREAL, Inc. All rights reserved. fi } @Bean public Hoge hoge(Fuga fuga) { return new Hoge(fuga); }

31.

#jsug いろんなDI ※メソッドインジェクションとも呼びます ▸ コンストラクタインジェクション @Component public class Hoge { private final Fuga fuga; } @Autowired public Hoge(Fuga fuga) { this.fuga = fuga; } ▸ フィールドインジェクション @Component public class Hoge { } @Autowired Fuga fuga; ▸ setterインジェクション @Component public class Hoge { private Fuga fuga; } @Autowired public setFuga(Fuga fuga) { this.fuga = fuga; } 唯一Hogeを変更不能にできるのでコンストラクタインジェクション推奨 ※変更不能(イミュータブル)＝フィールドの値を書換不可能 (C) CASAREAL, Inc. All rights reserved. 31

32.

33.

34.

35.

#jsug スコープとは ▸ コンテナが管理している、Beanの有効範囲 ▸ Beanがいつ生成され、いつ破棄されるかスコープの種類説明 singleton インスタンスは1つのみ（デフォルト） prototype 必要な時にインスタンスが毎回作られる request リクエストと同じ session セッションと同じ 35 (C) CASAREAL, Inc. All rights reserved.

36.

37.

38.

#jsug スコープの指定方法① ▸ @Scope("スコープ名")をBeanに付加 @Scope("session") @Component public class Hoge { ... } @Configuration public class AppConfig { } @Scope("request") @Bean public Hoge hoge() { ... } 38 (C) CASAREAL, Inc. All rights reserved.

39.

#jsug スコープの指定方法② ▸ @RequestScope・@SessionScopeも用意されている @SessionScope @Component public class Hoge { ... } @Configuration public class AppConfig { } @RequestScope @Bean public Hoge hoge() { ... } 39 (C) CASAREAL, Inc. All rights reserved.

40.

41.

42.

43.

44.

45.

#jsug どういうこと？これがBeanになるのではなく・・・ @Component public class HogeImpl implements Hoge { public void doSomething() { ... } } こんなクラスが実行時に生成され、これがBeanになる！ // このコードはイメージです public class HogeProxy implements Hoge { @Override public void doSomething() { ... } } 45 (C) CASAREAL, Inc. All rights reserved.

46.

#jsug プロキシの目的① AOP ▸ 本来の処理の前後に、割り込み処理を行う // このコードはイメージです public class HogeProxy implements Hoge { public void doSomething() { // 本来のインスタンス Hoge hoge = ...; // 前処理の割り込み ▸ トランザクションの開始・終了、権限チェックなど ▸ 詳細は後述 interceptor.doBefore(); // 本来の処理 hoge.doSomething(); // 後処理の割り込み } } interceptor.doAfter(); 46 (C) CASAREAL, Inc. All rights reserved.

47.

#jsug プロキシの目的② スコープの違いを吸収 @Scope("singleton") @Component public class SingletonScopeBeanImpl implements SingletonScopeBean { private final RequestScopeBean rsb; @Autowired public SingletonScopeBean(RequestScopeBean rsb) { this.rsb = rsb; } こちらもsingletonに } public void doSomething() { rsb.execute(); } なってしまう？ → DIされるのはプロキシ 47 (C) CASAREAL, Inc. All rights reserved.

48.

#jsug プロキシの目的② スコープの違いを吸収 // このコードはイメージです public class RequestScopeBeanProxy implements RequestScopeBean { ApplicationContext context; } 毎回コンテナから取得している！ @Override public void execute() { RequestScopeBean rsb = context.getBean(RequestScopeBean.class); rsb.execute(); } ※このプロキシはインタフェースで作成していますが、継承の場合でも同様です (C) CASAREAL, Inc. All rights reserved. 48

49.

#jsug プロキシの目的③ Beanをシングルトンに保つ @Configuration Sample1のインスタンスが public class HogeConfig { Sample1のインスタンスが 2つ作られる！？ @Bean 2つ作られる！？ public Sample1 sample1() { シングルトンでなくなる！？ return new Sample1(); } @Bean public Sample2 sample2() { return new Sample2(sample1()); } @Bean public Sample3 sample3() { return new Sample3(sample1()); } } 49 (C) CASAREAL, Inc. All rights reserved.

50.

#jsug プロキシの目的③ Beanをシングルトンに保つ // このコードはイメージです public class HogeConfigProxy extends HogeConfig { @Override public Sample1 sample1() { if (既にDIコンテナにSample1のBeanがあったら) { return context.getBean(Sample1.class) } else { return new Sample1(); } sample1()が何回実行されても } } ... Beanはシングルトン！ 50 (C) CASAREAL, Inc. All rights reserved.

51.

#jsug どんなBeanにプロキシが作られるか ① AOPを利用しているBean TARGET̲CLASS → CGLIB INTERFACES → JDK ② @ScopeでproxyMode=TARGET_CLASS またはINTERFACESが指定されているBean ③ @ComponentScanにscopedProxy=TARGET_CLASS またはINTERFACESが指定されているBean ④ @ConfigurationにproxyBeanMethods=true が指定されているJava Con g（デフォルトでtrue） 51 fi (C) CASAREAL, Inc. All rights reserved.

52.

#jsug プロキシの作られ方① JDK Proxy <<interface>> Hoge ▸ デフォルトの挙動 ▸ 本来のクラスが実装している全ての実装インタフェースを実装したクラスがプロキシ実行時に作られ、それがプロキシ（かつBean）となる HogeImpl ▸ java.lang.reflect.Proxyの機能 ▸ 何らかのインタフェースを実装したクラスに使われる 52 (C) CASAREAL, Inc. All rights reserved.

53.

54.

#jsug Beanがインタフェースを実装していても CGLIB Proxyを使いたい場合 ① Spring BootではデフォルトがCGLIB Proxy ▸ spring.aop.proxy-target-class=trueであるため（falseにすればJDK Proxy） ② @Scope(proxyMode=TARGET_CLASS) ▸ 付加したBeanのみが対象 ③ @ComponentScan(scopedProxy=TARGET_CLASS) ▸ コンポーネントスキャンした全Beanが対象 54 (C) CASAREAL, Inc. All rights reserved.

55.

56.

#jsug プロキシのまとめ ▸ プロキシ＝本来BeanとなるはずだったインスタンスをラップしたBean ▸ インタフェース（JDK Proxy）または継承（CGLIB Proxy）を利用して作られる ▸ Spring BootではデフォルトがCGLIB Proxy ▸ AOP、スコープの違いの吸収、Beanをシングルトンに保つ、が目的 ▸ 各プロキシの制約に注意 56 (C) CASAREAL, Inc. All rights reserved.

57.

58.

59.

60.

#jsug AOPの使い方 com.exampleパッケージの全クラス・全メソッドの前後に割り込む @Aspect @Component public class LoggingAspect { @Around("execution(* com.example.*.*(..))") public Object log(ProceedingJoinPoint jp) throws Exception { System.out.println("start"); // 前処理 Object value = jp.proceed(); System.out.println("end"); } } // 本来の処理 // 後処理 return value; 60 (C) CASAREAL, Inc. All rights reserved.

61.

#jsug AOPの使い方 package com.example; 割り込み対象は必ずBean @Component public class HelloService { public void hello() { System.out.println("hello"); } } 実行結果 start hello end 61 (C) CASAREAL, Inc. All rights reserved.

62.

63.

#jsug ポイントカット式 ▸ どのクラス・どのメソッドに割り込むかの条件を指定する execution(* com.example.*.*(..)) 戻り値の型は任意 com.exampleパッケージの全クラス・全メソッド引数の個数は任意 execution(@annotation(com.example.MyAnno)) @com.example.MyAnnoアノテーションが付加された全メソッドポイントカットの正式な文法は、AspectJのリファレンスを参照 https://www.eclipse.org/aspectj/doc/next/progguide/language-joinPoints.html (C) CASAREAL, Inc. All rights reserved. 63

https://www.eclipse.org/aspectj/doc/next/progguide/language-joinPoints.html

64.

65.

#jsug プロキシによるAOPの実現 // このコードはイメージです public class HelloServiceProxy implements HelloService { @Override public void hello() { HelloService target = ...; // 割り込み対象 Interceptor interceptor = ...; interceptor.doBefore(); target.hello(); // 前処理 // 本来の処理 interceptor.doAfter(); } // 割り込み処理担当 // 後処理 } 65 (C) CASAREAL, Inc. All rights reserved.

66.

#jsug AOPの注意点 ▸ 同一クラス内のメソッド呼び出しには割り込みがされない！ ▸ 特に@Transactionalで間違い多し @Component public class SampleService { public void method1() { System.out.println("method1()"); method2(); このmethod2()には } 割り込みされない！ } public void method2() { System.out.println("method2()"); } 66 (C) CASAREAL, Inc. All rights reserved.

67.

68.

#jsug 割り込みされるようにするには Spring Bootでも付ける @Configuration @EnableAspectJAutoProxy(exposeProxy = true) public class AspectConfig { ... } @Component public class SampleService { public void method1() { ... ((SampleService) AopContext.currentProxy()) .method2(); } public void method2() { ... } } 68 (C) CASAREAL, Inc. All rights reserved.

69.

70.

71.

72.

73.