100년 뒤 개발자 한승규입니다.

사용자가 로그인 한 동안에는 사용자가 API 요청 할 때마다 사용자의 정보를 가져와서 처리해야 할 것이다.

보통 이런 경우에는 2가지 방법 중 하나를 사용하는데, 세션혹은 쿠키를 사용한다.

우선 세션을 먼저 알아보고, 해당 강의가 끝나면 JWT를 통한 쿠키 인증 방법을 알아보자.

우선 cookie-session을 사용할 것인데, 이 라이브러리는 기존의 세션과는 다르게 세션데이터를 클라이언트의 쿠키에 저장한다고 한다.

어쩌면 쿠키라고 말하는 것이 맞을 거 같기도 하다.

이런식으로 세션을 유지한다고 한다.

우선 cookie-session 라이브러리부터 가져오자.

 npm install cookie-session

 npm install @types/cookie-session

그 다음에 main.ts에 cookie-session을 설정해준다.

const cookieSession = require('cookie-session');

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalPipes(
      new ValidationPipe({
        whitelist: true,
      })
  );
  app.use(cookieSession({
    keys:['seungkyu']
  }))
  await app.listen(process.env.PORT ?? 3000);
}
bootstrap();

cookie-session은 ts가 되지 않아, 저렇게 require를 사용해야 한다고 한다.

app.use로 cookieSession을 설정해주고, key를 넣어야 한다.

이 key는 cookie에 평문 그대로 넘겨주지 않으니 약간의 암호화를 하는데, 그 때 사용하는 키다.

지금은 연습단계니 간단하게 이름으로 추가했다.

이제 간단하게 userController에 /test 핸들러를 추가해서 세션을 조작해보자.

    @Get("/test/:name")
    testWriteSession(@Param('name') name:string, @Session() session: any){
        session.name = name;
    }

    @Get("/test")
    testReadSession(@Session() session: any){
        return session.name;
    }

이렇게 데코레이터로 Session을 가져온다.

우선 간단하게 쓰고, 읽도록 만들어보았다.

이제 다음과 같은 http call을 날려보자.

그 다음 위의 http call을 날려보면

이렇게 Set-Cookie가 온 것을 볼 수 있다.

쿠키의 위조를 막기 위해 하나는 실제 쿠키, 하나는 서명값이 온다고 하고

seungkyu가 온 것이 아니라 암호화가 되어 온 것을 볼 수 있다.

그 다음 밑의 http call은

이렇게 정상적으로 다시 해독해서 온 것을 볼 수 있다.

그리고 위의 http call을 다시 날려보면

Set-Cookie가 없는 것을 볼 수 있는데, 쿠키가 같으면 굳이 nest에서 새롭게 쿠키를 굳이 업데이트 하지 않기 때문이다.

일단 간단하게 nest에서 session을 사용하는 방식을 알아보았다.

이제 이 session을 사용해 사용자의 로그인을 유지해보자.

저번시간에는 salt를 통한 단방향 암호화로 데이터베이스에 사용자의 비밀번호를 저장했다.

해당 비밀번호는 해독이 불가능하기에 해당 비밀번호를 풀어서는 비밀번호가 맞는지 확인할 수 없다.

사용자가 입력한 비밀번호를 암호화해서 비교하는 방식을 사용해야 한다.

우선 사용자에게 로그인 정보를 받는 컨트롤러를 만들어보자.

    @Post("/signIn")
    signIn(@Body() loginUserDto: LoginUserDto): Promise<Users>{
        return this.authService.signIn(loginUserDto)
    }

loginUserDto에는 당연히 email, password를 받고 있다.

우선 입력받은 email을 바탕으로 사용자를 데이터베이스에서 찾아온다.

해당 사용자가 존재하지 않으면 에러를 반환한다.

	const {email, password} = loginUserDto;

        const user = await this.usersService.findByEmail(email);
        
        if(!user)
            throw new UnauthorizedException();

이 user class 안에는 암호화된 비밀번호와 salt값이 결합되어 있을 것이다.

그거를 분리해서 salt와 hashedPassword로 가져온다.

const [salt, hashedPassword] = user.password.split('.');

그리고 사용자가 입력한 비밀번호를 salt로 암호화하고 데이터베이스의 비밀번호와 비교한다.

        const hashed = (await scrypt(password, salt, 32)) as Buffer;

        if(hashedPassword != hashed.toString('hex'))
            throw new UnauthorizedException();

        return user;

