[Spring Boot] Discord Bot(디스코드 봇) 만들기 - Spring Boot(스프링 부트)를 이용한 간단한 API 만들기 feat.mybatis(마이바티스)

 

 

 

전자정부 표준 프레임워크의 양대 핵심 기술 세트 : 스프링 + 마이바티스

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

 

 

🗂 목차

1. [Spring Boot] Discord Bot(디스코드 봇) 만들기
2. [Spring Boot] Discord Bot(디스코드 봇) 만들기 - Spring Boot(스프링 부트)를 이용한 간단한 API 만들기 feat.Mybatis(마이바티스)

3. [Spring Boot] Discord Bot(디스코드 봇) 만들기 - JAVA를 이용한 API 호출

4. [Spring Boot] Discord Bot(디스코드 봇) 만들기 - 디스코드 봇을 이용하여 API 호출

 

 

 

 

🚀 시작하기 전에

    🔽  개요

안녕하세요? 주니입니다.

지난 번에 만들었던 디스코드 봇을 좀 더 발전 시켜 이번에는 API를 통해 Data Base(DB - 데이터 베이스)에 저장된 값을 가져올 수 있도록 발전 시켜보려고 해요.

지난 번에도 언급했었지만, 기깔나는 사람들 지원자 정보를 각 간부들이 보다 편리하게 디스코드에서 확인할 수 있도록 개발 중인 것이라 실제 작업을 하기 전 연습한 것을 블로그에 남겨 보려고 합니다.

기본적으로 JDA를 이용한 디스코드 봇 만들기는 이 곳에 관심을 주세요.

여러 IT 회사에서 Java - Spring(자바 - 스프링)을 이용해서 BackEnd (백엔드)를 만들 때, JPA와 QueryDSL (쿼리디에스엘) 조합 혹은 JPA와 MyBatis(마이바티스) 혹은 MyBatis만을 이용하여 개발 하는 곳이 있더라구요.

주니가 경험한 바로는 마이바티스는 Back Office(백 오피스)에서 주로 많이 사용되고, 이용자 (대국민) 서비스의 경우 JPA + QueryDSL 혹은 JPA + 마이바티스를 쓰는 곳을 많이 보았어요.

기깔나는 사람들은 이런 이유 때문에 이용자 서비스의 경우 JPA와 QueryDSL 조합으로 데이터 베이스를 조작하고, 백 오피스의 경우 마이바티스를 이용해서 데이터 베이스를 조작하려고 해요.

그렇기 때문에 이번 디스코드 봇 만들기 글은 기깔나는 사람들 백 오피스에서 사용할 것이고, 마이바티스를 이용하려고 합니다.

 

 

GitHub - junyharang-personal-project/juny-discord-bot-test: JDA를 이용한 Spring Boot Discord Bot 연습이에요.

 

 

 

 

 

    🔽  의존성 추가

build.gradle

 

이 전 글에서보다 더 많은 의존성들이 추가 되었어요.

plugins {
    id 'java'
    id 'org.springframework.boot' version '2.7.9'
    id 'io.spring.dependency-management' version '1.0.15.RELEASE'
}

group = 'com.junyss'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'

configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    compileOnly 'org.projectlombok:lombok'
    developmentOnly 'org.springframework.boot:spring-boot-devtools'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    // Discord Bot 사용을 위한 JDA 의존성
    implementation 'net.dv8tion:JDA:5.0.0-beta.5'
    implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.3.0'
    compileOnly 'org.projectlombok:lombok'
    runtimeOnly 'com.h2database:h2'
    // MyBatis Log를 찍기 위한 의존성 추가(https://mvnrepository.com/artifact/ch.qos.logback/logback-classic)
    testImplementation 'ch.qos.logback:logback-classic:1.4.5'
    // SQL query show
    implementation 'org.bgee.log4jdbc-log4j2:log4jdbc-log4j2-jdbc4.1:1.16'
    // GSON 의존성
    // https://mvnrepository.com/artifact/com.google.code.gson/gson
    implementation 'com.google.code.gson:gson:2.10.1'
    // https://mvnrepository.com/artifact/com.googlecode.json-simple/json-simple
    implementation 'com.googlecode.json-simple:json-simple:1.1.1'
    //SpringDoc 의존성 추가
    // https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-ui
    implementation 'org.springdoc:springdoc-openapi-ui:1.6.14'
    // https://mvnrepository.com/artifact/org.json/json
    implementation 'org.json:json:20220924'
}

