<Infra> Spring Slack 메세지 전송 (Incoming Webhook)

📌 슬랙 연결 방법 선택

구현할 기능이 메세지 전송이기 때문에 위 방법 중에서, Web API 혹은 Webhook을 사용할 수 있다.

• Slack API: Slack에서 제공하는 다양한 기능(메세지, 채널 관리, 파일 업로드, 유저 정보)을 사용할 수 있는 인터페이스이다. Slack API를 사용하는 경우 API 토큰이 필요하며, 해당 토큰을 사용하여 인증 및 권한 부여를 받아야 한다.
• Slack Incoming Webhook: Slack Incoming Webhook은 새로운 메시지를 특정 채널에 자동으로 게시할 수 있는 방법이다. Incoming Webhook을 생성한 후 Webhook URL을 사용하여 새로운 메시지를 게시할 수 있다. Webhook URL은 인증 및 권한 부여가 필요하지 않으며, 누구나 사용할 수 있다.

위와 같은 특징을 지니는데, 메세지 전송만을 하기엔 webhook으로 하는 것이 더 유리하다 생각하여 webhook을 사용할 예정이다.

 

📌 워크 스페이스 및 APP 생성

🔺 워크 스페이스 생성

좌측 바에서 + 누르고 생성하면 됨

🔺 APP 생성

Slack api 페이지이다.

여기서 진행하면 된다.

SlackApi

Slack API: Applications | Slack

여기서 Create App 누르고 from scratch

이름 적고, 사용할 워크 스페이스 정하고 create 진행

🔺 APP 권한 설정

Basic Infomation 메뉴로 들어와서 Permission으로 이동

\

내려보면 Scope 나오는데,

여기서 Bot Token Scope 수정

채널에 글을 작성해야하므로 chat:write 추가

🔺 APP 토큰 발행 및 워크 스페이스에 봇 추가

토큰 발행 먼저 한다.

slack 앱으로 돌아가서 채널 세부정보 보기 클릭

앱 추가 → app 찾은 후 추가

그러면 완료

---

📌 스프링 환경 셋팅

🔺 dependency 추가

implementation("com.slack.api:slack-api-client:1.28.0")

slack api 사용위해 설치

🔺 application.yml 설정

slack:
  token: '토큰'
  channel:
    monitor: '채널 명'

워크 스페이스 이름 아님 주의

---

📌 슬랙 연결

🔺 Incoming Webhook 설정

채널 세부정보 보기 → 통합 → 앱 추가

incoming webhook 찾아서 설치

채널 찾아서 앱 추가

그러면 Webhook url 보임

그리고 테스트 코드를 제공한다.

curl -X POST --data-urlencode "payload={\\"channel\\": \\"#test\\", \\"username\\": \\"webhookbot\\", \\"text\\": \\"이 항목은 #개의 test에 포스트되며 webhookbot이라는 봇에서 제공됩니다.\\", \\"icon_emoji\\": \\":ghost:\\"}" <https://hooks.slack.com/services/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>

이걸 테스트 해보면

정상적으로 전송된 경우 ok라는 응답을 보이며

메세지를 받을 수 있다.

 

---

📌 스프링 코드 구현

🔺 Slack 알림 구현

eventlistener를 이용하여 구현했다.

// Event.java

public class Event {
    private static ApplicationEventPublisher publisher;

    static void setPublisher(ApplicationEventPublisher publisher) {
        Event.publisher = publisher;
    }

    public static void raise(Object event) {
        if (publisher != null) {
            publisher.publishEvent(event);
        }
    }
}

이벤트 발생과 출판을 위해 ApplicationEventPublisher 를 사용한다.

Event 라는 클래스를 만들어서 이벤트를 편하게 발생할 수 있도록 했다.

// EventConfig.java

@Configuration
public class EventConfig {
    @Autowired
    private ApplicationEventPublisher applicationEventPublisher;

    @Bean
    public InitializingBean eventsInitializer() {
        return () -> Event.setPublisher(applicationEventPublisher);
    }
}

Event 클래스를 초기화해준다.

// SlackService.java

@Service
@RequiredArgsConstructor
public class SlackService {
    public void SlackTest() {
        Event.raise(new TestEvent(100));
    }
}

Event.raise() 를 통해 이벤트를 발생시킨다

raise 함수의 인자로 TestEvent 라는 객체가 전달되는데, 이는 이벤트에 필요한 정보를 전달해주는 역할을 한다.

// TestEvent.java

@AllArgsConstructor
@Getter
public class TestEvent {
    private int number;
}

TestEvent 는 일반적인 객체이다.

// SlackSendMessageHandler.java

@Component
public class SlackSendMessageHandler {
    @Value("${slack.webhook.url}")
    String url;

    @Async
    @EventListener(TestEvent.class)
    public void handle(TestEvent testEvent) {
        final Slack slack = Slack.getInstance();
        final Payload payload =
                Payload.builder().text(Integer.toString(testEvent.getNumber())).build();

        String responseBody = null;
        try {
            responseBody = slack.send(url, payload).getBody();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }
}

raise 함수를 통해 publishEvent 함수가 실행되면, EventListener 를 통해 handle 함수가 작동한다.

payload 에 보낼 내용을 적은 후, send 함수를 통해 전송하면 된다.

성공!!

🔺 유저 정보 및 Markdown 편집

메세지를 보내는데 성공했지만, 유저 정보와 내용을 편집하고싶다.

해보자!

1. 유저 정보 편집

final Payload payload = Payload.builder()
	                        .text(Integer.toString(testEvent.getNumber()))
	                        .username("유저")
	                        .iconEmoji(":dog:")
	                        .build();

Payload 에 설정을 하면 가능하다.

1. markdown 편집

final Payload payload = Payload.builder()
	                        .text(Integer.toString(testEvent.getNumber()))
	                        .username("유저")
	                        .iconEmoji(":dog:")
	                        .blocks(blocks)
	                        .build();

private List<LayoutBlock> SlackMessageConverter(TestEvent testEvent) {
    List<LayoutBlock> layoutBlocks = new ArrayList<>();
    // 제목
    layoutBlocks.add(HeaderBlock.builder().text(plainText("제목")).build());
    // 구분선
    layoutBlocks.add(new DividerBlock());
    // text
    MarkdownTextObject messageText = MarkdownTextObject.builder()
            .text(Integer.toString(testEvent.getNumber()))
            .build();
    layoutBlocks.add(SectionBlock.builder().text(messageText).build());
    return layoutBlocks;
}

마크다운 오브젝트가 Slack Api에 포함되어 있기 때문에,

이들을 조합하면 된다.

아래 사이트를 참고하자!

Slack Block Builder

Slack

---