[Kotlin] Slack API로 슬랙 채널에 Message 발송하기

📎 Slack API로 슬랙 채널에 Message 보내기

안녕하세요, 이번 시간에는 슬랙에서 제공되는 API를 통해 Java 어플리케이션에서 Slack 채널에 메시지를 전송해보도록 하겠습니다.

 

프로젝트를 운영하다보면 특정 문제(로그, 에러, 메모리, 배치 실패 등)가 발생했을 때 이러한 문제점을 바로 확인할 수 있도록 장애에 대해서는 알림을 받아 문제를 확인하는 것이 중요하다고 생각하는데요, 이러한 알림 중 하나가 슬랙을 활용하는 방법입니다.

슬랙의 경우 많은 기업에서 사용하고 있고, 또한 굉장히 많은 기능을 제공하고 있는데요, 이러한 기능을 활용하면 무궁무진하게 커스텀을 할 수 있을 것 같습니다.

 

해당 포스팅에서는 슬랙을 다운받거나 회원가입하는 등의 기본적인 설정을 제외한 슬랙에 메세지를 발송하기 위한 설정부터 발송 코드까지 처음부터 끝까지 살펴보겠습니다.

 

 

Slack App 생성

다음 사이트에서 Create New App을 통해 App을 생성해줍니다.

(슬랙을 가입하거나 생성하는 등 초기 단계는 따로 설명하지 않습니다. 슬랙 채널은 기본으로 public으로 생성하였으나 private로 생성하여도 방법은 있습니다. 아래에서 설명드릴게요.)

좌측 사진은 기존에 App을 생성한 경우가 있는 화면이고, 우측 사진은 App을 처음 생성하는 화면입니다.

 

 

다음으로 From scratch를 클릭합니다.

 

 

App Name과 workspace를 설정하고 Create App을 클릭하여 앱을 생성합니다.

(workspace의 경우 슬랙에서 알림을 받고자 하는 워크페이스를 선택하시면 됩니다.)

 

 

Scopes 설정 및 Token 발급

그럼 위와 같은 초기화면이 나올텐데요, OAuth Tokens를 발급받기 위해 OAuth & Permissions를 클릭합니다.

 

권한(Authentication)에 대해 궁금하시다면 아래 링크를 참고해주세요 😃

• https://api.slack.com/authentication

 

위 화면에서 OAuth Scope를 설정합니다.

저는 channels:read, chat:write, users:write를 선택했는데요,

• channels:read - 워크스페이스의 public 채널에 대한 정보 보기
• chat:write - SlackApi로 message 발송
• users:write - SlackApi를 위한 presence(?) 설정

슬랙 채널에 메시지를 보내기 위해서는 chat:write는 반드시 추가를 해야합니다.

위 설정 외에도 더 많은 설정들이 존재하는데요, 자세한 사항은 문서에서 확인할 수 있습니다 :)

 

 

+ 혹시 슬랙 채널을 private로 설정하실 경우, groups:read Scope를 추가적으로 설정해주셔야 합니다.

 

 

OAuth Scope 설정을 마친 후 위로 올라가서 Install to Workspace를 클릭하여 OAuth Tokens을 발급받습니다.

※ Token은 인증키로 사용될 용도니 반드시 외부로 노출해서는 안되며 개인보관을 해야 합니다.

Slack의 Bot Token은 xoxb- 형식입니다.

 

 

Slack에 앱 설정

다음으로 위에서 생성한 Slack App을 채널에서 직접 앱을 등록합니다.

• 알림을 받고자 하는 채널 우클릭 > 채널 세부정보 열기 > 통합 > 앱 추가 클릭
• 위에서 설정한 워크스페이스(SlackApi) 추가

 

알림을 설정받을 Channel ID 값 얻기

이곳에 접근하여 위에서 얻은 Bot Token인 xoxb~의 토큰값을 위 빨간색 네모박스에 설정하고 하단에 Test method 버튼을 클릭하여 슬랙의 정보를 확인합니다.

 

그럼 위와 같이 슬랙의 정보를 확인할 수 있습니다.

id가 슬랙 메시지에 발송할 때 필요한 채널의 id이고, 바로 아래 name은 슬랙 채널명 입니다.

id값은 코드 작성할 때 필요한 값이므로, 발송할 채널의 id값을 따로 보관합니다.

 

 

+ 혹시 private 채널을 확인하고 싶은 경우, 위에서 Scope에 groups:read를 설정하신 후

types에 private_channel를 입력하면 정보를 확인할 수 있습니다.

 

슬랙 채널에 Message 발송하기

