🏄 AWS CDK 101 - 🐲 dynamodb와 함께 AppSync를 사용하는 GraphQL

🔰 AWS CDK를 처음 사용하는 초보자는 이 시리즈의 이전 기사를 하나씩 살펴보십시오.

이전 기사를 놓친 경우 아래 링크에서 찾으십시오.

🔁 🔗의 원본 이전 게시물Dev Post

🔁 이전 게시물을 🔗에 다시 게시했습니다.

이 기사에서는 dynamodb 테이블 위에 래퍼로 ​​데이터 액세스 계층을 소개합니다. 여기에서는 특히 기본 목록 항목을 수행하고 dynamodb에서 항목을 가져오기 위해 AWS appsync를 사용하는 graphql을 선택했습니다.

건설 🏗️

새 스택을 위한 새 파일lib/appsync-stack.ts을 생성하여 시작하겠습니다.

이 새로운 스택에 사용된 가져오기 ⛩️

여기서 정의에 도움이 되도록 아래 개체를 가져왔습니다.

import { Duration, Expiration, Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { Table } from 'aws-cdk-lib/aws-dynamodb';
import { GraphqlApi, MappingTemplate, Schema, FieldLogLevel, AuthorizationType } from 'aws-lib-cdk/aws-appsync-alpha';

⛺ 정의가 있는 Appsync 구성

아래와 같이 appsync 끝점을 정의하는 데 사용되는 새 스택이 생성됩니다.

여기에서 주기적으로 교체할 수 있도록 만료 기간이 7일인 기본 API 키를 받게 됩니다. 그 외에도 백그라운드 프로세스를 훨씬 더 잘 이해할 수 있도록 API를 충분히 기록했습니다.

export class GqlStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    const AppSyncApi = new GraphqlApi(this, 'gqlApi', {
      name: 'gqlApi',
      schema: Schema.fromAsset('assets/messages-schema.gql'),
      xrayEnabled: true,
      logConfig: {
            excludeVerboseContent: false,
            fieldLogLevel: FieldLogLevel.ALL,
      },
      authorizationConfig: {
          defaultAuthorization: {
              authorizationType: AuthorizationType.API_KEY,
              apiKeyConfig: {
                  name: 'default-api-key',
                  description: 'default-api-key-description',
                  expires: Expiration.after(Duration.days(7))
              }
          }
      }
    })

  }
}

스키마 정의 파일 🎢

확실하게 알고 있는 경우 CDK 자산 파일에서 업데이트하기 전에 AWS 콘솔을 사용하여 스키마를 업데이트할 수도 있습니다.

type Message {
    message: AWSJSON!
}

type MessagesTable {
    createdAt: AWSTimestamp!
    messageId: String!
    event: Message
}

type MessagesTableConnection {
    items: [MessagesTable]
    nextToken: String
    scannedCount: Int
}

type Query {
    getMessage(messageId: String!, createdAt: AWSTimestamp!): MessagesTable
    listMessages(filter: TableMessagesTableFilterInput, limit: Int, nextToken: String): MessagesTableConnection
}

input TableAWSTimestampFilterInput {
    ne: AWSTimestamp
    eq: AWSTimestamp
    le: AWSTimestamp
    lt: AWSTimestamp
    ge: AWSTimestamp
    gt: AWSTimestamp
    contains: AWSTimestamp
    notContains: AWSTimestamp
    between: [AWSTimestamp]
}

input TableMessagesTableFilterInput {
    createdAt: TableAWSTimestampFilterInput
    messageId: TableStringFilterInput
}

input TableStringFilterInput {
    ne: String
    eq: String
    le: String
    lt: String
    ge: String
    gt: String
    contains: String
    notContains: String
    between: [String]
    beginsWith: String
}

데이터 소스로서의 Dynamodb 연결 🛶

여기서 우리는 dynamodb API를 graphql과 데이터 소스로 직접 통합하고 있습니다.

const messages = Table.fromTableName(this,'MessagesTableImport', 'MessagesTable');

const MessagesDS = AppSyncApi.addDynamoDbDataSource("MessagesDataSource", messages);

VTL 매핑 템플릿 🛩️

여기에서 VTL(Velocity Template Language)을 사용하여 요청을 변환/조작하고 아래 리졸버에서 보내거나 받는 응답이 필요합니다. 이는 appsync 및 API 게이트웨이뿐만 아니라 많은 곳에서 사용할 수 있으므로 이를 사용하는 것이 좋은 전략이 될 수 있습니다.

