시나공공

작년에 클라이언트 프로그램에서 이슈가 발생했을 때 사용자에게 문자를 보내줘야하는 기능을 개발 해야했는데 

SMS는 돈주고 사야하므로 유료이므로 난 그럴 능력이 없으므로 텔레그램 봇을 개발했었다. 

그때는 "NetTelegramBotApi"라는 라이브러리를 사용해 개발을 했었는데

지금 글을 쓰려고 다시 찾아보니 Nuget에 더 좋은 라이브러리가 있었다.

"NetTelegramBotApi"는 패스 

Nuget에서 telegram을 검색하면 제일 위에 나오는 "Telegram.Bot"라이브러리를 써보자.

 <- 요놈 받으면 된다.

일단 개발해보기에 앞서 Telegram Bot을 만들려면 API access 키를 발급 받아야 한다.

어려울거 하나 없다.

핸드폰 보랴 모니터 보랴 왔다갔다 하지말고 https://web.telegram.org/ 에 들어가서 봇을 추가하자.

1. BotFather를 찾아라.

BotFather를 클릭하면 아래와 같이 화면이 바뀐다.

Start 버튼을 클릭하자.

그럼, 봇아빠가 알아듣는 커맨드가 쭈루룩 나온다. 그걸 잘 읽어보면 봇을 만들 수 있다.

2. Bot을 추가해라.

봇아빠에게 /newbot 이라고 입력하자.

그럼 이름을 말하라고 한다.

원하는 봇의 이름을 입력하자.

주의할점은 끝에 _bot 또는 Bot이 꼭 들어가야 한다. 안그러면 안만들어쥼

이름을 잘 입력해서 만들면 access token을 바로 똭하고 준다.

/// 그 외 다양한 커맨드가 있으니 한번씩 해보세요. 재밌어요.

3. Access Token을 받아 개발을 해보자.

그럼 access token을 복사해서 봇을 만들어 보자.

* 참고 

Telegram 홈페이지 Telegram Bot API : Telegram API Doc

Telegram.Bot 라이브러리 도큐먼트 : Telegram.Bot dll Doc

Telegram.Bot 라이브러리 예제 : Telegram.Bot Example  << 예제를 보면 다양한 케이스가 많다. 사진, 음성, 위치접근, 연락처, 등등

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////만들어 보자

나는 C# 콘솔 응용 프로그램 으로 만들었다.

    class Program
    {
        static void Main(string[] args)
        {
            /// 봇 접근 함수 호출
            testAPIAsync();
            Console.ReadLine();
        }

        /// 비동기 봇 접근
        static async void testAPIAsync()
        {
            var Bot = new Telegram.Bot.TelegramBotClient("봇 아빠가 준 access token을 넣어요.");
            var me = await Bot.GetMeAsync();
            // 올바르게 접속이 되면 봇 이름이 출력된다.
            System.Console.WriteLine("Hello my name is " + me.FirstName);
        }
    }

위 소스를 실행 하면 다음과 같은 결과 화면을 볼 수 있다.

간단하게 봇을 실행 시키는 것까지 성공했다.

하지만 내가 해야할 것은 이벤트가 생겼을 때 telegram 봇이 사용자에게 메세지를 전송 하거나, 

사용자로 부터 명령을 받아 DB를 바꾼다던지, DB를 조회해 정보를 보여준다던지 등의 작업을 해야한다.

아래 소스를 하나씩 따라가보자.

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

///텔레그램 dll using
using Telegram.Bot;
using Telegram.Bot.Types;
using Telegram.Bot.Types.Enums;
using Telegram.Bot.Types.ReplyMarkups;

namespace telegram
{
    class Program
    {
        //봇 생성
        private static readonly TelegramBotClient Bot = new TelegramBotClient("봇 아빠가 준 access token을 넣어요.");

        //임시방편 유저 리스트
        private static List<User> Users = new List<User>();
        
        //telegram 사용자의 상태 저장 변수
        private static Dictionary<long, UserState> dicUserState = new Dictionary<long, UserState>();

