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

 

 

 

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

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

 

 

 

🗂 목차

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를 JAVA(자바)를 이용해서 호출할 수 있는 코드를 만들어 보려고 해요.

이렇게 만들어야 디스코드 봇을 통해 해당 API를 호출할 수 있기 때문이에요.

API가 필요하신 분들은 이 곳에 관심을 주세요.

All in One Java 애플리케이션 개발 : Spring Hibernate MyBatis를 활용한

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

 

 

 

 

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

 

 

 

 

 

    🔽 HTTP Util

최초 JAVA를 이용해서 API를 호출하기 전 URL 만드는 작업을 해 줄거에요.

URL은 검색 조건이 있는지와 어떤 검색 조건이 있는지 그리고, 검색 조건이 없을 때를 검토하여 정확한 URL을 만들고, API를 호출하도록 만들어 줘야 해요.

com/junyss/discordbottest/common/util/HttpUtil.java 1 ~ 38번째 줄

 

crewByAll()은 검색 조건 없이 모든 크루를 검색하고자 할 때, 호출되는 Method(메소드)에요.

URL을 만들 때,  IOException이 터질 수 있기 때문에 try-catch 문으로 감싸서 처리를 했고, SpringBootAPICaller.callApi()를 호출할 때, HTTP Method 값과 URL 값을 만들어 던져 주었어요.

그런 뒤 API 호출을 통해 Data Base(데이터 베이스)에 조회된 값을 문자열로 반환하게 처리해 주었어요.

참고로 URL 객체를 만들 때, URL 형식이 잘못된 경우 MalformedURLException이 발생하게 되요. 해당 Exception은 IOException에 자식 Exception Class이기 때문에 주니는 IOException을 Catch로 처리해 주었어요.

com/junyss/discordbottest/common/util/HttpUtil.java 47 ~ 57번째 줄

 

crewBySearchOption()은 검색 조건이 있을 때, 호출 되는 메소드에요.

해당 검색 조건을 가지고, URL을 만드는 메소드를 호출하여 URL을 만들어서 SpringBootAPICaller.callApi()를 호출하도록 처리해 주었고, 마찬가지로 API 호출을 통해 데이터 베이스에 조회된 값을 문자열로 반환하게 처리해 주었어요.

com/junyss/discordbottest/common/util/HttpUtil.java 58 ~ 93번째 줄

 

어쩌면 HttpUtil Class에서 makeURL()이 가장 복잡하고, 중요한 역할을 하고 있을 수도 있겠어요.

makeURL()은 검색 조건을 담은 DTO를 매개 변수로 동작하게 되요.

최초 검색 조건이 없어도 API를 호출할 때, 쓰이는 기본 URL 값을 defaultUrl 문자열 변수에 넣어 주었어요.

makeURL()에 진입하게 되면 DTO 객체에 어떤 값이 있느냐를 확인하여 URL을 만들어 주는 걸 확인할 수 있어요.
참고로 URL Parameter(매개 변수)의 Key (키 - 열쇠) 값은 URLEncode.encode()를 통해 인코딩 해주면 API 호출을 할 때, 특수문자가 인코딩이 되버리기 때문에 문제가 발생할 거에요.

그래서 키 값은 인코딩하지 않고, 매개 변수의 Value(값)만 인코딩 하도록 하여 문자열이 합쳐 지도록 하였어요.

먼저 if문을 통해 DTO에 모든 검색 조건이 Null이 아닌지 확인하고, Null이 아니라면 URL 파라미터를 그에 맞게 생성을 해주는 거에요.

그렇게 else if()를 통해서 DTO에 상태를 확인하고, URL을 만들어 준 뒤 만들어진 URL 문자열을 반환해 주었어요.

com/junyss/discordbottest/api/common/constant/APIUriInfo.java 1 ~ 9번째 줄

 

위 Interface(인터페이스)를 통해 URL 관련 String(문자열) 값들을 정의하고, 가져다 쓰는 방식으로 만들어 주었어요.

 

 

 

    🔽 API Caller

com/junyss/discordbottest/common/SpringBootAPICaller.java 1 ~ 13번째 줄

 

 

com/junyss/discordbottest/common/SpringBootAPICaller.java 14 ~ 48번째 줄

반응형

 

해당 객체는 JAVA를 이용해서 API를 호출하기 위해 만든 객체에요.

실제 API 호출을 담당하는 callApi()에 대해 알아볼게요.

