Spring 순환 참조 해결

 

프로젝트 진행 중 순환 참조 오류가 발생했다.

 

에러 메세지를 읽어 보면 principalOAuth2Service 와 securityConfig 가 서로 순환참조를 하고 있기 때문에 실패했다고 한다.

 

내가 알기로 설정에서 이걸 그냥 무시할수도 있기는 한데 원인과 해결방법을 기록한다.

 

 

 

SecurityConfig.java

@Configuration
@EnableWebSecurity
public class SecurityConfig {

    private final PrincipalOAuth2UserService principalOAuth2UserService;

    @Autowired
    public SecurityConfig(PrincipalOAuth2UserService principalOAuth2UserService) {
        this.principalOAuth2UserService = principalOAuth2UserService;
    }

    @Bean
    PasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }
    
    // ....
}

 

PrincipalOAuth2UserService.java

@Service
@Slf4j
public class PrincipalOAuth2UserService extends DefaultOAuth2UserService {


    private final PasswordEncoder passwordEncoder;
    private final MemberService memberService;

    @Autowired
    public PrincipalOAuth2UserService(PasswordEncoder passwordEncoder, MemberService memberService) {
        this.passwordEncoder = passwordEncoder;
        this.memberService = memberService;
    }

	// ... 
}

 

원인

• 흐름을 생각해보면 빌드가 시작되고 스프링 컨테이너가 SecurityConfig 를 Bean 으로 등록하려고 할 것이다.
• 그런데 SecurityConfig 은 PrincipalOAuth2Service 에 의존하고 있기 때문에 PrincipalOAuth2Service 을 생성해야 한다.
• 자 그래서 PrincipalOAuth2Service 로 갔는데 PrincipalOAuth2Service 은 PasswordEncoder 빈이 필요하다.
• 그런데 PasswordEncoder 는 SecurityConfig 빈이 존재해야 생성할수 있다.

 

따라서 순환 참조가 발생하는 것이다.

 

 

해결

지금 문제는 PasswordEncoder 가 SecurityConfig 에서 @Bean 으로 설정하고 있기 때문에 발생하는 것이다.

따라서 AppConfig.java 같은 다른 클래스에서 PasswordEncoder 빈을 설정하면 된다.

 

애초에 이 문제가 발생한 이유는 Spring Security 설정 클래스인 SecurityConfig.java 에서 빈을 설정했기 때문이다.

 

그런데 스프링 시큐리티를 좀 사용해보니까 지금처럼 SecurityConfig 에는 @Bean 으로 새로운 빈을 설정하지 않고 AppConfig 같은 다른 곳에서 설정하고, 필요하면 주입 받는게 좋을것 같다.