Microservice Architecture

Microservice Architecture란?🤔

• 한 프로젝트를 여러 작은 서비스로 분해하여 개발,운영,배포하는 방법
• 여러 모듈로 분리했기 때문에 팀별 독립적으로 개발 가능
  

- 💡 장점

1. 소스코드 전체를 빌드/배포하려면 시간이 오래 걸림
   -> 게시판API 바뀌면 게시판 폴더만 다시 배포
2. 에러나서 서버가 죽으면 모든 API 사용불가능
   -> 게시판이 죽어도 상품, 로그인 등 나머지는 모두 사용가능
3. NestJS개발자만 뽑아야됨
   -> 게시판은 Nestjs 상품은 Django 로그인은 Spring 다양한 개발자 채용 가능

- 💡 단점

전체적인 기술 복잡도 증가 => 작은 서비스보다 큰 서비스에서 많이 사용!

[예시 파이프라인]

[공통 설정]

• 모든 폴더에 Dockerfile생성
• docker-compose.yaml파일은 가장 상위 폴더에 생성

version: "3.3"

services:
  api-gateway:
    build:
      context: ./api-gateway
      dockerfile: Dockerfile
    volumes:
      - ./api-gateway/src:/api-gateway/src
    ports:
      - 3000:3000

  auth-service:
    build:
      context: ./services/auth
      dockerfile: Dockerfile
    volumes:
      - ./services/auth/src:/auth-service/src
    ports:
      - 3001:3001

  resource-service:
    build:
      context: ./services/resource
      dockerfile: Dockerfile
    volumes:
      - ./services/resource/src:/resource-service/src
    ports:
      - 3002:3002

[Rest]

1. API-Gateway폴더

• Module에서 ClientModule생성 => 각각의 service들에 대한 정보 입력
• Controller에서 서비스 주입하고 엔드포인트 작성,cmd는 MessagePattern을 기입

//app.module.ts
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { ClientsModule, Transport } from '@nestjs/microservices';

@Module({
  imports: [
    ClientsModule.register([
      {
        name: 'AUTH_SERVICE', // ip주소
        transport: Transport.TCP, // TCP가 가장 기본 연결
        options: { host: 'auth-service', port: 3001 }, // ip주소
      },
      {
        name: 'RESOURCE_SERVICE', // ip주소
        transport: Transport.TCP,
        options: { host: 'resource-service', port: 3002 },
      },
    ]),
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

// app.controller.ts
import { Controller, Get, Inject } from '@nestjs/common';
import { AppService } from './app.service';
import { ClientProxy } from '@nestjs/microservices';

@Controller()
export class AppController {
  constructor(
    private readonly appService: AppService,

    @Inject('AUTH_SERVICE')
    private readonly clientAuthService: ClientProxy,
    @Inject('RESOURCE_SERVICE')
    private readonly clientResourceService: ClientProxy,
  ) {}

  @Get('/auth/login')
  login() {
    return this.clientAuthService.send({ cmd: 'aaa' }, { name: '철수' 	});
  }
  
  @Get('/boards')
  fetchboards() {
    return this.clientResourceService.send({ cmd: 'bbb' }, { age: 13 });
  }
}

2. Service 폴더 내 각각의 기능 폴더

• yarn add @nestjs/microservices 설치
• 앱모듈은 create가 아닌 createMicroservice사용
• transport는 기본적으로 TCP레이어 사용
• Controller에서 @Get이나 @Post 같은 Rest-API의 Method를 적는게 아니라 @MessagePattern사용

// main.ts
import { Transport, MicroserviceOptions } from '@nestjs/microservices';
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.createMicroservice<MicroserviceOptions>(
    AppModule,
    {
      transport: Transport.TCP, /
      options: { host: 'auth-service', port: 3001 },
    },
  );
  await app.listen();
}
bootstrap();

//app.controller.ts
import { Controller } from '@nestjs/common';
import { AppService } from './app.service';
import { MessagePattern } from '@nestjs/microservices';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @MessagePattern({ cmd: 'login' })
  login(): string {
    return 'login을 요청하셨습니다!';
  }
}

[Graphql]

모든 파일에 yarn add @nestjs/graphql @nestjs/apollo graphql apollo-server-express 설치

1. API-Gateway폴더

• 각각의 subgraph를 하나로 연결해주는 역할
  yarn add @apollo/gateway 설치

• app.module.ts에 subgraph 정보 입력

//app.module.ts
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { GraphQLModule } from '@nestjs/graphql';
import { ApolloGatewayDriver, ApolloGatewayDriverConfig } from '@nestjs/apollo';
import { IntrospectAndCompose } from '@apollo/gateway';

@Module({
  imports: [
      driver: ApolloGatewayDriver,
      gateway: {
        //입구
        supergraphSdl: new IntrospectAndCompose({
          // 연결 설정
          subgraphs: [
            // subgraph 정보 입력
            { name: 'auth', url: 'http://auth-service:3001/graphql' },
            { name: 'resource', url: 'http://resource-service:3002/graphql' },
          ],
        }),
      },
    }),
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

📌localhost:3000으로 접속하면 app.module.ts파일의 주소를 통해 각각의 port로 연결됨

2. Service 폴더 내 각각의 기능 폴더

• subgraph역할
  yarn add @apollo/federation설치
  yarn add @apollo/subgraph설치
• main.ts에서 포트번호 설정
• Module에 GraphQLModule추가 - Federation사용!

//main.ts
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(3001);
}
bootstrap();

// app.resolver.ts
import { Resolver, Mutation } from '@nestjs/graphql';
import { AppService } from './app.service';

@Resolver()
export class AppResolver {
  constructor(private readonly appService: AppService) {}

  @Mutation(() => String)
  login() {
    return '로그인 성공!';
  }
}

// app.module.ts
import { Module } from '@nestjs/common';
import { AppResolver } from './app.resolver';
import { AppService } from './app.service';
import { GraphQLModule } from '@nestjs/graphql';
import {
  ApolloFederationDriver,
  ApolloFederationDriverConfig,
} from '@nestjs/apollo';

@Module({
  imports: [
    GraphQLModule.forRoot<ApolloFederationDriverConfig>({
      driver: ApolloFederationDriver,
      autoSchemaFile: 'scr/common/grapql/schema.gql',
    }),
  ],
  providers: [AppService, AppResolver],
})
export class AppModule {}

[nginx]

Nginx Reverse Proxy
1) 순방향 Proxy(Forward Proxy)

