[Nest.js] TypeORM @EntityRepository is Deprecated

 

 

NestJS로 배우는 백엔드 프로그래밍:타입스크립트 환경의 차세대 서버 프레임워크를 만나다

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

 

https://github.com/junyharang-coding-study/GraphQL-Study/tree/master/type-script-nest-graph-ql-%EC%8B%A4%EC%8A%B5

 

 

👷‍♂️ 작업 중인 내용

TypeORM을 이용한 Repository 만드는 도 중

TypeORM을 이용하여 Repository를 만드는 중 @EntityRepository가 Deprecated된 Issue를 확인하게 되었어요.

출처: https://github.com/junyharang-personal-project/development-community-service-nodejs/blob/master/src/board/dev-inquery/dev-inquery.repository.ts

예전에 처음 Nest.js를 공부할 때는 TypeORM 0.2.45 Version을 사용해서 문제가 없었지만,
지금은 TypeORM 0.3.17 Version을 사용하면서 이런 문제를 맞닥뜨리게 되었어요.

🤔 이유는?

@EntityRepository를 Deprecate 시킨 이유는 무엇일까요?

TypeORM을 사용하는 개발자들이 Service Layer에서 Business Logic만 작성하고, Repository Layer에서 Query Logic을 작성(Data Mapper Pattern)하게 돼요.

이 부분에서 문제가 발생했어요.

위와 같이 모든 User를 조회하는 Logic을 만든다고 할 때, TypeORM에서 표준으로 지원하는 find()가 있음에도 불구하고, 동일 역할을 하는 getAllUsers()를 Repository Class 내부에 만들어서 생성하였어요.

위와 같이 했을 때, 여러 개발자들이 엄격한 Data Mapper Pattern의 사용이 좋지 않다고 목소리를 냈고,
이를 통해 TypeORM 개발자들은 @EntityRepository Decorator를 Deprecated 하며, Active Record Pattern 사용을 권장 하는 듯 해 보여요.

또한, Nest.js의 Module성과 확장성을 개선하기 위함도 있어요.
Nest.js는 Version Update를 통해 Framework의 기능을 향상시키고, 사용자가 더 효과적으로 Code를 작성하고,
유지 관리할 수 있도록 노력하고 있어요.

EntityRepository Decorator는 TypeORM에서 제공하는 것이 아닌 Nest.js에서 추가된 것이에요.
Nest.js는 주로 간편한 Code 구성을 위해 몇 가지 Custom Decorator를 제공했었는데,

이 중 일부는 향 후 Release에서 변경 또는 Deprecated 되기로 결정 되었다고 해요.

Nest.js에서는 보다 일반적이고, 표준에 부합하는 방식으로 TypeORM을 사용하길 바라고 있어요.

또한, TypeORM이 Update 되면서 Framework의
Lifecycle과 통합되도록 설계된 Decorator 및 기능을 사용하는 것이 좋아요.

Update된 Library Version은 새로운 기능과 개선 사항, 보안 패치 등을 포함하고 있을 가능성이 높기 때문이에요.

 

 

 

🍻 문제 해결!

이 문제를 해결하기 위해서는 직접 Decorator를 만들고, 해당 Decorator가 적용된 Repository를 받아줄 Module을 사용하는 방법으로 해결을 해보려고 해요.

src/app/common/custom/decorator/typeorm-repository.decorator.ts

728x90

최초 위와 같이 @TypeormRepository Decorator를 만들어 주었어요.

이 코드는 Nest.js에서 사용되는 간단한 Custom Decorator 및 Metadata 설정을 위한 Code에요.

setMetadata()는 Nest.js에서 제공하는 Decorator 생성 함수에요.
이것을 이용해서 Metadata 생성을 할 수 있어요.

metadata Key로 사용된 문자열은 Metadata의 Key로 사용되는 상수값인데,
이 Key를 통해 Metadata에 접근할 수 있어요.
해당 Code에서는 TypeORM과 관련된 Custom Repository에 대한 Metadata 설정을 위해 사용하려고 해요.

TypeormRepository()는 Class Decorator로 동작하게 돼요.
이 함수를 이용해 주어진 Eneity에 대한 Custom Repository를 설정하기 위해 SetMetadata()를 호출하게 돼요.
즉, 해당 Class를 지정한 Custom Repository로 사용하고자 할 때, 이 Decorator를 사용하면 돼요.

src/app/common/custom/module/typeorm-custom.module.ts

위 코드는 Nest.js에서 TypeORM의 Custom Repository를 Module로 만들기 위한 Code에요.

DynamicMoule과 Provider는 Nest.js에서 Module과 Provider를 정의하기 위한 Interface에요.

TypeormCustomMoule Class는 Modul을 정의 해주는 역할을해요.

forCustomRepository()는 동적으로 Custom Repository를 생성하는데, 사용하려고 만들었어요.
이 Method는 repositories[]를 맙다 해당 Repository Module에 추가하는 역할을 해요.

providers[]는 Module에서 사용할 Provider를 담는 배열이에요.

for...of Loop를 사용하여 전달된 repositories[]를 순회하면서 각 Repository에 대한 Provider를 생성해줘요.

Reflect.getMetadata(...) 이 부분은 TypeormRepository Metadata를 읽어오는 부분이에요.
이 Metadata는 @TypeormRepository Decorator를 사용하여 지정된 Entity를 나타낸답니다.
또한, Metadata Key 값인 TYPEORM_CUSTOM_REPOSITORY에 해당 하는 Entity를 가져오게 돼요.

13 ~ 24번째 줄은 providers[]에 유요한 Entity에 대한 Provider가 추가된 것을 확인하는데,
그렇지 않은 경우에 건너뛰게 되어있어요.

useFafactory()는 해당 Repository에 대한 Provider를 생성하는 Factory 함수에요.
여기서는 Data Source를 주입 받아 해당 Entity에 기본 Repository를 생성하고,
이를 이용해 새로운 Repository를 만들게 해 주었어요.

Module은 DynamicModule 객체를 반환하게 되고, providers[]를 내보내며,
TypeormCustomModule을 Module로 지정하게 해주었어요.

이 Module은 forCustomRepository()를 사용하여 어떤 Custom Repository든 동적으로 생성하고,
이를 Nest.js Application에 통합할 수 있도록 만든 것이에요.

src/app/equipment/repository/equipment.repository.ts

반응형

Deprecated된 Decorator를 삭제하고, 위와 같이 Custom Decorator를 입력해 주었어요.

src/app.module.ts

그리고 위 코드 30번째 줄과 같이 Custom Module을 생성해 주었어요.

src/app/equipment/service/equipment-service-impl.service.ts

기존에 @EntityRepository를 사용했다면 @InjectRepository를 Service Layer에서 사용했지만,
이제는 사용하면 Error가 터질거에요.

그래서 @InjectRepository Decorator를 지워주어야 해요.

src/app/equipment/service/equipment-service-impl.service.ts

 

 

 

 

NestJS로 배우는 백엔드 프로그래밍:타입스크립트 환경의 차세대 서버 프레임워크를 만나다

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

 

https://github.com/junyharang-coding-study/GraphQL-Study/tree/master/type-script-nest-graph-ql-%EC%8B%A4%EC%8A%B5



 

 

🧐 참고 자료

How to workraound this TypeORM error, "EntityRepository is deprecated , use Repository.extend function instead"?