
## 해당 글이 필요한 독자

- SEO의 중요성을 알고, 구글 검색 시에 어떤 결과가 나타나는지 API로 가져오고 싶은 사람
- 원하는 키워드와 함께 검색된 키워드들을 API로 가져오고 싶은 사람 

## 구글 검색 결과를 API로 가져오는 방법

구글은 따로 검색 결과에 대한 API를 제공하지 않습니다. 
하지만, [Serp Api](https://serpapi.com/)를 이용하면 구글 검색 결과를 API로 가져올 수 있습니다.

무료 계정의 경우 달마다 100건의 검색 결과를 가져올 수 있습니다.

<MDXImage 
    src="/how-to-get-google-search-result/site.png"
    alt="serpapi site"
    width={3680}
    height={2382}
    maxWidth={900}
/>

먼저, 오른쪽 위 `Register`를 클릭하여 계정을 생성합니다.

그 뒤 진입하는 `Dashboard`에서 가운데 `Playground`를 클릭하여 API를 테스트할 수 있는 페이지로 이동합니다.

<MDXImage
    src="/how-to-get-google-search-result/dashboard.png"
    alt="serpapi dashboard"
    width={3680}
    height={2382}
    maxWidth={900}
/>

`Playground`에서는 검색을 원하는 `Keyword`와 filter 값들을 입력할 수 있습니다.
검색한 뒤 오른쪽 JSON 파일을 통해 제대로 결과가 왔는지 확인할 수 있습니다.

가장 편한 점은 우측 상단에 `Export To Code`를 클릭하면 각각의 언어에 맞게 어떻게 사용하면 될지 표시 됩니다.

<MDXImage
    src="/how-to-get-google-search-result/available-language.png"
    alt="available-languages"
    width={308}
    height={574}
    maxWidth={300}
/>

`Python`, `Node.js`, `Go` 등 다양한 언어를 지원하고 있는 것을 알 수 있습니다.
저는 `Python`에서 사용할 예정이니 이에 대한 예시를 들고 옵니다.

```python
from serpapi import GoogleSearch

params = {
  "api_key": "---sensitive information---",
  "engine": "google",
  "q": "Chavo Kim",
  "location": "South Korea",
  "google_domain": "google.co.kr",
  "gl": "kr",
  "hl": "ko"
}

search = GoogleSearch(params)
results = search.get_dict()
```
 
다음과 같이 results를 얻을 수 있는 코드를 생성해줍니다.

`💡 API key의 경우 개인 정보이기 때문에 github 등 공개적으로 코드를 올릴 때는 조심하시기 바랍니다.`

Python에서 library를 사용하기 위해 아래 명령어로 설치해줄 수 있습니다. ([깃헙링크](https://github.com/serpapi/google-search-results-python))

```python
pip install google-search-results
```

위의 코드를 Python에서 실행해주면 Playground와 똑같은 results를 얻을 수 있습니다.



구글 검색 기록 API로 가져오는 방법 (feat. SerpApi)


## CQRS가 왜 필요한가요?

다음과 같은 상황을 가정해봅시다.

- 당신은 개발자 포트폴리오 사이트 `devfolio`를 만들고 있습니다.
- `devfolio`에는 개발자들이 자신들의 `깃헙`, `링크드인`의 계정을 연결하고, 해당 계정의 정보를 들고 올 수 있습니다.
- 두 사이트 모두 `계정 이름`, `프로필 사진`, `소개글`, `등록한 웹사이트` 등의 정보를 가지고 있습니다.

웹 개발자라면 `social_profile_info`라는 개념적 데이터 모델을 만들고,
이를 CRUD 할 수 있는 API를 만들어서 사용할 것입니다.

<MDXImage 
    src={"/what-is-cqrs/crud-example.png"}
    alt="CRUD Example"
    width={2880}
    height={2160}
    maxWidth={900}
/>

`Github`에서 제공해주는 API에서의 변수와 `Linkedin`에서 제공해주는 API에서의 변수가 다를 수 있습니다.
(실제 API와는 전혀 다릅니다.) 제품을 출시할 당시에는 위의 그림과 같이 응답이 왔고, 이를 받은 뒤
서버에서 변수명을 변환한 뒤 정보를 저장했습니다.

그런데 어느 날,

- `Github`에서 제공해주는 API의 변수명이 바뀌었습니다.

그래서 Github에서 제공해주는 API를 사용하는 `devfolio`의 서버에서는
오류가 발생했습니다.

<MDXImage
    src={"/what-is-cqrs/crud-error.png"}
    alt="CRUD Error about Github API"
    width={1920}
    height={1080}
    maxWidth={900}
/>

서버의 코드를 수정하고 다시 배포합니다.  
사이트 배포 뒤 반응이 좋아 이번에는 `Github`, `Linkedin`뿐만 아니라

- `Discord`, `Slack`, `Rocket Punch` 등의 계정도 연결할 수 있게 되었습니다.

API가 수정되는 일이 점점 더 빈번해지고, 변경되는 시점마다 해당 기능이 동작하지 않고 심하게는 사이트가 다운되는 일이 발생합니다.
당신은 이 문제를 해결하기 위해 다음과 같은 방법을 생각해냅니다.

- 각 계정의 정보를 업데이트해주는건 응답된 JSON 파일 그대로 업데이트하고, 이후에 웹사이트에서 보여줄 때는 필요한 정보만 추출해서 보여주면 어떨까?

다음과 같이 데이터베이스 업데이트와 읽기의 책임을 분리하기 위해 나온 것이 **CQRS**입니다.

## CQRS란 무엇인가요?

CQRS(Command Query Responsibility Segregation)는 CUD(Create, Update, Delete) 로직을
처리하는 `Command`와 Read 로직을 처리하는 `Query`를 분리하는 패턴입니다.

위의 예시에서는 `데이터베이스에 각 계정 정보를 업데이트한다`라는 `Command`와
`서비스에서 각 계정 정보를 보여준다`라는 `Query`를 분리하는 것으로 예시를 들 수 있습니다.

예시에는 같은 데이터베이스에서 쓰기와 읽기의 데이터 모델을 분리하는 식으로 구현했지만, 아예 데이터베이스 자체를 분리하는 방법도 있습니다.
예를 들어 쓰기 전용 데이터베이스는 `MySQL`을 사용하고, 읽기 전용 데이터베이스는 `Elasticsearch`를 사용하는 방법도 있습니다.

<MDXImage
    src={"/what-is-cqrs/cqrs.png"}
    alt="CRUD Error about Github API"
    width={1920}
    height={1080}
    maxWidth={900}
/>

이러한 경우에는 `Command`와 `Query`의 데이터베이스가 다르기 때문에, 이 둘의 일관성(데이터 동기화)을 유지하기 위해
`Event Sourcing`을 사용하여 그 둘을 동기화시켜 주기도 합니다.

`Event Sourcing`은 `Command`가 들어올 때마다 `Event`를 발생시켜 해당 `Event`를 `Query`가 읽어서 데이터를 업데이트하는 방식입니다.
보통 해당 이벤트를 큐에다 저장해두고 이를 `Query`가 읽어서 데이터를 업데이트하는 `public`/`subscribe` 패턴을 사용합니다.

[Pub/Sub 패턴에 대한 정보](/blog/practical-websocket#3.%20WebSocket%20서버%20Scaling하기)는 웹소켓 관련 글에서 다룬 바 있습니다. :)

## CQRS의 장단점은 무엇인가요?

CQRS는 다음과 같은 장점을 가지고 있습니다.

- `Command`와 `Query`를 분리함으로써, `Command`의 로직이 변경되어도 `Query`의 로직에는 영향을 주지 않습니다.
- 위의 사례처럼 여러 타입의 쓰기가 들어와도 `Command`의 로직을 변경하지 않아도 되어 유연하게 확장이 가능합니다.
- `Command`와 `Query`의 로직이 분리되어 있기 때문에, 각각의 로직을 최적화하기도 쉽습니다.

CQRS는 다음과 같은 단점을 가지고 있습니다.

- `Command`와 `Query`의 로직이 분리되어 있기 때문에, CRUD에 최적화된 ORM을 사용할 때는 오히려 코드를 추가하여 복잡성이 증가합니다.
- `Event Sourcing`을 비동기로 구현하는 경우 Command에서 업데이트한 데이터가 Query에서 바로 반영되지 않습니다. (일정 시간이 지나야 반영됩니다.)

## CQRS를 사용해야 할까요?

위와 같은 장단점때문에 CQRS는 모든 서비스에 적용하기에는 적합하지 않습니다.
하지만 특정 서비스에서는 CQRS를 적용하는 것이 복잡도를 훨씬 낮춰줄 수 있습니다.
CQRS를 적용해야 하는 서비스의 예시는 다음과 같습니다.

- 읽기 수가 쓰기 수보다 훨씬 많아서 읽기 로직을 최적화 해야하는 경우 둘을 분리할 수 있습니다.
- 쓰기에 대한 비즈니스 규칙이 자주 바뀌는 경우 CQRS를 사용해서 복잡성을 줄여줄 수 있습니다.
- Microservice Architecture에서는 CQRS를 사용해서 각 서비스의 데이터 모델을 분리할 수 있습니다.

## Reference

- [CQRS](https://martinfowler.com/bliki/CQRS.html)
- [CQRS 패턴](https://learn.microsoft.com/ko-kr/azure/architecture/patterns/cqrs)
- [A Beginner's Guide to CQRS](https://www.eventstore.com/cqrs-pattern)

CQRS는 무엇인가요? (Command Query Responsibility Segregation)

2023년 2분기 회고글


## 왜 이 글을 쓰게 되었는가?

아래는 제 블로그의 [서치 콘솔](https://search.google.com/search-console/about)입니다.

<MDXImage 
    src={"/birthday-slack-app/search-console.png"}
    alt="Search console"
    width={723}
    height={1145}
    maxWidth={500}
/>

대부분의 분들이 저의 [Slack과 Google Docs로 연차관리 자동화하기](/blog/vacation-system-automation-with-slack)를
보고 찾아오셨습니다. :)  
코드 없이 슬랙과 스프레드시트만으로 자동화를 할 수 있다는 것이 매력적이었던 것 같습니다.
그래서 이번에는 글또 8기에서 생일 축하 알림을 슬랙으로 보내는 앱을 만든 경험을 공유하고자 합니다.

이미 [BirthdayBot](https://awsstartuptow-il91477.slack.com/apps/A0QAZV90X-birthdaybot)이 존재하지만,
30명 이상이 넘어가는 경우 인당 1.59 달러에 해당하는 돈을 내야했기 때문에 `스프레드시트의 앱스크립트 기능`과 `슬랙 인커밍웹훅`을 사용해서 직접 만들어보기로 했습니다.

<MDXImage
    src={"/birthday-slack-app/gukbab.png"}
    alt="Gukbob"
    width={2948}
    height={1416}
    maxWidth={500}
/>
<div className="text-center">
    이미지 출처: <a href="https://jjikkyu.github.io/gukbap/">국밥계산기</a> <br />
</div>



## 슬랙 인커밍웹훅(Incoming Webhooks)

[슬랙 인커밍웹훅](https://awsstartuptow-il91477.slack.com/apps/A0F7XDUAZ-incoming-webhooks)은 슬랙에서 제공하는 기능으로, 
**HTTP request**를 통해 슬랙 채널에 메시지를 보낼 수 있습니다.

1. `Add to Slack` 버튼을 눌러서 슬랙 워크스페이스에 앱을 추가합니다.

<MDXImage
    src={"/birthday-slack-app/add-to-slack.png"}
    alt="Add to slack"
    width={2160}
    height={1074}
    maxWidth={500}
/>

2. 메세지를 남기길 원하는 채널을 선택한 후 `Add Incoming WebHooks integration`을 클릭합니다.

<MDXImage
    src={"/birthday-slack-app/incoming-webhooks-integration.png"}
    alt="Add to slack"
    width={1976}
    height={664}
    maxWidth={500}
/>

3. `Webhook URL`을 복사합니다.

<MDXImage
    src={"/birthday-slack-app/webhook-url.png"}
    alt="Add to slack"
    width={2014}
    height={814}
    maxWidth={500}
/>

## 스프레드시트 앱스크립트(Spreadsheet App Script)

[스프레드시트 앱스크립트](https://developers.google.com/apps-script)는 구글에서 제공하는 기능으로,
구글 스프레드시트에서 자바스크립트를 사용할 수 있게 해줍니다.  
그리고 **트리거**를 이용해서 해당 함수를 정해진 시각에 실행할 수 있습니다.

1. 구글 스프레드시트를 만듭니다. [예시](https://docs.google.com/spreadsheets/d/1jaTNcl86cIGxyWuzdXXjy82ADrVLOxYPIfcgUKFmkhk/edit#gid=0)는 다음과 같습니다.

2. `Extensions > Apps Script`(확장 프로그램 > Apps Script)를 클릭합니다.

<MDXImage
    src={"/birthday-slack-app/apps-script.png"}
    alt="Apps script"
    width={1590}
    height={710}
    maxWidth={500}
/>

3. `Code.gs`를 클릭한 뒤, 다음과 같은 함수를 넣어줍니다.

```js
// 본인의 스프레드시트 아이디를 넣어주세요.
// 스프레드시트 아이디는 스프레드시트 링크에서 https://docs.google.com/spreadsheets/d/1jaTNcl86cIGxyWuzdXXjy82ADrVLOxYPIfcgUKFmkhk/edit#gid=0
// d/부터 다음 /까지가 구글스프레드 시트의 id값입니다.
const spreadsheetId = "1jaTNcl86cIGxyWuzdXXjy82ADrVLOxYPIfcgUKFmkhk";

// 발급받은 Webhook URL을 넣어주세요.
const webhookURL = "https://hooks.slack.com/services/......";

const range = SpreadsheetApp.openById(spreadsheetId).getRange("생일!A1:B"); 

function isValidDate(d) {
  if ( Object.prototype.toString.call(d) !== "[object Date]" )
    return false;
  return !isNaN(d.getTime());
}

function getBirthdayMap() {
  const birthdayMap = {}

  const rowNum = range.getNumRows();
  for(let i = 2; i <= rowNum; i++) {
    const nameCell = range.getCell(i, 1);
    if(nameCell.isBlank()) {
      break;
    }

    const date = range.getCell(i, 2).getValue();

    if(isValidDate(date)) {
      const dateKey = date.toLocaleDateString(undefined, {
        month: "2-digit",
        day: "2-digit",
      });

      if(birthdayMap[dateKey]) {
        birthdayMap[dateKey].push(i)
      } else {
        birthdayMap[dateKey] = [i, ]
      }
    }
  }

  return birthdayMap;
}

function sendMessageToSlack(today, birthdayMembers) {
  const todayDateKey = Utilities.formatDate(today, "KST", "yyyy-MM-dd");

  let text = "";

  if(birthdayMembers)
    text = birthdayMembers.reduce((acc, rowNum) => acc + "@" + range.getCell(rowNum, 1).getValue().toString() + " ", "");
  // 생일이 아닐 경우 출력할 메세지를 입력합니다.
  else
    text = "오늘 생일인 사람이 존재하지 않습니다. :)";

  // 여기에서 전송될 메세지 양식을 바꿔줄 수 있습니다.
  // 아래 링크에서처럼 다양한 포맷을 통해 메세지를 전송해줄 수 있습니다.
  // https://api.slack.com/messaging/webhooks#advanced_message_formatting
  const message = {
    "attachments":[
        {
          "color":"#2eb886",
          "fields":[
              {
                "title":`생일 축하드려요. 🥳 (${todayDateKey})`,
                "value":`${text}\n\n🙌`,
                "short":false
              }
          ]
        }
    ]
  }

  var options = {
    'method' : 'post',
    'contentType': 'application/json',
    // Convert the JavaScript object to a JSON string.
    'payload' : JSON.stringify(message)
  };

  UrlFetchApp.fetch(webhookURL, options);
}

function sendBirthdayMessage() {
  const birthdayMap = getBirthdayMap();

  const today = new Date();

  const todayDateKey = Utilities.formatDate(today, "KST", "MM/dd");

  const birthdayMembers = birthdayMap[todayDateKey];

  sendMessageToSlack(today, birthdayMembers);
}
```

3. `Save Project`를 클릭한 뒤, 왼쪽 Nav Bar에서 `Triggers`를 클릭합니다.

<MDXImage
    src={"/vacation-system-automation-with-slack/trigger.png"}
    maxWidth={400}
    width={712}
    height={515}
    alt={"trigger"}
/>

4. `Add Trigger`를 클릭한 뒤, 아래와 같이 설정합니다.

<MDXImage
    src={"/birthday-slack-app/trigger.png"}
    maxWidth={400}
    width={1466}
    height={1674}
    alt={"trigger"}
/>

`Select time of day` 설정을 바꿔서 언제 메세지를 보낼지 설정할 수 있습니다.

5. `Save`를 클릭합니다.

Save를 클릭하면 권한을 승인하기 위한 로그인 화면이 뜹니다.

<MDXImage
    src={"/vacation-system-automation-with-slack/verification-error.png"}
    maxWidth={400}
    width={599}
    height={496}
    alt={"verification-error"}
/>

로그인을 하면 위와 같은 에러가 뜰텐데, 당황하지 않고 `Advanced > Go to ExampleOfSendBirthdayMessage (unsafe)`를 클릭합니다.
그러면 권한 제공 승인을 진행할 수 있습니다. :)

이제 매일 트리거에 설정한 시간에 슬랙으로 생일 축하 메세지가 전송됩니다. 🥳

잘전송되는지 확인하고 싶다면, 왼쪽 Nav Bar에서 `Editor`를 클릭한 뒤, `Run`을 클릭하면 됩니다.

<MDXImage
    src={"/birthday-slack-app/run.png"}
    maxWidth={400}
    width={1618}
    height={1124}
    alt={"run"}
/>

Voila!

<MDXImage
    src={"/birthday-slack-app/message.png"}
    maxWidth={400}
    width={974}
    height={374}
    alt={"message"}
/>

6. (Optional) 슬랙 메세지를 보낼 때, 슬랙 봇의 이름을 바꾸고 싶다면,
인커밍 웹훅 (설정 페이지)[https://chavodev.slack.com/apps/A0F7XDUAZ-incoming-webhooks?tab=settings&next_id=0]
으로 가서 `Customize Name`과 `Customize Icon`을 바꿔주면 됩니다.

<MDXImage
    src={"/birthday-slack-app/configuration.png"}
    maxWidth={400}
    width={1496}
    height={952}
    alt={"configuration"}
/>

## 마치며

이번 포스팅에서는 구글 스프레드시트와 슬랙을 이용해서 생일 축하 메세지를 자동으로 보내는 방법을 알아봤습니다.  
생각보다 간단하게 구현할 수 있었는데, 해당 아이디어를 바탕으로 또다른 원하는 자동화를 구현할 수 있을 것 같습니다.

이번 포스팅이 도움이 되셨다면, 좋아요와 댓글 부탁드립니다. 🙏
읽어주셔서 감사합니다~!


Chavo Kim: Specialist in Generalist