tasks.named('test') {
    useJUnitPlatform()
}

반응형

 

 

 

    🔽  DTO와 VO

최초 API를 만들기 전 DTO(Data Transfer Object)와 VO(Value Object)를 먼저 만들어 볼게요.

com/junyss/discordbottest/api/crew/model/dto/request/CrewSearchDTO.java 1 ~ 36번째 줄

 

 최초 디스코드 봇을 통해 검색을 하려고 할 때, 그 검색 타입과 검색어 그리고, 날짜를 이용해 검색을 할 수 있도록 각 변수를 만들어 주었어요.

35번째 줄에 Method(메서드)는 Client(클라이언트) 즉, 사용자가 검색을 위해 검색어를 입력 했을 때, 그 값이 마이바티스에서 꺼내 사용할 수 있도록 만들어준 Getter(게터)인데, searchType 변수가 Enum Type(열거형 타입)이고, 이를 그대로 마이바티스에서 가져다 사용하게 하면 문제가 발생하기 때문에 이를 String (문자열)로 바꿔서 가져가게 하도록 하려고 만든 게터 메서드에요. 

com/junyss/discordbottest/api/crew/model/dto/request/CrewSearchDTO.java 41 ~ 67번째 줄

47번째 setSearchType()은 클라이언트에서 검색을 위해 입력한 검색 타입을 받고, 이를 switch(스위치) 문을 통해 분기처리를 하여 해당 문자열을 분석하고, 그에 맞는 열거형 타입의 값을 searchType 변수에 넣을 수 있도록 하여 주었어요.


이번에는 Response(응답) DTO를 살펴 볼게요.

com/junyss/discordbottest/api/crew/model/dto/response/CrewListResponseDTO.java 1 ~ 29번째 줄

위 DTO 객체는 마이바티스를 통해 조회된 검색 결과들을 Mapping(매핑)하여 클라이언트에게 반환해 주기 위한 객체에요.

toDTO()는 마이바티스에서 조회된 검색 결과가 VO 객체형으로 나오게 되는데, 이를 DTO 형태로 반환해 주기 위한 메서드에요.

이렇게 하지 않고, 여러가지 방법을 통해 매핑할 수 있는데, 주니는 이렇게 해 주었어요. 

사실 VO와 응답 DTO의 값이 똑같기 때문에 바로 VO를 반환해 줘도 되지만, Service(서비스)가 커지면 커질수록 또한, 목록 조회는 이렇게 전체 데이터를 보여주지 않기 때문에 따로 응답 DTO를 만들게 되기 때문에 그에 중점을 두고, 만들어 주었어요.

com/junyss/discordbottest/api/crew/model/vo/CrewVO.java 1 ~ 18번째 줄

VO에 경우 위와 같이 만들어 주었어요.

10번째 줄에 어노테이션은 기본 생성자의 접근 제어를 PROTECTED(다른 Package에 소속된 Class (상속 제외)는 접근 불가)로 설정하기 위해 명시한 것인데, 이는 무분별한 객체 생성을 막기 위함이에요.

만약 위에서 명시한 모든 변수를 다 사용하는 경우에서만 기본 생성자가 사용되도록 해야 하는데, 이 중 하나라도 사용하지 않고 사용할 경우 new 연산자 등을 이용해 VO 객체를 만들어서 사용할 때, 해당 VO 객체는 완전하지 않은 객체가 될 거에요.

쉽게 말하면 Null 값을 가진 변수를 갖고 있는 객체라는 이야기에요.

이런 상황을 막기 위해 이럴 때는 Builder(빌더) 나, 다른 메서드를 이용해서 접근하게 하는 것이 좋은데, 주니는 연습이기 때문에 모두 다 사용하도록 만들어 줄거에요.

    🔽  Controller (컨트롤러)

이번에는 클라이언트 요청에 최전선을 맡고 있는 컨트롤러를 만들어 볼게요.

com/junyss/discordbottest/api/crew/controller/CrewController.java