여기까지 하셨으면 슬랙에 메시지를 발송하기 위한 셋팅은 끝입니다.

이제 Kotlin 코드를 작성하여 슬랙에 메시지를 보내보겠습니다.

(테스트 하기 위한 코드이므로 코드또한 굉장히 단순한데요 실제로는 투표와 같은 버튼을 발송하거나, 이미지, 파일, 메일발송 등 다양하게 커스텀하여 메세지를 발송할 수 있습니다.)

 

먼저 slack-api-client 라이브러리 의존성을 추가합니다.

// Gradle
implementation("com.slack.api:slack-api-client:1.20.2")

// Maven
<dependency>
    <groupId>com.slack.api</groupId>
    <artifactId>slack-api-client</artifactId>
    <version>1.20.2</version>
</dependency>

 

다음으로 테스트를 보내기 위한 코드를 작성합니다.

interface SlackService {
    fun sendMessage(text: String)

    fun sendMessage(channel: String, text: String)
}


import com.slack.api.Slack
import org.slf4j.LoggerFactory
import org.springframework.beans.factory.annotation.Value
import org.springframework.stereotype.Service

@Service
class SlackServiceImpl : SlackService {

    private val log = LoggerFactory.getLogger(javaClass)

    @Value("\${slack.bot.token}")
    lateinit var token: String

    @Value("\${slack.monitor.channel.token}")
    lateinit var defaultChannel: String

    override fun sendMessage(text: String) {
        sendMessage(defaultChannel, text)
    }

    /**
     * Send Slack Alarm
     */
    override fun sendMessage(channelId: String, text: String) {
        val client = Slack.getInstance().methods()
	runCatching {
            client.chatPostMessage {
                it.token(token)
                    .channel(channelId)
                    .text(text)
            }
        }.onFailure { e ->
            log.error("Slack Send Error: {}", e.message, e)
        }
    }
    
    /**
     * Slack Channel name, id list
     */
    fun showSlackInfo() {
        val client = Slack.getInstance().methods()
        var result: ConversationsListResponse = ConversationsListResponse()
        kotlin.runCatching {
            result = client.conversationsList {
                it.token(token)
            }
        }.onSuccess {
            result.channels.stream().forEach {
                log.info("{} -> {}", it.name, it.id)
            }
        }
    }
}

• https://api.slack.com/messaging/sending

사이드 프로젝트를 Kotlin으로 진행중이기 때문에 스프링과 코틀린을 사용하여 예제 코드를 작성했지만 간단히 테스트하는 코드이기 때문에 자바로 변환하여 사용하도 무관할 듯 합니다.

(runCatching의 경우 Java에서의 try-catch 구문입니다.)

 

token, defaultChannel의 경우 위에서 설정한 Bot Token(OAuth Token)과 channel id 값을 설정해주면 됩니다.

 

sendMessage() 메소드의 경우 2개의 메소드를 만들었는데요, 현재는 알림을 받을 채널이 한개만 존재하지만, 추후 채널이 추가된다면 직접 channel의 id를 파라미터로 받기 위해 추가적으로 만들었습니다.

 

또한 SlackService를 인터페이스로 만들고 이를 구현하도록 SlackServiceImpl 클래스를 생성해주었는데요, 이는 프로젝트를 운영중인 서버에서 외부 호출을 할 때 프록시 서버 등을 통해 경유할때 추가적으로 구현하여 사용할 수 있도록 인터페이스를 사용했습니다.

 

마지막으로 showSlackInfo() 메소드의 경우 sendMessage() 메소드에서 사용될 슬랙 채널의 정보를 얻을 수 있습니다.

(위에서 conversations.list 에서 확인하는 것과 동일합니다.)

 

실제 위 sendMessage() 메소드에 text 메세지를 인자로 전달해서 테스트해보면 위와 같이 슬랙에 알림이 오는것을 확인할 수 있습니다.

 

 

정리

이상으로 Slack Api를 통해 슬랙 채널에 메시지를 보내는 방법에 대해 알아보았습니다.

슬랙은 굉장히 다양한 서비스와의 연동이 가능하기 때문에 대부분의 알림을 슬랙을 통해 받고 있는데요, 이러한 알림은 프로젝트 운영에 있어 거의 필수적인 부분이라고 생각합니다.

 

하지만, 너무나 많은 서비스에 알림 설정을 할 경우 이 또한 관리 포이트가 많아지는 경우가 생길 수 있기 때문에, 서비스가 커진다면 서비스의 상황에 맞게 반드시 필요한 알림만 설정하여 받을 수 있도록 하는것이 좋을 것 같습니다 😃