関西Node学園#9での発表資料です GitHub: https://github.com/jiko21/nest-todo-rest
NestJSA progressive web framework#kng9@jiko_21 (a.k.a Daiki Kojima)
View Slide
Grad Student @ Kyoto univFrontend / Serverside EngineerAndroid DeveloperͩͬͨΓ͢ΔLove: Vue.js, TypeScript, Kotlin, Golang…@jiko_21 (a.k.a Daiki Kojima)@jiko_21@jiko21
Agenda• NestJSͬͯԿ?• ͔ΜͨΜͳ֓ཁ• ҰൠతͳApplicationΛॻ͘ͷʹඞཁͳࣝ• NestJSͷಛ• ·ͱΊ
2018 Warsaw @ PorlandͰ ͜Μͳηογϣϯ͕͋ͬͨ
JavaScript Conference’18 @Warsawhttps://youtu.be/f0qzBkAQ3mk
NestJSͱ• Progressive Node.js framework• TypeScriptͰهड़Մೳ• ༷ʑͳπʔϧ͕ఏڙ͞Ε͍ͯΔ
࣮ࡍʹதΛݟͯΈΔ
NestJSͷجૅ• module• ίʔυΛ·ͱΊͯػೳΛཧతͳ୯Ґʹׂ ˠ ࠶ར༻Մೳʹ!• શͯͷNestͷΞϓϦέʔγϣϯʹroot module͕ଘࡏ͠ ΞϓϦέʔγϣϯΛىಈͤ͞Δ (Angularͱಉ༷)
NestJSͷجૅ3PPUNPEVMF4VCNPEVMF جຊతʹ͍ΖΜͳͷΛ͜Εʹ ٧ΊࠐΊ͍ͯ͘
moduleΛߏ͢Δͷ
moduleΛߏ͢Δͷ$POUSPMMFST
moduleΛߏ͢Δͷ1SPWJEFST$POUSPMMFST
moduleΛߏ͢Δͷ1SPWJEFST$POUSPMMFST*NQPSUT
moduleΛߏ͢Δͷ1SPWJEFST$POUSPMMFST*NQPSUT &YQPSUT
moduleΛߏ͢Δͷ@Module({imports: [TypeOrmModule.forFeature([Todo]),],providers: [TodosService],controllers: [TodosController],exports: [],})export class TodosModule {}
moduleΛߏ͢Δͷ@Module({imports: [TypeOrmModule.forFeature([Todo]),],providers: [TodosService],controllers: [TodosController],exports: [],})export class TodosModule {}!.PEVMFʹͦΕͧΕΛهೖ͍ͯ͘͠
Controllers
Controllers• ϧʔςΟϯάΛ୲͏• pathͱmethod͕ ରԠ@Controller('todos')export class TodosController {constructor(private readonly todosService: TodosService) {}@Get()getTodos(): Promise {return this.todosService.findAll();}@Get(':id')getTodo(@Param('id', new ParseIntPipe()) id: number): Promise {return this.todosService.findById(id);}@Post('')createTodo(@Body() todoDao: TodoDao): Promise {return this.todosService.create(todoDao)}…}
Controllers• ϧʔςΟϯάΛ୲͏• pathͱmethod͕ ରԠ@Controller('todos')export class TodosController {constructor(private readonly todosService: TodosService) {}@Get()getTodos(): Promise {return this.todosService.findAll();}@Get(':id')getTodo(@Param('id', new ParseIntPipe()) id: number): Promise {return this.todosService.findById(id);}@Post('')createTodo(@Body() todoDao: TodoDao): Promise {return this.todosService.create(todoDao)}…}! ΞϊςʔγϣϯͰ NFUIPEͱQBSBNɺQBUIΛઃఆ
• ϧʔςΟϯάΛ୲͏• pathͱmethod͕ ରԠControllers@Controller('todos')export class TodosController {constructor(private readonly todosService: TodosService) {}@Get()getTodos(): Promise {return this.todosService.findAll();}@Get(':id')getTodo(@Param('id', new ParseIntPipe()) id: number): Promise {return this.todosService.findById(id);}@Post('')createTodo(@Body() todoDao: TodoDao): Promise {return this.todosService.create(todoDao)}…}
• ϧʔςΟϯάΛ୲͏• pathͱmethod͕ ରԠControllers@Controller('todos')export class TodosController {constructor(private readonly todosService: TodosService) {}@Get()getTodos(): Promise {return this.todosService.findAll();}@Get(':id')getTodo(@Param('id', new ParseIntPipe()) id: number): Promise {return this.todosService.findById(id);}@Post('')createTodo(@Body() todoDao: TodoDao): Promise {return this.todosService.create(todoDao)}…}DPOTUSVDUPSʹґଘ͢Δ0CKFDUΛॻ͍͓ͯ͘ͱ.PEVMF͕ґଘΛղܾ %*ɺޙड़
Providers• providersͷίʔυ NestJSʹΑͬͯΠϯελϯεԽ ͞ΕͯModuleͰڞ༗ (DI)@Module({imports: [TypeOrmModule.forFeature([Todo]),],providers: [TodosService],controllers: [TodosController],exports: [],})export class TodosModule {}
Providers@Injectable()export class TodosService {constructor(@InjectRepository(Todo) todoRepo: Repository) {}}@Controller('todos')export class TodosController {constructor(private readonly todosService: TodosService) {}}@Module({imports: [TypeOrmModule.forFeature([Todo]),],providers: [TodosService],controllers: [TodosController],exports: [],})export class TodosModule {}
Providers@Injectable()export class TodosService {constructor(@InjectRepository(Todo) todoRepo: Repository) {}}@Controller('todos')export class TodosController {constructor(private readonly todosService: TodosService) {}}@Module({imports: [TypeOrmModule.forFeature([Todo]),],providers: [TodosService],controllers: [TodosController],exports: [],})export class TodosModule {}*OKFDUBCMFΛ ࢦఆ
Providers@Injectable()export class TodosService {constructor(@InjectRepository(Todo) todoRepo: Repository) {}}@Controller('todos')export class TodosController {constructor(private readonly todosService: TodosService) {}}@Module({imports: [TypeOrmModule.forFeature([Todo]),],providers: [TodosService],controllers: [TodosController],exports: [],})export class TodosModule {}*OKFDUBCMFΛ ࢦఆ DPOUSPMMFSʹ ྲྀ͠ࠐΈ *OKFDU
Imports• ͜ͷModuleͰproviderͱ͔͕ඞཁͱ͍ͯ͠ΔModuleΛ ͜͜Ͱॻ͍ͯ͋͛Δ• TypeORMΈ͍ͨͳthird party module• ࣗͰॻ͍ͨΧελϜmodule
Imports@Module({imports: [TypeOrmModule.forFeature([Todo]),],providers: [TodosService],controllers: [TodosController],exports: [],})export class TodosModule {}@Module({imports: [TodosModule],controllers: [AppController],providers: [AppService],})export class AppModule {}
Imports@Module({imports: [TypeOrmModule.forFeature([Todo]),],providers: [TodosService],controllers: [TodosController],exports: [],})export class TodosModule {}@Module({imports: [TodosModule],controllers: [AppController],providers: [AppService],})export class AppModule {}JNQPSU͍ͯ͘͜͠ͱͰ .PEVMF͕͑Δ
ׂ͞ΕͨModuleΛ͓͏!
ͱ͍͑…
Serviceͱ͔ͬͯɺ ผͷModuleͰݺͼͨ͘ͳΔΑͶ…
exports• providerͷαϒηοτ• ͜͜ʹॻ͔Ε͍ͯΔͷɺ͜ͷmoduleΛimport͍ͯ͠Δ ଞͷmodule͔Βར༻͕Ͱ͖Δ!
JestͰςετ͕ॻ͚Δ
Jestͱ• FacebookͷJavaScript༻Testing Framework• ଞͷTesting Libraryͱҧ͍ɺAll in one• ϑϩϯτΤϯυͩͱ…• React, Vue.jsͰΑ͘ΘΕΔ…
ॻ͖ํͷҰྫdescribe('TodosService', () => {let service: TodosService;let repository: Repository;beforeEach(async () => {...});afterEach(async () => {...});it('findAll success', async () => {expect(await service.findAll()).toEqual(TODOS_ARAY);});});
ॻ͖ํͷҰྫdescribe('TodosService', () => {let service: TodosService;let repository: Repository;beforeEach(async () => {...});afterEach(async () => {...});it('findAll success', async () => {expect(await service.findAll()).toEqual(TODOS_ARAY);});});֤ςετέʔεલʹ࣮ߦ
ॻ͖ํͷҰྫdescribe('TodosService', () => {let service: TodosService;let repository: Repository;beforeEach(async () => {...});afterEach(async () => {...});it('findAll success', async () => {expect(await service.findAll()).toEqual(TODOS_ARAY);});});֤ςετέʔεલʹ࣮ߦ֤ςετέʔεޙʹ࣮ߦ
JestͰΑ͋͘Γ͕ͪͳ͜ͱ…• ୯ମςετͰɺ֎෦ϞδϡʔϧͷڍಈΛϞοΫ͍ͨ͠• jest.spyOnͰϞοΫit('getProducts', async () => {jest.spyOn(service, ‘findAll').mockResolvedValue(PRODUCTS_ARRAY);expect(await controller.getProducts()).toBe(PRODUCTS_ARRAY);});@Get()getProducts(): Promise {return this.productsService.findAll();}ςετର ςετίʔυ
JestͰΑ͋͘Γ͕ͪͳ͜ͱ…• ୯ମςετͰɺ֎෦ϞδϡʔϧͷڍಈΛϞοΫ͍ͨ͠• jest.spyOnͰϞοΫit('getProducts', async () => {jest.spyOn(service, ‘findAll').mockResolvedValue(PRODUCTS_ARRAY);expect(await controller.getProducts()).toBe(PRODUCTS_ARRAY);});@Get()getProducts(): Promise {return this.productsService.findAll();}ςετର ςετίʔυ͍ͭ͜ͷڍಈΛNPDL͍ͨ͠
JestͰΑ͋͘Γ͕ͪͳ͜ͱ…• ୯ମςετͰɺ֎෦ϞδϡʔϧͷڍಈΛϞοΫ͍ͨ͠• jest.spyOnͰϞοΫit('getProducts', async () => {jest.spyOn(service, ‘findAll').mockResolvedValue(PRODUCTS_ARRAY);expect(await controller.getProducts()).toBe(PRODUCTS_ARRAY);});@Get()getProducts(): Promise {return this.productsService.findAll();}ςετର ςετίʔυ͍ͭ͜ͷڍಈΛNPDL͍͍ͨͭ͜͠ͷڍಈΛNPDL͢Δ
NestJSͩͱ• moduleʹΑͬͯґଘղܾΛߦ͏ͷͰɺͦ͜ͰmockΛ ྲྀ͠ࠐΜͰ͠·͑OKdescribe('Todos Controller', () => {let controller: TodosController;let service: TodosService;beforeEach(async () => {const module: TestingModule =await Test.createTestingModule({providers: [{provide: TodosService,useValue: todoServiceMock,}],controllers: [TodosController],}).compile();controller = module.get(TodosController);service = module.get(TodosService);});});export const todoServiceMock = {findAll: () => TODOS_ARAY,findById: (id: number) => TODOS_ARAY[0],create: (todoDao: TodoDao) => todoDao,};mockؔςετίʔυ
Ұ୴ɺجૅతͳͱ͜Ζݟͨ!
NestJSͰ։ൃ͢Δ ͏·ΈͬͯԿ?
ओͳಛ1. TypeScriptͰͷهड़͕default2. πʔϧ܈͕๛3. όοΫΤϯυ (http provider) ΛબՄೳ
TypeScriptͰͷهड़͕default• cliʹΑͬͯੜ͞ΕͨίʔυશͯTypeScriptͰॻ͔Ε͍ͯΔ• ଞͷFrameworkͩͱ(Express…)• ࣗલͰTypeScriptԽ͕ඞཁ• ͱ͍͑JavaScriptͰॻ͚Δ
πʔϧ܈͕๛• ৭ʑͳͷ͕ఏڙ͞Ε͍ͯΔ• DI, test util, microservice support, WebSockets, RxJS• ʮNestJSϓϥοτϑΥʔϜͰ͋Δʯɺͱ͍͏ࢥ͔Β ͜ͷΑ͏ʹͳ͍ͬͯΔ
όοΫΤϯυ (http provider) ΛબՄೳ• package.jsonͱpackage-lock.jsonΛݟͯΈΔ{"name": "todo-app","dependencies": {"express": {"version": "4.17.1","resolved": “...”,"integrity": “...“,"requires": {...},"dependencies": {...}},}}{"name": "todo-app","version": "0.0.1","scripts": {},"dependencies": {"@nestjs/common": "^6.7.2","@nestjs/core": "^6.7.2","@nestjs/platform-express": "^6.7.2",...},"devDependencies": {"@nestjs/cli": "^6.9.0","@nestjs/schematics": "^6.7.0","@nestjs/testing": "^6.7.1","@types/express": "^4.17.1",...},}
όοΫΤϯυ (http provider) ΛબՄೳ• ࣮NestJSͷhttp providerࣗલͷͷͰͳ͍• σϑΥϧτExpress• ଞͷhttp providerར༻͢Δ͜ͱ͕Մೳ• Fastifyͱ͔ → expressͷ2ഒ΄ͲϕϯνϚʔΫͰྑ͍ੑೳ• ͜ΕʹΑΓ༷ʑͳthird-party plugin͕ར༻Մೳʹ
fastifyʹมߋ• ҎԼͷίϚϯυͰಋೖ • main.tsΛҎԼͷΑ͏ʹ͢Δ$ npm i @nestjs/platform-fastifyimport { NestFactory } from '@nestjs/core';import { AppModule } from './app.module';import { FastifyAdapter } from '@nestjs/platform-fastify';async function bootstrap() {const app = await NestFactory.create(AppModule, new FastifyAdapter());await app.listen(3000);}bootstrap();
͡Ό͋ͳΜͰ
σϑΥϧτ͕expressͳͷ͔…
৭ʑཧ༝͋Γ• express͕͘ΘΕ͍ͯͯmiddleware͕ଟ͍• Nested routerʹରԠ͍ͯ͠ͳ͍ͨΊɺSub-Domain routing ʹରԠ͍ͯ͠ͳ͍• sub-domain routingΛ༗ޮʹ͢ΔͱexpressʹΓସΘΔ
·ͱΊ• NestJSmodule୯ҐͰͷϩδοΫׂΛجຊͱ͓ͯ͠Γɺ ࠶ར༻ੑͷߴ͍ίʔυ͕ॻ͚Δ• TypeScriptͷσϑΥϧταϙʔτɺDIͷඪ४ఏڙͳͲɺ αϙʔτ͕ڧ͍ (TypeScript൛Spring BootͱݴͬͯաݴͰͳ͍)
Reference• Building a platform: NestJS from the ground up | KamilMyśliwiec | jsPoland 2018 https://youtu.be/f0qzBkAQ3mk• Document of NestJS: https://docs.nestjs.com/
ऴ੍࡞ɾஶ࡞ᴸᴸᴸᴸᴸ@jiko_21
jiko21
aramaki
seike460
hirokiigeta
tamaiyutaro
gen519
chiroruxx
okunokentaro
koic
oracle4engineer
gothedistance
yusukeshimizu
tgalopin
rocio
hatefulcrawdad
andyhume
philnash
bcantrill
reverentgeek
brettharned
keathley
paigeccino
morganepeng
hannesfritz
marcduiker