feat: sqs 게시글 작성

_posts/2024-06-03-use-sqs.md

@@ -0,0 +1,232 @@
+---
+title: "NestJS에서 AWS SQS 사용하기"
+author: yujiniii
+date: 2024-06-03 20:00:00 +0900
+categories: [Backend, NestJS]
+tags: ["backend", "node"]
+img_path: "/assets/img/posts/sqs/"
+pin: false
+---
+> 1. AWS SQS를 생성할 수 있다.   
+> 2. NestJS 프로젝트에서 AWS SQS를 활용할 수 있다. 
+
+## AWS SQS (Simple Queue Service)
+[Amazon 심플 큐 서비스란?](https://docs.aws.amazon.com/ko_kr/AWSSimpleQueueService/latest/SQSDeveloperGuide/welcome.html)
+
+Amazon Simple Queue Service(Amazon SQS)는 AWS에서 제공하는 보안 호스팅 대기열 (QUEUE) 이다.
+보안, 내구성, 가용성, 확장성, 신뢰성, 사용자 지정 등의 특장점을 갖고 있다.
+
+
+![https://choiblog.tistory.com/190](https://img1.daumcdn.net/thumb/R1280x0/?scode=mtistory2&fname=https%3A%2F%2Fblog.kakaocdn.net%2Fdn%2FHtvMH%2Fbtsihd2v9gL%2FedzofXXpRxXSes3jNgd7q0%2Fimg.png)
+[이미지 출처](https://choiblog.tistory.com/190)
+
+#### Amazon SQS 대기열 유형
+
+<img src="sqs-aws.png" alt="SQS 유형 표" width=700>
+
+[Amazon SQS 대기열 유형](https://docs.aws.amazon.com/ko_kr/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-types.html) 은 참고차 더했다.
+
+
+### AWS SQS 생성 및 테스트
+<img src="sqs-make.png" alt="SQS 만들기" width=700>
+
+기본값 그대로 두고 일반 큐로 생성해보았다.
+
+<img src="sqs-test.png" alt="SQS test" width=700>
+
+우상단의 `메시지 전송 및 수신` 을 이용해서 자유롭게 테스트가 가능하다.
+
+<img src="sqs-test-2.png" alt="SQS test" width=700>
+
+
+
+## NestJS 에서 사용하기
+[@ssut/nestjs-sqs](https://www.npmjs.com/package/@ssut/nestjs-sqs) 라이브러리를 선택했다. 
+
+
+```bash
+npm i @ssut/nestjs-sqs @aws-sdk/client-sqs
+```
+> 편해보여서 항상 썼는데, 알고보니 만드신 분이 전 재직자셔서 좀 신기했던 기억.. 
+
+
+```bash
+# .env.skel
+AWS_SQS_QUEUE_NAME=
+AWS_SQS_QUEUE_URL=
+AWS_REGION='ap-northeast-2'
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+```
+
+
+> AWS_ACCESS_KEY_ID은 [IAM에서 사용자를 생성한 후 발급](https://docs.genians.com/nac/6.0/rc/ko/install/aws/access-key-setting.html)이 가능합니다. 
+> (정책은 `AmazonSQSFullAccess`만 부여)  
+> 다만 AWS에서는 이렇게 iam user의 access key 인증은 지양하기를 권장합니다.
+[액세스 키 보안](https://docs.aws.amazon.com/ko_kr/IAM/latest/UserGuide/id_credentials_access-keys.html#securing_access-keys)
+
+### consumer (소비자)
+consumer는 대기열에 자신이 처리할 메시지기 있는지 확인하고 메시지를 가져온다.
+
+```ts
+// app.module.ts
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+    }),
+    SqsModule.registerAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: (configService) => ({
+        consumers: [
+          {
+            name: configService.get('AWS_SQS_QUEUE_NAME'),
+            queueUrl: configService.get('AWS_SQS_QUEUE_URL'),
+          },
+        ],
+        producers: [],
+      }),
+    }),
+  ],
+  providers: [AppConsumer],
+})
+export class AppModule {}
+```
+
+
+```ts
+// app.consumer.ts
+const QUEUE = process.env.AWS_SQS_QUEUE_NAME || '';
+
+@Injectable()
+export class AppConsumer {
+  @SqsMessageHandler(QUEUE)
+  async messageHandler(message: Message) {
+    console.log(message);
+    if (!message?.Body) {
+      console.error('No message body');
+      return message;
+    }
+    const body: object | null = JSON.parse(message.Body); // 실제 값 사용 부분
+    return body;
+  }
+}
+
+```
+큐로부터 넘어오는 값 원본은 아래와 같다. `console.log(message);`
+
+
+```bash
+{
+  Body: '{"test":"test"}',
+  MD5OfBody: '828bcef8763c1bc616e25a06be4b90ff',
+  MessageId: 'feb95320-eed8-4688-aa38-5f9b1f7b912e',
+  ReceiptHandle: 'AQEBfD0NZ7S+gNoO6Mm6KC1IQZoyiZZCEHvwy3mtd6caLbfCAkJVz2izX6hYnpWomUZTRDZ1zbSRFVHILoeQNYVEq7PzlWzPKR00739ymYtf3UKbNqBxpA+8KK365MUdG4N2jjmuEYKhp84jMPVQlq0YQPPtSx530gWznTQiIhAvM8h+OQw/n9h+m7xSIB+5rXtlSuvCrnt67W4aNenXHoVbCpV9RnrYqChfddDG48F4gJrOTbVUz2EctfzNY3K9ALU7qnd6gr89rFVBjrwUV6LqJU55Ke3Mf+Ob8l+mGkzc2fgY1hxg/LTrQbQOvAJyK0A1Q5VDDFByBoTaR1Q1I++bFY7TunCWtVov55Y0BKfTb4K28gJpS0fcF4/dEZShJO4L6+nJcBDQ3a3jTUYBizeV0Q=='
+}
+```
+
+실제로는 `JSON.parse(message.Body);` 를 해서 사용해야 한다. 
+
+
+
+
+
+### Producer (생산자)
+Producer 는  SQS 대기열로 메시지를 전송한다.
+
+
+
+```ts
+// app.module.ts
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+    }),
+    SqsModule.registerAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: (configService) => ({
+        consumers: [],
+        producers: [
+          {
+            name: configService.get('AWS_SQS_QUEUE_NAME'),
+            queueUrl: configService.get('AWS_SQS_QUEUE_URL'),
+          },
+        ],
+      }),
+    }),
+  ],
+  providers: [AppConsumer],
+})
+export class AppModule {}
+```
+
+
+```ts
+// app.service.ts
+
+export class AppService {
+  constructor(
+    private readonly configService: ConfigService,
+    private readonly sqsService: SqsService,
+  ) {}
+
+  async sendSqsMessage() {
+    const queueName = this.configService.get('AWS_SQS_QUEUE_NAME');
+    let result: SendMessageBatchResultEntry[];
+
+    try {
+      result = await this.sqsService.send(queueName, {
+        id: uuid(), // make unique id
+        body: {
+          test: 'test',
+        },
+      });
+      console.log(result);
+      return result;
+    } catch (err) {
+      console.error(err);
+    }
+  }
+  }
+}
+```
+
+```ts
+// app.controller.ts
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+  @Get('test')
+  sendSqs() {
+    return this.appService.sendSqsMessage();
+  }
+}
+```
+
+
+```bash
+curl localhost:3000/test
+[{"Id":"45ceec65-5592-4a00-b4ac-627806246ee2","MD5OfMessageBody":"828bcef8763c1bc616e25a06be4b90ff","MessageId":"8f760bc7-da41-4553-993c-0ec4ed9a99e4"}]%               
+```
+
+
+
+
+
+<img src="sqs-rec.png" alt="SQS 수신" width=700>
+
+`MessageId` 인 `8f760bc7-da41-4553-993c-0ec4ed9a99e4` 를 메시지 수신ID 에서 찾을 수 있다.
+
+<img src="sqs-rec-val.png" alt="SQS 수신2" width=400>
+
+보낸 내용도 동일함을 확인한다. 
+
+
+## 마무리
+입사후 가장 먼저 구현한 기능이 SQS라, 각별히 기억에 남는다. 그 작업 덕분에 다른 작업의 worker 구현에서도 유용하게 써먹을 수 있었다. 
+다음 번에는 다른 메시지 브로커를 활용해보고싶다..!