Spring Bootでコンストラクタの引数に文字列を受け渡したい

Question

前提・実現したいこと

Springbootの練習で生徒の名前を検索するシステムを作っています

RepositoryクラスはCSVファイルからデータを読込、検索
ServiceクラスはRepositoryクラスから生徒番号と生徒名を受け取っています

以前は以下の検索メソッドにCSVファイルのディレクトリを直貼りしていましたが、
Repositoryクラスで作ったコンストラクタで引数を用意し、そちらにディレクトリの文字列を受け渡そうと考えています。

どのように修正すればいいでしょうか？

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

Parameter 0 of constructor in com.example.demo.StudentRepositoryImpl required a bean of type 'java.lang.String' that could not be found.

Consider defining a bean of type 'java.lang.String' in your configuration.

該当のソースコード

@Repository
public class StudentRepositoryImpl implements StudentRepository {
	private String dataName;
	public StudentRepositoryImpl(String str) {
		dataName = str;
	}
        // 検索メソッド
	@Override
	public Student searchNo(String studentNo) throws Exception  {
		// このメソッドでdataNameを使用
        }

ソースコード
@Service
public class StudentServiceImpl implements StudentService {

	private final StudentRepository studentRepository;

	public StudentServiceImpl(StudentRepository studentRepository) {
		this.studentRepository = studentRepository;
	}
	
	@Override
	public String findNo(String number) throws Exception {
		try { 
			Student student = studentRepository.searchNo(number);
			return student.getName();
		}
		catch (Exception e) {
			throw e;
		}
	}
}

試したこと

下記のように記述しましたが、実行するとエラーが発生し、実現しません。

StudentRepository studentRepository = new StudentRepositoryImpl("C:/mydata/StudentName.csv");

Answer 1

ファイルパスの値が Bean 登録されていないため、
@Repository のついた StudentRepositoryImpl をBean登録できずにエラーになっています。

解決策としては以下のどちらかになるかと思います。

• 設定ファイルに値を書いて、@Value から取得する
• 設定ファイルの値を @ConfigurationProperties で class にバインドして、その値を使う

例えば、設定ファイルに resources/application.yaml に以下のように書いて

app:
  sample:
    csv-file: "C:/mydata/StudentName.csv"

RepositoryImpl の実装を以下にすると、設定ファイルに書いたファイルパスを読み込めます

@Repository
public class StudentRepositoryImpl implements StudentRepository {
    private final String dataName;
    public StudentRepositoryImpl(@Value("${app.sample.csv-file}") String str) {
        dataName = str;
    }
// 以下省略...
}

クラスにバインドしたい場合、以下の手順で追加できます
org.springframework.boot:spring-boot-configuration-processor をビルドツールの設定に追加する。
SpringBoot の Application class に @ConfigurationPropertiesScan を付与する。
適当に設定ファイルに設定と、SpringBoot のスコープ内のどこかに class を作成する。
例としては以下

• 設定ファイル（resources/application.yaml）

app:
  config:
    csv-file: "hogehoge"
    timeout: 10

• 設定クラス

@Getter
@ConstructorBinding
@ConfigurationProperties("app.config")
public class SampleConfig {
    private final String csvFile;
    private final int timeout;

    public SampleConfig(String csvFile, int timeout) {
        this.csvFile= csvFile;
        this.timeout = timeout;
    }
}

このクラスがBean登録されるので、これを引数から渡すことができる

@Repository
public class ConfigRepositoryImpl implements StudentRepository {
    private final String cfvFilePath;
    private final int timeout;
    public ConfigRepositoryImpl(SampleConfig config) {
        cfvFilePath = config.getCsvFile();
        this.timeout = config.getTimeout();
    }
// 以下省略...
}

メリットとしては、何か設定値をいっぱい渡したいときに、設定値をひとつのクラスにまとめておくことができます。

Answer 2

以下コードではエラーになっているのではなく、他箇所でエラーになっているかと思います。

StudentRepository studentRepository = new StudentRepositoryImpl("C:/mydata/StudentName.csv");

通常Springで@Repositoryをつけたクラスはコンポーネントになり、Springコンテナ内Beanとして管理されます。これを実現するためにSpring起動時に各種Beanの初期化が発生するのですが、この時にStudentRepositoryImplのインスタンス化が発生し、引数のStringが取得できないと判断されエラーになっているかと思います（コンストラクタインジェクションなどでググってみてください）。

また、前述のとおり、StudentRepositoryImplはBeanとして管理しているため、DIして利用すべきです。そのため「new」を使って利用してはいけません。
よって、Repositoryクラスで作ったコンストラクタで引数を渡すことはできません。また、RepositoryクラスはSingletonなので、基本以下のようにしても同じかと思います。

@Repository
public class StudentRepositoryImpl implements StudentRepository {
    private String dataName;
    public StudentRepositoryImpl() {
        this.dataName = "C:/mydata/StudentName.csv";
    }

最後に、そもそも論ですが"C:/mydata/StudentName.csv"というファイルパスをコンストラクタ引数で渡すという設計がまちがっているかと思いますので、クラス設計から見直すことをお勧めいたします。

Comments

[manudon]

その外からオブジェクトを注入する
DIのやり方を知りたいです