【Spring】@Autowired と @Component を使用した DI の基本

@Component と @Autowired を使用して、 Spring Framework の中心とも言える DI ( Dependency injection : 依存性の注入 ) の基本について学習する。まずは最小限の簡単なサンプル。

@Component
public class ClassA {
	
	@Autowired
	private ClassA classA;

}

@Component はインスタンスを Spring 管理下におくため、クラスに付けるアノテーション。

@Autowired は Spring 管理下のオブジェクトの中から、適切なものを変数に自動でセットしてもらうため、インスタンス変数に付けるアノテーションである。

SpringMVC や Spring Boot では、慣習的に @Component の変わりに @Controller、@Service、@Repository を使用する。

慣習的にと言ったのは、これら３つのアノテーションは、すべて @Component を継承しており、ソースコードレベルでの差異はないからである。

ソースのリンクを貼っておく。

では早速 DI のサンプルを作っていこう。
　
　

フォルダ構成

フォルダ構成は以下のとおり。

[org.yyama.bean]パッケージ配下の２つのクラスを Spring のコンテナに管理させる。Main クラスは Spring の管理外にする。
　
　

ソース

まず、applicationContext.xml。org.yyama.bean 配下を Spring がスキャンして、管理下とする bean を探す設定にしている。「<context:component-scan ・・・」となっている一行がその設定。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="
      http://www.springframework.org/schema/beans
      http://www.springframework.org/schema/beans/spring-beans.xsd
      http://www.springframework.org/schema/context
      http://www.springframework.org/schema/context/spring-context.xsd">
	<context:component-scan base-package="org.yyama.bean" />
</beans>

クラスA。

package org.yyama.bean;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class ClassA {

	@Autowired
	private ClassB classB;

	public void proc() {
		classB.print();
	}

}

@ComponentでSpringコンテナに管理させるクラスとして宣言している。@Autowired を使用してクラスＢのインスタンスを Spring で自動的にセットしてもらう。

クラスＢ。

package org.yyama.bean;

import org.springframework.stereotype.Component;

@Component
public class ClassB {
	public void print() {
		System.out.println("ClassBのprint()メソッドです。");
	}
}

@Component で Springコンテナに管理させるクラスとして宣言している。

最後に Main クラス。

package org.yyama;

import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.yyama.bean.ClassA;

public class Main {
	public static void main(String... args) {
		ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
		ClassA classA = ctx.getBean(ClassA.class);
		classA.proc();
		ctx.close();
	}
}