또한 AWS 콘솔을 사용하여 CDK 자산 파일에서 업데이트하기 전에 로그의 샘플 페이로드를 사용하여 이러한 변환을 테스트할 수 있습니다.

메시지 리졸버 받기 🚠

여기에서 xray 추적을 조사하여 이러한 블록이 getMessage 리졸버에 활용되는 시기를 이해할 수 있습니다.

MessagesDS.createResolver({
      typeName: 'Query',
      fieldName: 'getMessage',
      requestMappingTemplate: MappingTemplate.fromFile('assets/getMessageRequest.vtl'),
      responseMappingTemplate: MappingTemplate.fromFile('assets/getMessageResponse.vtl'),
})

getMessageRequest VTL 템플릿 🌟

{
    "version": "2017-02-28",
    "operation": "GetItem",
    "key": {
        "messageId": $util.dynamodb.toDynamoDBJson($ctx.args.messageId),
        "createdAt": $util.dynamodb.toDynamoDBJson($ctx.args.createdAt)
    }
}

getMessageResponse VTL 템플릿 ⛱️

#set($ctx.result.event = $util.parseJson($ctx.result.event))

$util.toJson($ctx.result)

목록 메시지 리졸버 🤡

여기에서 xray 추적을 조사하여 이러한 블록이 listMessages 리졸버에 활용되는 시기를 이해할 수 있습니다.

MessagesDS.createResolver({
        typeName: 'Query',
        fieldName: 'listMessages',
        requestMappingTemplate: MappingTemplate.fromFile('assets/listMessagesRequest.vtl'),
        responseMappingTemplate: MappingTemplate.fromFile('assets/listMessagesResponse.vtl'),
})

listMessagesRequest VTL 템플릿 🎈

{
  "version": "2017-02-28",
  "operation": "Scan",
  "filter": #if($context.args.filter) $util.transform.toDynamoDBFilterExpression($ctx.args.filter) #else null #end,
  "limit": $util.defaultIfNull($ctx.args.limit, 20),
  "nextToken": $util.toJson($util.defaultIfNullOrEmpty($ctx.args.nextToken, null)),
}

listMessagesResponse VTL 템플릿 🎣

#set($children = [])
#foreach($item in $ctx.result.items)
  #set($item.event = $util.parseJson($item.event))
  $util.qr($children.add($item))
#end
#set($ctx.result.items = $children)
$util.toJson($ctx.result)

graphQl ❄️을 탐색하는 클라이언트

Appsync 탐색기 쿼리 ♨️

AWS 콘솔에서 appsync를 탐색하고 쿼리를 시작할 수 있습니다. 여기에 있는 한 가지 장점은 확인하려는 경우에 대비하여 클라우드 감시 및 추적 로그를 쉽게 사용할 수 있다는 것입니다.

아폴로 스튜디오 쿼리 🏕️

그러나 일반적으로 apollo graphql 스튜디오에서 어두운 모드를 선호합니다. 원하는 경우 시도해 볼 수도 있습니다. 언젠가는 AWS 콘솔에서도 사용할 수 있습니다.

결론 💫

이 연습에서는 검색 및 쿼리 작업의 효율성을 차별화하기 위해 get 및 list 작업만 시도했습니다.
scannedCount 위의 결과 값은 테이블이 커질수록 리스트 연산에 드는 비용을 나타냅니다. 아래와 같이 스캔한 레코드가 무엇인지 보여주기 위해 필터 변수를 제거했습니다.



최적의 속도와 리소스 활용을 달성하기 위해 다음 기사에서 이를 개선할 것입니다.

우리는 스택에 더 많은 연결을 추가하고 새로운 구성을 만들어 다음 기사에서 더 유용하게 만들 것이므로 제 뉴스레터를 팔로우하고 구독하는 것을 고려하십시오.

⏭ 서버리스에 대한 다음 기사가 있습니다. 확인하십시오.

🎉 응원해주셔서 감사합니다! 🙏

☕ Buy Me a Coffee을 원하시면 제 노력을 😍.





🔁 원본 게시물 🔗Dev Post

🔁 Reposted at 🔗

🏄 AWS CDK 101 - 🐲 GraphQL using AppSync with dynamodb
{ by }

Checkout more such in my pagehttps://t.co/CuYxnKr0Ighttps://t.co/phzOKFlXXO https://t.co/yeqeLZQt8A

— Aravind V (@Aravind_V7)