【Spring Security】 LoginUserDetailsのコンストラクターでエラーが発生する

Question

###実現したいこと

現在、【はじめてのSpringBoot[改訂版]】を使用し、ログイン機能を作成しようとしています。

DBマイグレーションはFlywayを使用しています。

しかし、SpringBootのバージョンアップに伴い、リポジトリのfindOneメソッドが、

findByIdメソッドに代わり、Optional<※※※>をつけて使用しているのですが、

LoginUserDetailsのコンストラクターでエラーが発生してしまい、うまく動作ができない状況です。

Spring Boot初学者です。

###使用環境

ー　Mac OS
ー　Java11
ー　SpringBoot 2.5.4
ー　SpringToolSuite 4.0

###コード

import com.example.hajibootthymeleaf.domain.User;
import lombok.Data;

import java.util.Optional;

import org.springframework.security.core.authority.AuthorityUtils;

@Data
public class LoginUserDetails extends org.springframework.security.core.userdetails.User {
	private final Optional<User> user;
	
	public LoginUserDetails(Optional<User> user) {
		super(user.getUsername(), user.getEncodedPassword(), 
                       ⬆︎エラー　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　⬆︎エラー
AuthorityUtils.createAuthorityList("ROLE_USER"));
		this.user = user;
	}
}

The method getEncodedPassword() is undefined for the type Optional<User>

import com.example.hajibootthymeleaf.domain.User;
import com.example.hajibootthymeleaf.repository.UserRepository;

import java.util.List;
import java.util.Optional;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.core.userdetails.UsernameNotFoundException;
import org.springframework.stereotype.Service;

public class LoginUserDetailsService implements UserDetailsService {
    @Autowired
    UserRepository userRepository;

    @Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        Optional<User> user = userRepository.findById(username);
        if (user == null) {
            throw new UsernameNotFoundException("The requested user is not found.");
        }
        return new LoginUserDetails(user);
    }
}

import com.example.hajibootthymeleaf.domain.User;

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

public interface UserRepository extends JpaRepository<User, String> {
}

import com.fasterxml.jackson.annotation.JsonIgnore;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;

import javax.persistence.*;
import java.util.List;

@Data
@NoArgsConstructor
@AllArgsConstructor
@Entity
@Table(name = "users")
@ToString(exclude = "customers")
public class User {
	@Id
	private String username;
	@JsonIgnore
	private String encodedPassword;
	@JsonIgnore
	@OneToMany(cascade = CascadeType.ALL, fetch = FetchType.LAZY, mappedBy = "user")
	private List<Customer> customers;
}

spring.datasource.driver-class-name=net.sf.log4jdbc.DriverSpy
spring.datasource.url=jdbc:log4jdbc:h2:file:./target/db/customer
logging.level.jdbc=OFF
logging.level.jdbc.sqltiming=DEBUG
spring.jpa.hibernate.ddl-auto=validate

security.basic.enabled=false

かなり詰まっていまして、どうにも解決できません。

ご教授いただければ幸いです。

どうぞよろしくお願い致します。

Answer 1

SpringBoot2.5.4では「findOne()」メソッドは使用できず、代わりに「findById()」が使用できます。しかし、Optionalでラップする必要があり、そのOptionalのラップが、今回の「getusername(), getEncodedPassword()」メソッドの妨げとなっていました。
よって、Optionalでラップしないよう「getById」メソッドを使用したところ、うまく動作しました。

findとgetの違いについての参考記事はこちらをご覧ください([findとgetの違いについて])(https://www.fixes.pub/program/245101.html)

修正点として

・上記、質問した際のコードの「Optional<クラス名>」のところを全て「クラス名」に変更します。
・以下のように再度修正する

package com.example.hajibootthymeleaf.service;

import com.example.hajibootthymeleaf.domain.User;
import com.example.hajibootthymeleaf.repository.UserRepository;


import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.core.userdetails.UsernameNotFoundException;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;　　// ←追加しました

@Service //←つけ忘れていました。すみません。

@Transactional //←追加しました（こちらがないと、セッションエラーになります。下記にエラー詳細のURL貼ります。）
// ※[セッションエラーについて](https://qiita.com/zakki/items/2f4dd7768313a3f855f7)

public class LoginUserDetailsService implements UserDetailsService {
    @Autowired
    UserRepository userRepository;

    @Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
		User user = userRepository.getById(username);　// ←変更しました
        if (user == null) {
            throw new UsernameNotFoundException("The requested user is not found.");
        }
        return new LoginUserDetails(user);
    }
}

その他、ご指摘等ございましたら、どうぞよろしくお願い致します。

Answer 2

Optional<User> user 変数から、getEncodedPassword() というメソッドを呼び出そうとしていると思うのですが、
変数 user は Optional クラスのインスタンスで、
java.util.Optional には getEncodedPassword() というメソッドは存在しておらず、そのため（コンパイル）エラーになっています。
https://docs.oracle.com/javase/jp/8/docs/api/java/util/Optional.html

（おそらく）User クラスの getUsername(), getEncodedPassword() を呼びだしたいのかなと思ったのですが、
その場合はいったん Optional<User> user から、Userクラスの変数を取り出して、
取り出したものに対してメソッドを呼び出す必要があります

// username, encodePassword が null の場合は空文字にしてますが、
// 初期値が設定したいのであれば適宜変更が必要
String name = user.map(User::getUsername).orElse("");
String encodePass = user.map(User::getEncodedPassword).orElse("");
super(name , encodePass);

他には以下など

// User が存在する場合だけ親のコンストラクタを呼び出せばよい場合
user.ifPresent(u -> super(u.getUsername(), u.getEncodedPassword()));

// User がない場合も親のコンストラクタを呼び出す必要がある場合
user.ifPresentOrElse(u -> super(u.getUsername(), u.getEncodedPassword()), () -> super("", ""));

// User がある場合はコンストラクタを呼び出して、ない場合は別の処理（例外を出すとか）をしたい場合
if (user.isPresent()) {
    User u = user.get();
    super(u.getUsername(), u.getEncodedPassword());
} else {
    throw new Exception("not exist user");
}

Comments

[1998Ttf]

ご回答ありがとうございます！！
ご指摘の
「変数 user は Optional クラスのインスタンスで、java.util.Optional にはgetEncodedPassword()というメソッドは存在しておらず、そのため（コンパイル）エラーになっている」
の通りでした！
いただいたコードは付け加えず、再度自身で考えた結果、
SpringBoot2.5.4では「findOne」が使えず、Optionalをつけないと実装できないので、「そもそもOptionalでラップしなければいいんじゃないか？」と考え、「getById」メソッドを使用し、実装したところ、動きました！
しかし、まだ初心者ですので、至らない点があるかと思います。下記に修正したコードを記載させていただきますので、どうぞご査収のほどよろしくお願い致します！

```LoginUserDetailsService
import org.springframework.transaction.annotation.Transactional; 　←追加しました

@Service

@Transactional　　←追加しました
public class LoginUserDetailsService implements UserDetailsService {
@Autowired
UserRepository userRepository;

@Override
public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
User user = userRepository.getById(username);　　←変更部分
if (user == null) {
throw new UsernameNotFoundException("The requested user is not found.");
}
return new LoginUserDetails(user);
}
}

```