컨트롤러는 위와 같이 만들어 주었는데, 25 ~ 32번째 줄까지 내용은 springdoc-openapi을 이용한 Swagger 문서 작성을 해 준 거에요.

 

위와 같이 나올 수 있도록 만들어 준거에요.

 

참고로 주니는 @ModelAttribute를 통해 검색 조건을 매개 변수로 받아주도록 하였어요.

 

 

💡 참고 사항
RequestParam과 ModelAttribute 차이

1. @RequestParam 이란?
Client 요청에 전달값을 Handler(Controller)의 매개 변수(Parameter)로 1:1 Mapping(매핑) 할 때 사용

@Slf4j
@Controller
public class JunyssTestController {
    @GetMapping("/")
    public String getTestPage(@RequestParam("name") String name) {
        log.info("이름 : " + name);
        return "test";
    }
}

위와 같은 Controller가 있을 때, Client가 URL을 통해 /?name=test 라고 요청을 보내게 되면 name 변수에는 test 라는 문자열이 들어감.

1. @ModelAttribute 란?
해당 어노테이션은 Method(메서드) Level(레벨)과 매개 변수 두 곳에서 사용 가능.

@Getter 
@Setter 
public class JunyssTestDTO { 
	private String name; private int age; 
} 

@Slf4j 
@RestController 
public class JunyssTestController { 
@GetMapping("/") 
    public String getTestPage(@ModelAttribute JunyssTestDTO junyssTestDTO) { 
    log.info("이름 : " + junyssTestDTO.getName()); 
    log.info("나이 : " + junyssTestDTO.getAge()); return "test"; 
	} 
}​

728x90

 

위와 같이 DTO와 Controller가 있을 때, name과 age를 인스턴스 Member 변수로 가지고 있는 DTO를 통해 Controller에서 해당 매개 변수에 맞는 값들을 받게 할 수 있다.

이 때, 이용자가 URL을 통해 /?name=Juny&age=99 라고 값을 보내게 되면 Controller의 DTO 객체로 Binding이 되게 된다.
단, 해당 매개 변수 객체는 반드시 Setter가 있어야 한다.

 

    🔽  Service (서비스)

이번에는 비즈니스 로직 처리를 담당하는 서비스 객체를 만나볼게요.

주니는 SOLID 원칙 중 OCP를 지키기 위해 Interface와 구현체를 분리해서 만들어 보았어요.
물론 다른 내용으로 대체할 것이 없긴 하지만, 일단 분리해 보았어요.

com/junyss/discordbottest/api/crew/service/CrewService.java 1 ~ 12번째 줄

 

 

com/junyss/discordbottest/api/crew/service/Impl/CrewServiceImpl.java 1 ~ 35번째 줄

 

Interface를 구현한 구현체에서 컨트롤러를 통해 전달된 CrewSearchDTO를 받아 비즈니스 로직을 처리하게 해 주었어요.

30 ~ 31번째 줄에서 crewSearchDTO를 이용해서 DAO (Data Access Object)의 findByCrewList()를 호출하여 데이터 베이스에서 조회된 값을 꺼내오게 하였고, 조회된 값이 Null safety하게 하기 위해 .filter(Objects::nonNull)을 명시하고, 조회된 값을 forEach 문을 통해 반복하면서 새롭게 만든 resultArray List에 담아주는데, 이 때, 위에서 이야기 했었던 VO를 DTO로 바꿔주는 toDTO()를 호출하여 DTO 객체로 바꿔 준 뒤에 resultArray에 담아 주었어요.

그런 뒤 해당 배열을 클라이언트에게 반환해 주도록 하였어요.

    🔽 Data Access Object (DAO - 다오)

이제 본격적으로 Data Base에 점점 가까워지고 있어요!

com/junyss/discordbottest/api/crew/dao/CrewDAO.java 1 ~ 21번째 줄

 

 

com/junyss/discordbottest/api/crew/dao/Impl/CrewDAOImpl.java 1 ~ 36번째 줄

이번에는 DAO에 대해 살펴 볼게요.

최초 31번째 줄에 어노테이션을 통해 findByCrewList()는 데이터 베이스에서 읽기 작업만 가능하게 하기 위해 사용하여 주었어요. 만약 쓰기 작업을 해야 한다면 (reaOnly = true)만 살포시 없애주면 되요.