일치하면 성공, 불일치하면 에러이다.

한 번 테스트를 해보자.

우선 다음과 같이 사용자를 생성한다.

그럼 다음과 같이 데이터가 생성된다.

해당 암호화값으로는 비밀번호를 알 수 없기에 로그인 API를 호출해보자.

우선 잘못된 값을 넣어보았다.

그러면 당연히 비밀번호가 일치하지 않아 인증 오류가 발생한다.

이번에는 제대로된 데이터를 넣어보자.

이렇게 제대로 유저가 응답되는 것을 볼 수 있다.

아마 이게 가장 정석적인 암호화 방법이라고 생각된다.

salt를 추가한 방법으로 로그인들을 구현하도록 하자.

기존에는 이렇게 비밀번호를 평문으로 저장하고 있다.

보안의 문제로 암호화해야 하기에 바로 변경해보도록 하자.

우선 인증은 크게 이렇게 동작한다.

쿠키는 회원가입 뿐만 아니라 로그인시에도 전달해주어야 한다.

일단 이번 글에는 생성되는 사용자에 따라, 비밀번호를 암호화하는 작업에 집중해보자.

우선 암호화는 복호화가 불가능해야한다.

이렇게 암호화는 가능하지만, 암호화된 값을 다시 원래 값으로 복원할 수 없어야 한다는 것이다.

하지만 문제가 있다.

mypassword를 암호화하면 언제나 저 값이기 때문에, $2a$12$rYxHFmJehRhNiMIVsmZeTeO2i314RIoe8gm5Frfb5VsxanaNyJ7/e 이 값을 가지고 있다면 역으로 mypassword의 값을 유추할 수 있는 것이다.

대표적으로 많이 쓰는 비밀번호들이 mypassword, password, asdf... 이런 값들에 대해 미리 암호화를 해두고, 암호화된 값을 비교해가며 원래 비밀번호를 유추하는 해커들이 존재한다.

그리고 그렇게 만들어둔 테이블을 레인보우 테이블이라고 한다.

그렇기 때문에 암호화하면서 무작위 값을 추가하여 암호화해야 한다.

그래야 원래 값이 같아도, 다른 암호화된 값이 나오기에 역으로 유추가 불가능하기 때문이다.

그 때 사용하는 값을 Salt라고 한다.

Salt가 ab152라고 한다면

ab152mypassword 이렇게 암호화를 진행하는 것이다.

그 암호화값이 $2a$12$/5YCKIUqJQoeOARsVvuDeuutm/2EKj4r14xXimYE6jt/MhyWJvO.i라면

$2a$12$/5YCKIUqJQoeOARsVvuDeuutm/2EKj4r14xXimYE6jt/MhyWJvO.i-ab152 이렇게 데이터베이스에 저장하고

로그인 할 때마다 salt를 분리하여 맞춰보는 방법을 사용한다.

이러면 기존이랑 값이 많이 달라지기에 레인보우 테이블로도 문제가 생기지 않는다.

우선 해당 작업을 위해, 기존에 사용하던 UserService와 분리된 AuthService를 생성한다.

확장을 위해 분리했으며, 관심사가 비슷한 User module에 생성하도록 한다.

클래스간의 의존성은 다음과 같다.

사이클이 생기지 않도록 잘 관리하도록 하자.

import {Injectable} from "@nestjs/common";
import {UsersService} from "./users.service";

@Injectable()
export class AuthService {
    constructor(private readonly usersService: UsersService) {}
}

@Module({
  imports: [TypeOrmModule.forFeature([Users])],
  controllers: [UsersController],
  providers: [UsersService, AuthService],
})
export class UsersModule {}

우선 AuthService를 추가해준다.

    async signUp(createUserDto: CreateUserDto) {
        const {email, password, name} = createUserDto;

        //해당 이메일의 중복 확인

        //사용자 비밀번호 암호화

        //사용자 정보 저장
        
        //사용자에게 응답
        return await this.usersService.create({email, password, name});
    }

우선 회원가입하는 로직은 다음과 같을 것이다.

우선 중복을 확인하고 중복이면 에러를 반환한다.

        //해당 이메일의 중복 확인
        const existedUser = await this.usersService.findByEmail(email);

        if(existedUser){
            throw new ConflictException('Email already exists');
        }

