<div id="readability-page-1" class="page"><div><figure></figure>현재 직방에선 TypeOrm 0.2.x를 사용하고 있습니다.2022년 03월 TypeOrm 0.3.x가 나왔으며 새로 나온 기능을 사용하려면 TypeOrm 버전을 올릴수 밖에 없습니다.그래서 TypeOrm 0.3.x의 주요 변경사항과 업그레이드 방법을 소개하려고 합니다.<h2 id="352f">TypeOrm 0.3.0의 주요 변경 사항</h2><h2 id="5201">DataSource의 등장</h2>Connection 옵션이 사라지고 DataSource로 대체되었습니다.그리고 DataSource를 여러 개 연결하면 여러 개의 DB에 연결할 수 있습니다.<pre>export const dataSource = new DataSource({ /*...*/ }) export const dataSource1 = new DataSource({ /*...*/ }) export const dataSource2 = new DataSource({ /*...*/ }) export const dataSource3 = new DataSource({ /*...*/ })// load entities, establish db connection, sync schema, etc. await dataSource.connect()// destroy dataSource await dataSource.destroy()</pre><h2 id="042e">@EntityRepository의 삭제</h2>0.2.x에선 @EnxtityRepository 를 이용하여간단히 사용하던 방식이 @Injectable 를 이용하여 사용하거나 DataSource를 통하여 Repository를 생성하도록 변경되었다.<pre>// UserRepository.ts (0.2.x)@EntityRepository() class UserRepository extends Repository&lt;User&gt; { ... }</pre><pre>// UserRepository.ts (0.3.x)const userRepository = dataSource.getRepository(User).extend({})// OR@Injectable() export class UserRepository { constructor( @InjectRepository(UserEntity) private readonly userRepository: Repository&lt;UserEntity&gt;, ) {} }</pre><h2 id="1c69">Find — Select 절 사용의 변경</h2>기존 string array로 된 select 절이 Entity의 property를 지정할수 있게 되었습니다. 그리고 관계된 테이블의 컬럼도 지정할 수 있습니다.<pre>// UserRepository.ts (0.2.x)userRepository.find({ select: ["id", "firstName", "lastName"] })</pre><pre>// UserRepository.ts (0.3.x)userRepository.find({ select: { id: true, firstName: true, lastName: true, photo: { id: true, filename: true, album: { id: true, name: true, } } } })</pre><h2 id="89dc">Where — Condifion 절 Nested 지원</h2>기존 지원되지 않던 관계시 nested한 조건을 지정할 수 있습니다.<pre>// UserRepository.ts (0.3.x)userRepository.find({ where: { photos: { album: { name: "profile" } } } })</pre>그 외에도 관계를 nested하게 작성할 수 있고, order에 대한 변경점도 있으니 자세한 부분은 <a href="https://typeorm.io/" rel="noopener ugc nofollow" target="_blank">공식문서</a>에서 확인하시면 됩니다.현재 직방의 모든 Repository는 @EntityRepository를여 정의하고 있다.TypeOrm 0.3.x 업그리에드를 위해선 다량의 코드 수정이 불가피한 상황에서 업그레이드를 위한 방법과 제가 선택한 방법을 아래에 소개하겠습니다.<h2 id="cdeb">NestJs에서 TypeOrm 0.3.x 업그레이드 방법</h2><h2 id="428e">첫번째 방법</h2>기존 provider들과 똑같이 쓰는 것으로 Repository에서 dataSource를 injection 받는 방법입니다.<pre>// UserModule.ts@Module({ imports: [TypeOrmModule.forFeature([User])], controllers: [UserController], providers: [UserService, UserRepository], }) export class UserModule {}// UserRepository.ts@Injectable() export class UserRepository extends Repository&lt;User&gt; { constructor(private dataSource: DataSource) { super(User, dataSource.createEntityManager()); } async findByUsername(username: string): Promise&lt;User&gt; { const result = await this.createQueryBuilder('user') .where('user.username = :username', { username: username }) .getOne(); return result; } }// UserService.ts@Injectable() export class UserService { constructor( private userRepository: UserRepository, ) {} async findByUsername(username: string): Promise&lt;User&gt; { return this.userRepository.findByUsername(username); } }</pre><h2 id="674e">두번째 방법</h2>@EntityRepository와 유사하게 만든 @CustomRepository를 사용하는 방법입니다.<ol><li id="8873">CustomRepository 데코레이터를 만들어 줍니다.</li><li id="4980">해당 데코레이터를 사용하는 Repository를 Provider에 등록하기 위한 모듈을 만들어 줍니다.</li><li id="908a">Repository에 @EntityRepository 대신 @CustomRepository를 달아줍니다.</li><li id="2f3c">DB 모듈에 새로 작성한 모듈을 import, export에 넣어줍니다.</li></ol><pre>// CustomRepository.decorator.tsimport { SetMetadata } from "@nestjs/common"export const TYPEORM_EX_ENTITY_REPOSITORY = "TYPEORM_EX_ENTITY_REPOSITORY"export function CustomRepository(entity: Function): ClassDecorator { return SetMetadata(TYPEORM_EX_ENTITY_REPOSITORY, entity) }// TypeOrmExModule.module.tsimport { DynamicModule, Provider } from "@nestjs/common" import { getConnectionToken } from "@nestjs/typeorm" import { DataSource } from "typeorm" import { TYPEORM_EX_ENTITY_REPOSITORY } from "../decorators/CustomRepository"export class TypeOrmExModule { public static forFeature&lt;T extends new (...args: any[]) =&gt; any&gt;(repositories: T[]): DynamicModule { const providers: Provider[] = [] for (const repository of repositories) { const entity = Reflect.getMetadata(TYPEORM_EX_ENTITY_REPOSITORY, repository) if (!entity) continue providers.push({ inject: [ getConnectionToken() ], provide: repository, useFactory: (dataSource: DataSource): typeof repository =&gt; { const baseRepository = dataSource.getRepository&lt;any&gt;(entity) return new repository(baseRepository.target, baseRepository.manager, baseRepository.queryRunner) }, }) } return { exports: providers, module: TypeOrmExModule, providers, } } }// UserRepository.ts@CustomRepository(User) export class UserRepository extends Repository&lt;User&gt; {}// DbModule.tsconst userDbModules = [ TypeOrmModule.forRoot(typeOrmConfig), TypeOrmExModule.forFeature([UserRepository]), ]@Global() @Module({ imports: userDbModules, exports: [ TypeOrmExModule ], }) export class DbModule { }</pre>이렇게 해주면 nestjs에서 사용하던 TypeOrm0.2.x 버전의 @EntityRepository와 유사하게 사용할 수 있다.저는 두번째 방법으로 TypeOrm0.3.x로 업그레이드 하였습니다. 기존과 유사한 Repository 생성 방법과 코드 수정량을 최소화 하기 위한 선택이었습니다.<h2 id="d5de">마치며</h2>지금까지 TypeOrm 0.3.x의 변경사항과 Nestjs에서 업그레이드 하는 방법을 알아 보았습니다. 깊은 내용을 다루진 않았지만 누군가에겐 도움이 되었으면 합니다. 읽어주셔서 감사합니다.<h2 id="1bad">참고자료</h2><ul><li id="878d"><a href="https://typeorm.io/" rel="noopener ugc nofollow" target="_blank">https://typeorm.io/</a></li><li id="734b"><a href="https://github.com/typeorm/typeorm/pull/8616" rel="noopener ugc nofollow" target="_blank">https://github.com/typeorm/typeorm/pull/8616</a></li><li id="698e"><a href="https://github.com/typeorm/typeorm/blob/master/CHANGELOG.md#030-2022-03-17" rel="noopener ugc nofollow" target="_blank">https://github.com/typeorm/typeorm/blob/master/CHANGELOG.md#030-2022-03-17</a></li><li id="94a4"><a href="https://stackoverflow.com/questions/71557301/how-to-workraound-this-typeorm-error-entityrepository-is-deprecated-use-repo" rel="noopener ugc nofollow" target="_blank">https://stackoverflow.com/questions/71557301/how-to-workraound-this-typeorm-error-entityrepository-is-deprecated-use-repo</a></li><li id="a016"><a href="https://greeng00se.tistory.com/57" rel="noopener ugc nofollow" target="_blank">https://greeng00se.tistory.com/57</a></li></ul></div></div>