해당 Method(메소드)는 HTTP Method와 URL을 매개 변수로 받게 됩니다.
HTTP Method는 GET 혹은 POST 등을 문자열로 받게 되요.

그리고, API를 호출할 때, 입력 혹은 출력 관련해서 문제가 발생하면 그 처리를 호출한 곳에 넘기기 위해 throws IOException을 명시해 주었어요.

31번째 줄에 StringBuilder 객체를 생성해 주었어요.

32번째 줄에 API 연결을 위해 HttpURLConnection 객체를 만들어 주는데, URL 객체의 openConnection()을 호출하여 해당 결과값을 HttpURLConnection 객체로 형 변환하여 변수를 만들어 주었어요.

URL 객체의 openConnection()을 통해 URLConnection 객체를 얻을 수 있어요. 만약 Protocol(프로토콜)이 http:// 인 경우 반환된 객체를 HttpURLConnection 객체로 형 변환 할 수 있는데, 그를 위해 32번째 줄과 같이 해 준 거에요.

33 ~ 37번째까지 실제로 URLConnection 구성을 위한 작업을 해 주었어요.

실제로 연결을 설정하기 전에 Time Out(타임아웃), Cache(캐시), HTTP Request Method (HTTP 요청 방법) 등과 같이 Client(클라이언트)와 Server(서버) 간 다양한 Option(옵션)을 설정해 줄 수 있어요. 그것을 URLConnection 클래스 안에 여러 메소드를 통해 해 줄 수 있구요.

∙ setRequestMethod(String method) : HTTP Method(메소드) GET, POST, HEAD, OPTIONS, PUT, DELETE, TRACE 중 하나인 URL 요청에 대한 메소드 설정. Default Value is GET (기본값은 GET)

∙ setConnectTimeout(int timeout) : HTTP 연결 제한 시간 설정(단위는 ms(밀리 초))하는 것으로 제한 시간이 만료되고, 연결의 입력 Stream(스트림)에서 읽을 수 있는 DATA(데이터)가 없으면 SocketTimeoutException이 발생하게 된다. 시간 초과가 0이면, 무한대 제한 시간 설정.

∙ setRequestProperty (String key, String value) : 키와 값(Key=value) 쌍으로 지정된 일반 요청 속성을 설정하는 부분으로 키가 있는 속성이 이미 있는 경우 이전 값을 새 값으로 지정하게 된다. 이러한 메소드는 연결을 설정하기 전에 호출되어야 하며, 일부 메소드는 연결이 이미 설정된 경우 IllegalStateException을 발생 시키게 된다. 또한, 자식 클래스 HttpURLConnection은 HTTP 관련 기능을 사용하여 연결을 구성하기 위한 메서드를 제공한다.

∙ setDoOutput(boolean doOutput) : URLConnection이 Server(서버)에 데이터를 보내는데 사용할 수 있는지 여부 설정 (기본값은 false - 거짓)

💡 참고 사항
또다른 URLConnection Class 안의 Method

1. setReadTimeout (int timeout) : 읽기 제한 시간 값 설정(단위 밀리초). 제한 시간이 만료되고, 연결의 입력 스트림에서 읽을 수 있는 데이터가 없을 경우 SocketTimeoutException이 터진다. 해당 설정 값이 0이면 무한대를 의미.

2. setDefulatUseCaches (boolean defulat) : URLConnection이 기본적으로 캐시를 사용하는지 여부 설정. (기본값은 True) 해당 메소드는 URLConnection 클래스의 다음 인스턴스에 영향을 준다.

3. setUseCaches (boolean useCaches) : 연결이 캐시를 사용하는지 여부 설정(기본값 True).

4. setDoInput (boolean doInput) : URLConnection을 서버에서 콘텐츠를 읽는데, 사용할 수 있는지 여부 설정 (기본값 True).

5. selfModifiedSince (long itme) : 주로 HTTP Protocol(프로토콜)에 대해 클라이언트가 검색한 콘텐츠의 마지막 수정 시간을 새로 설정. 예를 들어 서버가 지정된 시간 이후 정적 콘텐츠(Image, HTML 등)가 변경되지 않으면 콘텐츠를 가져오지 않고, HTTP Statue Code(HTTP 상태 코드) 304 - 수정되지 않음을 반환한다. 클라이언트는 지정된 시간보다 최근에 수정된 경우 새로운 콘텐츠를 받게 된다.

6. setAllowUserInteraction (boolean allow) : 사용자 상호 작용을 활성화 또는 비활성화 한다. 예를 들어 필요한 경우 인증 대화 상자 표시 등.(기본값 false)

