[트러블 슈팅] 스프링 순환 참조(spring circular reference) 해결하기

🚫 개요

개발하다가 다음과 같은 에러를 마주쳤다.

***************************
APPLICATION FAILED TO START
***************************

Description:

The dependencies of some of the beans in the application context form a cycle:

   commentController defined in file [/Users/youngeun/Desktop/Owori-Server/build/classes/java/main/com/owori/domain/comment/controller/CommentController.class]
      ↓
   commentService defined in file [/Users/youngeun/Desktop/Owori-Server/build/classes/java/main/com/owori/domain/comment/service/CommentService.class]
┌─────┐
|  storyService defined in file [/Users/youngeun/Desktop/Owori-Server/build/classes/java/main/com/owori/domain/story/service/StoryService.class]
↑     ↓
|  heartService defined in file [/Users/youngeun/Desktop/Owori-Server/build/classes/java/main/com/owori/domain/heart/service/HeartService.class]
└─────┘


Action:

Relying upon circular references is discouraged and they are prohibited by default. Update your application to remove the dependency cycle between beans. As a last resort, it may be possible to break the cycle automatically by setting spring.main.allow-circular-references to true.


Process finished with exit code 1

스프링 순환 참조(Circular Reference)란 서로 다른 빈들이 서로 참조를 맞물리게 주입되면서 생기는 현상이라고 한다.

beanA에서 beanB를 참조하게되는데 beanB에서도 beanA를 참조해야 하는 경우 순환참조 문제가 생기게 되는 것이다. 

 

 

---

👿 원인 파악

나와 같은 경우에는 

@Service
@RequiredArgsConstructor
public class StoryService {
    private final HeartService heartService;
    private final CommentService commentService;
    .
    .
}

@Service
@RequiredArgsConstructor
public class HeartService {
    private final StoryService storyService;
    .
    .
}

@Service
@RequiredArgsConstructor
public class CommentService {
    private final StoryService storyService;
    .
    .
}

 

 

그림과 같이 두 가지의 순환 참조가 생기고 있었다.

애플리케이션을 구동하면 이제 스프링 컨테이너(IOC)는 Story Service 빈을 생성하기위해 Comment Service와 Heart Service를 주입해줘야하기 때문에 Comment Service와 Heart Service를 찾을 것이다.
근데 Comment Service와 Heart Service를 생성하려 하니 Story Service 를 주입해야 해서 다시 Story Service를 찾게되면서 무한 반복이 생기게 된 것이다. 

 

---

✅ 해결

내가 생각한 해결 방법으로는 두 가지가 있다. 

 

1️⃣ story service 대신에 story repository를 주입해주기 

각각 comment service와 heart service에 story repository를 주입하는 것이다. 

그런데 이번 프로젝트에서 서비스에서만 서비스만 받기! 로 정해두어서 적용할 수 없었다. 

그래서 서비스를 분리하는 방안을 고려해보았다. 

 

2️⃣ story service 분리하기 

story service에만 comment service와 heart service를 주입해주고,

그리고 comment service와 heart service에서 사용하는 메소드만 story expansion service 에 두었다. 

그리고 comment service와 heart service에서는 story expansion service를 주입받도록 말이다!

 

가장 좋은 방법은 순환참조가 일어나지 않도록 설계를 하는 것 같다.