<div id="readability-page-1" class="page"><div id="entry-view">
                
                <main>
                    <div>
                            <article id="mainContent">
                                <div>
                                    <p><a href="/m/category/%ED%86%A0%EC%9D%B4%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8/%EB%94%94%EC%8A%A4%EC%BD%94%EB%93%9C%20%EC%9B%B9%ED%9B%85%20API"><span>토이프로젝트/디스코드 웹훅 API</span></a></p><h3>easy-discord-webhook-api v1.0 정리하기</h3>
                                </div>
                                <p><cite>Berno</cite>
                                    <span> 2023. 7. 21. 18:52</span>
                                </p>
                                            
            


            
                <div>
                                <h3 data-ke-size="size23"><b>0. 이 글의 목적</b></h3>
<p data-ke-size="size16"><a href="https://github.com/0113bernoyoun/easy-discord-webhook-api" target="_blank" rel="noopener">https://github.com/0113bernoyoun/easy-discord-webhook-api</a></p>
<figure id="og_1689933160047" contenteditable="false" data-ke-type="opengraph" data-ke-align="alignCenter" data-og-type="object" data-og-title="GitHub - 0113bernoyoun/easy-discord-webhook-api" data-og-description="Contribute to 0113bernoyoun/easy-discord-webhook-api development by creating an account on GitHub." data-og-host="github.com" data-og-source-url="https://github.com/0113bernoyoun/easy-discord-webhook-api" data-og-url="https://github.com/0113bernoyoun/easy-discord-webhook-api" data-og-image="https://scrap.kakaocdn.net/dn/otHLe/hyTpafInnn/BWtFsNArMoxhpQ4W7OBJb1/img.png?width=1200&amp;height=600&amp;face=0_0_1200_600"><a href="https://github.com/0113bernoyoun/easy-discord-webhook-api" target="_blank" rel="noopener" data-source-url="https://github.com/0113bernoyoun/easy-discord-webhook-api">

<div>
<p data-ke-size="size16">GitHub - 0113bernoyoun/easy-discord-webhook-api</p>
<p data-ke-size="size16">Contribute to 0113bernoyoun/easy-discord-webhook-api development by creating an account on GitHub.</p>
<p data-ke-size="size16">github.com</p>
</div>
</a><img src="https://scrap.kakaocdn.net/dn/otHLe/hyTpafInnn/BWtFsNArMoxhpQ4W7OBJb1/img.png?width=1200&amp;height=600&amp;face=0_0_1200_600"></figure>
<p data-ke-size="size16">이 프로젝트를 배포하면서 했던 일들 정리하기 위함이 목적</p>


<h3 data-ke-size="size23"><b>1. 구조</b></h3>
<p data-ke-size="size16">Slack은 라이브러리를 제공해 줘서 참 좋은데 discord는 이게 없다. 그래서 만들면 재미있겠다 싶어서 무작정 만들기 시작했다.</p>
<p data-ke-size="size16">다행히 어떤 parameter가 어떤 역할을 하는지에 대해서는 잘 나와있다.</p>
<p data-ke-size="size16"><a href="https://birdie0.github.io/discord-webhooks-guide/discord_webhook.html">https://birdie0.github.io/discord-webhooks-guide/discord_webhook.html</a></p>
<figure id="og_1690360294377" contenteditable="false" data-ke-type="opengraph" data-ke-align="alignCenter" data-og-type="website" data-og-title="Discord Webhook - Discord Webhooks Guide" data-og-description="Before using Webhooks you have to know the structure. All elements listed here are optional but request body should contain content, embeds or attachments, otherwise request will fail. username - overrides the predefined username of the webhook avatar_url " data-og-host="birdie0.github.io" data-og-source-url="https://birdie0.github.io/discord-webhooks-guide/discord_webhook.html" data-og-url="https://birdie0.github.io/discord-webhooks-guide/discord_webhook.html" data-og-image="https://scrap.kakaocdn.net/dn/bCHUcw/hyTqyvWXl1/2T5IOXWYvMskDxHtiaq6x1/img.png?width=598&amp;height=614&amp;face=0_0_598_614"><a href="https://birdie0.github.io/discord-webhooks-guide/discord_webhook.html" data-source-url="https://birdie0.github.io/discord-webhooks-guide/discord_webhook.html">