        static void Main(string[] args)
        {
            ///임시방편 유저 리스트에 유저 추가
            Users.Add(new User("시나공공", 28)); //28살이다...ㅁㄴ아ㅓㄹ ㅓㅁㄴ아ㅣㄹ허 님
            Users.Add(new User("텔레그램", 30));
            Users.Add(new User("봇아빠", 55));

            ///봇 이벤트 추가
            Bot.OnMessage += Bot_OnMessage;
            Bot.OnMessageEdited += Bot_OnMessage;
            Bot.OnReceiveError += Bot_OnReceiveError;
        
            ///Me 획득 (Me가 뭔지 정확하게는.... 일단 눈치껏 보면 Username에 sinagonggongBot이 들어가는걸 보면 Bot 본인을 뜻하는 듯하다)
            var me = Bot.GetMeAsync().Result;

            Console.Title = me.Username;

            /// Recv Start
            Bot.StartReceiving();
            Console.ReadLine();
            /// Recv Stop
            Bot.StopReceiving();
        }

        /// Recv Error
        private static void Bot_OnReceiveError(object sender, Telegram.Bot.Args.ReceiveErrorEventArgs e)
        {
            Debugger.Break();
        }

        ///사용자로 부터 Message Recv
        private static async void Bot_OnMessage(object sender, Telegram.Bot.Args.MessageEventArgs messageEventArgs)
        {
            /// Message 객체
            var message = messageEventArgs.Message;

            /// 예외처리
            if (message == null || message.Type != MessageType.TextMessage) return;

            /// "/사용자추가" 라는 명령을 받음
            if (message.Text.StartsWith("/사용자추가"))
            {
                dicUserState[message.Chat.Id] = UserState.addUser;
                await Bot.SendTextMessageAsync(message.Chat.Id, 
                    @"사용자 이름과 나이를 입력해 주세요.
ex)시나공공,28");
            }

            /// "/사용자삭제" 라는 명령을 받음
            else if (message.Text.StartsWith("/사용자삭제"))
            {
                dicUserState[message.Chat.Id] = UserState.deleteUser;
                await Bot.SendTextMessageAsync(message.Chat.Id, "사용자 이름을 입력해 주세요.");
            }

            /// "/사용자목록" 라는 명령을 받음
            else if (message.Text.StartsWith("/사용자목록"))
            {
                dicUserState[message.Chat.Id] = UserState.none;

                string _message = string.Empty;
                Users.ForEach(x => _message += string.Format("이름 : {0}, 나이 : {1}\r\n", x.Name, x.Age) );

                await Bot.SendTextMessageAsync(message.Chat.Id, _message);
            }

            /// "/도움말" 라는 명령을 받음
            else if(message.Text.StartsWith("/도움말"))
            {
                var usage = @"
/사용자추가    - 사용자 추가
/사용자삭제 - 사용자 삭제
/사용자목록  - 사용자 목록
/도움말       - 도움말
                            ";

                await Bot.SendTextMessageAsync(message.Chat.Id, usage,
                    replyMarkup: new ReplyKeyboardHide());
            }
            /// 그 외 다른 말을 받을 경우 사용자 상태를 보고 적절하게 대응한다.
            else
            {
                /// 예외처리
                if(!dicUserState.ContainsKey(message.Chat.Id))
                {
                    await Bot.SendTextMessageAsync(message.Chat.Id, "먼 말인지 모르겠어요.");
                    return;
                }

                /// 사용자 상태가 사용자 추가일 경우
                if (dicUserState[message.Chat.Id] == UserState.addUser)
                {
                    /// 이름,나이 로 입력을 받을 것이기 때문에 , 로 tokenizing하자
                    /// 0번은 이름, 1번은 나이
                    string[] NameAndAge = message.Text.Split(',');

                    /// 쪼갰는데 개수가 2보다 작으면 잘못된 값을 받았다 판단
                    if (NameAndAge.Length < 2)
                    {
                        await Bot.SendTextMessageAsync(message.Chat.Id, 
                            @"다시 입력해 주세요.
ex)시나공공, 28");
                        return;
                    }

                    /// 이름 나이 셋팅
                    string _name = NameAndAge[0];
                    int _age = 0;
                    bool result = Int32.TryParse(NameAndAge[1], out _age);

                    /// 나이값이 정상이면 추가
                    if(result)
                    {
                        // DB작업을 해야한다면 여기서 하면 될것같다.
                        Users.Add(new User(_name, _age));
                        await Bot.SendTextMessageAsync(message.Chat.Id, message.Text + " 사용자를 추가 했어요.");
                        dicUserState[message.Chat.Id] = UserState.none;
                    }
                    /// 나이값이 이상하면 예외
                    else
                    {
                        await Bot.SendTextMessageAsync(message.Chat.Id,
                            @"나이가 이상해요.
다시 입력해 주세요.");
                    }
                }

                /// 사용자 상태가 사용자 삭제일 경우
                else if(dicUserState[message.Chat.Id] == UserState.deleteUser)
                {
                    /// SingleOfDefault로 사용자를 찾았는데 없으면 예외처리 있으면 삭제
                    var _user = Users.SingleOrDefault(x => x.Name == message.Text);
                    if (_user != null)
                    {
                        // DB작업을 해야한다면 여기서 하면 될것같다.
                        Users.Remove(_user);
                        await Bot.SendTextMessageAsync(message.Chat.Id, message.Text + " 사용자를 삭제 했어요.");
                        dicUserState[message.Chat.Id] = UserState.none;
                    }
                    else
                    {
                        await Bot.SendTextMessageAsync(message.Chat.Id, 
                            message.Text + @" 사용자가 없어요.
다시 입력해 주세요.");
                    }
                }

                /// 사용자 상태가 추가, 삭제가 아닌 경우 시치미 뚝
                else
                {
                    await Bot.SendTextMessageAsync(message.Chat.Id, "먼 말인지 모르겠어요.");
                }

                
            }
        }
    }

    /// <summary>
    /// 사용자를 상태를 나타내는 enum
    /// </summary>
    public enum UserState
    {
        addUser,
        deleteUser,
        none
    }

    /// <summary>
    /// 사용자 클래스, 이름과 나이
    /// </summary>
    public class User
    {
        string name = string.Empty;
        public string Name
        {
            get { return name; }
            set { name = value; }
        }

        int age = 0;
        public int Age
        {
            get { return age; }
            set { age = value; }
        }

        public User() : this("none", 0) { }
        public User(string name, int age)
        {
            this.Name = name;
            this.Age = age;
        }
    }
}

이렇게 하면 아래와 같은 결과를 볼 수 있다.

봇에게 말을 걸려면 봇아빠에게 말을 걸었던것과 같이 하면 된다.

나의 경우 @sinagonggongBot을 검색해 대화를 시작했다.

Telegram Bot을 이용해 간단하게 요청을 하고 응답을 받는 서비스를 만들어봤다.

네이버나 다음의 API를 섞어서 사용하거나, 나름의 알고리즘으로 유용한 봇을 만들 수 있을 것 같다.

아 5초마다 이벤트 발생시켜서 사용자한테 메세지 보내는걸 까먹었네. 그건 패스할게요... 귀찮...

키포인트는 Message.Chat.Id를 잘 보관해야 한다.

작년 개발 당시 Message.Chat.Id를 로그인 DB에 컬럼을 추가해 같이 저장해 이용했다.

이슈가 생겼을 때 DB의 TelegramID를 조회해 sendMessage를 했었다.

Group Chat방에 메세지를 보낼땐 https://stackoverflow.com/a/45577773 참조 바랍니다. (Group Chat ID 얻어오기 Tip)

끝.

log4net 사용 관련 참고 사이트 : http://hind.pe.kr/1199

log4net 설정 관련 참고 사이트 : http://egloos.zum.com/empty79/v/2956254

C#에서 logging을 할때 손쉽고 편하게 사용할 수 있는 라이브러리를 소개하려한다.

Log4Net이라는 라이브러리 이다.

이 라이브러리는 log4j라는 java라이브러리에서 따온것이라고 알고있다.

log4net에 대한 자세한 내용은 홈페이지를 참조 바랍니다.

https://logging.apache.org/log4net/

1. 사용 방법

