[ASP.NET] Core Worker Service로 레드마인 일감을 시놀로지 챗 메시지로 알림 보내기

개발 배경

저는 회사에서 업무 관리를 위해 시놀로지 도커에서 레드마인을 사용하고 있습니다. 그리고 레드마인의 메일 설정을 통해 일감 생성, 편집 시 메일로 알림을 받고 있습니다. 메일의 경우 아웃룩으로 확인하고 있습니다. 그런데 지금까지 레드마인을 사용하면서 너무나 아쉬운 점이 있었습니다. 바로 알림을 즉시 확인할 수 없다는 것이죠

레드마인 알림이 있는지 확인하기 위해 아웃룩에서 직접 보내기/받기 버튼을 클릭하거나 시간 간격을 짧게 설정해야 했습니다. 하지만 PC에서는 이렇게 확인하면 되지만 스마트폰에서는 알림 받기가 쉽지 않습니다. 알림을 켜자니 수신되는 모든 메일에 대해 알림이 오니 영 불편했습니다

그래서 생각한 것이, '레드마인 일감이 생성되면 메신저로 알림을 줄 수 있지 않을까'입니다. 게다가 저는 사내 메신저로 시놀로지 챗(Chat)을 사용하고 있기 때문에, 챗으로 알림 메시지를 받길 원했습니다

그런데 역시나 안 되는 건 없더군요. 레드마인은 REST API를, 챗은 Incoming Webhook을 제공하고 있었습니다. 즉, 실시간으로 레드마인 REST API를 호출하여 신규 일감을 조회하고, 일감이 있다면 챗으로 메시지를 보내면 되는 것이죠!

구상도

ASP.NET Core Worker Service

그런데 문제가 있었습니다. '어디'에서 프로그램을 돌리느냐입니다. 처음에는 특정 컴퓨터에 프로그램을 실행해 무한 루프로 계속 돌릴지, 아니면 윈도우 서비스로 개발하여 컴퓨터가 켜지면 계속 돌아가게 할지 고민을 했었습니다. 그런데 생각해보니 저는 시놀로지 서버를 사용하고 있었습니다. 즉, 서버에 개발한 프로그램을 돌리면 되지 않을까 싶었죠. 그래서 알게 된 것이 ASP.NET Core였습니다.

ASP.NET Core는 Windows, macOS 및 Linux에서 인터넷 연결 앱을 동작할 수 있는 프레임 워크입니다. 그리고 C#을 지원합니다. 즉, 간단히 설명하면 제가 원하는 동작을 수행하는 코드를 빌드하고 그 결과물을 ASP.NET Core를 통해 서비스를 동작할 수 있다는 것입니다.

게다가 Visual Studio에서 제작 가능한 ASP.NET Core Worker Service(작업자 서비스) 템플릿은 장기간 실행되는 서비스 앱을 개발하기 위해 제공됩니다. 즉, 이번 구상과 같이 멈추지 않고 계속해서 돌릴 서비스를 제작하기 위한 프로젝트라는 것이죠.

개발 순서

이제 본격적으로 개발에 돌입하기에 앞서, '어떻게' 개발해 나갈 것인지 설명하겠습니다. 중간 중간 내용이 꽤 많아서 하위 포스팅을 첨부했습니다.

1. 테스트 프로그램

우선 레드마인 REST API와 시놀로지 챗 Incoming Webhook을 연동할 줄 알아야겠죠? 레드마인 REST API와 Incoming Webhook을 다루는 방법은 아래 링크를 참고하세요. 

[.Net] C# 레드마인 REST API 사용하는 방법(예제 포함)

[챗봇/.NET] C#에서 시놀로지 Chat에 챗봇 메시지 보내기(예제 포함)

2. Windows Docker with Worker Service

도커는 Windows와 Linux 운영체제 모두 지원하는데요. 최종 목표는 리눅스 기반의 시놀로지 도커이지만, 중간 검증을 위해 윈도우용 도커에서 먼저 테스트를 진행하려고 합니다. 그리고 도커에서 서비스를 구동하기 위해서는 Visual Studio에서 제공하는 작업자 서비스(Worker Service) 템플릿을 사용하면 됩니다.