그 다음은 아래의 코드로 scrypt를 가져와준다.

import {randomBytes, scrypt as _scrypt} from 'crypto';
import {promisify} from 'util';

const scrypt = promisify(_scrypt);

그리고 다음과 같이 salt를 만들어서 암호화하고 이어준다.

        //사용자 비밀번호 암호화
        //SALT값 생성
        //8바이트로 16자리의 16진수 랜덤 문자열을 생성
        const salt = randomBytes(8).toString('hex');

        //SALT와 합쳐서 암호화
        //32자로 암호화된 값을 버퍼로
        const hash = (await scrypt(password, salt, 32)) as Buffer;

        //암호화된 값(16진수로 변환)과 SALT를 결합
        const result = salt + '.' + hash.toString('hex');

전체 메서드는 다음과 같다.

    async signUp(createUserDto: CreateUserDto) {
        let {email, password, name} = createUserDto;

        //해당 이메일의 중복 확인
        const existedUser = await this.usersService.findByEmail(email);

        if(existedUser){
            throw new ConflictException('Email already exists');
        }

        //사용자 비밀번호 암호화
        //SALT값 생성
        //8바이트로 16자리의 16진수 랜덤 문자열을 생성
        const salt = randomBytes(8).toString('hex');

        //SALT와 합쳐서 암호화
        //32자로 암호화된 값을 버퍼로
        const hash = (await scrypt(password, salt, 32)) as Buffer;

        //암호화된 값(16진수로 변환)과 SALT를 결합
        const result = salt + '.' + hash.toString('hex');

        //사용자 정보 저장
        password = result;

        //사용자에게 응답
        return await this.usersService.create({email, password, name});
    }

Http로 테스트를 해보니 다음과같이 정상적인 데이터가 들어간 것을 볼 수 있었다.

저 비밀번호는 암호화가 불가능하다.

그렇기 때문에 비밀번호를 확인하기 위해서 사용자가 전달한 비밀번호를 암호화하고 비교해야 한다.

우선 여기까지만 글을 쓰고 다음 글에서 알아보도록 하자.

물론 response dto의 class를 만들고, 해당 클래스로 변환해서 응답하는 방법도 있다.

하지만 nest에서는 다른 방법도 많이 사용하는 것 같다.

우선 지금 GET /users/:id를 봐보자.

비밀번호가 그대로 나온다.

현재 인코딩을 하지는 않았지만, 인코딩을 한 비밀번호라도 사용자의 응답에는 노출되면 안 될 것이다.

이 비밀번호를 제거할 것인데, 방법은 2가지이다.

엔티티에 규칙을 추가하는 방법, 중간에 가로채는 방법이다.

우선 엔티티에 규칙을 먼저 추가해보자.

엔티티에 규칙을 추가

무려 nest 공식문서가 추천하는 방법이다.

우선 다음과 같이 제외할 properties에 @Exclude()를 붙여준다.

@Entity('users')
@Unique(['email'])
export class Users{

    @PrimaryGeneratedColumn()
    id: number;

    @Column()
    name: string;

    @Column()
    email: string;

    @Column()
    @Exclude()
    password: string;

    @AfterInsert()
    logInsert(){
        console.log(`user inserted id: ${this.id}`);
    }
}

그리고 해당 컨트롤러의 핸들러에 다음과 같은 데코레이터를 붙여준다.

@UseInterceptors(ClassSerializerInterceptor)

    @Get("/:id")
    @UseInterceptors(ClassSerializerInterceptor)
    findUser(@Param('id') id: number): Promise<Users> {
        return this.usersService.findOne(id)
    }

이렇게 해야 @Exclude()가 작동한다.

이러고 바로 요청을 해보면

바로 password가 빠진 것을 볼 수 있다.

하지만 이 방법은 안타까운 부분이 있다.

다른 권한 혹은 경로로 요청을 할 때마다 보여줘야 하는 속성이 다른 경우가 있다.

관리자 권한으로 요청을 하면 이메일이 보여야 하지만, 일반 유저로 요청하면 이메일이 보이면 안되는 이런 경우 말이다.

이런 상황에서는 @Exclude()로 완벽하게 해결 할 수 없다.

Interceptor

원하는 상황에서 원하는 property만 넘길 수 있는 Interceptor를 만들어보자.