7. setDefaultAllowUserInteraction (boolean default) : 이후 모든 URLConnection 객체에 대한 사용자 상호 작용의 기본값 설정.

8. setFixedLengthStreamingMode (long contentLength) : 콘텐츠 길이를 미리 알고 있는 경우 내부 버퍼링 없이 HTTP 요청 본문을 스트리밍할 수 있다.

9. setFollowRedirects (boolean follow) : HTTP Redirection(리다이렉션) 뒤에 HttpURLConnection 클래스의 인스턴스가 자동으로 따라와야 하는지 여부 설정. (기본값 True) 

10. setInstanceFollowRedirects (boolean follow) : HTTP 리다이렉션 뒤 HttpURLConnection 클래스의 인스턴스가 자동으로 따라와야 하는지 여부 설정(기본값 True)하며, 해당 메소드는 Setter(세터)이며, URLConnection과 HttpURLConnection 클래스는 해당 Getter(개터)도 제공. 

 

com/junyss/discordbottest/common/SpringBootAPICaller.java 14 ~ 48번째 줄

 

위와 같이 하면 API를 설정한 값에 따라 호출하게 되고, 39번째 줄에 호출 결과값 중 HTTP 응답 결과 코드가 200 즉, OK라면 40 ~ 48번째 줄이 작동하도록 해 주었어요.

최초 40번째 줄에 try-with-resource 문을 통해 BufferReader가 모든 사용을 끝내고, 닫힐 수 있도록 해 주었어요.

HttpURLConnection 객체에 getInputStream()을 통해 URL 클래스의 입력 스트림을 설정 즉, URL 클래스가 나타내는 자원으로부터 데이터를 읽어올 수 있고, 이를 BufferdReader 객체로 거쳐서 받아 오는데, 만약 이렇게 하지 않고 바로 InputStream 객체로 받아오게 되면 이는 Byte(바이트) 단위로 데이터를 읽어오기 때문에 한글과 같이 ASCII Code(아스키) 코드 외에 글자들이 깨지기 때문이에요.

728x90

그런 뒤 JSON 처리를 위해 JSONObject 객체를 생성해 주고, API에서 받아온 DATA 값을 받아줄 line 문자열 변수를 선언해 주었어요.

44번째 줄에 bufferReader의 readLine()이 Null이 아니면 즉, API를 통해 어떤 값을 받아왔다면 그 값을 line에 넣게 하고, JSONObject 객체에 해당 값을 넣어 JSON Type으로 변환되도록 해 주었어요.

48번째 줄에 JSON에는 

Response Value

위와 같은 형태로 값을 받아 왔기 때문에 JSON 값 중 data라는 키의 값을 꺼내 data 라는 JSONArray 변수에 넣어 주었어요.

 

 

com/junyss/discordbottest/common/SpringBootAPICaller.java 50 ~ 77번째 줄

그런 뒤 반복문을 data라는 JSONArray 배열 크기 만큼 반복문을 돌려 주면서 다시 해당 배열에 index 번째 값을 꺼내 JSONObject 객체형 변수 dataJSONObject에 담아 주었어요.

그런 뒤 위에서 만들어주었던 StringBuilder 객체 변수 resultMessage에 주니가 받고 싶은대로 요리하여 API를 통해 받은 값들을 전달 받을 수 있게 가공한 뒤 StringBuilder 객체 toString()을 통해 문자열로 반환되도록 하여 주었어요.

하지만, API 통신이 실패하여 응답 코드가 200이 아니라면 else 절을 통해 문제가 발생하였단 내용을 클라이언트 즉, 디스코드 봇이 사용자에게 전달할 수 있도록 반환 메시지를 가공하여 보내주도록 하였어요.

근데 if문에도 들어오지 못하고, else 문에도 들어오지 못한 어떤 문제는 75번째 문자열이 반환되게 하여 문제가 발생하였음을 알리도록 하였습니다.

 

 

 

이번에는 이렇게 JAVA를 이용해서 API에 호출하는 방법에 대해 정리해 보았어요.

다음 글에서는 본격적으로 디스코드 봇을 이용해서 이번에 만든 API 호출을 위한 클래스들을 이용해서 API를 호출하고, 데이터 베이스 내에 저장된 값들을 원하는 검색 기능을 통해 가져오면서 가공해서 받아 보는 것을 정리해 보도록 할게요.

 

 

 

 

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

 

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

All in One Java 애플리케이션 개발 : Spring Hibernate MyBatis를 활용한

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