zigbang - Medium

현재 직방에선 TypeOrm 0.2.x를 사용하고 있습니다.
2022년 03월 TypeOrm 0.3.x가 나왔으며 새로 나온 기능을 사용하려면 TypeOrm 버전을 올릴수 밖에 없습니다.
그래서 TypeOrm 0.3.x의 주요 변경사항과 업그레이드 방법을 소개하려고 합니다.
TypeOrm 0.3.0의 주요 변경 사항
DataSource의 등장
Connection 옵션이 사라지고 DataSource로 대체되었습니다.
그리고 DataSource를 여러 개 연결하면 여러 개의 DB에 연결할 수 있습니다.
export const dataSource = new DataSource({ /*...*/ })
export const dataSource1 = new DataSource({ /*...*/ })
export const dataSource2 = new DataSource({ /*...*/ })
export const dataSource3 = new DataSource({ /*...*/ })
// load entities, establish db connection, sync schema, etc.
await dataSource.connect()
// destroy dataSource
await dataSource.destroy()
@EntityRepository의 삭제
0.2.x에선 @EnxtityRepository 를 이용하여간단히 사용하던 방식이 @Injectable 를 이용하여 사용하거나 DataSource를 통하여 Repository를 생성하도록 변경되었다.
// UserRepository.ts (0.2.x)
@EntityRepository()
class UserRepository extends Repository<User> {
...
}
// UserRepository.ts (0.3.x)
const userRepository = dataSource.getRepository(User).extend({})
// OR
@Injectable()
export class UserRepository {
 constructor(
 @InjectRepository(UserEntity)
 private readonly userRepository: Repository<UserEntity>,
 ) {}
}
Find — Select 절 사용의 변경
기존 string array로 된 select 절이 Entity의 property를 지정할수 있게 되었습니다. 그리고 관계된 테이블의 컬럼도 지정할 수 있습니다.
// UserRepository.ts (0.2.x)
userRepository.find({
 select: ["id", "firstName", "lastName"]
})
// UserRepository.ts (0.3.x)
userRepository.find({
 select: {
 id: true,
 firstName: true,
 lastName: true,
 photo: {
 id: true,
 filename: true,
 album: {
 id: true,
 name: true,
 }
 }
 }
})
Where — Condifion 절 Nested 지원
기존 지원되지 않던 관계시 nested한 조건을 지정할 수 있습니다.
// UserRepository.ts (0.3.x)
userRepository.find({
 where: {
 photos: {
 album: {
 name: "profile"
 }
 }
 }
})
그 외에도 관계를 nested하게 작성할 수 있고, order에 대한 변경점도 있으니 자세한 부분은 공식문서에서 확인하시면 됩니다.
현재 직방의 모든 Repository는 @EntityRepository를여 정의하고 있다.
TypeOrm 0.3.x 업그리에드를 위해선 다량의 코드 수정이 불가피한 상황에서 업그레이드를 위한 방법과 제가 선택한 방법을 아래에 소개하겠습니다.
NestJs에서 TypeOrm 0.3.x 업그레이드 방법
첫번째 방법
기존 provider들과 똑같이 쓰는 것으로 Repository에서 dataSource를 injection 받는 방법입니다.
// UserModule.ts
@Module({
 imports: [TypeOrmModule.forFeature([User])],
 controllers: [UserController],
 providers: [UserService, UserRepository],
})
export class UserModule {}
// UserRepository.ts
@Injectable()
export class UserRepository extends Repository<User> {
 constructor(private dataSource: DataSource) {
 super(User, dataSource.createEntityManager());
 }
 async findByUsername(username: string): Promise<User> {
 const result = await this.createQueryBuilder('user')
 .where('user.username = :username', { username: username })
 .getOne();
 return result;
 }
}
// UserService.ts
@Injectable()
export class UserService {
 constructor(
 private userRepository: UserRepository,
 ) {}
 