더 자유롭게 사용 가능하지만, 구현 난이도는 조금 더 높다.

AOP의 느낌으로 컨트롤러에서 client에게 가는 데이터를 가로채서 변환하는 방법이다.

Inteceptor는 NestInterceptor를 구현해서 만든다.

구현해야 하는 메서드는

intercept(context: ExecutionContext, next: CallHandler)

inercept는 자동으로 컨트롤러가 호출되면 전과 후에 호출되는 메서드이며, context는 도착한 request의 정보를 담고 있으며, next는 controller에서도 request를 처리해야 하는 handler의 정보를 담고 있다.

우선 간단하게 interceptor가 어떻게 동작하는지 보자.

import{
    UseInterceptors,
    NestInterceptor,
    ExecutionContext,
    CallHandler,
} from '@nestjs/common';
import { Observable } from 'rxjs';
import { map } from 'rxjs/operators';
import { plainToClass } from 'class-transformer';

export class SerializeInterceptor implements NestInterceptor {

    intercept(context: ExecutionContext, next: CallHandler<any>): Observable<any> {
        console.log("before");
        console.log(context);

        return next.handle().pipe(
            map((data: any) => {
                console.log("after");
                console.log(data);
                return data;
            })
        );
    }

}

이렇게 일단 로그만 출력하는 interceptor를 만들고,

    @Get("/:id")
    @UseInterceptors(SerializeInterceptor)
    findUser(@Param('id') id: number): Promise<Users> {
        console.log("i'm handler");
        return this.usersService.findOne(id)
    }

Get users에 interceptor 달아서 한 번 요청해보았다.

우선 가장 먼저 interceptor가 실행된다.

가장 위에 있는 부분이며, ExecutionContextHost에는 

이렇게 http 요청에 대한 정보들이 포함되어 있다.

그 다음으로 handler메서드가 실행되고, interceptor의 로그가 출력된다.

결국 아래의 그림과 같이 handler의 실행 전후를 감싸고 있는 구조인 것이다.

그럼 이제 이 interceptor를 사용해서 json을 변환해보자.

우선 해당 response를 명세할 dto는 필요하긴 하다.

중간에 interceptor가 가로채서 dto로 바꿔준다고 생각하면 된다.

import {Expose} from "class-transformer";

export class UserDto {
    @Expose()
    id: number;

    @Expose()
    email: string;
}

우선 무조건 UserDto로 변환하게 만들어보면

export class SerializeInterceptor implements NestInterceptor {

    intercept(context: ExecutionContext, next: CallHandler<any>): Observable<any> {

        return next.handle().pipe(
            map((data: any) => {
                
                
                return data;
            }),
        );
    }

}

여기의 map 안에서 해당 데이터의 properties 중에 UserDto에 해당하는 것만 가져오게 만드는 것이다.

export class SerializeInterceptor implements NestInterceptor {
    intercept(context: ExecutionContext, next: CallHandler<any>): Observable<any> {
        return next.handle().pipe(
            map((data: any) => {
                return plainToInstance(UserDto, data, {
                    excludeExtraneousValues: true
                });
            }),
        );
    }
}

이렇게 plainToInstance로 UserDto의 속성들만 뽑아낸다.

한 번 다시 요청해보자.

이렇게 원하는 속성들만 나오는 것을 볼 수 있다.

일단 원하는 속성들만 추출하도록 만들었으니, 이제 이 interceptor를 dto를 동적으로 받을 수 있도록 리펙토링 해보자.

우선 이 SerializeInterceptor에 무언가 값을 받을 수 있도록 해야겠다.

@UseInterceptors(new SerializeInterceptor(UserDto))

이런식으로 UserInterceptor에서 SerializeInterceptor를 생성하고, UserDto를 넘기는 방법 말이다.

그리고 SerializeInterceptor에서 생성자로 dto를 받아, 해당 dto로 변환하도록 만든다.

export class SerializeInterceptor implements NestInterceptor {
    constructor(private dto: any){}
    intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
        return next.handle().pipe(
            map((data: any) => {
                return plainToInstance(this.dto, data, {
                    excludeExtraneousValues: true,
                });
            }),
        );
    }
}

그리고 현재 데코레이터에 new SerializeInterceptor로 넘기고 있기에, 이거도 함수로 만들어서 코드를 줄여준다.

export function Serialize(dto: any){
    return UseInterceptors(new SerializeInterceptor(dto));
}

