누버 이츠 클론 코딩 - Backend using Node.js framework
GraphQL 및 TypeScript 시작하기
GraphQL은 API를 위한 강력한 쿼리 언어(Query Language)이자, 기존 데이터로 쿼리를 수행하기 위한 런타임(Runtime)입니다. 또한, REST API에서 일반적으로 발견되는 많은 문제(Over-fetching, Under-fetching 등)를 해결하는 접근 방식입니다.
패키지가 설치되면 GraphQLModule을 가져와 forRoot() 정적 메서드로 구성할 수 있습니다.
forRoot()를 통해 설정한 옵션은 ApolloServer 생성자에 전달됩니다.
https://docs.nestjs.com/graphql/quick-start#getting-started-with-graphql--typescript
@nestjs/graphql 패키지 설치
npm i @nestjs/graphql @nestjs/apollo @apollo/server graphql
개요
Nest는 GraphQL 애플리케이션을 구축하는 두 가지 방법, 즉 code first 및 schema first을 제공합니다.
Code first (GraphQL스키마를 자동으로 생성)
code first 접근 방식에서는 데코레이터와 TypeScript 클래스를 사용하여 해당 GraphQL 스키마(schema.graphql파일)를 생성합니다.
code first 접근 방식을 사용하려면 먼저 옵션 객체에 autoSchemaFile 속성을 추가하세요.
autoSchemaFile 속성 값은 자동으로 생성된 스키마가 생성될 경로입니다. 또는 메모리에서 즉석에서 스키마를 생성할 수 있습니다.
이를 활성화하려면 autoSchemaFile 속성을 true로 설정하십시오.
// 경로 지정시 해당 경로에 schema.graphql파일을 생성
autoSchemaFile: join(process.cwd(), 'src/schema.graphql')
// true로 지정시 자동으로 메모리에 생성 (파일은 생성되지 않음)
autoSchemaFile: true
https://docs.nestjs.com/graphql/quick-start#code-first
Schema first (.graphql파일을 직접 생성 및 작성)
Schema first 접근 방식을 사용하려면 먼저 옵션 객체에 typePaths 속성을 추가합니다.
typePaths 속성은 GraphQLModule이 작성할 GraphQL SDL 스키마 정의 파일을 찾아야 하는 위치를 나타냅니다.
이러한 파일은 메모리에 결합됩니다.이를 통해 스키마를 여러 파일로 분할하고 해당 resolver 근처에서 찾을 수 있습니다.
https://docs.nestjs.com/graphql/quick-start#schema-first
Code first방식에서 resolver 클래스는 resolver 함수를 정의하고 Query type을 생성합니다.
여러 해석기 클래스를 정의할 수 있습니다. Nest는 런타임에 이들을 결합합니다.
https://docs.nestjs.com/graphql/resolvers#code-first-resolver
GraphQL 스키마의 대부분의 정의는 object types입니다.
정의하는 각 object type은 응용 프로그램 클라이언트가 상호 작용해야 하는 도메인 객체를 나타내야 합니다.
이 경우 code first 접근 방식을 사용하여 TypeScript 클래스를 사용하여 스키마를 정의하고 TypeScript 데코레이터를 사용하여 해당 클래스의 field에 주석을 추가합니다.
https://docs.nestjs.com/graphql/resolvers#object-types
@Args() 데코레이터를 사용하여 메서드 핸들러에서 사용할 요청에서 인수를 추출합니다. 이것은 REST 경로 매개변수 인수 추출과 매우 유사한 방식으로 작동합니다.
@Args('id') id: string
https://docs.nestjs.com/graphql/resolvers#args-decorator-options
Mutation이 객체를 argument로 취해야 하는 경우 Input type을 만들 수 있습니다.
Input type은 argument로 전달할 수 있는 특수한 유형의 객체이다.
@InputType()
export class UpvotePostInput {
@Field()
postId: number;
}
https://docs.nestjs.com/graphql/mutations#code-first
@InputType사용
@Args('createRestaurantInput') createRestaurantInput: createRestaurantInput
@ArgsType사용
@Args() createRestaurantInput: CreateResta urantInput
class-validator, class-transformer 설치
npm i class-validator class-transformer
TypeORM
https://typeorm.io/#/
Postgres.app
https://postgresapp.com/
Postico
https://eggerapps.at/postico
TypeORM은 NodeJS, Browser, Cordova, PhoneGap, Ionic, React Native, NativeScript, Expo 및 Electron 플랫폼에서 실행할 수 있는 ORM이며 TypeScript 및 JavaScript(ES5, ES6, ES7, ES8)와 함께 사용할 수 있습니다.
https://github.com/typeorm/typeorm
Database
Nest는 데이터베이스에 구애받지 않으므로 모든 SQL 또는 NoSQL 데이터베이스와 쉽게 통합할 수 있습니다.
https://docs.nestjs.com/techniques/database
TypeORM Integration
SQL 및 NoSQL 데이터베이스와의 통합을 위해 Nest는 @nestjs/typeorm 패키지를 제공합니다.
Nest는 TypeScript에서 사용할 수 있는 가장 성숙한 ORM(Object Relational Mapper)이기 때문에 TypeORM을 사용합니다.
TypeScript로 작성되었기 때문에 Nest 프레임워크와 잘 통합됩니다.
설치
npm install --save @nestjs/typeorm typeorm pg
Warning
synchronize: true은 production에서 사용하면 안됩니다.
그렇지 않으면 production 데이터가 손실될 수 있습니다.
응용 프로그램은 종종 다른 환경에서 실행됩니다. 환경에 따라 다른 구성 설정을 사용해야 합니다.
Nest에서 이 기술을 사용하는 좋은 방법은 적절한 .env 파일을 로드하는 ConfigService를 노출하는 ConfigModule을 만드는 것입니다.
npm i @nestjs/config --save
"start:dev": "cross-env NODE_ENV=dev nest start --watch",
https://docs.nestjs.com/techniques/configuration
cross-env
cross-env를 통해 가상변수를 설정할 수 있습니다.
NODE_ENV=production으로 환경 변수를 설정하면 대부분의 Windows 명령 프롬프트가 인식합니다. cross-env를 사용하면 플랫폼에 맞게 환경 변수를 설정하거나 사용하는 것에 대해 걱정하지 않고 단일 명령을 사용할 수 있습니다. POSIX 시스템에서 실행되는 것처럼 설정하기만 하면 cross-env가 적절하게 설정합니다.
npm i cross-env
https://www.npmjs.com/package/cross-env
env.dev
DB_HOST=
DB_PORT=
DB_USERNAME=
DB_PASSWORD=
DB_NAME=
ConfigModule.forRoot({})
host: process.env.DB_HOST,
port: +process.env.DB_PORT,
username: process.env.DB_USERNAME,
password: process.env.DB_PASSWORD,
database: process.env.DB_NAME,
Joi
JavaScript용 가장 강력한 스키마 설명 언어 및 데이터 유효성 검사기.
npm i joi
import * as Joi from 'joi';
https://joi.dev/api/?v=17.4.2
https://www.npmjs.com/package/joi
Schema validation
Joi 내장 유효성 검사기. Joi를 사용하여 개체 스키마를 정의하고 이에 대해 JavaScript 개체의 유효성을 검사합니다.
https://docs.nestjs.com/techniques/configuration#schema-validation
validationOptions
allowUnknown: 환경 변수에 알 수 없는 키를 허용할지 여부를 제어합니다. 기본값은 true입니다.
abortEarly: true인 경우 첫 번째 오류에서 유효성 검사를 중지합니다. 거짓이면 모든 오류를 반환합니다. 기본값은 false입니다.
Entity는 데이터베이스 테이블(또는 MongoDB를 사용할 때 컬렉션)에 매핑되는 클래스입니다. 새 클래스를 정의하고 @Entity()로 표시하여 엔터티를 만들 수 있습니다. 기본 엔터티는 열과 관계로 구성됩니다. 각 엔터티에는 기본 열(또는 MongoDB를 사용하는 경우 ObjectId 열)이 있어야 합니다(MUST). @PrimaryGeneratedColumn()
Active Record 패턴은 모델 내에서 데이터베이스에 액세스하는 접근 방식입니다.
// example how to save AR entity
const user = new User();
user.firstName = "Timber";
user.isActive = true;
await user.save();
const users = await User.find({ skip: 2, take: 5 });
Data Mapper 패턴은 모델 대신 리포지토리 내의 데이터베이스에 액세스하는 접근 방식입니다. 데이터 매퍼 접근 방식을 사용하여 "리포지토리"라는 별도의 클래스에서 모든 쿼리 메서드를 정의하고 리포지토리를 사용하여 객체를 저장, 제거 및 로드합니다.
데이터 매퍼에서 엔터티는 매우 멍청합니다.객체는 속성을 정의하고 일부 "더미" 메서드가 있을 수 있습니다.
const userRepository = connection.getRepository(User);
// example how to save DM entity
const user = new User();
user.firstName = "Timber";
user.isActive = true;
await userRepository.save(user);
const users = await userRepository.find({ skip: 2, take: 5 });
https://typeorm.io/#/active-record-data-mapper
Repository Pattern
TypeORM은 repository design pattern,을 지원하므로 각 엔터티에는 자체 저장소가 있습니다.
이러한 리포지토리는 데이터베이스 연결에서 얻을 수 있습니다.
TypeOrmModule.forFeature() 메서드를 사용하여 엔티티를 현재 범위(현재 module)에 등록될 저장소를 imports합니다. @InjectRepository() 데코레이터를 사용하여 UsersRepository를 UsersService에 주입할 수 있습니다.
https://docs.nestjs.com/techniques/database#repository-pattern
@Injectable()
export class UsersService {
constructor(@InjectRepository(User) private readonly users: Repository<User>) {}
}
(보너스) constructor 사용 시 private, readonly 둘 다 사용하는 이유
- private is to make the property private so no other class can access it
- readonly make the property read only so no method inside the class can override it by accident.
NestJS Repository
https://docs.nestjs.com/recipes/sql-typeorm
https://docs.nestjs.com/recipes/mikroorm#repositories
create()
엔티티 생성
새 엔티티 인스턴스를 만들고 이 개체의 모든 엔터티 속성을 새 엔티티에 복사합니다. 엔터티 스키마에 있는 속성만 복사합니다. 자바스크립트 오브젝트를 만들 때 사용합니다.
save()
엔티티를 데이터베이스에 저장 또는 업데이트
데이터베이스에 지정된 모든 엔터티를 저장합니다. 엔티티가 데이터베이스에 없으면 삽입하고, 그렇지 않으면 업데이트합니다. 서버에 업데이트 할 때 사용합니다.
// restaurant.service.ts
createRestaurant(createRestaurantDTO: createRestaurantDTO): Promise<Restaurant> {
const newRestaurant = this.restaurant.create(createRestaurantDTO); // js object create return this.restaurant.save(newRestaurant); // server save }
https://typeorm.io/#/undefined/save-a-one-to-one-relation
주의 이 장은 code first 접근 방식에만 적용됩니다. CRUD(Create/Read/Update/Delete)와 같은 기능을 구축할 때 기본 엔터티 유형에 대한 변형을 구성하는 작업이 종종 존재합니다. Nest는 이 작업을 보다 편리하게 하기 위해 유형 변환을 수행하는 여러 유틸리티 함수를 제공합니다.
종류: - Partial, Pick, Omit, Intersection, Composition Mapped types들을 사용하기 위해서는 @InputType 데코레이터로 선언되야 하고, 따로 지정하지 않으면 부모 클래스와 동일한 데코레이터를 사용합니다.
부모 클래스와 자식 클래스가 다른 경우(예: 부모가 @ObjectType으로 선언된 경우) 두 번째 인수로 InputType을 전달해서 자식 클래스에게 @InputType데코레이터를 사용하도록 한다.
또는 @InputType({ isAbstract: true })을 지정하여 현재 클래스를 GraphQL스키마에 추가하지 않고, 어딘가에 복사해서 쓰는 용도로만 사용하도록 지정한다.
@InputType()
export class UpdateUserInput extends PartialType(User, InputType) {}
export class CreateRestaurantInput extends OmitType(Restaurant, ['id']) {}
https://docs.nestjs.com/graphql/mapped-types
엔티티를 부분적으로 업데이트합니다. 엔티티는 주어진 조건으로 찾을 수 있습니다. save 메소드와 달리 캐스케이드, 관계 및 기타 작업이 포함되지 않은 기본 작업을 실행합니다. 빠르고 효율적인 UPDATE 쿼리를 실행합니다. 데이터베이스에 엔터티가 있는지 확인하지 않습니다. Promise 객체를 반환합니다.
updateRestaurant({ id, data }: UpdateRestaurantDTO) {
return this.restaurants.update(id, { ...data });
}
추가 기능을 사용할 수 있는 몇 가지 Special columns들이 있습니다.
@CreateDateColumn은 엔터티의 삽입 날짜로 자동 설정되는 특수 열입니다. 이 열은 설정할 필요가 없습니다. 자동으로 설정됩니다.
@UpdateDateColumn은 entity manager 또는 repository의 저장을 호출할 때마다 엔티티의 업데이트 시간으로 자동 설정되는 특수 컬럼입니다. 이 열은 설정할 필요가 없습니다. 자동으로 설정됩니다.
@DeleteDateColumn은 entity manager 또는 repository의 일시 삭제를 호출할 때마다 엔터티의 삭제 시간으로 자동 설정되는 특수 열입니다. 이 열은 설정할 필요가 없습니다. 자동으로 설정됩니다. @DeleteDateColumn이 설정되면 기본 범위는 "삭제되지 않음"이 됩니다.
https://typeorm.io/#/entities/special-columns
모든 엔터티에는 특정 엔터티 이벤트를 listen하는 커스텀 로직 메서드를 가질 수 있습니다.
그래서 listen하려는 이벤트를 메서드에 특별한 데코레이터로 마크해줍니다.
주의! listener 내에서 데이터베이스 호출을 수행하지 말고, 대신 subscribers를 사용하십시오.
https://typeorm.io/#/listeners-and-subscribers
@BeforeInsert
엔터티를 데이터베이스에 삽입 전에 이 데코레이터가 적용되면 해당 메서드를 호출합니다.
엔티티에 메소드를 정의하고 @BeforeInsert 데코레이터로 표시하면,
TypeORM은 엔티티가 repository/manager save를 사용하여 insert되기 전에 이 메서드를 호출합니다.
ex) mongoose에서 pre save처럼 DB에 저장되기 전에 실행되는 함수
@BeforeInsert()
updateDates() {
this.createdDate = new Date();
}
https://typeorm.io/#/listeners-and-subscribers/beforeinsert
bcrypt
npm i bcrypt
npm i @types/bcrypt -D
https://www.npmjs.com/package/bcrypt
[주의] import * as bcrypt from 'bcrypt';가 아닌 import bcrypt from 'bcrypt';로 import하게 되면 bcrypt에 함수가 아닌 undefined가 담겨 hash함수가 제대로 동작하지 않으므로 모듈 import 주의