 async findByUsername(username: string): Promise<User> {
 return this.userRepository.findByUsername(username);
 }
}
두번째 방법
@EntityRepository와 유사하게 만든 @CustomRepository를 사용하는 방법입니다.
CustomRepository 데코레이터를 만들어 줍니다.
해당 데코레이터를 사용하는 Repository를 Provider에 등록하기 위한 모듈을 만들어 줍니다.
Repository에 @EntityRepository 대신 @CustomRepository를 달아줍니다.
DB 모듈에 새로 작성한 모듈을 import, export에 넣어줍니다.
// CustomRepository.decorator.ts
import { SetMetadata } from "@nestjs/common"
export const TYPEORM_EX_ENTITY_REPOSITORY = "TYPEORM_EX_ENTITY_REPOSITORY"
export function CustomRepository(entity: Function): ClassDecorator {
 return SetMetadata(TYPEORM_EX_ENTITY_REPOSITORY, entity)
}
// TypeOrmExModule.module.ts
import { DynamicModule, Provider } from "@nestjs/common"
import { getConnectionToken } from "@nestjs/typeorm"
import { DataSource } from "typeorm"
import { TYPEORM_EX_ENTITY_REPOSITORY } from "../decorators/CustomRepository"
export class TypeOrmExModule {
 public static forFeature<T extends new (...args: any[]) => any>(repositories: T[]): DynamicModule {
 const providers: Provider[] = []
 for (const repository of repositories) {
 const entity = Reflect.getMetadata(TYPEORM_EX_ENTITY_REPOSITORY, repository)
 if (!entity) continue
 providers.push({
 inject: [ getConnectionToken() ],
 provide: repository,
 useFactory: (dataSource: DataSource): typeof repository => {
 const baseRepository = dataSource.getRepository<any>(entity)
 return new repository(baseRepository.target, baseRepository.manager, baseRepository.queryRunner)
 },
 })
 }
 return {
 exports: providers,
 module: TypeOrmExModule,
 providers,
 }
 }
}
// UserRepository.ts
@CustomRepository(User)
export class UserRepository extends Repository<User> {}
// DbModule.ts
const userDbModules = [
 TypeOrmModule.forRoot(typeOrmConfig),
 TypeOrmExModule.forFeature([UserRepository]),
]
@Global()
@Module({
 imports: userDbModules,
 exports: [ TypeOrmExModule ],
})
export class DbModule { }
이렇게 해주면 nestjs에서 사용하던 TypeOrm0.2.x 버전의 @EntityRepository와 유사하게 사용할 수 있다.
저는 두번째 방법으로 TypeOrm0.3.x로 업그레이드 하였습니다. 기존과 유사한 Repository 생성 방법과 코드 수정량을 최소화 하기 위한 선택이었습니다.
마치며
지금까지 TypeOrm 0.3.x의 변경사항과 Nestjs에서 업그레이드 하는 방법을 알아 보았습니다. 깊은 내용을 다루진 않았지만 누군가에겐 도움이 되었으면 합니다. 읽어주셔서 감사합니다.
참고자료
https://typeorm.io/
https://github.com/typeorm/typeorm/pull/8616
https://github.com/typeorm/typeorm/blob/master/CHANGELOG.md#030-2022-03-17
https://stackoverflow.com/questions/71557301/how-to-workraound-this-typeorm-error-entityrepository-is-deprecated-use-repo
https://greeng00se.tistory.com/57
TypeOrm 0.3.X 업그레이드 was originally published in 직방 기술 블로그 on Medium, where people are continuing the conversation by highlighting and responding to this story.

TypeOrm 0.3.X 업그레이드

댓글