springboot @RequiredArgsConstructorについて

Question

実現したいこと

@RequiredArgsConstructorの動きがよくわからないのでご教授いただきたいです。

前提

@RequiredArgsConstructorアノテーションをつけたメソッドではprivate finalを記述した
ものはその先のフィールドのコンストラクタが生成されるという認識です。
下記内容はprivate final をつけた先のクラスにフィールドが存在していません。
(22行目がprivate finalがついた部分で62行目から下が対象クラスになります）

なんのためにprivate finalをつけているのでしょうか？？

お手数おかけしますがご教授お願いいたします。

該当のソースコード

@Controller
@RequiredArgsConstructor
public class LoginController {
	
	private final LoginService service;
	
	/** PasswordEncoder*/
	private final PasswordEncoder passwordEncoder;
	
	@GetMapping("/login")
	public String view(Model model,LoginForm form) {
		return "login";
	}
	
	@PostMapping("/login")
	public String login(Model model,LoginForm form) {
		//ログインIDが存在しているか確認
		//serviceのserchUserByIdメソッドへID情報を渡し処理している
		var userInfo = service.searchUserById(form.getLoginId());
		var isCorrectUserAuth = userInfo.isPresent()
				&& passwordEncoder.matches(form.getPassword(),userInfo.get().getPassword());
		if(isCorrectUserAuth) {
			return "redirect:/menu";
		}else {
			//TODO エラーメッセージはプロパティファイルで管理する
			model.addAttribute("errorMsg","ログインIDとパスが間違っています");
			return "login";
		}
	}
}

package com.example.demo.repository;

import org.springframework.data.jpa.repository.JpaRepository;

import com.example.demo.entity.UserInfo;

@Repository
public interface UserInfoRepository extends JpaRepository<UserInfo,String> {

}

Comments

[jimbe]

コードのマークダウンはコードのファイル毎に分けてください。
で、コードのマークダウン内では **～** のような文字修飾等のマークダウンは効きません。(効いたらコードがそのまま表示出来無くなります。)

[退会済みユーザー]

普通にRequiredArgsConstructorでググるだけで日本語だとなぜか3番目に正解が出てきます(英語だと当然1番上)が…

https://projectlombok.org/features/constructor

Answer 1

Springはコンストラクタがひとつしか定義されていない場合、そのコンストラクタからBeanをインジェクションします。つまり、Springを通して、serviceフィールドとpasswordEncoderフィールドにインジェクションする場合は、次のようなコンストラクタを定義する必要があるわけです。

public LoginController (LoginService service, PasswordEncoder passwordEncoder) {
    this.service= service;
    this.passwordEncoder = passwordEncoder;
}

今回のコードでは、@RequiredArgsConstructorを利用して、このコンストラクタ定義を行っています。@RequiredArgsConstructorはSpringではなくLombokが提供する機能で、finalをつけたフィールドを使ったコンストラクタを自動生成します。

なんのためにprivate finalをつけているのでしょうか？？

要するに、@RequiredArgsConstructorによるコンストラクタ生成の対象にするため、private finalを使っているわけです。

Comments

[masahito11]

ご回答ありがとうございます。コンストラクタ定義については理解しました。