<div>
<p data-ke-size="size16">Discord Webhook - Discord Webhooks Guide</p>
<p data-ke-size="size16">Before using Webhooks you have to know the structure. All elements listed here are optional but request body should contain content, embeds or attachments, otherwise request will fail. username - overrides the predefined username of the webhook avatar_url</p>
<p data-ke-size="size16">birdie0.github.io</p>
</div>
</a><img src="https://scrap.kakaocdn.net/dn/bCHUcw/hyTqyvWXl1/2T5IOXWYvMskDxHtiaq6x1/img.png?width=598&amp;height=614&amp;face=0_0_598_614"></figure>
<p data-ke-size="size16"><a href="https://discord.com/developers/docs/resources/webhook">https://discord.com/developers/docs/resources/webhook</a></p>
<figure id="og_1690360294377" contenteditable="false" data-ke-type="opengraph" data-ke-align="alignCenter" data-og-type="website" data-og-title="Discord Developer Portal — API Docs for Bots and Developers" data-og-description="Integrate your service with Discord — whether it's a bot or a game or whatever your wildest imagination can come up with." data-og-host="discord.com" data-og-source-url="https://discord.com/developers/docs/resources/webhook" data-og-url="https://discord.com/developers/docs/resources/webhook" data-og-image="https://scrap.kakaocdn.net/dn/GFMvy/hyTrXASUx0/oM7PYDBPZ2l6i6qroznDzK/img.png?width=2400&amp;height=1256&amp;face=0_0_2400_1256"><a href="https://discord.com/developers/docs/resources/webhook" data-source-url="https://discord.com/developers/docs/resources/webhook">

<div>
<p data-ke-size="size16">Discord Developer Portal — API Docs for Bots and Developers</p>
<p data-ke-size="size16">Integrate your service with Discord — whether it's a bot or a game or whatever your wildest imagination can come up with.</p>
<p data-ke-size="size16">discord.com</p>
</div>
</a><img src="https://scrap.kakaocdn.net/dn/GFMvy/hyTrXASUx0/oM7PYDBPZ2l6i6qroznDzK/img.png?width=2400&amp;height=1256&amp;face=0_0_2400_1256"></figure>

<p data-ke-size="size16">우선 record를 사용했다.</p>
<p data-ke-size="size16">record는 jdk14에서 도입된 data class이다.(코틀린의 data와 동일하다고 생각하면 된다.)</p>
<p data-ke-size="size16">롬복에 대한 의존성도 제거를 하고 싶었고 그 과정에서 데이터에 대한 접근을 편하게 하려고 record로 진행했다.</p>
<figure data-ke-mobilestyle="widthOrigin" data-origin-width="448" data-origin-height="732">
    <span data-url="https://blog.kakaocdn.net/dn/bMlKwX/btso6iWAgHp/9kVQsUX8yotzT4EqnXT4y0/img.png" data-lightbox="lightbox">
        <img src="https://blog.kakaocdn.net/dn/bMlKwX/btso6iWAgHp/9kVQsUX8yotzT4EqnXT4y0/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" width="302" height="493" data-origin-width="448" data-origin-height="732">
    </span>
    
</figure>
<p data-ke-size="size16">문제는 record에서는 생성자 오버로딩이 안된다는 점이다.</p>
<figure data-ke-mobilestyle="widthOrigin" data-origin-width="946" data-origin-height="312">
    <span data-url="https://blog.kakaocdn.net/dn/qMkOz/btso08gsQ5n/quRm8GT9RysOX6kPs8OUE0/img.png" data-lightbox="lightbox">
        <img src="https://blog.kakaocdn.net/dn/qMkOz/btso08gsQ5n/quRm8GT9RysOX6kPs8OUE0/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" width="654" height="216" data-origin-width="946" data-origin-height="312">
    </span>
    
</figure>
<p data-ke-size="size16">이 점 때문에 값을 넣지 않고 싶어하는 파라미터에 억지로 null이라도 채워 넣어야 하는데 이 부분은 Builder패턴으로 해결했다.</p>

<p data-ke-size="size16">이후 사용자가 전송을 하게 되는 클래스는 MsgAPI로 만들었다.</p>
<p data-ke-size="size16">싱글턴으로 만들어서 한번 webhookurl을 설정하면 계속해서 가지고 있게 할 목적이었다.</p>