이렇게 SerializeInterceptor를 담은 UseInterceptor를 넘겨주고, 이 Serialize를 데코레이터로 넘기면 된다.

@Serialize(UserDto)

마지막으로 저 dto 자리의 type이 any이기 때문에, 사실 어떤 값(1, true)를 넣어도 동작하게 된다.

따라서 저기에 class만 넣을 수 있도록 만들어야 한다.

interface ClassConstructor{
    new (...args: any[]): any;
}

export function Serialize(dto: ClassConstructor){
    return UseInterceptors(new SerializeInterceptor(dto));
}

이렇게 생성자가 존재한다는 조건을 걸어주면 클래스만 인자로 받을 수 있게 된다.

이제 한 번 직접 실행해보자.

이렇게 원하는 응답만 오는 것을 볼 수 있다.

그럼 여기서 갑자기 궁금한 부분이 생긴다.

과연 데코레이터는 싱글톤일까?

알아보기위해 우선 데코레이터를 2군데에 작성했다.

export function Serialize(dto: ClassConstructor){
    console.log("function", Math.random().toString(36));
    return UseInterceptors(new SerializeInterceptor(dto));
}

그리고 해당 함수를 거칠 때마다 랜덤값을 출력하도록 하니

서버를 실행할 때만 이렇게 로그가 발생하고, 요청간에는 발생하지 않았다.

이것을 보아 싱글톤은 아니고, 핸들러마다 하나씩 생성되어 사용되는 것을 알 수 있었다.

저번에 User와 관련한 Entity를 만들었었다.

@Entity('users')
@Unique(['email'])
export class Users{

    @PrimaryGeneratedColumn()
    id: number;

    @Column()
    name: string;

    @Column()
    email: string;

    @Column()
    password: string;
}

이 Entity를 등록했었고, 이거를 바탕으로 nest repository를 서비스에 만들어보자.

@Injectable()
export class UsersService {
    
    constructor(@InjectRepository(Users) private readonly userRepository: Repository<Users>) { }
}

이렇게 UserService에 UserRepository의 의존성을 등록해준다.

컨트롤러의 내용은 제외하고 서비스의 코드만 채워볼것이다.

• Create

우선 create부터 만들어보자.

async create(createUserDto: CreateUserDto) {
        const user = this.userRepository.create({
            name: createUserDto.name,
            email: createUserDto.email,
            password: createUserDto.password
        });
        
        return await this.userRepository.save(user);
    }

create와 save를 사용했는데, create가 데이터베이스에 값을 create하는 메서드는 아니다.

해당 entity 구조를 바탕으로 새로운 entity를 만들어주는 메서드이다.

save가 데이터베이스에 해당 값을 저장해주는 메서드이다.

사실 아래와 같은 방법으로도 저장은 가능하다.

this.userRepository.save({name: createUserDto.name, email: createUserDto.email,  password: createUserDto.password});

하지만 그럼에도 불구하고 entity를 생성해서 저장하는 이유는 entity에 비즈니스 로직들이 들어있으며, 데코레이터등을 사용해 값을 미리 검증할 수 있다.

그리고 insert, update와 같은 작업 이후에 특정 메서드가 동작하도록 할 수 있다.

    @AfterInsert()
    logInsert(){
        console.log(`user inserted id: ${this.id}`);
    }

이렇게 AfterInsert()를 사용하면 데이터베이스 저장 이후에 로그가 출력되도록 할 수 있다.

이렇게 entity의 기능들과 hook을 사용할 수 있도록, 직접 객체 리터럴로 저장하는 것이 아닌 create로 엔티티를 생성해서 저장하도록 하자.

• Read

이번엔 read이다.

우선 id를 사용해 하나의 entity만 가져오는 메서드이다.

    async findOne(id: number){
        return this.userRepository.findOne({where: {id: id}});
    }

이렇게 findOne where절 내에 조건을 작성해주면 된다.

id는 PK이기 때문에 하나만 값을 가져와 findOne() 메서드를 사용했다.

여기서 만약 찾지 못하는 경우를 대비해 404 에러를 반환할수 있도록 하자.

    async findOne(id: number): Promise<Users> {
        const user = await this.userRepository.findOne({where: {id: id}});
        if(!user){
            throw new NotFoundException('User not found');
        }
        return user;
    }

