Springboot で他パッケージで定義されたクラスのインスタンスを生成しようとするとエラーになってしまう

Question

前提・実現したいこと

前提：インスタンスを生成できません。
今回解決を望みませんが、SpringStarterProjectでLombokを入れた状態での起動には失敗しています。

Springbootで webアプリを作っています。
src/main/java/SecurityConfig.javaで
@Autowired
private final UserDetailsService userDetailsService;
しても、userDetailsServiceというインスタンスが、UserDetailServiceクラスに認識されていないのか、エラーになってしまいます。

Springbootに表示される指摘内容
The blank final field useDetailsService may not have been initialized.
Initialize final field 'useDetailsService' at declaration.これをクリックすると;の前に=nullが付与され、
private final UserDetailsService userDetailsService = null;に変換されます。（この時@Autowiredは消されます。）

実現したいこと：=nullを使わずに、インスタンスを生成したい。

質問内容
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;でインポートしたものを、private final UserDetailsService userDetailsService;
としてインスタンス生成する方法を教えていただけると幸いです。
よろしくお願いいたします。

発生している問題・エラーメッセージ

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'springSecurityFilterChain' defined in class path resource [org/springframework/security/config/annotation/web/configuration/WebSecurityConfiguration.class]: Bean instantiation via factory method failed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [javax.servlet.Filter]: Factory method 'springSecurityFilterChain' threw exception; nested exception is java.lang.RuntimeException: Could not postProcess org.springframework.security.authentication.dao.DaoAuthenticationProvider@562398ac of type class org.springframework.security.authentication.dao.DaoAuthenticationProvider
Caused by: org.springframework.beans.BeanInstantiationException: Failed to instantiate [javax.servlet.Filter]: Factory method 'springSecurityFilterChain' threw exception; nested exception is java.lang.RuntimeException: Could not postProcess org.springframework.security.authentication.dao.DaoAuthenticationProvider@562398ac of type class org.springframework.security.authentication.dao.DaoAuthenticationProvider
Caused by: java.lang.RuntimeException: Could not postProcess org.springframework.security.authentication.dao.DaoAuthenticationProvider@562398ac of type class org.springframework.security.authentication.dao.DaoAuthenticationProvider
Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'org.springframework.security.authentication.dao.DaoAuthenticationProvider@562398ac': Invocation of init method failed; nested exception is java.lang.IllegalArgumentException: A UserDetailsService must be set
Caused by: java.lang.IllegalArgumentException: A UserDetailsService must be set

該当のソースコード

import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@RequiredArgsConstructor
@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Autowired
    //private final UserDetailsService userDetailsService;
    //本来は上のインスタンスを使いたいのですが、エラーになってしまうため、以下のコードで対処しています。
    private final UserDetailsService userDetailsService = null;

    //作成したuserDetailsServiceを使用し、DBからユーザを参照できるようにする
    @Override
    protected void configure(AuthenticationManagerBuilder auth)
            throws Exception {
        auth.userDetailsService(userDetailsService)
            .passwordEncoder(passwordEncoder());
    }
	
}

試したこと

上のコードにも書いたが、userDetailService;で終わるとエラーになってしまうので、
private final UserDetailsService userDetailsService = null;
に変更しました。

実行すると、以下のエラーが出力されました。
java.lang.IllegalArgumentException: A UserDetailsService must be set

Comments

[hoshi-takanori]

後から代入するなら、final を外せば良いのでは。

Answer 1

UserDetailsServiceにはアノテーションに @Serviceや@Component など、
Bean としてDIコンテナに登録するためのアノテーションがついている前提で話を進めさせて頂くのですが、

Autowired を使ったフィールドインジェクションを使いたい場合、final 修飾子はつけると意図した代入をできないと考えてよいと思います。
フィールドインジェクションはクラスの生成の後に代入するにもかかわらず、クラスの初期化でfinal のついたフィールド変数をの初期化が必要になる性質とうまく整合性を保てませんです。
Autowired アノテーションを使う必要がある場合、フィールド変数からfinal 修飾子を取り除いてください。

再代入を防ぐというメリットを享受するため、フィールド変数の修飾子に final をつけたい場合、
コンストラクタインジェクションを使うとよいと思います
SpringでField InjectionよりConstructor Injectionが推奨される理由 - abcdefg.....

Comments

[tech_learning]

ご回答ありがとうございます。
クラスが生成された後でインジェクションによって代入されるなど、順番については全く理解していなかったので、エラー対処の知識として蓄えることができました。ありがとうございます。

kiinoさんの仰っていることが半分くらいしか理解できていないので確認したいのですが、
以下ような解釈で大体合っておりますか。
お忙しい中とは思いますが、ご回答をよろしくお願いいたします。

Autowiredを使う＝フィールドインジェクションを使うということでしょうか

全体の流れ
１.アプリケーション起動
→２.クラス生成
→３.フィールドインジェクションによる代入

２のクラス生成(クラスの初期化)でフィールド変数も初期化（新しく定義）している
finalを使う場合はこれ以降で変更できない
３でフィールドインジェクションしても、2の段階で変更できないので、結果として代入できない
よって非推奨

[maigo_name]

すいません。コメントついてるのに今気づきました。

> Autowiredを使う＝フィールドインジェクションを使うということでしょうか

フィールド変数に @Autowired を付けた場合はそうなります。
クラスの部分につければコンストラクタインジェクション同等になります。
と、いう内容が参考として記載させていただいたブログの「SpringでのDependency Injection」に書いております。

> ２のクラス生成(クラスの初期化)でフィールド変数も初期化（新しく定義）している
finalを使う場合はこれ以降で変更できない
３でフィールドインジェクションしても、2の段階で変更できないので、結果として代入できない
よって非推奨

ここは私の意図した内容と異なります。
話したかったこととしては以下の2点になります。
- DIには「フィールドインジェクション」、「コンストラクタインジェクション」などのパターンがあり、コンストラクタインジェクションの方が望ましい
- final のついたフィールドにはフィールドインジェクションを用いた代入はできません。

コンストラクタインジェクションのメリットについては参考として貼らせて頂いたブログに詳細にかかれているので、
重複かつここに書くには長くなってしまうので書けないのですが、
コンストラクタインジェクションの方が得られるメリットしては大きいと考えています
（特に現代のソフトウェア開発では）
なので、コンストラクタインジェクションを推奨している。という文脈になります。

final をフィールド変数につけていると、@Autowired を用いたフィールドインジェクションができません。
（推奨・非推奨という話ではなく技術的に不可）
なので、以下のどちらかの選択する必要があります。
- `userDetailsService` などに @Autowired を使いたい場合 => final を外す
- `userDetailsService`などに final 修飾子をつけておきたい場合 => @Autowired をクラスにつける or コンストラクタを定義し、そこからDIできるように実装する