• 서버들이 인터넷에 접속할때 먼저 Proxy 서버를 거쳐서 인터넷에 연결되는 방식
• 보안: Proxy Server에서 In/Out bound 패킷에 대한 보안 정책(Content filtering 등)을 적용
• 성능 : Proxy Server는 내부에 Cache를 유지하며 이미 한번 통신한 외부 서버의 이미지, 파일, 그 외정보들을 저장 가능 => Proxy 서버가 데이터를 제공하여 빠른 통신을 지원

2) 역방향 Proxy (Reverse Proxy)

• 외부에서 내부 서버가 제공하는 서비스 접근 시, Proxy 서버를 먼저 거쳐서 내부 서버로 들어오는 방식
• 보안 : 외부 사용자는 실제 내부망에 있는 서버의 존재를 모름
• 로드밸런싱 : Proxy 서버가 내부 서버의 정보를 알고 있으므로 로드밸런싱을 통해 부하 여부에 따라 요청을 분배 가능

• docker-compose.yaml에 api-gateway에서 nginx추가!!

version: "3.3"

services:
  api-gateway:
    image: nginx:latest
    volumes:
      - ./api-gateway/default.conf:/etc/nginx/conf.d/default.conf
    ports:
      - 80:80

  auth-service:
    build:
      context: ./services/auth
      dockerfile: Dockerfile
    volumes:
      - ./services/auth/src:/auth-service/src
    ports:
      - 3001:3001

  stock-service:
    build:
      context: ./services/stock
      dockerfile: Dockerfile
    volumes:
      - ./services/stock/src:/stock-service/src
    ports:
      - 3002:3002

1. API-Gateway폴더

• nginx 설정 파일 (default.conf) => nginx가 역방향 Proxy를 진행할 수 있도록 설정!

server{
    listen 80; # 80이 기본 포트
    
    # /graphql로 시작하는 주소가 들어오면 넘겨줄 내용(url)
    location /graphql{ 
        proxy_pass http://auth-service:3001;

    }

	# /stocks로 시작하는 주소가 들어오면 넘겨줄 내용(url)
    location /stocks { 
        proxy_pass http://stock-service:3002;
    }

}

2. Service 폴더 내 각각의 기능 폴더

• 각각 사용하는 프레임워크에 맞게 설정!