이번에는 name을 사용해 많은 데이터들을 검색하는 메서드이다.

    async findAll(name: string): Promise<Users[]> {
        return await this.userRepository.find({where: {name}});
    }

역시 where절의 조건으로 name을 추가해주었고, 하나의 엔티티만 가져오는 것이 아니기 때문에 find() 메서드를 사용한다.

여기서는 만약 해당하는 값이 없다면 404에러가 아닌 빈 배열이 반환되게 될 것이다.

• Update

    async update(id: number, userAttrs: Partial<Users>): Promise<Users> {
        const user = await this.findOne(id);
        Object.assign(user, userAttrs);
        return await this.userRepository.save(user);
    }

여기서 Partial 타입을 사용한 것을 볼 수 있는데

Users의 부분적인 속성들을 가지는 클래스이다.

{name}, {name, email} ... 등등 Users 클래스 내의 속성들을 부분적으로 가지고 있는 클래스이다.

그 값을 Object.assign을 통해 기존의 user 데이터에 덮어쓰고, save() 메서드를 통해 데이터베이스에 저장한다.

export class UpdateUserDto {

    @IsString()
    @IsOptional()
    name: string;

    @IsEmail()
    @IsOptional()
    email: string;

    @IsString()
    @IsOptional()
    password: string;
}

dto에서 @IsOptional()을 사용하면, json에서 선택적으로 값을 넣어 요청할 수 있다.

• Delete

    async delete(id: number): Promise<Users> {
        const user = await this.findOne(id);
        return this.userRepository.remove(user);
    }

저번과 마찬가지로 조회 후 값을 확인하고 삭제한다.

remove()는 아이디가 아닌 entity를 넣어서 삭제한다.

그럼 여기서 궁금한점이 있다.

save() 메서드는 언제 insert로 동작하고, 언제 update로 동작하는걸까?

다음과 같은 3가지 상황을 만들어서 save()를 호출해봤다.

모두 find를 호출하지 않은 상태로 save()를 호출하는 것이다.

• save()로 넘긴 entity에 id가 없는 경우
• entity에 id가 있지만 데이터베이스에는 해당 id가 없는 경우
• entity에 id가 있으며, 데이터베이스에도 해당 id가 존재하는 경우

우선 현재 데이터베이스에는 해당 값만 존재한다.

첫번째 경우는 역시 성공한다.

POST http://localhost:3000/users/test
Content-Type: application/json

{
  "name": "승규",
  "email": "sda1fs@gmail.com",
  "password": "1234"
}

그냥 평범하게 insert 쿼리가 날아간 것을 볼 수 있다.

두번째 경우도 성공한다.

POST http://localhost:3000/users/test
Content-Type: application/json

{
  "id": 123,
  "name": "승규",
  "email": "sda1123fs@gmail.com",
  "password": "1234"
}

쿼리를 보면 신기하게도 미리 조회를 해보고, insert 한 것을 볼 수 있다.

세번째 경우에서는 중복 에러가 발생할 줄 알았지만 성공했다.

POST http://localhost:3000/users/test
Content-Type: application/json

{
  "id": 123,
  "name": "승규",
  "email": "sda112123s@gmail.com",
  "password": "1234"
}

이렇게 요청을 하니

이거도 미리 조회를 하고, 값이 있기에 update로 바꾼 것을 볼 수 있었다.

save() 메서드는 id가 존재하는 경우에 데이터베이스에 2번 접근하는 것을 알 수 있었다.

우선 필요한 라이브러리들을 가져와준다.

npm install @nestjs/typeorm typeorm mysql2

그리고 AppModule에 우리가 사용할 데이터베이스의 연결정보를 추가해줘야 한다.

imports에 TypeOrmModule.forRoot()로 다음과 같이 추가해준다.