 - Nuget으로 Log4Net을 검색하면 아파치 log4net이 제일 상위에 나타난다

 "설치"버튼을 클릭하면 사용준비 끝.

2. 설정 파일

 - 사실 설정 파일에 대해 정확하게 알지 못한다. 일단 구글링을 통해 알아본 기본적인 틀을 확인해보자.

   응용 프로그램의 경우 app.config 파일에 설정 내용을 입력 하지만 나는 asp.net에서 로깅을 하려하기 때문에

   별도의 LogConfig.xml 파일을 생성하였다. (web.config에 하면 되려나)

<log4net>
  <appender name="RollingFile" type="log4net.Appender.RollingFileAppender">
    <file value="C:\Log\"/>
    <appendtofile value="true"/>
    <datepattern value="yyyy-MM-dd'_Log.log'"/>
    <staticlogfilename value="false"/>
    <rollingstyle value="Date"/>
    <layout type="log4net.Layout.PatternLayout">
      <conversionpattern value="%d [%t] %-5p - %m%n"/>
    </layout>
  </appender>
  <root>
    <level value="ALL"/>
    <appender-ref ref="RollingFile"/>
  </root>
</log4net>

<appender> 태그는 로그를 어떤식으로 남길 것인지에 대한 큰 틀이라고 보면된다.

appender 태그 안에서 파일을 어느곳에 만들것인지 파일이름을 어떻게 할것인지 로그 패턴을 어떻게 할것인지를 정할 수 있다.

<root> 태그는 기본 logger 설정을 하며, level 태그는 ALL, Warn, 등등 으로 나뉘며 해당 레벨 이상의 로그만 로그파일에 쓰길 원할경우 설정한다.

appender-ref 태그에는 appender의 name을 입력하여 연결을 해준다.

3. 소스

//using 해준다.
using log4net;
using log4net.Config;

//로깅할 곳에 로그 변수 추가
private ILog _logger = null;
public readonly ILog Logger
{
  get { return _Logger; }
}

string strDirPath;
strDirPath = @"C:\Log";
DirectoryInfo dirInfo = new DirectoryInfo(strDirPath);
//log4net에서 폴더를 만들어주는지 안만들어주는지 몰라서.. 일단 혹시나해서 만듦

if (dirInfo.Exists == false)
{
  if (dirInfo != null)
  dirInfo.Create();
}

//LogConfig.xml 경로를 설정해준다.
string AppPath = AppDomain.CurrentDomain.BaseDirectory;
//log4net.config 하위의 xmlconfigurator에 설정 파일을 등록한다.
XmlConfigurator.Configure(new System.IO.FileInfo(AppPath + @"bin\LogConfig.xml"));
//설정파일의 appender의 name에 아까 입력한 RollingFile을 입력하여 logger를 추가한다.
_logger = log4net.LogManager.GetLogger("RollingFile");
// ----------- 이렇게 해서 기본적인 변수 선언과 사용준비는 끝.

// 사용

//error
if(_logger.IsErrorEnabled)
  _logger.Error("Error!!!!!!!!!!!");

if(_logger.IsDebugEnabled)
  _logger.Debug("Debug!!!!!!!!!!!");

if(_logger.IsInfoEnabled)
  _logger.Info("Info!!!!!!!!!!!");

로그를 남길때 수준을 정할 수 있다.

Error, Fatal, Warn, Info, Debug

이렇게 해서 로그 파일을 확인해 보면 아래와 같이 로그가 남는 것을 확인 할 수 있다.

*log4net을 사용하다 보면 남겨야 하는 로그의 성격이 다른 것들이 있다. 이럴경우 로그파일을 나눠서 로그를 남기고 싶을 경우가 있다.

이럴 경우에는 설정파일을 살짝 바꿔서 사용하면된다.

아래와 같이 appender를 추가하고 logger를 추가해주면 끝. 알기쉽게 이름을 잘 지어주면 끝.

눈치가 빠른 사람들은 소스에서 어떻게 사용하는지도 대충은 파악했을 것이다.

<log4net>
	<appender name="Common" type="log4net.Appender.RollingFileAppender">
		<file value="C:\Log\" />
		<appendToFile value="true" />
		<datePattern value="yyyy-MM-dd'_Common.log'" />
		<staticLogFileName value="false" />
		<rollingStyle value="Date" />
		<layout type="log4net.Layout.PatternLayout">
			<conversionPattern value="%d [%t] %-5p - %m%n" />
		</layout>
	</appender>
	<appender name="Socket" type="log4net.Appender.RollingFileAppender">
		<file value="C:\Log\" />
		<appendToFile value="true" />
		<datePattern value="yyyy-MM-dd'_Socket.log'" />
		<staticLogFileName value="false" />
		<rollingStyle value="Date" />
		<layout type="log4net.Layout.PatternLayout">
			<conversionPattern value="%d [%t] %-5p - %m%n" />
		</layout>
	</appender>
	<appender name="Database" type="log4net.Appender.RollingFileAppender">
		<file value="C:\Log\" />
		<appendToFile value="true" />
		<datePattern value="yyyy-MM-dd'_Database.log'" />
		<staticLogFileName value="false" />
		<rollingStyle value="Date" />
		<layout type="log4net.Layout.PatternLayout">
			<conversionPattern value="%d [%t] %-5p - %m%n" />
		</layout>
	</appender>
	<root>
		<level value="ALL" />
	</root>