이와 관련된 내용은 아래 링크를 참고하세요.

[ASP.NET] C# Windows Docker 용 작업자 서비스 만드는 방법

3. Synology Docker with Worker Service

윈도우 도커에서 검증이 됐다면, 시놀로지 도커에 이미지를 올리고 컨테이너를 실행하면 끝입니다. 여기서 Putty를 사용하여 시놀로지에 접속하는 과정이 있기 때문에 PuTTY 사용 방법도 숙지하시기 바랍니다.

[Synology NAS] 푸티(PuTTY)로 시놀로지 접속하는 방법

PuTTY 사용법도 익혔다면 리눅스 도커용 작업자 서비스 만드는 방법을 참고하세요.

[ASP.NET] C# 시놀로지 Linux Docker 용 작업자 서비스 만드는 방법​

동작 설계

현재 제가 사용하는 레드마인에는 타 부서에서 업무를 요청할 수 있는 '업무 요청' 프로젝트가 따로 있습니다. 타 부서 담당자들은 모두 이곳에서 일감을 생성하여 업무를 요청하게 됩니다. 그리고 처리된 일감은 해당 프로젝트에서 사라지게 됩니다.

이를 기반으로, 제가 생각한 서비스의 동작은 다음과 같습니다.
① 업무 요청 프로젝트에 존재하는 '처리되지 않은 일감'을 조회한다.
② 일감 번호를 기억하여 중복으로 메시지를 전달하지 않도록 한다.
③ 메신저로 일감 웹 사이트 주소와 제목을 메시지로 전송한다. 

아주 간단하죠? 이를 기반으로 코드 구현을 해보겠습니다.

서비스 동작

코드 구현

중간중간 확인해야 할 것들이 꽤 많았습니다. 그럼 본격적으로 프로젝트의 목표를 위한 핵심 코드 구현은 어떻게 되는지 살펴보겠습니다.

public class Worker : BackgroundService
{
	//신규 일감 알림 메시지 중복 방지를 위한 객체
	private Dictionary<int, string> _list = new Dictionary<int, string>();
	
    //... 생략...
    
    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            try
            {
            	//1초 마다 지연
                await Task.Delay(1000, stoppingToken);
				//현재 존재하는 일감 조회
                var issues = searchIssues();
                //존재하는 일감이 있다면
                if (issues != null)
                {
                    foreach (var issue in issues)
                    {
                        try
                        {
                        	//일감 번호와 제목을 _list에 추가
                            _list.Add(issue.Id, issue.Subject);
                            //시놀로지 Chat에 메시지 전송
                            notifyChatMessage(issue);
                        }
                        catch (Exception exc)
                        {
                        	//이미 _list에 일감 제목이 존재하면 예외로 처리
                            continue;
                        }
                    }
                }
				//현재 존재하는 일감이 없다면
                else 
                {
                	//모든 신규 일감을 Chat에 메시지를 보냈으므로,
                    //현재 존재하는 목록을 지운다(중복 방지)
                    if (_list.Count != 0)
                    {
                        _list.Clear();
                    }
                }
            }
            catch(Exception exc)
            {
                _logger.LogInformation(exc.Message);
            }
        }
    }
}

코드는 생각보다 아주 간단하고, 주석으로도 충분히 설명이 될 것 같습니다. 중간에 호출하는 searchIssues()는 레드마인 REST API 포스팅을, notifyChatMessage()는 Chat에 챗봇 메시지 보내기 포스팅을 참고하세요.

후기

실제 알림 화면

해당 서비스를 제작한 후 빠르게 업무 요청 일감을 관리하고 있습니다. 이전에는 다른 일을 하느라 바쁘면 메일 확인이 늦어 업무 확인이 늦어졌는데, 현재는 PC 또는 스마트폰으로 알림이 즉시 오니 바쁘더라도 빨리 확인하게 되어 업무 지연이 최소화되었습니다. 역시 불편하면 직접 만들어서 해결하는 것이 정답인 것 같습니다.