junwork123 / chatbot

챗봇

Spring Boot ChatBot

Hi guys!

This is a project to build a ChatBot Framework based on Spring Boot.

Author

• junwork123 (Project Owner)

Feature

• Spring Framework Based Environment
• Easy to Implement each Platform(Discord, Line, Slack etc.)
• Easy to expand Commands & Actions

Process

Core Packages

• domain : this package is focusing on Subject like playing a Music, telling a joke or notice on Something via Controller & Service.

• platform : this package is implementation of ChatBot interfaces depend on specific platform such as Discord, Slack or Line.

Core Concept

• Command : Command is Enum class for predefined Actions. it has a Meta-Info values for filtering or finding a controller.

• @CommandMapping : This annotation helps us find controller and method to be executed. it needs String Value named startCommand matching Command.

• @ChatBotController : Actually, This annotation is same as @Controller, But it could help Dispatcher and distinguish @ChatBotController from @Controller when Dispatcher finds a controller.

• ChatBotDispather : this interface has 2 methods. One is dispatch for finding controller and method to be executed. Another is onMessage to invoke them.

Release Notes

quick start

example

To-do

• Event Driven Architecture(ref)
• Batch Service
• Auto Command Complete

Thanks to

kingbbode님

chatbot's Issues

#style : dispatcher class 이름 변경

#chore : 클라우드 서비스 적용

chore : 빌드 부분 혹은 패키지 매니저 수정사항

#feat 메시지 템플릿을 JSON으로 관리

feat : 새로운 기능 추가

#feat : 음악 재생 기능 추가

feat : 새로운 기능 추가

#feat : 명령어 Json 인식

style : 코드 의미에 영향을 주지 않는 변경사항

#feat : 캐릭터 검색 기능 추가

feat : 새로운 기능 추가

#feat : 메시지 템플릿 추가

답변 형식을 꾸며주는 메시지 템플릿 추가
커맨드 호출방식을 API 응답방식으로 변경
템플릿에 맞게 convert하도록 변경

#style : Util 클래스 추가(response 전달 방식 API 형식으로 변경)

style : 코드 의미에 영향을 주지 않는 변경사항

#doc : readme.md 작성

프로젝트 소개
프로젝트 구성
프로젝트 흐름도(3가지 측면 : 개념, 코드, 사용)
기능별 구현 움짤

#feat : Command에 따라 분기하는 기능

feat : 새로운 기능 추가

!로붕쿤 AA해줘
!로붕쿤 BB해
...
등등

커맨드에 추가로 행동이 붙으면
그에 맞는 서비스 객체에 연결시키자

#test Mock 테스트 추가

test : 테스트 코드 추가

#feat : LogUtils 작성

feat : 새로운 기능 추가

#bug : 커맨드 입력 시 무응답 버그

스프링을 실행시키고
이벤트를 등록해도 봇이 반응하지 않음

discord4j.gateway.retry.InvalidSessionException: Reconnecting due to non-resumable session invalidation
이런 메시지를 발견했음

#style : 전체 패키지 구조 변경

#refact : Command가 Service 직접 호출하는 구조를 변경

refact

Command가 Service를 직접 호출하는 구조를 Controller가 호출하도록 변경

#refact : 어노테이션 리팩터링(생성자 Autowired)

#feat : 명령어를 어노테이션으로 등록하고 컨트롤러를 호출

#chore : 도메인 기반으로 패키지 재구축

#feat : 플랫폼에 종속된 채팅기능 추가(방 입장, 강퇴, 환영인사 등)

feat : 새로운 기능 추가

command 인터페이스가 다양한 명령어에 대응할 수 있는가?

feat : 새로운 기능 추가

command 종류와 깊이(depth)가 다양해질수록
현재 command 구조는 반복작업이나 큰 변경없이 대응할 수 있을까?

#refact : Controller에 있는 Command, Adapter 종속성 제거

#style #chore : 패키지 구조 및 이름 변경

style : 코드 의미에 영향을 주지 않는 변경사항

chore : 빌드 부분 혹은 패키지 매니저 수정사항

디스코드 챗봇 뿐만 아니라
다양한 사양에 대응할 수 있는 이름과 구조로 변경

#style : api key를 숨김처리

style : 코드 의미에 영향을 주지 않는 변경사항

#feat : DB 및 JPA 기능 추가

feat : 새로운 기능 추가

chore : 빌드 부분 혹은 패키지 매니저 수정사항