@Module({
  imports: [TypeOrmModule.forRoot({
    type: 'mysql',
    host: 'localhost',
    port: 3306,
    username: 'root',
    password: '1204',
    database: 'usedCars',
    entities: [__dirname + '/**/*.entity{.ts,.js}'],
    synchronize: true
  }), UsersModule, ReportsModule],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

mysql을 사용하기 때문에 type은 mysql이며, database로 스키마를 나타낸다.

synchronize를 사용하면 변경된 entity 정보가 데이터베이스의 스키마에도 반영된다.

개발 환경에서만 사용하고, 배포 환경에서는 사용하지 말도록 하자.

entities에 우리가 작성할 entity들을 넣어준다.

작성한 entity들을 하나하나 추가할 수 있지만, 많은 양의 entity를 작성하기 때문에 convention에 따라 .entity.ts로 끝나는 파일들을 모두 추가해주도록 path를 지정해주자.

이제 예시로 entity를 하나 만들어보자.

nest에서는 entity를 다음과 같은 과정으로 생성한다.

1번으로 UserEntity를 만들어보도록 하겠다.

@Entity('users')
@Unique(['email'])
export class Users{

    @PrimaryGeneratedColumn()
    id: number;

    @Column()
    email: string;

    @Column()
    password: string;
}

@Entity를 붙여 Entity임을 알려주고, 사용할 테이블의 이름을 적는다.

@Unique()에는 unique 속성을 가질 column 명을 적어준다.

@PrimaryGeneratedColumn을 사용하면 autoincrement의 int column이 생성된다.

그 다음에는 2번으로 UserModule에 UserEntity를 추가한다.

@Module({
  imports: [TypeOrmModule.forFeature([Users])],
  controllers: [UsersController],
  providers: [UsersService]
})
export class UsersModule {}

3번도 해야하지만, 해당 path의 모든 entity를 등록했기에 우리는 할 필요가 없다.

일단 이렇게 해서 서버를 실행해보면, synchronize가 true이기 때문에 데이터베이스에 다음과 같이 테이블이 생성된 것을 볼 수 있다.

UserEntity는 성공적으로 작성 한 것 같다.

스프링에서도 최근에는 모듈간의 의존성을 만들어서 멀티모듈로 개발을 했었다.

그렇게 개발하는 방법이 중복되는 코드를 줄일 수 있기 때문이다.

Nest에서도 해당 방법으로 개발을 해보도록 하자.

우선 생성할 프로젝트의 구조는 다음과 같다.

Cpu module과 Disk module에서 Power module을 가져와서 사용하고, 최종적으로는 그 모듈들을 Computer Module에서 사용하는 것이다.

단순히 기능만 사용하는 것이기 때문에 Controller는 Computer module에만 생성하면 될 것이다.

모듈들은 미리 생성을 해두었고 우선 가장 기본이 되는 Power module부터 만들어보자.

nest g service power

그리고 해당 서비스에 간단한 메서드를 추가해보았다.

@Injectable()
export class PowerService {

    supplyPower(amount: number){
        console.log(`${this.constructor.name} 클래스에서 ${amount}의 전력을 공급했습니다.`)
    }
}

가장 기본적으로 전력을 공급하는 역할을 할 것이고, 해당 클래스의 정보를 확인하기 위해 값을 추가해보았다.

그리고 PowerModule에서 해당 서비스를 exports 해준다.

@Module({
  providers: [PowerService],
  exports: [PowerService]
})
export class PowerModule {}

이렇게 하면 PowerModule을 import한 다른 모듈에서 PowerService를 사용할 수 있게 된다.

마찬가지로 Cpu module과 Disk module에서 해당 모듈들을 가져가 사용해보자.

먼저 Disk module이다.

Disk module에서는 Power module을 가져오고, DiskService를 export 해야하니 다음과 같이 작성한다.

@Module({
  providers: [DiskService],
  imports: [PowerModule],
  exports: [DiskService]
})
export class DiskModule {}

그리고 service에서는 그냥 같은 모듈이라고 생각하며 의존성을 가져온다.

@Injectable()
export class DiskService {

    constructor(
        private readonly powerService: PowerService
    ) {}

    getData(): number[]{
        this.powerService.supplyPower(10);
        
        return [Math.floor(Math.random() * 10),  Math.floor(Math.random() * 10)];
    }
}

CpuService에서는 그냥 다음과 같이 만들어줬다.

@Injectable()
export class CpuService {
    constructor(private readonly powerService: PowerService) { }
    
    calculate(a: number, b: number): number {
        this.powerService.supplyPower(20);
        return a + b;
    }
}

이제 이 모든 것을 사용할 Computer module이다.

사용할 모듈들은 imports에 추가하고, 컨트롤러를 빼준다.

@Module({
  providers: [ComputerService],
  controllers: [ComputerController],
  imports: [CpuModule, DiskModule]
})
export class ComputerModule {}

@Injectable()
export class ComputerService {

    constructor(private readonly cpuService: CpuService,
                private readonly diskService: DiskService) {}

    useCom(): number{
        const numbers = this.diskService.getData()
        return this.cpuService.calculate(numbers[0], numbers[1]);
    }

}

코드를 다음과 같이 작성하고 요청을 해보니

이렇게 Power module의 서비스를 이용하는 것을 볼 수 있다.

같은 인스턴스인지 궁금해서 랜덤값으로 값을 부여하고 출력해보았는데, 같은 값이 나왔다.

같은 서버 내에서는 imports 하더라도 싱글톤으로 같은 인스턴스를 공유하고 있는 것을 알 수 있었다.

이렇게 다른 모듈에서 export, import 하게 되면 컨테이너에서 해당 import 클래스들을 가져올 수 있게 된다.

결국 Nest도 프레임워크이기 때문에 제어의 역전과 런타임 중 클래스를 주입하는 DI를 사용하게 된다.

스프링과 동일한 개념이겠지만, 어차피 마지막으로 정리하는 것일테니 자세하게 정리하고 가자.

우선 IOC(Inversion of Control Principle, 제어의 역전)은 다음을 말한다.

클래스가 의존성이 필요한 클래스를 본인이 직접 인스턴스를 생성하는 것이 아니라, 알아서 주입이 되도록 제어의 권한을 프레임워크에 위임하는 것을 말한다.

기존에는 생성자에 의존성이 있는 클래스를 다음과 같이 생성했었다.

@Controller('messages')
export class MessagesController {

    private messagesService: MessagesService;

    constructor(){
        this.messagesService = new MessagesService();
    }
}

이거를 IOC의 DI로 바꾸어야 한다는 것이다.

여기에서 messageService를 이용할 수 있도록 하는 방법은 3가지가 있을 것이다.

• 인스턴스 직접 생성

이번에 만들었던 방법대로 직접 인스턴스를 생성하는 것이다.

@Controller('messages')
export class MessagesController {

    private messagesService: MessagesService;

    constructor(){
        this.messagesService = new MessagesService();
    }
}

• 생성자를 통해 외부에서 주입

@Controller('messages')
export class MessagesController {

    private messagesService: MessagesService;

    constructor(messagesService: MessagesService){
        this.messagesService = messagesService;
    }
}

• 해당 클래스의 추상화를 주입

interface Service{
	....
}

@Controller('messages')
export class MessagesController {

    private messagesService: Service;

    constructor(messagesService: Service){
        this.messagesService = messagesService;
    }
}

당연히 아래로 갈수록 의존성이 낮아지기에 좋은 방법이다.

다른 구현체로 변경하기가 쉽기 때문이다.

예를들면 실제 배포에서는 우리가 만들었던 서비스를 주입하고, 테스트 환경에서는 해당 인터페이스를 모킹해서 구현한 서비스를 주입하는 작업을 할 수 있기 때문이다.

결국 모든 목적은 컨트롤러가 될 것이다.

컨트롤러를 만들어야 적절한 API를 제공하기 때문이다.

그렇게 컨트롤러의 의존성에 대해 필요한 클래스들을 싱글톤으로 생성하여 등록해두고 의존성이 있는 클래스들에 대하여 해당 클래스들을 공유한다.

순서는 다음과 같다.

1. 시작하면 모든 클래스들을 컨테이너에 등록한다.

2. 컨테이너는 각 클래스들의 의존성들을 파악한다.

3 컨테이너에게 각 클래스들의 인스턴스 생성을 요청한다.

4. 컨테이너는 필요한 모든 의존성을 생성하고, 우리에게 인스턴스를 제공한다.

5. 컨테이너는 모든 클래스들을 싱글톤으로 생성하고, 의존성이 있는 각 클래스들에 공유한다.

이제 이렇게 DI를 사용하는 방법으로 코드를 리펙토링 해보자.

우선 의존성으로 가져가야 하는 클래스들에 @Injectable()을 붙여준다.

그러면 이 클래스들이 생성한 인스턴스로 컨테이너에 등록된다.

그리고 그 중 제공되어야 하는 클래스들을 알리기 위해 @Module()에 providers로 등록한다.

이렇게하면 providers에서 의존성으로 필요한 클래스들을 가져가서 컨테이너까지 생성하게 된다.

실행을 해보면 정상적으로 실행되는 것을 볼 수 있다.