그런 뒤 Mapper 객체의 findByCrewList()를 호출하여 역시 DTO를 전달해 주었어요.

 

    🔽 MyBatis Mapper (매퍼)

com/junyss/discordbottest/api/crew/mapper/CrewManagementMapper.java 1 ~ 24번째 줄

 

이 곳에서 실제로 마이바티스에 SQL 문을 작성하는 XML을 매핑해 줄 수 있어요.

@Param은 마이바티스의 SQL 문장에 여러 매개 변수값을 전달할 때, 붙혀줘야 하는 어노테이션인데, 이렇게해야 여러가지 매개 변수를 받을 때, 명확하게 마이바티스 SQL 문장에 매개 변수를 전달해 줄 수 있어요.

mapper/CrewManagementMapper.xml 1 ~ 41번째 줄

주니가 작성한 마이바티스 매퍼 XML이에요.

위에서 이야기한대로 @Param을 통해 매개 변수로 전달된 DTO 값의 Getter를 호출하여 해당 변수의 값을 가지고 올 수 있는데, 10번째 줄에 검색 타입이 Null이거나, 공백이라면 11 ~ 31번째 줄을 타지 않게 해 주었어요.

만약 검색 타입이 있다면 그 값에 어떤 문자열이 있는지 확인하고, 해당 문자열에 맞는 컬럼에 searchWord 즉, 검색어가 있는지 검색할 수 있게 만들어 주었어요.

그런 뒤 27번째 줄에 날짜 범위 검사를 위한 startDate와 endDate가 Null이 아닌지 확인하고, and 절을 통해 Null이 아니면 BETWEEN A And B 를 이용하여 날짜 범위를 검색할 수 있도록 처리해 주었어요.

33번째 줄에는 10번째 줄이 Null이거나, 공백 즉, 검색 타입에 값이 없어 검색어를 이용한 검색이 이뤄지지 않을 때, 날짜 범위 검색만을 원해 해당 값이 Null이 아니면 날짜 범위 검색이 되도록 처리해 주었어요.

    🔽 Data Base Initialization (데이터 베이스 초기화)

init/database/schema.sql 1 ~ 10번째 줄

 

주니는 테스트를 위해 이렇게 데이터 베이스에 미리 테이블이 만들어 지도록 하였어요.

init/database/data.sql 1 ~ 8번째 줄

 

그리고 이렇게 테스트용 DATA (데이터)가 쌓일 수 있도록 해 주었어요.

application.yml 5 ~ 29번째 줄

 

주니는 위와 같이 H2 Embeded (임베디드)로 데이터 베이스가 사용되도록 해 주었는데, 20 ~ 24번째 줄 설정을 해주면 위와 schema.sql과 data.sql을 사용할 수 있어요.

discord:
  bot:
    token: <Discord Bot Token Value>
spring:
  h2:
    console:
      enabled: true
      path: /h2-console
      settings:
        web-allow-others: true

  datasource:
    url: jdbc:log4jdbc:h2:~/giggal-discord-bot?serverTimezone=UTC&characterEncoding=UTF-8;MODE=MySQL;
    username: sa
    password:
    driver-class-name: net.sf.log4jdbc.sql.jdbcapi.DriverSpy

  sql:
    init:
      mode: always
      schema-locations: classpath:init/database/schema.sql
      data-locations: classpath:init/database/data.sql

mybatis:
  mapper-locations: classpath:mapper/*.xml
  configuration:
    map-underscore-to-camel-case: true

springdoc:
  api-docs:
    groups:
      enabled: true
  swagger-ui:
    operations-sorter: alpha
    tags-sorter: alpha
    path: /swagger.html
    disable-swagger-default-url: true
    display-query-params-without-oauth2: true
    doc-expansion: none
    version: v1
    display-request-duration: true

  cache:
    disabled: true

  paths-to-match:
    - /api/**

 

 

 

GitHub - junyharang-personal-project/juny-discord-bot-test: JDA를 이용한 Spring Boot Discord Bot 연습이에요.

 

주니가 만든 Source Code(소스 코드)가 궁금하신 분들은 위에 Git Hub 링크에서 확인 가능하도록 준비해 두었어요.

 

 

전자정부 표준 프레임워크의 양대 핵심 기술 세트 : 스프링 + 마이바티스

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."