	<logger name="Common">
    		<level value="ALL" />
    		<appender-ref ref="Common" />
	</logger>

	<logger name="Socket">
    		<level value="ALL" />
    		<appender-ref ref="Socket" />
	</logger>

	<logger name="Database">
    		<level value="ALL" />
    		<appender-ref ref="Database" />
	</logger>
</log4net>

여러 파일에 로그 남기기 소스는 첨부파일을 열어보자

LogManager.cs

압축 알고리즘 선택 기준 : http://bspfp.pe.kr/192 참조

Snappy 개요 : http://www.mimul.com/pebble/default/2012/04/10/1334044735206.html 참조

Snappy 사용법

1. Nuget에서 Snappy를 검색하여 Snappy for .NET을 설치한다.

2. using Snappy;

 
//압축된 내용
byte[] byteCompressed = null;
//압축 해제 된 내용
byte[] byteDeCompressed = null;

Stream stream = null;

ulong ulJsonLength = 0;

byteCompressed = File.ReadAllBytes("FilePath");

byteDeCompressed = SnappyCodec.Uncompress(byteCompressed);

stream = new MemoryStream(byteDeCompressed);

// stream에 담아 지지고볶고 사용 하면 된다.
// ** 해당 내용은 압축 해제를 다룬 내용.
// ** 압축은 위의 소스를 조금만 수정하여 사용하면 될듯 하다.

* Snappy 함수들

함수가 많지 않다. 압축과 압축 해제는 Compress, Uncompress 함수를 사용하면 된다. 단순히 byte[] 만 넣어주면 알아서 압축과 해제를 해주니 사용하기는 간단하다.

Index라는 컬럼을 가진 DataTable이 있을때 Index로 Sorting을 하고싶다면 다음과 같이 사용하면 된다.

DataTable dt;
//Columns add ... 
//Rows add ...
dt.DefaultView.Sort = "index desc";

desc : 내림차순

asc : 올림차순

* Sotring 후 그냥 dt를 사용 할경우 Sorting된 값을 사용할 수 없다. dt.DefaultView를 사용 해야 Sorting된 값을 확인 할 수 있다.

tip

Sorting 후 key값의 index를 알고싶을때는 find 함수를 사용하면 된다.

예를 들어 Index라는 컬럼이 Datatable의 key값일 경우

dt.DefaultView.Sort = "index desc";
//20이라는 index의 Row를 알고싶을 경우
int nRow = dt.DefaultView.find(20);
//nRow를 사용하면 된다.
//find에서 찾는 값이 없을 경우 -1을 리턴하니 참고하길
//Row를 찾았으니 이제 해당 row의 값을 가져오는 방법을 알아보자
//Datatable에 Name이라는 컬럼이 있다고 한다면 아래와 같은 방법으로 사용가능하다.
string Student_Name = dt.DefaultView[nRow]["Name"].ToString();
//....