<p data-ke-size="size16">최대한 라이브러리에 대한 의존성을 제외하기 위해 OkHTTP나 Retrofit등의 라이브러리를 사용하지 않고 HttpUrlConnection을 사용하였다.</p>
<p data-ke-size="size16">이제 남은 건 전송할 때 모든 값들을 json으로 변환해서 보내야 한다. 이건 좀 귀찮은 작업이라 1.0 버전에서는 ObjectMapper를 사용하였다.&nbsp;</p>

<p data-ke-size="size16">최종적으로 이 라이브러리의 외부 의존은 fasterxml과 jdk14버전 이상이 남게 되는 것이다.</p>

<h3 data-ke-size="size23"><b>3. 개선 사항 및 추후 방향</b></h3>
<p data-ke-size="size16">우선 클래스의 이름을 MsgAPI로 적었듯 나중에는 slack, discord를 통합한 라이브러리를 하나 가져가는 게 좋지 않을까 싶다.(이때는 레포가 바뀌거나 레포의 이름이 변경될 것 같다.)</p>
<p data-ke-size="size16">그리고 모든 의존성을 제거하기 위해 ObjectMapper에 대한 의존도 제거하고 record대신 class를 사용해야 할 것이다.</p>
<p data-ke-size="size16">이후 jar에 대한 빌드는 github action에 맡기면 될 것으로 생각된다.</p>



            
            
                </div>
            

                                

                            </article>
                            
                            
                            
                            
                            
                            
                                
                            
                        </div>
                </main>
                
            </div></div>

흔한 컴공출신 개발자

bernoyoun

0. 이 글의 목적
https://github.com/0113bernoyoun/easy-discord-webhook-api
이 프로젝트를 배포하면서 했던 일들 정리하기 위함이 목적
 
 
1. 구조
Slack은 라이브러리를 제공해 줘서 참 좋은데 discord는 이게 없다. 그래서 만들면 재미있겠다 싶어서 무작정 만들기 시작했다.
다행히 어떤 parameter가 어떤 역할을 하는지에 대해서는 잘 나와있다.
https://birdie0.github.io/discord-webhooks-guide/discord_webhook.html
https://discord.com/developers/docs/resources/webhook
 
우선 record를 사용했다.
record는 jdk14에서 도입된 data class이다.(코틀린의 data와 동일하다고 생각하면 된다.)
롬복에 대한 의존성도 제거를 하고 싶었고 그 과정에서 데이터에 대한 접근을 편하게 하려고 record로 진행했다.
문제는 record에서는 생성자 오버로딩이 안된다는 점이다.
이 점 때문에 값을 넣지 않고 싶어하는 파라미터에 억지로 null이라도 채워 넣어야 하는데 이 부분은 Builder패턴으로 해결했다.
 
이후 사용자가 전송을 하게 되는 클래스는 MsgAPI로 만들었다.
싱글턴으로 만들어서 한번 webhookurl을 설정하면 계속해서 가지고 있게 할 목적이었다.
 
최대한 라이브러리에 대한 의존성을 제외하기 위해 OkHTTP나 Retrofit등의 라이브러리를 사용하지 않고 HttpUrlConnection을 사용하였다.
이제 남은 건 전송할 때 모든 값들을 json으로 변환해서 보내야 한다. 이건 좀 귀찮은 작업이라 1.0 버전에서는 ObjectMapper를 사용하였다. 
 
최종적으로 이 라이브러리의 외부 의존은 fasterxml과 jdk14버전 이상이 남게 되는 것이다.
 
3. 개선 사항 및 추후 방향
우선 클래스의 이름을 MsgAPI로 적었듯 나중에는 slack, discord를 통합한 라이브러리를 하나 가져가는 게 좋지 않을까 싶다.(이때는 레포가 바뀌거나 레포의 이름이 변경될 것 같다.)
그리고 모든 의존성을 제거하기 위해 ObjectMapper에 대한 의존도 제거하고 record대신 class를 사용해야 할 것이다.
이후 jar에 대한 빌드는 github action에 맡기면 될 것으로 생각된다.

easy-discord-webhook-api v1.0 정리하기

댓글