規模の大きいプロジェクトになってくるとアノテーションベースでDIを制御することはせず、xmlファイルにて設定を行うことが多いとのことですが、SpringBootを利用した場合はどうなんでしょうか・・・？

私が前にいたプロジェクトはSpringではないが、DIコンテナの利用にxmlファイルにて設定を記載していた。

今回の記事ではxmlファイルにて設定を行ってみます。

SpringのCoreであるDI

SpringのCoreといえばDIとAOPとのことです

DIxAOPコンテナがSpringのフレームワークを支えるコアとなるもの
Bean定義ファイル”だけ”を使えばPOJOとしてインスタンスの受け渡しが可能
デフォルトでBean定義はapplicationContext.xmlに記載する
- @ImportResource(“classpath:applicationContext.xml”)を使うと読み込めます

DIコンテナ

BeanFactoryはBean定義ファイルに基づいてインスタンスの生成とインジェクションを行う
DIコンテナからインスタンスを取得するということは、BeanFactoryからインスタンスを取得しているということ
ApplicationContextはBeanFactoryの上位にあり、ApplicationContextを使っても良い

[余談]applicationの開始時にDIコンテナを取得したい場合は以下のようにして取得できます

@SpringBootApplication
@ImportResource("classpath:applicationContext.xml")
public class TesttestApplication {

	public static void main(String[] args) {
		ConfigurableApplicationContext con = SpringApplication.run(TesttestApplication.class, args);
		SampleUsecase sampleUsecase = con.getBean(SampleUsecase.class);
		System.out.println(sampleUsecase.get());
	}
}

Bean定義を作成する

src\main\resources\applicationContext.xmlを作成して以下のように記載する

<?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">
        <bean id="sampleUsecase" class="com.example.demo.usecase.impl.SampleUsecaseImpl"></bean>   
		<bean id="sampleRepository" class="com.example.demo.repository.impl.SampleRepositoryImpl">
		</bean>
</beans>

bean
- id一意のID
- classidの実態。パッケージ.クラス名
  - 一意のID
  - idの実態。パッケージ.クラス名

これでDIが可能になります。@Componentアノテーションはついてません。

public class SampleUsecaseImpl implements SampleUsecase{

	@Autowired
	private SampleRepository sampleRepository;

	@Override
	public String get() {
		String name = this.sampleRepository.findName();
		System.out.println(name);
		return name;
	}
}

public class SampleRepositoryImpl implements SampleRepository{
	@Override
	public String findName() {
		return "インデックス";
	}
}

これで@Componentアノテーションが消えました。

@Autowiredを消す

続いて@Autowiredを消します。この状態でSampleUsecaseImpl.javaにてアノテーションを消してもエラーになります

java.lang.NullPointerException: Cannot invoke &quot;com.example.demo.repository.SampleRepository.findName()&quot; because &quot;this.sampleRepository&quot; is null

xmlファイルを修正します

<?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">
        <bean id="sampleUsecase" class="com.example.demo.usecase.impl.SampleUsecaseImpl" autowire="byType"></bean>   
		<bean id="sampleRepository" class="com.example.demo.repository.impl.SampleRepositoryImpl">
		</bean>
</beans>

autowire
- byType

以下のように修正します

public class SampleUsecaseImpl implements SampleUsecase{

	private SampleRepository sampleRepository;

	@Override
	public String get() {
		String name = this.sampleRepository.findName();
		System.out.println(name);
		return name;
	}
	
	public void setSampleRepository(SampleRepository repository) {
		this.sampleRepository = repository;
	}
	
}

セッターメソッドを用意することで自動的にインジェクションしてくれるようになりました。

これで@Autowiredが消えました。

セッターメソッドを消す

コンストラクタインジェクションを行います。

xmlを修正します

<?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">
        <bean id="sampleUsecase" class="com.example.demo.usecase.impl.SampleUsecaseImpl" autowire="constructor"></bean>   
		<bean id="sampleRepository" class="com.example.demo.repository.impl.SampleRepositoryImpl">
		</bean>
</beans>

autowire
- constructorを指定

コンストラクタにてインジェクションするよう修正する

public class SampleUsecaseImpl implements SampleUsecase{

	private SampleRepository sampleRepository;

	@Override
	public String get() {
		String name = this.sampleRepository.findName();
		System.out.println(name);
		return name;
	}
	
	public SampleUsecaseImpl(SampleRepository repository) {
		this.sampleRepository = repository;
	}
}

これで消えました。

refを指定する

refを利用することで指定したbeanIdのbeanをインジェクションできます

xmlを修正します

<?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">
        <bean id="sampleUsecase" class="com.example.demo.usecase.impl.SampleUsecaseImpl">
        	<property name="sampleRepository">
        		<ref bean="secondRepository"></ref>
        	</property>
        </bean>   
		<bean id="sampleRepository" class="com.example.demo.repository.impl.SampleRepositoryImpl"></bean>
		<bean id="secondRepository" class="com.example.demo.repository.impl.SecondRepositoryImpl"></bean>
</beans>

SecondRepositoryImplは、SampleRepositoryImplと同じインターフェースを実装しています。
違う点はbean idです
UsecaseクラスのsampleRepositoryというプロパティに対してbean idがsecondRepositoryのものをインジェクションします

public class SampleUsecaseImpl implements SampleUsecase{

	private SampleRepository sampleRepository;
	
	@Override
	public String get() {
		String name = this.sampleRepository.findName();
		System.out.println(name);
		return name;
	}
	
	public void setSampleRepository(SampleRepository repository) {
		this.sampleRepository = repository;
	}	
}

セッターメソッドを用意します

これでSecondRepositoryImplの実装が利用できます。

プロパティファイルから値を取得する

おまけ編でプロパティファイルの値を取得してみます。

<?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"
	xmlns:util="http://www.springframework.org/schema/util"
	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
        http://www.springframework.org/schema/util
        http://www.springframework.org/schema/util/spring-util-2.0.xsd">
        
        <util:properties id="msgfile" location="classpath:messages.properties"></util:properties>
        <bean id="sampleUsecase" class="com.example.demo.usecase.impl.SampleUsecaseImpl">
        	<property name="sampleRepository">
        		<ref bean="secondRepository"></ref>
        	</property>
        	<property name="username">
        		<value>#{msgfile.username}</value>
        	</property>
        </bean>   
		<bean id="sampleRepository" class="com.example.demo.repository.impl.SampleRepositoryImpl"></bean>
		<bean id="secondRepository" class="com.example.demo.repository.impl.SecondRepositoryImpl"></bean>
</beans>

utilを使えるようにします
プロパティファイルをmsgfileというidで読み込みます
msgfile.usernameでプロパティファイルのusernameというkeyの値を設定します

javaの修正をします

public class SampleUsecaseImpl implements SampleUsecase{

	private SampleRepository sampleRepository;
	
	private String username;
	
	@Override
	public String get() {
		String name = this.sampleRepository.findName();
		System.out.println(name);
		System.out.println(username);
		return name;
	}
	
	public void setSampleRepository(SampleRepository repository) {
		this.sampleRepository = repository;
	}	
	public void setUsername(String name) {
		this.username = name;
	}
}

セッターメソッドを用意します

参考

ApplicationContext.xmlファイルの記述方法

SpringBoot | DIするのにアノテーションを排除する