<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:cc="http://cyber.law.harvard.edu/rss/creativeCommonsRssModule.html">
    <channel>
        <title><![CDATA[Stories by JeungJoo Lee on Medium]]></title>
        <description><![CDATA[Stories by JeungJoo Lee on Medium]]></description>
        <link>https://medium.com/@gloryan?source=rss-e1980d94947b------2</link>
        <image>
            <url>https://cdn-images-1.medium.com/fit/c/150/150/1*pJE-dSb9g5JCCzmNMVyhEA.png</url>
            <title>Stories by JeungJoo Lee on Medium</title>
            <link>https://medium.com/@gloryan?source=rss-e1980d94947b------2</link>
        </image>
        <generator>Medium</generator>
        <lastBuildDate>Fri, 20 Nov 2026 10:58:56 GMT</lastBuildDate>
        <atom:link href="https://medium.com/@gloryan/feed" rel="self" type="application/rss+xml"/>
        <webMaster><![CDATA[yourfriends@medium.com]]></webMaster>
        <atom:link href="http://medium.superfeedr.com/" rel="hub"/>
        <item>
            <title><![CDATA[BI Tableau 활용 시리즈— (1)]]></title>
            <link>https://medium.com/greendatakr/bi-tableau-%ED%99%9C%EC%9A%A9-%EC%8B%9C%EB%A6%AC%EC%A6%88-1-f73b22c8b72d?source=rss-e1980d94947b------2</link>
            <guid isPermaLink="false">https://medium.com/p/f73b22c8b72d</guid>
            <category><![CDATA[tableau]]></category>
            <category><![CDATA[business-intelligence]]></category>
            <category><![CDATA[big-data]]></category>
            <category><![CDATA[data-analysis]]></category>
            <category><![CDATA[research]]></category>
            <dc:creator><![CDATA[JeungJoo Lee]]></dc:creator>
            <pubDate>Fri, 23 Apr 2021 17:16:44 GMT</pubDate>
            <atom:updated>2021-04-25T05:51:17.906Z</atom:updated>
            <content:encoded><![CDATA[<p>에너지 관련 시스템 구축 프로젝트 중 고객의 요구사항이 명확하지 않은 상황에서 수집된 데이터의 가치를 어떻게 발견 할 수 있을지와 데이터 분석 시각화 화면 UI 를 개발 하기 전에 효과적으로 기획을 할 수 있는 방법에 대한 고민이 있었다. 뜻 밖에도 해당 해답은 AWS 관련 도서를 읽다가 발견하게 되었다.</p><p>데이터웨어하우스 역할을 하는 AWS 의 Redshift 에 저장소에서 Tool 을 저장소와 직접 연결하여 데이터를 여러 방면으로 분석할 수 있는 BI(Business Intelligence) Tool 이었다.</p><h3>Tableau 를 활용하게 된 이유</h3><p>아래와 같은 스프레드 시트에 담긴 행/열 데이터를 활용하여 시각화를 통해 데이터의 가치를 발견할 수 있는 분석 용 도구인데 시중에 굉장히 많지만 대표적으로 Tableau, Qlik 그리고 PowerBI 가 존재한다. 이 중 가장 대표적으로 많이 사용 되는 Tableau 였던것 같고 무엇보다도 이 도구를 선택했던 이유는 현재 프로젝트에서 사용 중인 NoSQL 데이터베이스 Mongo DB 데이터소스와 연결이 용이하다고 판단 되었기 때문이다.</p><figure><img alt="Tableau 에서 불러온 예제 스프레드 시트 데이터 원본" src="https://cdn-images-1.medium.com/max/1024/1*SAlKGxMn_po0XR0Psktpzw.png" /><figcaption>Tableau 에서 스프레드 시트의 데이터 원본을 불러온 모습</figcaption></figure><p>아래 시각화한 데이터들의 모습은 위의 스프레드 시트의 데이터를 행/열 별로 데이터의 값을 Aggregation 한 형태의 모습이다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*VH-4HgHhZr6Hb-fD9CeSCA.png" /><figcaption>행/열의 raw 데이터를 Tableau를 사용하여 시각화한 모습</figcaption></figure><h3><strong>라이선스 정책</strong></h3><p>Tableau 라이선스는 아쉽게도 유료이다. 아무래도 좋은 도구이고 인지도가 높은 만큼 비용이 들어간다. 대기업이 아닌 스타트 업에서 여러 개의 카피를 구매하여 사용하기에는 약간 빡 쌘 가격이다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*5NS2hK_NP3G7fkY0poPC2w.png" /><figcaption>라이선스 가격</figcaption></figure><p>Tableau 라이선스에는 Creator, Explorer 그리고 Viewer 가 존재하는데 Creator 는 Tableau 도구를 통해 데이터를 시각화하고 직접 분석용 대시보드를 만드는 사람이다. Explorer 는 Creator 가 만든 대시보드들을 수정할 수 있다. 마지막으로 Viewer 는 단순하게 보기 전용으로 볼 수 있는 사람이다. Tableau 는 이 세 종류의 타입의 사용자에게 모두 과금 한다. 최소로 잡아도 무려 1500 달러가 넘는 돈을 지불해야 이 소프트웨어를 사용할 수 있다는 말이 나온다.</p><p>고로 현재 사용 가치가 불분명한 상황에서 구매하고 쓰기에는 다소 무리감이 없지 않아 있다. 이런 것을 Tableau 를 만든 회사도 알아 차린것인지 사이트에 간단한 정보만 기입하면 약 15일동안 무료로 사용할 수 있는 Trial 버전을 제공해준다. 15일이 지나면 짤없이 끝나게 된다.</p><h3>초기 실행 화면</h3><p>Tableau 를 실행하면 아래와 같은 화면이 초기 화면으로 나올 것이다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*1GVkBiGzb4-O07Y7oGgaAA.png" /><figcaption>Tableau 실행 초기 화면</figcaption></figure><p>좌측 메뉴에 보면 데이터소스를 연결 할 수 있는 여러가지 방법들이 보인다. Excel 도 존재하고 JSON 파일도 연결 가능하고 심지어 PDF 파일의 데이터도 Tableau 에서 사용이 가능하다. 또한 [서버에 연결] 섹션에 보면 AWS Redshift 랑 ODBC 를 통한 DB 데이터 소스 와도 연결이 가능한 것으로 나온다.</p><p>직접 Mongo DB 와 커넥트 하여 데이터를 다루는 방법은 다른 챕터에서 소개하도록 하겠고 아래와 같이 Atlas MongoDB 를 유료로 사용하는 회사라면 BI Connector 사용에 대한 추가적인 비용만 지불하면 Tableau 와 연결할 수 있는 커넥터 리소스 정보를 Atlas 에서 제공해주게 된다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*C5E3a3HO3jou_9s11QIwlA.png" /><figcaption>BI Connector 유료를 사용했을 때 Atlas 에서 제공해주는 BI Connector 정보</figcaption></figure><h3>엑셀 데이터 불러오기</h3><p>스프레드 시트의 행/열 데이터 예제 중 미국의 년도 및 연령대별 실업률에 대한 엑셀 데이터를 불러오도록 하겠다. [파일의 연결] &gt; [Microsoft Excel] 을 클릭하면 Finder 팝업이 뜨고 엑셀을 선택하면 된다. 만약 CSV 파일 형태라면 [텍스트 파일]을 클릭하면 선택이 활성화 된다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*FW87HT-sXFxXAUcIdj3hOw.png" /></figure><p>엑셀 파일을 선택하게 되면 스프레드 시트 데이터 원본이 행/열 형태로 Tableau 에서 볼 수 있게 된다. 현재 데이터는 손색이 없을 정도로 컬럼 값에 null 값이 존재 하지 않고 정규화 된 데이터 이기 때문에 별도의 터치 작업은 필요하지 않지만 비 규정화 되고 가공이 필요한 경우라면 Tableau 도구에서 데이터 원본을 자동으로 정규화 해주는 좋은 기능도 제공하고 있다. 그 외로 엑셀 사용 시 데이터 분석할 때 많이 사용하는 Pivot 기능도 사용이 가능하다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*WnSDb7rB6oG39A1rSRt2lA.png" /></figure><p>위의 원본데이터를 기준으로 아래 세 가지의 아이콘 중 가장 왼쪽의 아이콘을 클릭하면 시각화를 위한 컴퍼넌트를 작성할 수 있게 된다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/272/1*qGm8RpbfjsecKdSzUk346Q.png" /></figure><p>클릭을 하게 되면 아래와 같은 화면이 나온다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*fe27rh1-EPww6vT-jPZW0Q.png" /></figure><p>여기서 살펴 보아야할 부분은 바로 데이터 원본에서 각 컬럼의 정보들이다. 우선 [열]에 년도를 넣어 보겠다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*w-MNlt4eu1yLkXmD-Qme2g.png" /></figure><p>Drag &amp; Drop 으로 왼쪽에 Period 정보를 끌어다가 [열] 공간에 놓게 되면 위와 같이 완성 된다. 그 다음 [행] 에는 Unemployed 값을 끌어 와 보자.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*lGEST_fkGdfHmtaVGwiMIw.png" /></figure><p>그럼 위와 같이 각 년도별로 실업자 수에 대한 정보가 Line Chart 로 표현될 것이다. 여기서 한 가지 알아두어야 할 점은 좌측의 데이터 원본에서 가져오 데이터들의 형태인데 #은 측정할 수 있는 숫자로 표현된 값들이고 Abc 의 경우 String 타입의 문자열들이다. Group By 나 Filter 를 걸 수 있는 항목이라고 생각 하면 될 것 같다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/386/1*T4NygPXovoSk7rqTgXBIaQ.png" /></figure><h3>차트의 다양한 표현</h3><p>이제부터 데이터원본을 기준으로 다양한 시각화를 통해 데이터의 해석이 달라지게 된다. 위의 년도별 실업자 수에서 [열] 의 년도로 설정되어 있는 부분을 조금 더 상세하게 월별로 Setup 하여 살펴 보겠다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/636/1*XmwpNozGPxWbsl4_Z-63Zg.png" /></figure><p>위의 년을 월로 바꾸게 되면 차트는 조금 더 세밀하게 Line Chart 가 만들어진다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*xKkub6mUzpHZgiKcWwdSFQ.png" /></figure><p>그리고 이 상태에서 Age 를 [색상]에다 Drag &amp; Drop 으로 끌어 놓게 되면 아래와 같이 라인차트가 연령대별로 색깔로 표현되게 된다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*-9WqclsRuIS_iULlxGJmxA.png" /></figure><p>이번에는 Line Chart 가 아닌 Circle Chart 로 표현해보겠다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*SCROTKP7gslQGFS-muiJdQ.png" /></figure><p>각 연령대별로 실업자 수가 각 년도별로 어떻게 분포되어 있는지 알 수 있다. 범례에서 해당 연령대를 선택하게 되면 그 연령대만 시트 상에서 볼 수 있다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*qPKLPmg6TTIW8axiRZWZkQ.png" /></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*xirac_SM2R9TlQpwpKZ9ng.png" /></figure><p>일단 기본적으로 이 차트를 통해 해당 데이터가 말해주고 있는 부분 중 기본적인 인사이트는 2009년부터 2010년 까지 실업자 수가 심각하게 증가하고 있는 것을 볼 수 있고 25세부터 54세까지 일을 가장 많이 해야하는 연령층들이 해당 기간에 실업자가 된 것을 알 수 있고 16~19세의 노동자들은 실업이 증가는 했지만 상대적으로 25세부터 54세 보다는 낮은 것을 알 수가 있다.</p><p>데이터 원본에서 아직 사용하지 않은 필드는 성별이다. 이 성별은 [필터] 에 끌어다 놓아 보겠다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*WYkkEiMGHS7PyGPbmZWdiQ.png" /></figure><p>위와 같은 팝업이 나오게 되고 모두 선택 후 확인을 누르면 필터가 추가 된 것을 확인 할 수가 있다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*qhYxsy5g3DDy97RZ84X_hg.png" /></figure><p>단, 필터의 값을 적용하기 위해선 Gender 에 마우스를 클릭하고 [필터 표시] 메뉴를 클릭한다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/680/1*_jURVpBBK7cmCcsNbrQDKw.png" /></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*hZm458-y-Nc4y5XV1-WyPQ.png" /></figure><p>그럼 위와 같이 Gender 에 대한 필터의 값을 사용할 수가 있게 된다.</p><p>위의 Circle Chart를 이번에는 Area Chart로 바꿔보도록 하겠다. 아까 Circle 보다는 보기가 조금 더 쉬워진 느낌이다. 여기에 하나 더 각 영역 별로 Age 영역대 Label 을 Chart에 표현했는데 이 부분의 경우 [마크] 메뉴 공간에 [레이블] 이라는 곳에 Age 값을 마우스로 끌어다 놓기만 하면 아래와 같이 영역에 Label 이 표시가 된다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*2av7lBQ9w-XU2yyuhmOGng.png" /></figure><p>이 처럼 데이터의 원본을 기준으로 다양한 차트를 적용하며 같은 데이터를 바라보더라도 여러가지의 관점으로 해석하거나 조금 더 명확하게 데이터를 볼 수 있다는 장점이 생기게 된다.</p><h3>데이터 조인</h3><p>이 번에 살펴볼 데이터는 각 유럽 국가에서 고객별로 마트에서 판매한 판매 데이터를 기준으로 각 테이블 3개의 조인을 Tableau 에서 하는 과정을 먼저 살펴보도록 하겠다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*8XzpXGgG9vMwHhKFVgx1aw.png" /></figure><p>위의 엑셀 데이터를 동일하게 Tableau 에서 데이터 원본으로 불러오도록 하자.</p><p>아래의 화면은 최종적인 Inner Join 을 각 3 개의 테이블을 특정 컬럼의 값으로 Join 한 모습이다. 이 Join 된 데이터들은 Tableau 에서 하나의 테이블의 값처럼 사용할 수 있다. 이것은 마치 RDB 에서 우리가 SQL 을 사용하여 Join 문을 활용해 각 데이터의 값들을 모두 불러온 형태라고 생각 하면 될 것 같다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*mlSC1Yt3Gew-LkqHmAv_4w.png" /></figure><p>위의 판매 데이터를 기준으로 여러 관점의 데이터 시각화가 나올 수 있지만 딱 두 가지만 보도록 하겠다.</p><h3>국가/주 별 판매금액 및 마진율 (Map Chart 활용)</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*FkotpoqtnWTAddvMWRAcaA.png" /></figure><p>위의 데이터 원본 에서는 각 고객별로 거주 국가와 주 그리고 도시에 대한 정보가 존재한다. 해당 값을 기준으로 Map 을 자동화해서 그릴 수 있는데 Tableau 에서는 2 가지 케이스로 Map 을 자동으로 그려 주는 것 같다. 첫 번째는 네이밍을 기반으로 한다. 예를 들어 판매 데이터에 고객 A 가 Sweden 의 Stockholm 주에 거주한다면 해당 네이밍을 대상으로 위/경도를 바탕으로 Map 에 표현해주고 아예 데이터 자체에 위/경도가 존재한다면 해당 위치를 기반으로 데이터를 Aggregation 할 수도 있다.</p><p>위의 데이터는 원의 크기는 판매금액을 의미한다. 커질 수록 판매 금액이 높은 것으로 표현 하였고 Profit Margin 의 경우 데이터 원본에 없는 데이터지만 [계산된 필드] 기능을 사용하면 추가적으로 만든 데이터를 활용해서 시각화에 사용할 수도 있다. 현재는 Sales(판매금액) 과 Profit (이윤) 데이터만 존재하기 때문에 이에 대한 각 국가/주별 전체 판매금액에 따른 이윤의 총합의 비율을 아래와 같이 추가해 줄 수 있다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*byhKb8vuylc6C2RPinayCg.png" /></figure><p>추가된 Profit Margin 을 색깔별로 데이터를 추가해주면 아래와 같이 마진율이 높을 수록 블루 계열로 낮을수록 레드 계열로 색깔이 표현 됨을 알수 있을 것이다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*RDrC7Mt3yUqHYgEUCiSJwQ.png" /></figure><h3>대시보드 기능</h3><p>이 외에 시트를 여러 형태로 만들어서 시각화를 여러 방면으로 만들고 이를 하나로 합쳐서 대시보드 형태로 만들 수 있는 기능이 Tableau 에서 [대시보드] 기능이라 한다. 하단에 메뉴 중 두 번째를 클릭하면 대시보드를 만들 수 있을 것이다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/242/1*HgJNxsiiU2NrRZCicbiHlw.png" /></figure><p>대시보드를 클릭하게 되면 아래와 같이 여러 시각화 된 차트 컴퍼넌트들을 한곳에서 볼 수 있게 되고 클릭 또는 마우스 오버 시 이벤트를 걸어 해당 되는 필터에 대해서만 데이터를 볼 수 있게 하는 기능도 있어 마치 Front-End 개발을 기능적으로 해서 볼 수 있는 효과를 주게 된다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*NaonayGHyDJgHxKV7Up_RA.png" /></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*5MObkjg-SGhlnyprHFwT-g.png" /></figure><p>클릭 시 이벤트의 경우 [필터로 사용] 이라는 메뉴를 클릭하게 되면 자동적으로 동작에 대한 정의를 Tableau 가 인식하고 해당 데이터들을 클릭 했을 때 다른 시트에도 필터가 걸게 된다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*CW1EvHx4hKQVV-ocjgOQpg.png" /></figure><p>위의 United Kingdom 을 눌렀을 때 해당 지역에 판매량과 마진율을 볼 수 있게 되고 각 년도별로 시계열의 데이터를 확인할 수 있다.</p><h3>마치며</h3><p>이 외에 다음 시간에 살펴볼 내용은 위의 대시보드를 조금 더 Advanced 하게 만들어 보고 스토리텔링 기능을 활용하여 현업에게 전달할 수 있는 방법을 알아볼 예정이다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*QMJcmJpzpsRWjOy9JXSdFg.png" /></figure><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=f73b22c8b72d" width="1" height="1" alt=""><hr><p><a href="https://medium.com/greendatakr/bi-tableau-%ED%99%9C%EC%9A%A9-%EC%8B%9C%EB%A6%AC%EC%A6%88-1-f73b22c8b72d">BI Tableau 활용 시리즈— (1)</a> was originally published in <a href="https://medium.com/greendatakr">GreenDataKR</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[MQTT 프로토콜]]></title>
            <link>https://gloryan.medium.com/mqtt-%ED%94%84%EB%A1%9C%ED%86%A0%EC%BD%9C-e85a352636c1?source=rss-e1980d94947b------2</link>
            <guid isPermaLink="false">https://medium.com/p/e85a352636c1</guid>
            <category><![CDATA[mqtt]]></category>
            <category><![CDATA[software-development]]></category>
            <category><![CDATA[event-driven-architecture]]></category>
            <dc:creator><![CDATA[JeungJoo Lee]]></dc:creator>
            <pubDate>Mon, 28 Sep 2020 00:27:08 GMT</pubDate>
            <atom:updated>2020-09-28T00:27:08.444Z</atom:updated>
            <content:encoded><![CDATA[<h3>MQTT 이란?</h3><p>Message Queue for Telemetry Transport 의 약자임</p><p>TCP/IP 프로토콜 기반 위에서 작동하고 IoT 기기를 위해 낮은 전력, 낮은 대역폭과 패킷량으로 통신하는 프로토콜이다. 기존 Pub/Sub 의 경량 프로토콜이라고 생각하면 좋을 듯하다. 가볍다 라는 장점은 존재하지만 QoS(서비스 품질)에는 제약이 있다. 저전력/소규모 디바이스를 위한 통신 프로토콜에 적합하기 때문에 IoT 에 적합한 프로토콜이다.</p><h3>QoS란?</h3><p>Quality of Service 의 약자로 서비스의 품질이라는 뜻을 내포하고 있고 총 3 단계를 지원하게 된다.</p><ul><li>0 단계 : Topic 을 통해 Publisher가 최대 1회의 메시지 전송하는데 <strong>꼭 Subscriber 가 받는 다는 보장을 해주지 않음</strong></li><li>1 단계 : 최소 1회의 전송하고 Subscriber 가 message 를 받았는지 불확실하면 정해진 횟수 만큼 다시 재전송 ( 중복 위험 )</li><li>2단계 : Subscriber 가 message 를 정확히 한 번에 수신할 수 있도록 보장함</li></ul><h3>Use Cases</h3><p>Facebook Messanger, 우아한 형제들 ( 지금 사용하는지는 모르겠음 )</p><p><strong>우아한 형제들 사례 ( 2017.08.11 )</strong></p><p>기존 API Polling → MQTT 프로토콜로 변경함.</p><p><a href="https://woowabros.github.io/experience/2017/08/11/ost_mqtt_broker.html">MQTT 적용을 통한 중계시스템 개선 — 우아한형제들 기술 블로그</a></p><h3>MQTT Pub/Sub/Broker 구조</h3><p>TCP 기반의 HTTP 프로토콜에서 사용하는 Client ↔서버 통신 방식이 아닌 아래와 같은 Broker, Publisher, Subscriber 의 구조로 되어있다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*xE-i0u9d2__WPpuPRzb6fA.png" /></figure><h3>MQTT Broker 의 역할</h3><p>Network 가 단절 되지 않는 한 Socket 통신처럼 계속 디바이스와 연결을 MQTT Broker 가 Client 와 맺고 있음. 연결이 끊어진 이후에 계속 재접속을 지원하기 때문에 State 상태가 유지가 됨 또한 Cleint 에서 발생하는 Topic 별 message 를 받거나 Broadcasting 하기 위해 heartbeat check 을 클라이언트들에게 하는 역할을 담당함</p><h3>Topic 발행(Publication) 과 구독(Subscription)</h3><p>개설된 Topic 에 message 를 Pub 역할을 하는 클라이언트가 발행하면 Sub 역할을 하는 클라이언트가 해당 Topic 을 수신하여 처리할 수 있다. 1:N 1:1 메시지 전송이 가능하다.</p><h3>클라이언트 개발을 위한 Library</h3><p>클라이언트 개발을 위해 NodeJS, Python, Java, C 등 다양한 언어로 제공되고 있고 클라이언트 라이브러리 뿐만 아니라 Broker 또한 구성을 할 수 있도록 Library가 제공 된다. 대부분 유료의 경우 QoS 2단계를 지원하고 보통 QoS 1단계 까지만 지원한다.</p><h3>MQTT Broker 기준으로 한 클라이언트 들의 도식화</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*a3ddgapmNnoqDAp2Khtapw.png" /></figure><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=e85a352636c1" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[JS] 실행 컨텍스트]]></title>
            <link>https://medium.com/crocusenergy/js-%EC%8B%A4%ED%96%89-%EC%BB%A8%ED%85%8D%EC%8A%A4%ED%8A%B8-2b8ab8da4f4?source=rss-e1980d94947b------2</link>
            <guid isPermaLink="false">https://medium.com/p/2b8ab8da4f4</guid>
            <category><![CDATA[software-development]]></category>
            <category><![CDATA[javascript]]></category>
            <category><![CDATA[ecmascript-6]]></category>
            <category><![CDATA[execution-context]]></category>
            <category><![CDATA[javascript-engine]]></category>
            <dc:creator><![CDATA[JeungJoo Lee]]></dc:creator>
            <pubDate>Thu, 24 Sep 2020 01:46:43 GMT</pubDate>
            <atom:updated>2020-09-24T01:46:43.607Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/240/0*4c7ilcdbAhPKIjWq.jpg" /></figure><p>이번 시간에 살펴볼 것은 자바스크립트 개념 중 하나인 실행 컨텍스트에 대해 알아보도록 하겠습니다.</p><h3><strong>실행 컨텍스트란?</strong></h3><p>실행 컨텍스트란 실행 코드에 제공할 정보들을 모아 놓은 객체입니다. 무슨 말인지 아직 감이 잘 안오실 겁니다. 이 실행 컨텍스트는 아래와 같이 자바스크립트 코드를 실행 시 자바스크립트 엔진의 스택에 쌓게 됩니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/650/1*eANS26fEAiZ1wY-B880p5A.png" /></figure><h3>실행 컨텍스트가 생성되는 시점?</h3><p>실행 컨텍스트가 생성되는 시점은 다음과 같은 경우 생기게 됩니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/914/1*Ii7WvFqa1l3QT1kKtes9rw.png" /></figure><p>위의 4 가지 케이스에서 생기게 되는데요. 먼저 가장 기본적으로 실행 컨텍스트가 생기는 것은 바로 전역 공간에서 anonymous func() 실행 컨텍스트가 스택에 쌓입니다. 그 이후 코드 상 함수, { } 코드 블럭을 사용할 때도 하나의 실행 컨텍스트로 보고 콜 스택에 차례로 쌓이게 됩니다. 여기서 eval 이라는 함수도 실행 컨텍스트가 만들어지긴 하지만 잘 안쓰이고 지양하는 코딩 방법이기 때문에 흔히 볼수는 없을 것입니다.</p><p>자 그럼 아래 코드를 통해 스택의 변화를 살펴보도록 하겠습니다.</p><pre>// ------------------------ (1)<br>var a = 1;<br>function outer() {<br>   function inner() {<br>      console.log(a);<br>      var a = 3;<br>      // ------------------ (2)<br>   }<br>   inner(); // ------------ (3)<br>   console.log(a);<br>   // --------------------- (4)<br>}<br>outer(); // --------------- (5)<br>console.log(a);<br>// ------------------------ (6)</pre><p>위의 코드가 실행 되는 시점에 자바스크립트 엔진 에서는 실행을 위한 실행 컨텍스트의 정보들을 아래와 같이 스택에 먼저 쌓게 됩니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*opiv5MPSWom3U-wT8NzIzw.png" /></figure><p>코드에 사이 사이에 삽입한 숫자를 토대로 어떤 순차로 스택에 실행 컨텍스트를 쌓게 되는지 위에서 확인 할 수 있습니다. inner 함수 까지 쌓은 실행 컨텍스트의 정보는 inner 함수 실행 후 종료 시 스택에서 제거해 나갑니다. 그 다음은 outer 함수를 스택에서 제거하고 마지막은 전역 컨텍스트를 실행 컨텍스트에서 제거하면서 스택에 컨텍스트들이 없어지게 됩니다.</p><p>대부분 자바스크립트를 엔진에서 파싱하면서 코드를 실행 할 때 스택의 변화는 위와 같다라고 볼 수 있을 것입니다.</p><h3>실행 컨텍스트의 구조</h3><p>그렇다면 실행 컨텍스트를 구성하는 구조는 어떻게 되는지 아래 그림을 보고 살펴보도록 하겠습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*ATxZELtK8tjuZ0RGTEl5Vg.png" /></figure><p>실행 컨텍스트는 크게 Variable Environment, Lexical Environment, thisBinding 이 세 가지의 정보를 가지고 있다라고 볼 수 있습니다.</p><p>Variable Environment 와 Lexical Environment 의 내부에는 envrionmentRecord 와 outerEnvironmentReference 의 객체를 가지고 있다는 부분에서 동일하지만 Variable Environment 는 최초의 스냅샷의 개념으로 변경되는 컨텍스트 정보에 대해 업데이트를 하지 않습니다.</p><p>여기서 각 실행 컨텍스트를 구성하는 범위를 Scope 이라고 하면 상위 Scope 과 하위 Scope 이 존재할텐데 이 Scope 을 연결하여 현재 Scope에서 선언되지 않는 변수를 호출 한다면 상위에서 찾을 수 있도록 outerEnvironmentReference 가 스코프체인을 구성할 수 있도록 주소를 참조하게 됩니다. environmentRecord 의 경우 해당 컨텍스트에서 선언된 변수 식별자 정보들이 저장되어 있다. thisBinding 은 현재 이 컨텍스트가 어떤 this 를 바인딩하고 있는지 정보를 가지고 있는데 자바스크립트의 경우 this 가 바라보는 것이 일반적인 언어와 약간 다른데 그 부분은 나중에 언급하도록 하겠다. 기본적으로 this 를 명시하지 않으면 전역객체를 바라보게 되어있다.</p><p>이번 시간에 살펴본 것은 자바스크립트에서 코드를 실행할 때 실행 컨텍스트가 무엇인지 그리고 스택에 어떠한 순서대로 쌓는지 그리고 실행 컨텍스트가 구성하는 정보가 어떤 것들이 있는지를 살펴보았다.</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=2b8ab8da4f4" width="1" height="1" alt=""><hr><p><a href="https://medium.com/crocusenergy/js-%EC%8B%A4%ED%96%89-%EC%BB%A8%ED%85%8D%EC%8A%A4%ED%8A%B8-2b8ab8da4f4">[JS] 실행 컨텍스트</a> was originally published in <a href="https://medium.com/crocusenergy">CrocusEnergy</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[JS] undefined, null 어떨 때 쓸까?]]></title>
            <link>https://medium.com/crocusenergy/js-undefined-null-%EC%96%B4%EB%96%A8-%EB%95%8C-%EC%93%B8%EA%B9%8C-8782dc3c35b6?source=rss-e1980d94947b------2</link>
            <guid isPermaLink="false">https://medium.com/p/8782dc3c35b6</guid>
            <category><![CDATA[software-development]]></category>
            <category><![CDATA[undefined]]></category>
            <category><![CDATA[closure]]></category>
            <category><![CDATA[null]]></category>
            <category><![CDATA[javascript]]></category>
            <dc:creator><![CDATA[JeungJoo Lee]]></dc:creator>
            <pubDate>Fri, 18 Sep 2020 07:18:40 GMT</pubDate>
            <atom:updated>2020-09-18T07:18:40.893Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*Q8bHCV-9ApEQ2X5WeMvG6A.png" /></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/450/1*blwiJtR0mluF6R2UyakaSA.png" /><figcaption>undefined vs null</figcaption></figure><p>이번 포스팅은 자바스크립트에서 흔하게 볼 수 있는 undefined 와 null 에 대하여 이야기 하고자 한다. 도대체 언제 undefined 가 출력되고 null 이 나올까? 정말 많이 보는 데이터 타입인데 무심코 지나게 된다.</p><p>먼저 아래 코드를 통해 undefined 일 때 케이스를 확인해 보자</p><pre>let a;</pre><p>위의 코드를 보면 a 라는 변수를 선언하면 메모리에 변수 영역에 a 라는 식별자가 저장되는데 값이 할당 되어있지 않는 상태이다. 만약 이 상태에서 a 를 출력하거나 실행하려고 하면 undefined 라는 결과가 나오는 것을 확인할 수 있다. 이것을 통해 우리가 알 수 있는 사실은 a 변수를 메모리에 선언하고 값이 할당되어 있지 않은 상태에서 자바스크립트 실행을 하면 Runtime 시 undefined 데이터 타입의 값을 출력한다는 것을 알 수 있다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/360/1*Ev-BvvAYUws3nTo7Bm_KkA.png" /></figure><h3>undefined 도 값이다</h3><p>undefined 는 데이터 타입이자 값이다. 아무 것도 존재하지 않는 다는 표현의 값으로 생각하면 좋을 듯하다. 모든 변수에 값이 할당 되지 않는 경우 이 undefined는 값으로써 값이 할당되지 않은 모든 변수들이 자바스크립트 Runtime 시 할당되어 출력되게 된다.</p><p>아래 코드를 보자</p><pre>let a;<br>let b = undefined;</pre><pre>console.log(a); // undefined<br>console.log(a == b); // true<br>console.log(a === b); // true</pre><p>b 의 경우는 undefined 를 명시적으로 선언하고 있다. 그리고 a 변수와 변수 b는 == 느슨한 동등 연산자와 === 타입까지 체크하는 동등 연산자를 통해 비교해보면 true 로 값과 타입까지 같다는 것을 확인 할 수 있다.</p><p>어찌 보면 당연한 이야기지만 불편한 코드는 바로 b 에 undefined 를 선언하는 코드이다. 심심치 않게 코딩을 하다보면 저런 코드를 볼 수 있었는데 과연 저렇게 사용하는 것이 맞을까 라는 생각이 든다.</p><h3>null 은 뭐야?</h3><p>undefined는 ‘없음&#39;을 뜻하는 데이터 타입이다. 근데 자바스크립트에도 다른 정적 언어와 마찬가지로 null 이라는 데이터 타입이 존재한다. 아래 코드를 확인해 보자</p><pre>const n = null;<br>console.log(typeof n);</pre><p>명시적으로 n 이라는 상수에 null 을 할당 하였다. undefined 와 마찬가지로 null 도 ‘없음&#39;을 표현할 때 쓴다. 두 번째 줄의 typeof 를 하면 무엇이 나올까?</p><p>null 도 데이터 타입이기 때문에 null 이라는 출력값을 기대할 수 있겠지만 전혀 예상과 다른 값이 나온다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/582/1*8q8HovvkdlG25z-cFPvjGg.png" /></figure><p>두둥… 바로 object 참조데이터 타입이 나온다…. 이건 명백한 <strong>자바스크립트의 오류</strong>이다. ( 그래서 우린…. 더더욱.. 타입스크립트를 써야 한다.. -_-)</p><p>동등 연산자로 undefined 와 같이 아래 코드에서 비교해보도록 하겠다.</p><pre>const n = null;</pre><pre>console.log(n == undefined); // true<br>console.log(n == null); // true<br>console.log(n === undefined); // false<br>console.log(n === null); // true</pre><p>n = null 로 선언된 n 과 느슨한 동등 연산자로 undefined 와 null 를 비교하면 없음을 의미하는 값으로써 같다 라는 true 가 출력이 된다. 반면 type 까지 체크해주는 === 연산자와 비교시 undefined 와는 다르다 라는 false 가 나온다. 없음을 의미하는 측면에서 두 타입은 같지만 데이터 타입이 다르기 때문에 다르다 라는 것을 알 수 있다.</p><h3>그렇다면 언제 undefined 를 쓰고 null 을 써야할까?</h3><p>언제 undefined 를 써야 할까 라는 질문에 답변은 쓰지 말아라 라는 답변이 적절치 않을까 싶다. 왜냐하면 개발자는 undefined 메시지를 볼 수 있는 케이스는 자바스크립트가 코드를 실행할 때 변수에 적절한 값이 할당 되어있지 않거나 아래 함수처럼 return 이 없는 함수를 실행할 때 undefined 를 출력하기 때문이다.</p><pre>function a() { console.log(123) }</pre><p>고로, 자바스크립트 엔진이 코드를 실행할 때 없음을 표현하는 데이터 타입은 undefined 이기 때문에 이 케이스는 개발자가 아니라 엔진에서 리턴 했다고 생각하면 되고 null 은 개발자가 명시적으로 변수에 할당한 값 이기 때문에 필요한 곳에서 사용 했구나 라고 인식하면된다.</p><h3>null은 GC 가 쓰지 않는 메모리를 수거할 때 유용하다</h3><p>null은 대부분 없음을 표현한다고 알고 있지만 우리가 자바스크립트의 메모리를 효율적으로 관리하고 싶을 때 적절하게 쓸수 있다. 가령 예를들어 클로저 함수에서 함수 내부에서 사용하는 외부 변수의 경우 함수 내부를 리턴 받아 사용하다가 라이프 사이클이 종료되거나 로직상 더 이상 사용하지 않는 경우 외부 변수의 참조로 인해 메모리에서 사라지지 않는 현상이 발생할 수 있다. 그럴 때 명시적으로 null 로 할당해주면 GC 는 해당 함수가 참조하고 있는 변수를 메모리에서 삭제할 수 있기에 효율적인 메모리 관리가 가능해진다. 예를들어 코드로 표현하자면 아래와 같다.</p><pre>function closure() {<br>   let a = 1;<br>   let b = 2;<br>   return () =&gt; {<br>      return {<br>         a: a++,<br>         b: b++    <br>      }</pre><pre>   }</pre><pre>}</pre><pre>let func = closure();<br>// 사용</pre><pre>func(); // { a: 1, b: 2}<br>func(); // { a: 2, c: 3}<br>func(); // { a: 3, c: 4}</pre><pre>func = null; // 사용 후 a, b 가 GC 에게 반납 될 수 있도록 func 를 null 처리</pre><p>간단한 코드를 통해서 클로저 함수에서 어떻게 null 을 통해 메모리를 효율화 할 수 있는지 알아보았다.</p><p>이번 시간에 알아본 undefined 와 null 을 조금 더 명확히 쓰는 연습을 해보도록 하자!</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=8782dc3c35b6" width="1" height="1" alt=""><hr><p><a href="https://medium.com/crocusenergy/js-undefined-null-%EC%96%B4%EB%96%A8-%EB%95%8C-%EC%93%B8%EA%B9%8C-8782dc3c35b6">[JS] undefined, null 어떨 때 쓸까?</a> was originally published in <a href="https://medium.com/crocusenergy">CrocusEnergy</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[NestJS] TypeORM Subscribers 기능]]></title>
            <link>https://medium.com/crocusenergy/nestjs-typeorm-subscribers-%EA%B8%B0%EB%8A%A5-f330fe30b653?source=rss-e1980d94947b------2</link>
            <guid isPermaLink="false">https://medium.com/p/f330fe30b653</guid>
            <category><![CDATA[nodejs]]></category>
            <category><![CDATA[typeorm]]></category>
            <category><![CDATA[nestjs]]></category>
            <category><![CDATA[software-development]]></category>
            <category><![CDATA[javascript]]></category>
            <dc:creator><![CDATA[JeungJoo Lee]]></dc:creator>
            <pubDate>Thu, 17 Sep 2020 08:36:28 GMT</pubDate>
            <atom:updated>2020-09-17T08:36:28.093Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/1000/0*a_lWiOsSn59HGz_h.png" /></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/1000/0*_2JfUzifUae56A2h.png" /></figure><p>지난 시간에는 <a href="https://medium.com/crocusenergy/nestjs-typeorm-relation-transactions-bcf5c1fb9942"><strong>[NestJS] TypeORM — Relation, Transactions</strong></a> 를 살펴보았다. 이번 시간에는 사용하는 Entity 에 Event Subscriber 를 설정하여 사용하는 방법을 알아보도록 하겠다. Audit Log 에사용하면 좋은 기능이 될 거 같다.</p><h3>TypeORM — Subscribers</h3><p>TypeORM 에 Subscriber 기능으로 특정 Entity 의 Event Subscriber Decorator 를 사용하여 DML 전후로 이벤트 처리가 가능하다. 이 기능은 DBMS 상에 Trigger 를 거는 행위와 비슷한 기능인데 어떤 기능 인지 코드로 살펴보자.</p><p>지난 챕터 CRUD 를 작성하는 문서에서 User 엔티티를 정의하고 해당 엔티티 객체에 Respository 디자인 패턴으로 데이터 조작을 해보았다. 해당 User 엔티티의 Event Subscriber 구독을 위해 아래와 같은 파일과 코드를 작성해 보도록 하겠다.</p><p><strong>src/user/domain/UserSubscriber.ts</strong></p><pre>import { Connection, EntitySubscriberInterface, EventSubscriber, InsertEvent } from &#39;typeorm/index&#39;;<br>import { User } from &#39;./User&#39;;</pre><pre>@EventSubscriber()<br>export class UserSubscriber implements EntitySubscriberInterface&lt;User&gt; {<br>  constructor(connection: Connection) {<br>    connection.subscribers.push(this);<br>  }</pre><pre>  listenTo() {<br>    return User;<br>  }</pre><pre>  **beforeInsert(event: InsertEvent&lt;User&gt;): Promise&lt;any&gt; | void {<br>    console.log(&#39;User 테이블에 입력 전 : &#39;, event.entity);<br>  }</pre><pre>  afterInsert(event: InsertEvent&lt;User&gt;): Promise&lt;any&gt; | void {<br>    console.log(&#39;User 테이블에 입력 후 : &#39;, event.entity);<br>  }**</pre><pre>}</pre><p>UserSubscriber 라는 클래스를 만들고 EventSubscriberInterface 인터페이스를 implement 하였다. 생성자를 통해 TypeORM 다이내믹 모듈을 통해 선언되었던 connection 객체의 의존성을 주입하고 해당 connection 을 통해 현재 선언한 클래스를 subscriber 로 등록 한다.</p><p>등록한 이후 listenTo 메서드를 오버라이드 하여 return 을 구독하고자 하는 Entity 객체로 리턴하고 어떤 Action 에 대한 이벤트를 통해 구독을 할 것인지 메서드로 정의한다. beforeInsert, beforeDelete, beforeUpdate 혹은 afterInsert, afeterDelete, afterUpdate 등 Entity 객체에 데이터를 조작하기 전과 후에 Event를 발생시킬 수 있고 해당 이벤트 안에 간단히 console.log 의 코드를 통해 작동 유무만 확인 해보도록 하겠다.</p><p>지난 번 만든 API 를 호출하고 User 엔티티에 값을 입력하여 로그를 확인을 해보도록 하겠다</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*kpWZL2X-kK1CXwpYTn6HHQ.png" /></figure><p>콘솔에는 다음과 같이 User 테이블 입력 전과 후의 Event가 구독을 통해 작동되는 것을 확인할 수 있을 것이다. 이 예제를 통해 향후 특정 Entity 의 값의 상태와 이력을 위해 별도의 Audit Table 에 이력이 남도록 Event Trigger를 작성 할 수도 있을 것 같다.</p><p>굉장히 간단하지만 임팩트있는 기능 같다. 각 상황에 알맞게 사용하면 좋은 기능이 될 듯 하다.</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=f330fe30b653" width="1" height="1" alt=""><hr><p><a href="https://medium.com/crocusenergy/nestjs-typeorm-subscribers-%EA%B8%B0%EB%8A%A5-f330fe30b653">[NestJS] TypeORM Subscribers 기능</a> was originally published in <a href="https://medium.com/crocusenergy">CrocusEnergy</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[NestJS] TypeORM — Relation, Transactions]]></title>
            <link>https://medium.com/crocusenergy/nestjs-typeorm-relation-transactions-bcf5c1fb9942?source=rss-e1980d94947b------2</link>
            <guid isPermaLink="false">https://medium.com/p/bcf5c1fb9942</guid>
            <category><![CDATA[javascript]]></category>
            <category><![CDATA[software-development]]></category>
            <category><![CDATA[nestjs]]></category>
            <category><![CDATA[nodejs]]></category>
            <category><![CDATA[typeorm]]></category>
            <dc:creator><![CDATA[JeungJoo Lee]]></dc:creator>
            <pubDate>Thu, 17 Sep 2020 08:28:09 GMT</pubDate>
            <atom:updated>2020-09-29T02:40:29.607Z</atom:updated>
            <content:encoded><![CDATA[<h3>[NestJS] TypeORM — Relation, Transactions</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/1000/0*wwsAZUu1oClOuat-.png" /></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/1000/0*Jx_rwR_dmW4y1g-7.png" /></figure><p>지난 시간에는 <a href="https://medium.com/crocusenergy/nestjs-typeorm-%EA%B8%B0%EB%B3%B8-crud-%EC%9E%91%EC%84%B1%ED%95%98%EA%B8%B0-69b9640dc826"><strong>[NestJS] TypeORM 기본 CRUD 작성하기</strong></a> 를 살펴보았다. 이번 시간에는 Entity 간의 Relation 을 어떻게 TypeORM 을 통해 맺는지와 트랜잭션 처리를 어떻게 하는지를 알아보도록 하겠다.</p><h3>Relations (엔티티 관계)</h3><p>RDB 의 경우 엔티티 간의 관계가 Primary Key 와 Foreign Key 를 통해 설정되는데 해당 부분을 살펴 보도록 하자.</p><p><strong>1 : 1 관계</strong></p><p>Primary Key 를 가지고 있는 하나의 테이블 안에 모든 row data 에서 자신 또는 다른 테이블의 하나의 row data 의 Foreign Key 로 관계를 맺을 수 있는 것을 말한다. 관계의 정의는 데코레이터로 표현이 가능하다.</p><p><strong>1 : N , N : 1 관계</strong></p><p>Primary Key 를 가지고 있는 하나의 테이블 안에 하나의 row data 에서 자신 또는 다른 테이블의 하나 이상의 row data 의 Foreign Key 로 관계를 맺을 수 있는 관계를 말한다. 관계의 정의는 데코레이터로 표현이 가능하다.</p><p><strong>N : N 관계</strong></p><p>Primary Key 를 가지고 있는 하나의 테이블 안에 하나 이상의 row data 에서 자신 또는 다른 테이블의 하나 이상의 row data 의 Foreign Key 로 관계를 맺을 수 있는 관계를 말한다. 관계의 정의는 데코레이터로 표현이 가능하다.</p><p>예시로 먼저 관계설정을 위해 아래와 같이 기존 User 엔티티 외의 Photo 라는 Foreign Table 을 만들어 관계를 설정하도록 하겠다.</p><p><strong>src/user/domain/Photo.ts</strong></p><pre>import { Column, Entity, ManyToOne, PrimaryGeneratedColumn } from &#39;typeorm/index&#39;;<br>import { User } from &#39;./User&#39;;</pre><pre>@Entity()<br>export class Photo {</pre><pre>  @PrimaryGeneratedColumn()<br>  id: number;</pre><pre>  @Column()<br>  url: string;</pre><pre>  @ManyToOne(type =&gt; User, user =&gt; user.photos)<br>  @JoinColumn({ name: &#39;ref_userId&#39; }<br>  user: User;</pre><pre>}</pre><p><strong>src/user/domain/User.ts</strong></p><pre>import { Column, Entity, OneToMany, PrimaryColumn, PrimaryGeneratedColumn } from &#39;typeorm/index&#39;;<br>import { Photo } from &#39;./Photo&#39;;</pre><pre>@Entity()<br>export class User {</pre><pre>  @PrimaryColumn()<br>  userId: string;</pre><pre>  @Column()<br>  userName: string;</pre><pre>  @Column()<br>  userPassword: string;</pre><pre>  @Column()<br>  age: number;</pre><pre>  @Column({ default: true })<br>  isActive: boolean;</pre><pre>  @OneToMany(type =&gt; Photo, photo =&gt; photo.user)<br>  photos: Photo[]</pre><pre>}</pre><p>User 와 Photo 의 관계를 설정하는데 있어서 User 는 Photo 와 1:N 의 관계를 맺는다고 했을 때 위와 같이 설정하면 된다. 그리고 TypeORM 모듈 설정이 Sync 가 true 되어 있다면 Context Reload 시 아래와 같이 자동으로 테이블이 생성이 되고 제약 설정이 자동으로 된다. ERD 를 확인하면 아래와 같다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/744/1*ccRKGnV2Uh5yDT-8kKXDhA.png" /></figure><p>photo 에서 ref_userId 컬럼이 Foreign Key 로 설정되어있고 이 Foreign Key는 User 테이블의 userId Primary Key 연결되어 있다.</p><p>이 설정을 하는데 있어서 app.module.ts 의 TypeORMModule 설정이 아래와 같이 Photo 가 Entities 에 추가가 되어야 에러가 나지 않는다.</p><pre>... 생략 ...<br>imports: [<br>    TypeOrmModule.forRoot({<br>      type: &#39;postgres&#39;,<br>      host: &#39;localhost&#39;,<br>      port: 5432,<br>      username: &#39;postgres&#39;,<br>      password: &#39;password&#39;,<br>      database: &#39;uaa&#39;,<br>      // autoLoadEntities: true,<br>      **entities: [User, Photo],**<br>      synchronize: true,<br>    }),<br>... 생략 ...</pre><p>수동적으로 추가를 할 수 있는 반면 자동으로 Entity가 Load가 되게 하려면 autoLoadEntities 설정이 true 로 되어 있어야 한다. 물론 사용하는 모듈에서는 아래와 같이 TypeOrmModule.forFeature 함수에선 해당 Entity를 사용하겠다 라고 선언 해줘야 한다.</p><p><strong>src/user/user.module.ts</strong></p><pre>import { Module } from &#39;@nestjs/common&#39;;<br>import { UserController } from &#39;./user.controller&#39;;<br>import { UserService } from &#39;./user.service&#39;;<br>import { TypeOrmModule } from &#39;@nestjs/typeorm&#39;;<br>import { User } from &#39;./domain/User&#39;;<br>import { Photo } from &#39;./domain/Photo&#39;;</pre><pre>@Module({<br>  imports: [TypeOrmModule.forFeature([User, Photo])],<br>  controllers: [UserController],<br>  providers: [UserService],<br>})<br>export class UserModule {}</pre><h3>Transaction 처리</h3><p>데이터베이스의 Transaction 처리는 비즈니스 로직상 굉장히 중요한 기능이다. 예를 들어 서로 다른 트랜잭션들을 처리하는 도중 하나의 단위 트랜잭션에서 에러가 발생한다면 이전에 성공 했던 트랜잭션들을 다시 rollback 을 해야 데이터의 정합성이 깨지지 않는다. 우선 TypeORM 을 논하기 전에 데이터베이스에서 서로 다른 트랜잭션을 하나로 처리하는 과정은 다음과 같은 Flow 가 존재할 것이다.</p><p><strong>[DB 트랜잭션 Flow]</strong></p><ol><li><strong>autoCommit = false 로 설정함</strong></li><li><strong>서로 다른 트랜잭션을 부분적으로 처리한다.</strong></li><li><strong>만약, 모든 트랜잭션이 정상적으로 완료되었 을 때는 Commit 을 한다.</strong></li><li><strong>만약, 트랜잭션 중 하나의 트랜잭션이 비정상적으로 처리되면 Rollback 을 수행한다.</strong></li></ol><p>위의 데이터베이스 상에 처리 과정을 숙지하고 TypeORM 을 통해 어떻게 트랜잭션을 처리 하는 지에 알아보도록 하자. 일단 여러가지 방법이 존재한다. 데코레이터로 @Transactional 이라는 선언을 하여 해당 메서드 위에 간편하게 처리하는 방법이 있는가 하면 Callback Style 로 처리하는 방법들이 존재한다. 하지만 Nest 재단에서 느낌상으로 추천하고 권고 하는 방법은 아래 방식인 거 같다. 명시적으로 트랜잭션을 코드 상에서 처리 하는 방법이 좋은 방법이라 생각 하는 것으로 추측된다.</p><p>명시적으로 queryRunner 를 통해 트랜잭션을 처리하는 방법은 아래와 같다. 우선 Connection 객체를 의존성 주입한다. 이 의존성은 이미 TypeORM 다이내믹 모듈을 import 한 것만으로도 의존성을 가져올 수 있다. 이 의존성을 토대로 createQueryRunner() 함수를 통해 queryRunner 객체를 가져올 수 있고 이 객체를 통해 트랜잭션 매니저를 수행할 수 있다. 코드를 살펴보자.</p><p><strong>src/user/user.service.ts</strong></p><pre>... 생략 ...<br>constructor(<br>    @InjectRepository(User) private userRepository: Repository&lt;User&gt;,<br>    private connection: Connection<br>  ) {<br>    this.connection = connection;<br>    this.userRepository = userRepository;<br>  }<br>... 생략 ...</pre><pre>/**<br>   * 다수의 유저 입력<br>   */<br>  async createUsers(users: User[]) {<br>    let isSuccess = true;<br>    const queryRunner = this.connection.createQueryRunner();<br>    await queryRunner.connect();<br>    await queryRunner.startTransaction();</pre><pre>    try {<br>      **await queryRunner.manager.save(users[0]); // (1)<br>      await queryRunner.manager.save(users[1]); // (2)**</pre><pre>      await queryRunner.commitTransaction();<br>    } catch (err) {<br>      console.log(&#39;Rollback 실행..&#39;)<br>      await queryRunner.rollbackTransaction();<br>      isSuccess = false;<br>    } finally {<br>      await queryRunner.release();<br>      return isSuccess;<br>    }<br>  }</pre><p>우선 테스트이기 때문에 간단히 처리 했다. 의도하는 바는 User 엔티티 타입의 객체를 Array 타입으로 가져와서 index 0, 1 번째만 각각 서로 다른 트랜잭션으로 저장할 수 있도록 코드를 (1), (2) 작성하였다.</p><p>이제에는 테스트 케이스를 만들어 아래와 같이 성공과 실패 두 가지 경우를 살펴 보도록 하겠다.</p><p><strong>Jest 테스트</strong></p><pre>export const getTypeOrmModule = () =&gt; {<br>  return TypeOrmModule.forRoot({<br>    type: &#39;postgres&#39;,<br>    host: &#39;localhost&#39;,<br>    port: 5432,<br>    username: &#39;postgres&#39;,<br>    password: &#39;password&#39;,<br>    database: &#39;uaa&#39;,<br>    autoLoadEntities: true,<br>    // entities: [User, Photo],<br>    synchronize: true,<br>  })<br>};</pre><pre>describe(&#39;테스트&#39;, () =&gt; {<br>  let app: TestingModule;<br>  <br>  beforeAll(async () =&gt; {<br>    app = await Test.createTestingModule({<br>      imports: [getTypeOrmModule(), TypeOrmModule.forFeature([User, Photo])],<br>      controllers: [UserController],<br>      providers: [UserService, TestService],<br>    }).compile();<br>  });  </pre><pre>  describe(&#39;UserService 테스트&#39;, () =&gt; {<br>    it(&#39;**createUsers 트랜잭션 처리 테스트 - 성공&#39;,** async () =&gt; {<br>      const userService = app.get&lt;UserService&gt;(UserService);<br>      const isSuccess = await userService.createUsers([<br>        new User(&#39;a1&#39;, &#39;a1&#39;, &#39;1234&#39;, 10, true, []),<br>        new User(&#39;b1&#39;, &#39;b1&#39;, &#39;1234&#39;, 10, true, [])<br>      ]);<br>      console.log(isSuccess);<br>      expect(isSuccess).toBeTruthy();<br>    });</pre><pre>    it(&#39;**createUsers 트랜잭션 처리 테스트 - 실패&#39;**, async () =&gt; {<br>      const userService = app.get&lt;UserService&gt;(UserService);<br>      const isSuccess = await userService.createUsers([<br>        new User(&#39;c1&#39;, &#39;c1&#39;, &#39;1234&#39;, 10, true, []),<br>        new User(null, &#39;d1&#39;, &#39;1234&#39;, 10, true, [])<br>      ]);<br>      console.log(isSuccess);<br>      expect(isSuccess).toBeFalsy();<br>    });</pre><pre>  });<br>});</pre><p>테스트 케이스의 사전 준비를 위해 TestingModule 을 통해 사용하게 될 모듈을 불러오고 TypeORM 셋팅을 beforeAll 로 단위 테스트를 하기 전에 셋팅하였다. 그 이후 ‘<strong>UserService 테스트</strong>’ 를 수행하게 되는 데 첫 번째 시나리오는 성공의 케이스다.</p><p>두 개의 User 엔티티에 값을 셋팅하고 저장해보았다 성공 시 boolean 으로 true 를 내뱉게 될 것이다.</p><p>실행을 해보면 아래와 같다.</p><p><strong>테스트 성공 시 ( true로 나오는 것으로 확인 됨 )</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*RQTD0nKPo81D3xxczpcCxg.png" /></figure><p><strong>User 테이블에 데이터를 확인하면 a1, b1 의 userId 가 기록 된 것을 볼 수 있다.</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*ylzxCxFJy_kzyU2hoeOwRg.png" /></figure><p><strong>테스트 실패 시 ( false 로 나오는 것으로 확인 됨 )</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*M1iEpk61iaaHP-eqi7ALDQ.png" /></figure><p>User 테이블에 데이터를 확인하면 부분적으로 성공 케이스 였던 C1 유저를 저장하는 트랜잭션도 데이터가 없는 것을 확인 할 수 있다. ( Rollback 이 된 것이다 )</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*Fbswi8IsB91khonMjGkB3Q.png" /></figure><p>이번 시간에는 Entity 간 Relation 설정과 Transaction 처리 방법을 알아보았다.</p><p><a href="https://medium.com/crocusenergy/nestjs-typeorm-subscribers-%EA%B8%B0%EB%8A%A5-f330fe30b653"><strong>다음. [NestJS] TypeORM Subscribers 기능</strong></a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=bcf5c1fb9942" width="1" height="1" alt=""><hr><p><a href="https://medium.com/crocusenergy/nestjs-typeorm-relation-transactions-bcf5c1fb9942">[NestJS] TypeORM — Relation, Transactions</a> was originally published in <a href="https://medium.com/crocusenergy">CrocusEnergy</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[NestJS] TypeORM 기본 CRUD 작성하기]]></title>
            <link>https://medium.com/crocusenergy/nestjs-typeorm-%EA%B8%B0%EB%B3%B8-crud-%EC%9E%91%EC%84%B1%ED%95%98%EA%B8%B0-69b9640dc826?source=rss-e1980d94947b------2</link>
            <guid isPermaLink="false">https://medium.com/p/69b9640dc826</guid>
            <category><![CDATA[javascript]]></category>
            <category><![CDATA[software-development]]></category>
            <category><![CDATA[nestjs]]></category>
            <category><![CDATA[typeorm]]></category>
            <category><![CDATA[nodejs]]></category>
            <dc:creator><![CDATA[JeungJoo Lee]]></dc:creator>
            <pubDate>Thu, 17 Sep 2020 08:08:48 GMT</pubDate>
            <atom:updated>2020-09-28T01:04:03.680Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/1000/0*wwsAZUu1oClOuat-.png" /></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/1000/0*Jx_rwR_dmW4y1g-7.png" /></figure><p>지난 시간에는 <a href="https://medium.com/crocusenergy/nestjs-%EA%B7%B8-%EC%99%B8-%EA%B8%B0%EB%B3%B8-%EA%B0%9C%EB%85%90%EB%93%A4-39cac4bb49e"><strong>[NestJS] 그 외 기본 개념들</strong></a><strong> </strong>을 살펴보았다. 이번 시간에는 NestJS 에서 TypeORM 을 사용하는 방법을 알아보도록 하겠다. 기본적인 CRUD 를 통해 알아보도록 할텐데 지난 포스팅에서 <a href="https://medium.com/crocusenergy/nestjs-starter-kit-bolierplate-%EA%B5%AC%EC%A1%B0-%EC%82%B4%ED%8E%B4%EB%B3%B4%EA%B8%B0-postgresql-docker-%EC%A4%80%EB%B9%84-5579723e0c52"><strong>PostgreSQL Docker 를 설치한 글</strong></a>을 확인하면 조금 더 실습을 하는데 원활할 것이다.</p><h3>TypeORM — 기본 CRUD 작성</h3><p>사실 TypeORM 은 NestJS 를 위해 나온 것은 아니고 NestJS 와 궁합이 잘 맞는 Object Relation Mapper( ORM ) 이기 때문에 사용하는 것이다. 우선 DB는 관계형 DB든 NoSQL이든 Vendor 가 무엇이든 대표적으로 Sequelize와 TypeORM 을 많이 사용한다. TypeORM은 Typescript를 잘 지원하고 있고 상대적으로 Java의 JPA 와 비슷한 부분이 많고 개인적 취향에 의해 TypeORM 이 더 매력적이어서 선택하게 되었다.</p><p>ORM 을 쓸 때 가장 매력적이었던 부분은 개발자가 TypeORM 을 통해 Vendor 가 어떤 것이든 추상화 객체를 통해 접근하여 코드의 일원화를 꾀할 수 있다는 부분이다. 물론 복잡한 쿼리를 사용할 때는 Native Query 를 사용할 수 밖에 없는 상황들이 발생할 때도 있지만 그래도 생산성이 높고 SQL 작성 보단 도메인 모델을 기반으로 적절한 설계와 유연성을 발휘할 수 있다는 것이 우선 ORM 의 일반적인 매력이다.</p><h3>TypeORM 설치</h3><pre>npm install --save @nestjs/typeorm typeorm pg</pre><p>우선 코드를 작성하기 전 dependency 설치가 필요하다 위와 같이 설치를 진행하자.</p><p>이전 챕터에서 도커 컴포즈를 통해 postgres 컨테이너를 올려 보았는데 해당 컨테이너 DB 에 NestJS app.module.ts 의 imports 를 통해 DB와 접속 해보도록 하겠다.</p><p><strong>src/app.module.ts</strong></p><pre>... 생략  ...</pre><pre>@Module({<br>  imports: [<br>    **TypeOrmModule.forRoot({<br>      type: &#39;postgres&#39;,<br>      host: &#39;localhost&#39;,<br>      port: 5432,<br>      username: &#39;postgres&#39;,<br>      password: &#39;password&#39;,<br>      database: &#39;uaa&#39;,<br>      entities: [],<br>      synchronize: true,<br>    }),**<br>    UserModule,<br>    TestModule,<br>    ExceptModule,<br>  ],<br>  controllers: [AppController],<br>  providers: [AppService],<br>})</pre><pre>... 생략 ...</pre><p>AppModule 데코레이터의 imports 부분에 TypeOrmModule 객체의 forRoot 를 통해 접속 정보와 커넥션 option을 작성 후 Context Reload 가 되면 Nest 코어는 아래와 같이 TypeOrmModule 을 초기화 한다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*k7QChUcL_J2CX40q1Mx7mg.png" /></figure><h3>User Entity 만들기</h3><p>지난 예제에서 만든 src/user 위치에 domain 폴더를 만들고 User 클래스를 만들어 Entity 의 역할을 할 수 있도록 코드로 작성 해보겠다.</p><p><strong>src/user/domain/User.ts</strong></p><pre>import { Column, Entity, PrimaryColumn, PrimaryGeneratedColumn } from &#39;typeorm/index&#39;;</pre><pre>@Entity()<br>export class User {</pre><pre>  @PrimaryGeneratedColumn(&#39;rowid&#39;)<br>  id: number;</pre><pre>  @PrimaryColumn()<br>  userId: string;</pre><pre>  @Column()<br>  userName: string;</pre><pre>  @Column()<br>  userPassword: string;</pre><pre>  @Column()<br>  age: number;</pre><pre>  @Column({ default: true })<br>  isActive: boolean;</pre><pre>}</pre><p>위와 같이 간단한 User Entity 를 만들어 보았고 완성된 User Entity 는 AppModule 의 TypeOrm의 Dynamic Module 의 entities 프로퍼티에 value로 넣는다.</p><p>❓AppModule 에 넣는데 왜 굳이 user 디렉토리에서 관리하는 것 일까라고 생각할 수 있는데 앞으로 쓰여질 기능 도메인의 위치에 엔티티 파일을 넣는 것이 조금 더 명확하게 구조를 잡을 수 있다는 생각이라 한다는 NestJS 프로젝트의 Reference 공식 문서에 있다.</p><p><strong>src/app.module.ts</strong></p><pre>... 생략 ...</pre><pre>@Module({<br>  imports: [<br>    TypeOrmModule.forRoot({<br>      type: &#39;postgres&#39;,<br>      host: &#39;localhost&#39;,<br>      port: 5432,<br>      username: &#39;postgres&#39;,<br>      password: &#39;password&#39;,<br>      database: &#39;uaa&#39;,<br>      **entities: [User], // 여기에 생성한 Entity 를 넣어준다.**<br>      synchronize: true,<br>    }),<br>    UserModule,<br>    TestModule,<br>    ExceptModule,<br>  ],<br>  controllers: [AppController],<br>  providers: [AppService],<br>})</pre><pre>... 생략 ...</pre><p>AppModule 에 등록 후 실제 사용하게 될 단위 모듈 위치인 UserModule 에서 아래와 같이 imports 를 통해 해당 Entity 객체를 세팅 해준다.</p><p><strong>src/user/user.module.ts</strong></p><pre>import { Module } from &#39;@nestjs/common&#39;;<br>import { UserController } from &#39;./user.controller&#39;;<br>import { UserService } from &#39;./user.service&#39;;<br>import { TypeOrmModule } from &#39;@nestjs/typeorm&#39;;<br>import { User } from &#39;./domain/User&#39;;</pre><pre>@Module({<br>  **imports: [TypeOrmModule.forFeature([User])],**<br>  controllers: [UserController],<br>  providers: [UserService],<br>})<br>export class UserModule {}</pre><p>이제 모든 설정이 완료 되었고 Java의 JPA 처럼 Repository 디자인 패턴으로 CRUD 를 해보도록 하겠다. 우선 기존에 만들었던 UserService 의 코드를 변경해보도록 하겠다.</p><p><strong>src/user/user.service.ts ( 기존 코드 )</strong></p><pre>import { Injectable } from &#39;@nestjs/common&#39;;<br>import { UserDto } from &#39;./dto/user.dto&#39;;</pre><pre>@Injectable()<br>export class UserService {<br>  private users: UserDto[] = [<br>    new UserDto(&#39;lee1&#39;, &#39;이정주&#39;),<br>    new UserDto(&#39;kim1&#39;, &#39;김명일&#39;),<br>  ];</pre><pre>  findAll() : Promise&lt;UserDto[]&gt; {<br>    return new Promise((resolve) =&gt;<br>      setTimeout(<br>        () =&gt; resolve(this.users),<br>        100,<br>      ),<br>    );<br>  }</pre><pre>  findOne(id: string) : UserDto | object {<br>    const foundOne = this.users.filter(user =&gt; user.userId === id);<br>    return foundOne.length ? foundOne[0] : { msg: &#39;nothing&#39; };<br>  }</pre><pre>  saveUser(userDto: UserDto) : void {<br>    this.users = [...this.users, userDto];<br>  }<br>}</pre><p><strong>src/user/user.service.ts ( User Repository 디자인패턴 적용 코드 )</strong></p><pre>import { Injectable } from &#39;@nestjs/common&#39;;<br>import { InjectRepository } from &#39;@nestjs/typeorm&#39;;<br>import { User } from &#39;./domain/User&#39;;<br>import { Repository } from &#39;typeorm/index&#39;;</pre><pre>@Injectable()<br>export class UserService {<br>  constructor(<br>    @InjectRepository(User) private userRepository: Repository&lt;User&gt;,<br>  ) {<br>    this.userRepository = userRepository;<br>  }</pre><pre>  /**<br>   * User 리스트 조회<br>   */<br>  findAll(): Promise&lt;User[]&gt; {<br>    return this.userRepository.find();<br>  }</pre><pre>  /**<br>   * 특정 유저 조회<br>   * @param id<br>   */<br>  findOne(id: string): Promise&lt;User&gt; {<br>    return this.userRepository.findOne({ userId: id });<br>  }</pre><pre>  /**<br>   * 유저 저장<br>   * @param user<br>   */<br>  async saveUser(user: User): Promise&lt;void&gt; {<br>    await this.userRepository.save(user);<br>  }</pre><pre>  /**<br>   * 유저 삭제<br>   */<br>  async deleteUser(id: string): Promise&lt;void&gt; {<br>    await this.userRepository.delete({ userId: id });<br>  }<br>}</pre><p>InjectRepository 데코레이터를 통해 User Entity 를 userRepository 를 UserService 에 주입하여 사용하는 모습이다. 이것이 가능했던 준비의 과정들은 이전에 Entity를 만들고 AppModule 에 TypeOrm 다이내믹 모듈을 통해 커넥션 정보와 Entities 에 User 를 등록하고 사용하는 UserModule 에서 User Entity를 TypeOrm 다이내믹 모듈의 forFeature 를 통해 등록하였다. 이 과정이 Setup이 되어야만 위의 Repository 로 의존성 주입이 가능하고 해당 Repository를 통해 CRUD 를 할 수 있다.</p><p>아마 위의 Service 코드가 바뀌면서 Controller도 변경을 할 수 밖에 없는 상황이 왔다. 아무래도 UserDTO 라는 객체에서 Entity 객체로 바뀌면서 Return 타입이 변경 되었고 Promise 를 반환하고 있기 때문에 해당 코드를 변경할 수 밖에 없는 상황이다.</p><p><strong>src/user/user.controller.ts</strong></p><pre>import { Body, Controller, Delete, Get, Param, Post, Res } from &#39;@nestjs/common&#39;;<br>import { UserDto } from &#39;./dto/user.dto&#39;;<br>import { UserService } from &#39;./user.service&#39;;<br>import { TestService } from &#39;../test/test.service&#39;;<br>import { User } from &#39;./domain/User&#39;;</pre><pre>@Controller(&#39;user&#39;)<br>export class UserController {</pre><pre>  constructor(<br>    private userService: UserService,<br>    private testService: TestService<br>  ) {<br>    this.userService = userService;<br>    this.testService = testService;<br>  }</pre><pre>  @Get(&#39;test&#39;)<br>  findAnotherTest(): string {<br>    return this.testService.getInfo();<br>  }</pre><pre>  @Get(&#39;list&#39;)<br>  async findAll(): Promise&lt;User[]&gt; {<br>    const userList = await this.userService.findAll();<br>    return Object.assign({<br>      data: userList,<br>      statusCode: 200,<br>      statusMsg: `데이터 조회가 성공적으로 완료되었습니다.`,<br>    });<br>  }</pre><pre>  @Get(&#39;:userId&#39;)<br>  async findOne(@Param(&#39;userId&#39;) id: string): Promise&lt;User&gt; {<br>    const foundUser = await this.userService.findOne(id);<br>    return Object.assign({<br>      data: foundUser,<br>      statusCode: 200,<br>      statusMsg: `데이터 조회가 성공적으로 완료되었습니다.`,<br>    });<br>  }</pre><pre>  @Post()<br>  async saveUser(@Body() user: User): Promise&lt;string&gt; {<br>    await this.userService.saveUser(user);<br>    return Object.assign({<br>      data: { ...user },<br>      statusCode: 201,<br>      statusMsg: `saved successfully`,<br>    });<br>  }</pre><pre>  @Delete(&#39;:userId&#39;)<br>  async deleteUser(@Param(&#39;userId&#39;) id: string): Promise&lt;string&gt; {<br>    await this.userService.deleteUser(id);<br>    return Object.assign({<br>      data: { userId: id },<br>      statusCode: 201,<br>      statusMsg: `deleted successfully`,<br>    });<br>  }</pre><pre>}</pre><p>아직 Response 하는 객체를 공통화 시키지 않고 Object.assign 을 통해 JSON String 으로 반환하고 있는데 일단 테스트니 향후에 본격적인 개발을 할 때 바꾸도록 한다. 우선 간단한 CRUD 를 통해 데이터를 조회/수정/삽입/삭제 를 수행한다.</p><h3>리스트 조회 ( UserService 객체 )</h3><pre>/**<br>   * User 리스트 조회<br>   */<br>  findAll(): Promise&lt;User[]&gt; {<br>    return this.userRepository.find();<br>  }</pre><p>위의 코드를 보면 Native Query는 존재하지 않는다 이미 추상화된 TypeORM의 find() 함수를 통해 Vendor 가 MySQL, Postgres, MariaDB, Mongoose 등 어떠한 것을 사용하던지 SELECT 를 할 수 있다. 물론 현재는 where 조건이나 Entity 의 One To One, One To Many 등의 관계 설정이 없는 심플한 상태이지만 복잡한 쿼리나 이런 것들이 가능하다. 리스트 조회를 해보면 아래와 같이 출력된다.</p><p><strong>/user/list GET</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*yNeMEpaw4LXIO7G_dNu6HQ.png" /></figure><p>ℹ️ TypeOrm 다이내믹 모듈 설정에서 Sync 가 true 로 설정 되어있어서 User Entity의 컬럼이 변경되면 해당 테이블의 구조도 변경되니 운영 시 적절한 설정 값을 통해 운영이 되도록 해야 한다. DEV와 PROD 그리고 LOCAL 에 따라 DB 접속정보를 env 로 다르게 가져갈 수 있도록 향후 개발 시 설정하면 될 것이다.</p><p><strong>User 테이블의 컬럼 정보 — Primary Key : userId</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*3mCOE__cRWD2P1NOUv8dQg.png" /></figure><p><strong>/user/{userId} GET</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*camGforxymZBTA54_0Wyog.png" /></figure><p>위의 Path Variable 로 esak248 아이디를 아래 userRepository.findOne 함수로 조회한다. 결과는 위의 캡처 이미지에서 보는 바와 같이 User Entity 타입으로 data 프로퍼티에 Binding 되어 출력된다.</p><pre>/**<br>   * 특정 유저 조회<br>   * @param id<br>   */<br>  findOne(id: string): Promise&lt;User&gt; {<br>    return this.userRepository.findOne({ userId: id });<br>  }</pre><p><strong>/user/{userId} DELETE</strong></p><p>반대로 esak248 의 ID 로 삭제를 하게 되면 삭제가 된다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*0Z7GNt6SwHa_SQni8x8u6g.png" /></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*OU2Tdc84LeiYeRT4V89qCA.png" /></figure><p><strong>/user POST</strong></p><p>데이터 삽입과 수정의 Action 을 나누지 않았다. 간편하게 POST를 통해 테스트 삼아 User Type의 객체를 Body 에 넣어 POST 로 요청하면 User 테이블에 userId 가 존재한다면 Update를 수행하고 없다면 신규로 데이터를 삽입하게 된다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*9qYOHF8mXa6yZGUXyBmq8Q.png" /></figure><h3>결론</h3><p>간단한 CRUD를 TypeORM 을 NestJS 에 구성하여 Repository 디자인 패턴으로 진행해보았다. 다음 세션에서는 TypeORM 에서 Entity 간의 Relation 을 조금 더 살펴 보도록 하겠다.</p><p><a href="https://medium.com/crocusenergy/nestjs-typeorm-relation-transactions-bcf5c1fb9942"><strong>다음. [NestJS] TypeORM — Relation, Transactions</strong></a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=69b9640dc826" width="1" height="1" alt=""><hr><p><a href="https://medium.com/crocusenergy/nestjs-typeorm-%EA%B8%B0%EB%B3%B8-crud-%EC%9E%91%EC%84%B1%ED%95%98%EA%B8%B0-69b9640dc826">[NestJS] TypeORM 기본 CRUD 작성하기</a> was originally published in <a href="https://medium.com/crocusenergy">CrocusEnergy</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[NestJS] 그 외 기본 개념들]]></title>
            <link>https://medium.com/crocusenergy/nestjs-%EA%B7%B8-%EC%99%B8-%EA%B8%B0%EB%B3%B8-%EA%B0%9C%EB%85%90%EB%93%A4-39cac4bb49e?source=rss-e1980d94947b------2</link>
            <guid isPermaLink="false">https://medium.com/p/39cac4bb49e</guid>
            <category><![CDATA[nodejs]]></category>
            <category><![CDATA[expressjs]]></category>
            <category><![CDATA[javascript]]></category>
            <category><![CDATA[software-development]]></category>
            <category><![CDATA[nestjs]]></category>
            <dc:creator><![CDATA[JeungJoo Lee]]></dc:creator>
            <pubDate>Thu, 17 Sep 2020 07:57:23 GMT</pubDate>
            <atom:updated>2020-09-17T08:09:28.852Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/1000/0*h2TzDRD3HSmTAn_w.png" /></figure><p>지난 시간 <a href="https://medium.com/crocusenergy/nestjs-middleware-%EA%B0%9C%EB%85%90-%EB%B0%8F-%EC%8B%A4%EC%8A%B5-649b14bf65ff"><strong>[NestJS] Middleware 개념 및 실습</strong></a> 을 살펴보았다. 오늘은 그 외 NestJS 의 개념들을 살펴보도록 하겠다.</p><h3><strong>그 외 기본 개념들</strong></h3><p>그 외 Exception Filters, Pipes 그리고 Custom decorators 등의 다양한 기본 개념들이 존재하는데 간단히 집고 넘어 가도록 하겠다.</p><p>이 외 Guards나 Interceptor 의 개념은 간단히 Gurads 는 Role에 따라 Route의 수행 여부를 권한 별로 설정할 수 있는 기능이고 Interceptor 는 Request 에서 Response 라이프 사이클에서 특정 함수가 개입하여 처리 및 데이터 조작 또는 로깅 등 다양한 기능을 이룰 수 있는 기능으로 근본적인 동작원리는 Filter 와 다르지만 유사성이 존재한다고 볼 수 있다.</p><h3>Exception Filters</h3><p>모든 어플리케이션에서는 Exception 에러 처리가 중요하다. 어떤 기능이든지 에러가 없다는 보장은 없고 그 에러를 어떻게 잘 핸들링 할 수 있을까에 대한 문제가 있다. 우선 except 폴더를 만들어 내장된 Http Exception 에러를 발생 시켜 보도록 하겠다.</p><pre>import { Controller, Get, HttpException, HttpStatus, Param } from &#39;@nestjs/common&#39;;<br><br>@Controller(&#39;except&#39;)<br>export class ExceptController {<br>  @Get(&#39;:code&#39;)<br>  executeError(@Param(&#39;code&#39;) code: HttpStatus) {<br>    if (code &gt;= 200 &amp;&amp; code &lt; 400) {<br>      return &#39;status ok&#39;;<br>    } else if (code == 403) {<br>      **throw new HttpException({<br>        status: HttpStatus.FORBIDDEN,<br>        error: &#39;Forbidden Error &#39;,<br>      }, HttpStatus.FORBIDDEN)**<br>    }<br>  }<br>}</pre><figure><img alt="" src="https://cdn-images-1.medium.com/max/1022/1*SUaskKw7_yvyBSKWbF82Kg.png" /></figure><p>우선 403 을 path variable 로 담아서 줬을 때 컨트롤러를 통해 code가 403일 경우 HttpException 을 throw 하도록 코드를 작성하였고 이 throw 를 했을 때 기본적으로 어떠한 메시지를 커스텀하게 담을 수 있는지도 코드로 작성 해보았다. Nest 의 경우 HttpException 을 base로 상속하여 기본적으로 제공하는 Exception 종류 들이 많은데 아래와 같다.</p><ul><li>BadRequestException</li><li>UnauthorizedException</li><li>NotFoundException</li><li>ForbiddenException</li><li>NotAcceptableException</li><li>RequestTimeoutException</li><li>ConflictException</li><li>GoneException</li><li>HttpVersionNotSupportedException</li><li>PayloadTooLargeException</li><li>UnsupportedMediaTypeException</li><li>UnprocessableEntityException</li><li>InternalServerErrorException</li><li>NotImplementedException</li><li>ImATeapotException</li><li>MethodNotAllowedException</li><li>BadGatewayException</li><li>ServiceUnavailableException</li><li>GatewayTimeoutException</li></ul><p>위의 HttpException 을 토대로 throw 한 에러를 공통으로 처리할 수 있는 ExceptionFilter도 작성하여 데코레이터를 해당 ExceptionFilter의 객체를 주입하므로 response 체계를 공통화 시킬 수 있는데 코드는 아래와 같다.</p><p><strong>src/exception/HttpExceptionFilter.ts</strong></p><pre>import { ExceptionFilter, Catch, ArgumentsHost, HttpException, Injectable } from &#39;@nestjs/common&#39;;<br>import { Request, Response } from &#39;express&#39;;</pre><pre>@Catch(HttpException)<br>export class HttpExceptionFilter implements ExceptionFilter {<br>  catch(exception: HttpException, host: ArgumentsHost) {<br>    const ctx = host.switchToHttp();<br>    const response = ctx.getResponse&lt;Response&gt;();<br>    const request = ctx.getRequest&lt;Request&gt;();<br>    const status = exception.getStatus();</pre><pre>    response<br>      .status(status)<br>      .json({<br>        statusCode: status,<br>        timestamp: new Date().toISOString(),<br>        path: request.url,<br>      });<br>  }<br>}</pre><p>Catch 데코레이터를 통해서 HttpException 에 관련된 에러를 Catch 하겠다 라는 선언이다. ExceptionFilter 의 인터페이스를 implements 하고 있고 catch 함수를 구현 하면 되는데 코드는 response 객체를 통해 statusCode, timestamp, 에러가 발생한 path 를 출력하고자 한다.</p><p>HttpExceptionFilter를 사용하고자 하는 컨트롤러의 Route 에서 UseFilters 라는 데코레이터를 이용하여 사용할 수 있다</p><pre>@Get(&#39;:code&#39;)<br>  **@UseFilters(new HttpExceptionFilter())**<br>  executeError(@Param(&#39;code&#39;) code: HttpStatus) {<br>    if (code &gt;= 200 &amp;&amp; code &lt; 400) {<br>      return &#39;status ok&#39;;<br>    } else if (code == 403) {<br>      throw new HttpException({<br>        status: HttpStatus.FORBIDDEN,<br>        error: &#39;Forbidden Error &#39;,<br>      }, HttpStatus.FORBIDDEN)<br>    }<br>  }</pre><p>위에 처럼 사용하게 되면 throw 된 HttpException 에 관련된 모든 에러들은 HttpExceptionFilter 에서 처리되게 된다. 403으로 줬을 때 결과는 아래와 같다. 이런식으로 실제 각 Exception 별로 에러를 공통화 시킬 수 있으며 개발시 유용하게 사용될 여지가 많은 기능 들이다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/956/1*A4G-yrwUOukgOP8C3p9uaQ.png" /></figure><p>그렇다면, 이렇게 일일이 다 각 Route 정보 위에 데코레이터인 UseFilters 를 선언하면서 선택적으로 사용해야만 하느냐라는 질문이 생길 것이다. 아래와 같이 모든 어플리케이션 레벨에서 공통화 시킬 수 있는 방법이 있는데 적용해보자</p><p><strong>src/main.ts</strong></p><pre>import { NestFactory } from &#39;@nestjs/core&#39;;<br>import { AppModule } from &#39;./app.module&#39;;<br>import { HttpExceptionFilter } from &#39;./exception/HttpExceptionFilter&#39;;</pre><pre>async function bootstrap() {<br>  const app = await NestFactory.create(AppModule, {});<br>  app.useGlobalFilters(new HttpExceptionFilter());<br>  await app.listen(3000);<br>}<br>bootstrap();</pre><p>App의 Entry 포인트인 main.ts 에서 NestFactory.create 를 통해 app 객체가 생성되는 곳에서 useGlobalFilters 함수를 통해 등록하여 사용할 수 있는데 이때 위와 같이 선언하면 모든 Route 의 HttpException 에러에 대한 공통 처리 로직이 반영된다.</p><p>위에 Exception 의 경우 HttpException 에 관련된 에러만 설정한 것인데 전체를 적용하기 위해서는 @Catch 데코레이터 에 HttpException 을 빼면 전체에 대한 Exception Handler 로써 catch 가 될 것이다.</p><p>이 외에도 APP_FILTER 를 통해 모듈 단위로 선별적으로 처리를 할 수 있는 방법이 존재하는데 일단은 넘어가도록 하겠다.</p><h3>Pipes</h3><p>파이프는 간단하게 말해 HttpRequest 로 넘어온 파라미터나 쿼리 또는 Body 를 Validation 해주거나 원시타입을 조작하거나 원하는 타입이 넘어오지 못했을 때 에러를 발생시킬 수 있는 기능을 담당한다. 간단하게 보자면 코드는 아래와 같다.</p><p>path variable 로 넘어온 id 는 number 타입이어야한다. 만약 string 이나 number가 아닌 다른 타입이 넘어왔을 때는 HttpStatus를 NOT_ACCEPTABLE 로 Response 할 수 있다.</p><pre>@Get(&#39;pipe/:id&#39;)<br>  exPipes(<br>    @Param(<br>      &#39;id&#39;,<br>      new ParseIntPipe({ errorHttpStatusCode: HttpStatus.NOT_ACCEPTABLE }),<br>    )<br>    id: number,<br>  ) {<br>    return `입력 받은 Number : ${id}`;<br>  }</pre><p>만약 abc 라는 문자열로 path 를 넘겼을 때 모습은 아래와 같다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/942/1*vxg8WTh-476fM_3_tA7KCA.png" /></figure><p>만약 숫자형으로 제대로 넘긴다면 출력이 잘 되는 것을 아래에서 확인할 수 있다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/966/1*Udc04n3AlAagfEeEWeVQdg.png" /></figure><p>이 외 POST 메서드로 처리할 때 데이터를 Payload 에 담아 처리하는 과정이 있을 것이라 예상된다. 이 때 서버사이드 쪽에서 Pipe 기능을 이용해 Validation 할 수 있는 코드를 만들어 적용 시킬 수 있다.</p><h3>커스텀 Decorator 만들어보기</h3><p>지금까지는 대부분 NestJS 에서 제공하는 기본 데코레이터를 사용하여 보았다. 만약 이 데코레이터를 사용자가 직접 만들어서 사용할 일이 있을 수도 있을텐데 그런 경우 어떻게 만들 수 있는지 아래 코드에서 확인해보도록 하자.</p><p>우선 아래처럼 AuthToken이라는 데코레이터를 만들었다. 하는 역할은 Request 헤더 정보에서 auth_token 으로 되어있는 토큰을 가져오는 공통 함수이다. 만약 header 정보에 토큰이 없다면 NOT DEFINED 메시지를 주도록 설정하였다.</p><p><strong>src/common/decorators/common.authToken.ts</strong></p><pre>import { createParamDecorator, ExecutionContext } from &#39;@nestjs/common&#39;;</pre><pre>export const AuthToken = createParamDecorator(<br>  (data: string, ctx: ExecutionContext) =&gt; {<br>    const request = ctx.switchToHttp().getRequest();<br>    const { headers } = request;<br>    console.log(headers);<br>    return headers[&#39;auth_token&#39;] ? headers[&#39;auth_token&#39;] : &#39;&quot;NOT DEFINED&quot;&#39;;<br>  }<br>)</pre><p>위에서 만든 데코레이터를 사용해보자.</p><p><strong>src/exception/except.controller.ts</strong></p><pre>@Get(&#39;auth/token&#39;)<br>  getAuthToken(<br>    @AuthToken() token: string<br>  ) {<br>    return `HEADER에 입력한 토근은 ${token} 입니다.`<br>  }</pre><p>AuthToken 데코레이터를 통해 추출된 헤더의 토큰 정보 중 auth_token 은 token 변수에 string 타입으로 바인딩 될 것이다. 그리고 출력하면 아래와 같이 입력된 HEADER 의 auth_token 의 값이 그대로 출력되는 것을 확인할 수 있다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*JCpd7KjbucVkhfYE6HWD8w.png" /></figure><p>위의 과정은 단순하게 데코레이터를 만들긴 했지만 좀 더 상황에 따라 복잡한 데코레이터를 유용하게 만들어 공통화 시키는 작업이 있을 수 있을 것이다.</p><p>이상 NestJS 의 기본적인 개념을 살펴보았고 다음시간에는 NestJS 프로젝트에서 지원하는 라이브러리는 아니지만 NodeJS ORM Framework 중 하나인 TypeORM 을 살펴보도록 하겠다.</p><p>다음. <a href="https://medium.com/crocusenergy/nestjs-typeorm-%EA%B8%B0%EB%B3%B8-crud-%EC%9E%91%EC%84%B1%ED%95%98%EA%B8%B0-69b9640dc826?sk=1a53d8768c0a7b0650772fb64879b564"><strong>[NestJS] TypeORM 기본 CRUD 작성하기</strong></a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=39cac4bb49e" width="1" height="1" alt=""><hr><p><a href="https://medium.com/crocusenergy/nestjs-%EA%B7%B8-%EC%99%B8-%EA%B8%B0%EB%B3%B8-%EA%B0%9C%EB%85%90%EB%93%A4-39cac4bb49e">[NestJS] 그 외 기본 개념들</a> was originally published in <a href="https://medium.com/crocusenergy">CrocusEnergy</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[NestJS] Middleware 개념 및 실습]]></title>
            <link>https://medium.com/crocusenergy/nestjs-middleware-%EA%B0%9C%EB%85%90-%EB%B0%8F-%EC%8B%A4%EC%8A%B5-649b14bf65ff?source=rss-e1980d94947b------2</link>
            <guid isPermaLink="false">https://medium.com/p/649b14bf65ff</guid>
            <category><![CDATA[javascript]]></category>
            <category><![CDATA[nextjs]]></category>
            <category><![CDATA[software-development]]></category>
            <category><![CDATA[middleware]]></category>
            <category><![CDATA[nodejs]]></category>
            <dc:creator><![CDATA[JeungJoo Lee]]></dc:creator>
            <pubDate>Thu, 17 Sep 2020 07:47:58 GMT</pubDate>
            <atom:updated>2020-09-17T07:57:55.104Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/1000/0*1tBS4LAYAWwX_daJ.png" /></figure><p>지난 시간 <a href="https://medium.com/crocusenergy/nestjs-modules-%EA%B0%9C%EB%85%90-%EB%B0%8F-%EC%8B%A4%EC%8A%B5-758b1328e9e7"><strong>[NestJS] Modules 개념 및 실습</strong></a> 에 대하여 알아보았다. 이번 시간에는 NestJS 개념 중 하나인 Middleware 에 대해 알아보도록 하겠다.</p><h3>Middleware</h3><p>미들웨어는 클라이언트 사이드에서 요청한 Http Request 에서 Router Handler 로 가기 전에 기능을 공통화 하여 사용하거나 처리하게 할 수 있는데 그 이후 next 라는 함수를 호출해서 다음 작업이 진행 될 수 있게 한다.</p><p>도식화를 하자면 아래와 같다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*iO3GXX2ofuOF6CQUcG9u-g.png" /></figure><p>핵심은 클라이언트로 부터 들어온 Request 에서 Response 과정의 전체 라이프 사이클에서 next 라는 함수를 통해 특정 함수를 실행하고 처리할 수 있다. 백문이 불여일견이라는 말이 있듯이 Nest 에서는 Middleware 처리를 어떻게 하는지 아래 코드를 보고 살펴보도록 하자.</p><p>우선 Middleware를 만들기 위해 NestMiddleware 라는 인터페이스를 살펴볼 필요가 있다.</p><pre>// @nestjs/common 패키지 아래 존재하는 NestMiddleware<br>export interface NestMiddleware&lt;TRequest = any, TResponse = any&gt; {<br>    use(req: TRequest, res: TResponse, next: () =&gt; void): any;<br>}</pre><p>Middleware를 NestJS 에서 구현하기 위해서는 위의 Interface 를 implements 하여 구현해야 한다. middleware 라는 폴더를 src 밑에 만들고 LoggerMiddleware.ts 라는 소스 파일을 만들어보겠다.</p><p><strong>src/middleware/LoggerMiddleware.ts</strong></p><pre>import { Injectable, NestMiddleware } from &#39;@nestjs/common&#39;;</pre><pre>@Injectable()<br>export class LoggerMiddleware implements NestMiddleware {<br>  use(req: any, res: any, next: () =&gt; void): any {<br>    **console.log(&#39;Client Request 요청됨.&#39;);<br>    console.log(req);**<br>    next();<br>  }<br>}</pre><p>NestMiddleware 를 implements 하여 정의된 use 함수를 LoggerMiddleware 에서 구현하는 모습이다. 위의 미들웨어의 기능으로 단순하게 console.log 를 통해 어떤식으로 작동이 되는지 로그를 찍었고 use 함수의 첫 번째 파라미터인 any 타입으로 된 req 객체를 로깅해보는 역할이다. 사실 req 는 HttpRequest 타입으로 정의할 수 있다. 로깅을 한 이후에 next() 를 하지 않는다면 Response 가 되지 않는 상태로 아마 클라이언트 쪽에서는 타임아웃이 발생할 때까지 hang이 걸릴 것이라 추측된다. 여튼 이 LoggerMiddleware 를 Injectable 데코레이터로 디펜던시로 사용하고 이 LoggerMiddleware 를 아래 AppModule 에서 NestModule 을 implement 하여 configure 를 통해 MiddlewareConsumer 객체를 통해 apply 시켜보도록하겠다.</p><p><strong>src/app.module.ts</strong></p><pre>import { MiddlewareConsumer, Module, NestModule } from &#39;@nestjs/common&#39;;<br>import { AppController } from &#39;./app.controller&#39;;<br>import { AppService } from &#39;./app.service&#39;;<br>import { UserModule } from &#39;./user/user.module&#39;;<br>import { TestModule } from &#39;./test/test.module&#39;;<br>import { LoggerMiddleware } from &#39;./middleware/LoggerMiddleware&#39;;</pre><pre>@Module({<br>  imports: [UserModule, TestModule],<br>  controllers: [AppController],<br>  providers: [AppService],<br>})<br>export class AppModule implements N**estModule {<br>  configure(consumer: MiddlewareConsumer): any {<br>    consumer<br>      .apply(LoggerMiddleware)<br>      .forRoutes(&#39;user&#39;)<br>  }</pre><pre>}**</pre><p>위의 Bold 체로 한 부분이 코드가 추가 된 부분인데 forRoutes 의 경우 어떤 Route Path 가 들어왔을 때 미들웨어를 사용할 것인지도 구분할 수 있다. 이 설정이 끝나면 정상적으로 Context Reload가 될 것이고 api 를 호출하면 다음과 같은 로그가 출력될 것이다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*pczfuyVXHY_Gdp47-0LsTw.png" /></figure><p>Client Request 요청됨 메시지와 console.log로 출력했던 HttpRequest 객체가 로깅되는데 이러한 부분을 통해 Header를 조작하거나 출력되는 Response를 조작하여 공통화 처리할 수 있다.</p><p>만약, 특정 URL 에 대해서 Middleware를 사용하지 않을 수도 있는데 exclude를 통해 Route path와 Method를 정의 하므로 특정을 예외로 처리할 수도 있다.</p><pre>export class AppModule implements NestModule {<br>  configure(consumer: MiddlewareConsumer): any {<br>    consumer<br>      .apply(LoggerMiddleware)<br>      **.exclude({path:&#39;user/list&#39;, method: RequestMethod.GET})**<br>      .forRoutes(&#39;user&#39;) </pre><pre>  }</pre><pre>}</pre><p>Apply를 진행할 때도 하나의 기능만이 아니라 여러 기능들을 설정할 수 있는데 다음 과 같이 설정할 수 있다.</p><pre>configure(consumer: MiddlewareConsumer): any {<br>    consumer<br>      .apply(**cors(), LoggerMiddleware)**<br>      .exclude({path:&#39;user/list&#39;, method: RequestMethod.GET})<br>      .forRoutes(&#39;user&#39;)</pre><pre>  }</pre><p>위에는 cors 를 설정할 것인데 helmet 이나 기타 미들웨어들을 직접 만들거나 라이브러리를 활용하여 적용 시킬 수 있다.</p><p><a href="https://medium.com/crocusenergy/nestjs-%EA%B7%B8-%EC%99%B8-%EA%B8%B0%EB%B3%B8-%EA%B0%9C%EB%85%90%EB%93%A4-39cac4bb49e?sk=502d5265d66922a6aad9606ca4f62db6"><strong>다음. [NestJS] 그 외 기본 개념들</strong></a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=649b14bf65ff" width="1" height="1" alt=""><hr><p><a href="https://medium.com/crocusenergy/nestjs-middleware-%EA%B0%9C%EB%85%90-%EB%B0%8F-%EC%8B%A4%EC%8A%B5-649b14bf65ff">[NestJS] Middleware 개념 및 실습</a> was originally published in <a href="https://medium.com/crocusenergy">CrocusEnergy</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[NestJS] Modules 개념 및 실습]]></title>
            <link>https://medium.com/crocusenergy/nestjs-modules-%EA%B0%9C%EB%85%90-%EB%B0%8F-%EC%8B%A4%EC%8A%B5-758b1328e9e7?source=rss-e1980d94947b------2</link>
            <guid isPermaLink="false">https://medium.com/p/758b1328e9e7</guid>
            <category><![CDATA[nodejs]]></category>
            <category><![CDATA[software-development]]></category>
            <category><![CDATA[nestjs]]></category>
            <category><![CDATA[dependencies]]></category>
            <category><![CDATA[javascript]]></category>
            <dc:creator><![CDATA[JeungJoo Lee]]></dc:creator>
            <pubDate>Thu, 17 Sep 2020 07:37:57 GMT</pubDate>
            <atom:updated>2020-09-17T07:50:10.180Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/1000/0*9sxknqB7XQ1YfXrq.png" /></figure><p>저번 시간에는 <a href="https://medium.com/crocusenergy/nestjs-providers-%EA%B0%9C%EB%85%90-%EB%B0%8F-%EC%8B%A4%EC%8A%B5-e811bccb809a"><strong>[NestJS] Providers 개념 및 실습 </strong></a>을 알아보았습니다. 이번 시간에는 NestJS의 Modules 개념을 살펴보고 실습을 진행하겠습니다.</p><p>모든 모듈은 각각 선언되어 최종적으로 하나로 취합된다. 앞서 만들었던 <strong>app.modules.ts</strong> 와 <strong>user.modules.ts</strong> 는 하나로 취합되어 최종적으로는 아래와 같은 형태로 병합되어야 한다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*pgXSKyD4aChC0TRTsIP-NQ.png" /></figure><p>그 병합된 module 의 경우 아래와 같이 main.ts 에서 NestFactory 를 통해 Create 되고 app 이 실행된다.</p><pre>import { NestFactory } from &#39;@nestjs/core&#39;;<br>import { AppModule } from &#39;./app.module&#39;;<br><br>async function bootstrap() {<br>  **const app = await NestFactory.create(AppModule, {});**<br>  await app.listen(3000);<br>}<br>bootstrap();</pre><p>AppModule의 경우 기존에 만들었던 UserModule 을 import 하고 있는데 아래와 같다.</p><pre>import { Module } from &#39;@nestjs/common&#39;;<br>import { AppController } from &#39;./app.controller&#39;;<br>import { AppService } from &#39;./app.service&#39;;<br>import { UserModule } from &#39;./user/user.module&#39;;<br><br>@Module({<br>  **imports: [UserModule],**<br>  controllers: [AppController],<br>  providers: [AppService],<br>})<br>export class AppModule {}</pre><p>결국 각각의 기능을 담당하는 Controller와 Providers 는 기능 모듈 별로 Module Decorator 에 등록되고 이 모듈들은 App Module 에 import 하여 최종적으로 NestFactory로 create 되는 플로우를 가지고 있다고 생각하면 될 것이다. 만약 AppModule에서 UserModule 을 import 하지 않는다면 아래와 같이 Nest Core 가 인식하지 못할 것이다.</p><p><strong>정상적으로 포함 했을 때 Context Reload 시</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*NisXKPEI6oI_65SWlHQGsQ.png" /></figure><p><strong>정상적으로 포함되지 않았을 때 Context Reload 시</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*bF_4qrmc-7Q4SINbklosJQ.png" /></figure><p>위와 같이 차이가 존재한다는 것을 인식할 수 있다.</p><p>작은 규모의 어플리케이션이 아니라면 분명 기능 단위로 @Module 을 만들고 그 하위에 Providers 에 등록되는 Dependency와 Controller 들이 존재할텐데 이 단위의 모듈은 최종적으로 Root 의 App 모듈에 포함되게 될 것이고 아래와 같이 각각 공유가 될 것이다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*AlgxIrdCuZwHG9FgLy2ilQ.png" /></figure><p>모듈로 부터 의존성이 기본적으로 Singleton 으로 유지되고 관리되는데 공유가 된다고 했다. 만약 이러한 케이스라면 어떻게 될까?</p><p>기존에 만들었던 UserController 에 userService 의존성이 아닌 testService 의 의존성을 주입하려고 한다고 치자. 해당 의존성은 UserModule 이 아닌 다른 TestModule 에서 참조한다고 했을 때 이론에 의하면 모듈의 의존성들이 서로 공유가 되기 때문에 별도의 설정 없이 사용할 수 있을 것 같다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*V2mylRDgdxU2F4xrcea0sA.png" /></figure><p>추가한 TestService와 TestModule 의 코드는 아래와 같다.</p><p><strong>src/test/test.module.ts</strong></p><pre>import { Module } from &#39;@nestjs/common&#39;;<br>import { TestService } from &#39;./test.service&#39;;</pre><pre>@Module({<br>  providers: [TestService]<br>})<br>export class TestModule {}</pre><p><strong>src/test/test.service.ts</strong></p><pre>import { Injectable } from &#39;@nestjs/common&#39;;</pre><pre>@Injectable()<br>export class TestService {<br>  getInfo(): string {<br>    return `This is TestService instance.`;<br>  }<br>}</pre><p>위의 두 가지를 추가하고 App Module 에 최종적으로 TestModule을 추가하였다.</p><pre>import { Module } from &#39;@nestjs/common&#39;;<br>import { AppController } from &#39;./app.controller&#39;;<br>import { AppService } from &#39;./app.service&#39;;<br>import { UserModule } from &#39;./user/user.module&#39;;<br>import { TestModule } from &#39;./test/test.module&#39;;</pre><pre>@Module({<br>  imports: [UserModule, TestModule],<br>  controllers: [AppController],<br>  providers: [AppService],<br>})<br>export class AppModule {}</pre><p>자 그렇다면 UserController에서 UserService가 아닌 TestModule 에 Provider로 등록된 TestService 도 쓸 수 있을 것 같다. 하지만, 아래와 같은 에러가 Context Reload 시 발생한다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*840hr2iWNkaLfQNZHfUafQ.png" /></figure><p>이유는 UserController에서 주입한 TestService 의 의존성을 찾을 수 없다는 것이고 의존성을 사용하기 위해서는 UserModule 에서 TestService를 포함하고 있는 모듈을 Import 해야 한다는 것이다.</p><p>위의 에러를 참고하여 코드를 UserModule에 추가 해보도록 하겠다.</p><p><strong>src/user/user.module.ts</strong></p><pre>import { Module } from &#39;@nestjs/common&#39;;<br>import { UserController } from &#39;./user.controller&#39;;<br>import { UserService } from &#39;./user.service&#39;;<br>import { TestModule } from &#39;../test/test.module&#39;;</pre><pre>@Module({<br>  imports: [TestModule],<br>  controllers: [UserController],<br>  providers: [UserService],<br>})<br>export class UserModule {}</pre><p>UserModule 에서 TestModule을 import 만 한다고 바로 쓰진 못하고 TestModule 에서 다른 모듈에서 사용하고자 할 의존성을 export 해줘야 한다.</p><p><strong>src/test/test.module.ts</strong></p><pre>import { Module } from &#39;@nestjs/common&#39;;<br>import { TestService } from &#39;./test.service&#39;;</pre><pre>@Module({<br>  providers: [TestService],<br>  exports: [TestService]<br>})<br>export class TestModule {}</pre><p>이렇게 다른 모듈에서 사용하고자 하는 의존성을 명시적으로 export 해줘야 아래와 같이 정상적으로 Nest Core가 작동하는 것을 볼 수 있다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*tF6ugSdmPglMeJhp91Iriw.png" /></figure><p>UserController 에서 TestService 의 의존성에서 추가한 부분은 아래와 같다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*RMgaFxMdNhsAHYYvPdR6ng.png" /></figure><p>Route로는 /user/test 라는 api 를 추가하였고 해당 기능은 testService 의존성에서 호출 되고 있다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1006/1*fHzjkdPpm4B8BXRZgP6G-Q.png" /></figure><p>API 도 정상적으로 호출 되는 것을 확인할 수 있다.</p><p>만약 이러한 과정이 번거롭고 해당 모듈을 Global 모드로 설정하여 모든 모듈에서 사용할 수 없을까 라는 생각도 할 수 있을 것이다. 그럴때는 @Global() 이라는 Decorator 를 모듈에서 선언 해주면 된다. 아래와 같이 Decorator 로 Global 이라고 설정하면 이 모듈에서 export 하고자 하는 모든 의존성은 다른 모듈에서 import를 할 필요 없이 사용이 가능하다.</p><pre>import { Global, Module } from &#39;@nestjs/common&#39;;<br>import { TestService } from &#39;./test.service&#39;;</pre><pre>@Global()<br>@Module({<br>  providers: [TestService],<br>  exports: [TestService]<br>})<br>export class TestModule {}</pre><p>글로벌로 선언을 남발하는 것은 아키텍처를 구성하는 상황에서 좋은 방향은 아니라고 NestJS 프로젝트를 주관한 재단에서 이야기 하고 있으니 잘 적절히 사용하도록 하자.</p><p>모듈은 Dynamic 모듈과 Config 모듈 등 다양한 전략들이 존재하는데 다음번에 설명하도록 하겠다.</p><p>다음 시간에는 <a href="https://medium.com/crocusenergy/nestjs-middleware-%EA%B0%9C%EB%85%90-%EB%B0%8F-%EC%8B%A4%EC%8A%B5-649b14bf65ff"><strong>[NestJS] Middleware 개념 및 실습</strong></a> 을 살펴보도록 하겠다.</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=758b1328e9e7" width="1" height="1" alt=""><hr><p><a href="https://medium.com/crocusenergy/nestjs-modules-%EA%B0%9C%EB%85%90-%EB%B0%8F-%EC%8B%A4%EC%8A%B5-758b1328e9e7">[NestJS] Modules 개념 및 실습</a> was originally published in <a href="https://medium.com/crocusenergy">CrocusEnergy</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
    </channel>
</rss>