<?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 Seonghun on Medium]]></title>
        <description><![CDATA[Stories by Seonghun on Medium]]></description>
        <link>https://medium.com/@dev-seonghun?source=rss-337b221bda85------2</link>
        <image>
            <url>https://cdn-images-1.medium.com/fit/c/150/150/1*mKtnq4KxnA3vtcIuLFbR9A.jpeg</url>
            <title>Stories by Seonghun on Medium</title>
            <link>https://medium.com/@dev-seonghun?source=rss-337b221bda85------2</link>
        </image>
        <generator>Medium</generator>
        <lastBuildDate>Fri, 20 Nov 2026 12:42:08 GMT</lastBuildDate>
        <atom:link href="https://medium.com/@dev-seonghun/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[스트릿 드랍에서 어드민을 개발하는 방법]]></title>
            <link>https://dev-seonghun.medium.com/%EC%8A%A4%ED%8A%B8%EB%A6%BF-%EB%93%9C%EB%9E%8D%EC%97%90%EC%84%9C-%EC%96%B4%EB%93%9C%EB%AF%BC%EC%9D%84-%EA%B0%9C%EB%B0%9C%ED%95%98%EB%8A%94-%EB%B0%A9%EB%B2%95-b26790665dd2?source=rss-337b221bda85------2</link>
            <guid isPermaLink="false">https://medium.com/p/b26790665dd2</guid>
            <category><![CDATA[spring-boot]]></category>
            <category><![CDATA[antd]]></category>
            <category><![CDATA[react]]></category>
            <category><![CDATA[admin]]></category>
            <category><![CDATA[spring-framework]]></category>
            <dc:creator><![CDATA[Seonghun]]></dc:creator>
            <pubDate>Thu, 06 Jun 2024 12:45:38 GMT</pubDate>
            <atom:updated>2024-06-06T12:45:38.781Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*S0VlsFqai305jqx1ZRtNvw.png" /></figure><p>저는 현재 길을 걸으며 <strong>지도에 음악을 드랍하는 위치기반 음악공유소셜 서비스,</strong> 스트릿 드랍에서 서버 개발을 담당하고 있습니다.</p><p>서비스 개발과 더불어 서비스를 운영하는 데 필요한 운영툴인 어드민을 집중적으로 개발하고 있습니다.</p><h3>어드민의 필요성</h3><p>스트릿 드랍은 위치기반의 커뮤니티 서비스이기 때문에, 시작부터 많은 운영 이슈가 존재했었습니다. 서비스내에서는 위치 기반으로 게시글이 보여지기 때문에 운영을 하면서 백엔드 개발자가 아니면 게시글을 확인하는데 다소 어려움이 있었습니다. 추가적으로 아래와 같은 여러 문제를 처리하는데도 많은 시간을 쏟아야 했습니다.</p><ul><li>지역 정보 관리</li><li>사용자 정보 확인</li><li>신고정보 확인</li><li>더미 데이터 생성(테스트 서버에서)</li></ul><p>기능 개발보다 지표 확인, 서비스 운영등에 많을 시간을 쏟아야 하다 보니, 이를 해결하기 위해 어드민을 개발하기로 정했습니다.</p><h3>어드민을 위한 프론트엔드 라이브러리선택</h3><p>스트릿 드랍은 서버 개발자 3명, iOS 개발자 3명, 디자이너 3명으로 구성되어 있어서 웹 프론트엔드개발을 전문적으로 맡아서 진행하는데는 다소 한계가 있었습니다. 따라서, 많은 리소스를 투입하지 않고 서버개발자들이 간단하게 어드민을 개발하기 위해서 다양한 라이브러리를 조사해보았습니다.</p><h4>AdminJs</h4><p>NodeJS 기반의 어드민 패널입니다. 데이터 베이스 연결만으로 간단하게 어드민 구축이 가능합니다. UI가 매우 깔끔하고 설정 또한 간편해서 고민을 했지만, 저희 팀원내에서 NodeJs 사용경험이 한명뿐이라서 선택하지는 않았습니다.</p><p><a href="https://adminjs.co/">AdminJS - the leading open-source admin panel for Node.js apps | AdminJS</a></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*3GyRCmrsz4g5bxKEZotbyw.png" /></figure><h4>Thymeleaf</h4><p>자바 진영에서 사용하는 템플릿 엔진으로 가볍게 응답 화면을 구성할 수 있습니다. 특히 Spring Boot 사용시 JSP는 Jar 빌드가 불가능하고 War 빌드만 가능하며, Spring Boot 내장 Tomcat과 호환이 떨어지기 때문에, Spring Boot와 사용할 경우 Thymeleaf가 권장됩니다.</p><p>기본적으로 제공되는 디자인이 아쉽고, 기본적으로 들어가야 하는 개발 리소스가 많아서 선택하지 않았습니다.</p><p><a href="https://www.thymeleaf.org/">Thymeleaf</a></p><h4>React + Antd</h4><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*fNXVWB3gLXJdeKSTUous7g.png" /></figure><p>최종적으로 React와 Antd를 선택했습니다. 우선 제가 인턴기간에 리액트를 잠깐 사용했던 경험이 있었기 때문에 선호되었습니다.</p><p>또한, Antd 라이브러리 특성상에서 Admin에서 필요한 요소를 많이 포함하고 있습니다. 특히 어드민의 경우 테이블 형태로 데이터를 보여주는 경우가 가장 많은데 정렬이나, 페이지네이션, 필터등이 포함되어 있어서 간편하게 사용할 수 있어서 많은 리소스 투여 없이 사용이 가능했습니다.</p><figure><img alt="Antd Table 기능" src="https://cdn-images-1.medium.com/max/1024/1*LCPTRVOaaV9CLEGXVtEalg.png" /><figcaption>Antd 테이블 기능</figcaption></figure><p>특히, 문서에서 각 컴포넌트에 대해서 예시 코드를 제공하고 있기 때문에, 많은 코드를 작성하지 않고 문서에 있는 컴포넌트를 확인하고 가져다 사용하기만 하면 됩니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*dGOTy3FKh_Ej5DorJfrTpg.png" /></figure><p>예를 들어, 유저 리스트를 제공하는 페이지를 만들고자 할때 다음과 같은 페이지네이션이 제공되는 API가 있다고 가정했을때 Table 컴포넌트를 활용하여 간단하게 페이지네이션이 구현된 화면을 구현할 수 있습니다.</p><p><strong>Server</strong></p><pre>@GetMapping(&quot;/users&quot;)<br>public ResponseEntity&lt;?&gt; getAllUsers(<br>        @PageableDefault(size = 20, page = 0, sort = &quot;createdAt&quot;,<br>                direction = Sort.Direction.DESC) Pageable pageable<br>) {<br>    var response = userService.getAllUsers(pageable);<br>    return ResponseDto.ok(response);<br>}</pre><p><strong>Client</strong></p><pre>function UserListPage() {<br>    const [users, setUsers] = useState([]);<br>    const [tableParams, setTableParams] = useState({pagination: InitialPagination});<br><br>    const columns = [<br>        {<br>            title: &#39;ID&#39;,<br>            dataIndex: &#39;id&#39;,<br>        },<br>        {<br>            title: &#39;닉네임&#39;,<br>            dataIndex: &#39;nickname&#39;,<br>        }<br>    ]<br><br>    const handleTableChange = (pagination,) =&gt; {<br>        setTableParams({pagination,});<br>        if (pagination.pageSize !== tableParams.pagination?.pageSize) {<br>            setUsers([]);<br>        }<br>    };<br><br>    useEffect(() =&gt; {<br>        fetchUser();<br>    }, [JSON.stringify(tableParams)]);<br><br><br>    const fetchUser = async () =&gt; {<br>        const response = await UserApi.getAllUser(tableParams.pagination.current - 1, tableParams.pagination.pageSize);<br>        setUsers(response.data.data);<br>        setTableParams({<br>            ...tableParams,<br>            pagination: {<br>                ...tableParams.pagination,<br>                total: response.data[&#39;meta&#39;][&#39;totalElements&#39;],<br>            },<br>        });<br>    }<br><br><br>    return (<br>        &lt;&gt;<br>            &lt;Table<br>                    columns={columns}<br>                    rowKey={record =&gt; record.id}<br>                    pagination={tableParams.pagination}<br>                    dataSource={users}<br>                    onChange={handleTableChange}<br>                /&gt;<br><br>        &lt;/&gt;<br>    )<br>}<br><br>export default UserListPage;</pre><p><strong>View</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*eBMa5JiD1yNl779TSzUpWQ.png" /><figcaption>Antd 화면</figcaption></figure><h3>프로젝트 구조 및 배포</h3><h4>프로젝트 구조</h4><p>이제 프론트를 위한 라이브러리를 선택했으니, 이를 처리하기 위한 API를 개발할 필요가 있습니다. Admin API를 위한 서버는 자바 기반의 Spring Boot로 개발을 진행했습니다.</p><pre>├── streetdrop-admin  # 관리자 웹 어플리케이션<br>│   ├── streetdrop-admin-server  # 관리자 웹 API 서버<br>│   ├── streetdrop-admin-web # 관리자 웹 프론트엔드<br>│   └── streetdrop-admin-web-server # 관리자 웹 프론트엔드 정적 배포용 서버<br>├── streetdrop-api  # API 서버<br>├── streetdrop-batch  # 배치 서버<br>├── streetdrop-common  # 공통 모듈<br>├── streetdrop-domain  # 도메인 모듈<br>└── streetdrop-search  # 검색 서버</pre><p>기존 모듈 구조에서는 엔티티 정보를 담아두고 있는 도메인 모듈이 있고, 다른 모듈들이 이를 참고하는 멀티모듈 구조를 가지고 있었습니다.</p><p>따라 관리자 어플리케이션 모듈을 만들고, 내부에는 어드민용 API 서버, 어드민 프론트엔드, 어드민 정적 배포용 서버로 구성했습니다.</p><h4>프로젝트 배포</h4><p>스프링 부트와 리액트를 함께 사용할때, 크게 3가지의 방법이 있습니다.</p><ol><li>스프링으로 리액트를 정적배포를 시키는 방법</li><li>Nginx로 리액트를 정적배포 시키는 방법</li><li>API서버와 다르게 정적 배포용 서버를 하나 두는 방법</li></ol><p><strong>스프링으로 리액트를 정적배포를 시키는 방법</strong></p><p>스프링을 빌드할 때, 리액트 프로젝트를 먼저 빌드하고 결과를 포함시켜야 합니다. 아래는 리액트 프로젝트를 빌드하고 결과를 스프링에 포함시키는 Gradle 빌드 스크립트입니다.</p><pre>def frontendDir = &quot;$projectDir/src/main/web&quot;<br><br>sourceSets {<br>    main {<br>        resources {<br>            srcDirs = [&#39;src/main/resources&#39;, frontendDir]<br>        }<br>    }<br>}<br><br>processResources { dependsOn &quot;copyReactBuildFiles&quot;}<br><br>tasks.register(&#39;installReact&#39;, Exec) {<br>    workingDir &quot;$frontendDir&quot;<br>    inputs.dir &quot;$frontendDir&quot;<br>    group = BasePlugin.BUILD_GROUP<br>    if (System.getProperty(&#39;os.name&#39;).toLowerCase(Locale.ROOT).contains(&#39;windows&#39;)) {<br>        commandLine &quot;npm.cmd&quot;, &quot;audit&quot;, &quot;fix&quot;<br>        commandLine &#39;npm.cmd&#39;, &#39;install&#39;<br>    } else {<br>        commandLine &quot;npm&quot;, &quot;audit&quot;, &quot;fix&quot; commandLine &#39;npm&#39;, &#39;install&#39;<br>    }<br>}<br><br>tasks.register(&#39;buildReact&#39;, Exec) {<br>    dependsOn &quot;installReact&quot;<br>    workingDir &quot;$frontendDir&quot;<br>    inputs.dir &quot;$frontendDir&quot;<br>    group = BasePlugin.BUILD_GROUP<br>    if (System.getProperty(&#39;os.name&#39;).toLowerCase(Locale.ROOT).contains(&#39;windows&#39;)) {<br>        commandLine &quot;npm.cmd&quot;, &quot;run-script&quot;, &quot;build&quot;<br>    } else {<br>        commandLine &quot;npm&quot;, &quot;run&quot;, &quot;build&quot;<br>    }<br>}<br><br>tasks.register(&#39;copyReactBuildFiles&#39;, Copy) {<br>    dependsOn &quot;buildReact&quot;<br>    from &quot;$frontendDir/build&quot;<br>    into &quot;$projectDir/src/main/resources/static&quot;<br>}</pre><p>스크립트에서 확인할 수 있듯이 스프링을 빌드할때마다 리액트 프로젝트를 먼저 빌드해야 하기 때문에 빌드 속도가 느리다는 단점과 리액트의 URL 매핑과 Spring 매핑을 맞춰주어야 하는 번거로움이 있습니다.</p><p>특히 이 방법을 활용해보았던 팀원이 빌드속도가 매우 지연된다는 의견이 있어서 해당 방법을 사용하지 않았습니다.</p><p><strong>Nginx로 리액트를 정적배포 시키는 방법</strong></p><p>다음과 같이 리액트 빌드파일을 배포할 수 있도록 간단하게 Nginx 설정파일을 간단하게 추가해서 정적배포가 가능합니다.</p><pre>server {<br>  listen 80;<br>  location / {<br>    root   /home/user/myapp/build;<br>    index  index.html index.htm;<br>    try_files $uri $uri/ /index.html;<br>  }<br>}</pre><p>Nginx로 리액트를 정적배포 시키는 방법의 경우 저희는 현재 <a href="https://nginxproxymanager.com/">Nginx Proxy Manger</a>을 통해 SSL을 적용하고 있었기 때문에, 이에 변경을 하는것이 다소 복잡하였기 때문에, 해당 방법을 선택하지 않았습니다.</p><p><a href="https://docs.street-drop.com/blog/nginx-proxy-manager/">Nginx Proxy Manger 사용기 | Street Drop</a></p><p><strong>API서버와 다르게 정적 배포용 서버를 하나 두는 방법</strong></p><p>스트릿 드랍팀에서는 결과적으로 정적 배포용 서버를 하나 두고 배포하는 방법을 선택하였습니다.</p><pre>app.use(&#39;/static&#39;, express.static(__dirname + &#39;/public&#39;));</pre><p>정적 배포용 서버는 Express를 통해서 리액트로 빌드된 파일을 단순히 서빙하는 역할만을 담당하고 있습니다.</p><h3>어드민 데이터 베이스와 인증</h3><p>사이드 프로젝트에서 내부망을 구축하기에는 다소 무리가 있어, 웹사이트 배포 이후 로그인을 통해, 보안 처리를 하기로 하였습니다.</p><p>이에 따라서, 어드민에서 관리해야 할 정보는 어드민 유저 정보 및 유저 권한 관리, 유저 접속 및 활동 로그, 어드민 허용 IP 관리등이 있습니다.</p><h4>어드민 데이터 베이스</h4><p>기존에 스트릿 드랍은 MySQL을 사용하고 있었습니다. 하지만 어드민의 경우 비즈니스 요구사항에 따라서 개발 방향이나 데이터 구조가 빠르게 변경되어야 했습니다. 따라서, 유동적인 요구사항을 빠르게 처리하기 위해서 MongoDB를 선택했습니다.</p><p>MongoDB는 스키마가 없는 NoSQL 데이터베이스로, 데이터 구조가 자주 변경되거나 유연한 설계가 필요한 경우에 적합합니다. 또한, 개발 초기 단계에서 데이터 모델이 확정되지 않았더라도 쉽게 데이터 구조를 변경할 수 있어 효율적입니다.</p><p>또한, 어드민의 특성상 기존 서비스 DB 뿐만 아니라 어드민 DB 두가지에 접근을 해야 합니다. 이 경우에 <a href="https://jong-bae.tistory.com/58">JPA를 사용하게 되면 다중 DataSource</a>를 사용해야 하고 이에 관한 설정이 추가로 필요합니다. 기존 서비스 DB와의 사용시 혼동 을 방지하기 위해서, NoSQL을 사용하였습니다.</p><h4>어드민 보안</h4><p><strong>어드민 로그인</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*Rg2FafaUxzvWTcfbLXop9w.png" /><figcaption>스트릿 드랍 어드민 로그인 페이지</figcaption></figure><p>서버에서는 JWT와 Spring Security를 통해서 로그인을 구현을 하였습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/771/1*D7vbOmiqYdo5TIA6CuV_-Q.png" /><figcaption>스프링 인증 처리 로직</figcaption></figure><p>유저가 아이디와 패스워드를 통해서 로그인 인증을 요청했을 때 위 그림에서 보이는 UsernamePasswordAuthenticationFilter 을 커스텀한 CustomUsernamePasswordAuthenticationFilter 를 거치게 됩니다.</p><p>다음UserPasswordAuthenticationToken을 발급한 뒤에AuthenticationProvider 가 AuthenticationManager 전달되어 인증을 처리하게 됩니다.</p><p>AuthenticationProvider 를 커스텀한 CustomAuthenticationProvider loadUserByUsername 라는 인증메서드를 호출하게 되고 MongoDB에 존재하는 관리자 정보를 확인한 뒤 AuthenticationSuccessHandler 에서 JWT 인증 토큰을 생성하고 클라이언트로 전달합니다.</p><p>React에서는 로그인 페이지에서 로그인 성공 응답값이 오게 되면, AuthService를 활용하여 accessToken 과 refreshToken 을 저장합니다.</p><p>AuthService.js</p><pre>const authService = {<br>    isLogin: () =&gt; !!browserStorage.get(&#39;accessToken&#39;),<br>    getAccessToken: () =&gt; browserStorage.get(&#39;accessToken&#39;),<br>    getRefreshToken: () =&gt; cookieStorage.get(&#39;refreshToken&#39;),<br>    saveToken: (accessToken, refreshToken) =&gt; {<br>        browserStorage.set(&#39;accessToken&#39;, accessToken)<br>        cookieStorage.set(&#39;refreshToken&#39;, refreshToken)<br>    },<br>    logout: () =&gt; {<br>        browserStorage.remove(&#39;accessToken&#39;)<br>        cookieStorage.remove(&#39;refreshToken&#39;)<br>    },<br><br>};<br><br>export default authService;</pre><ul><li><strong>browserStorage : </strong>브라우저의 localStorage를 사용하여 데이터를 저장, 조회, 삭제, 초기화하는 기능을 제공합니다. 주로 JSON 형식의 데이터를 문자열로 변환하여 저장합니다.</li><li><strong>cookieStorage : </strong>브라우저의 쿠키를 사용하여 데이터를 저장, 조회, 삭제하는 기능을 제공합니다. 쿠키는 보안 상의 이유로 HttpOnly 속성을 사용하여 설정됩니다.</li></ul><ul><li><a href="https://dreamcode.tistory.com/444">JWT 토큰 저장 방식?/위치? 정리 (보안)</a></li><li><a href="https://velog.io/@ohzzi/Access-Token%EA%B3%BC-Refresh-Token%EC%9D%84-%EC%96%B4%EB%94%94%EC%97%90-%EC%A0%80%EC%9E%A5%ED%95%B4%EC%95%BC-%ED%95%A0%EA%B9%8C">Access Token과 Refresh Token을 어디에 저장해야 할까?</a></li></ul><p>다음 Axios 요청을 보낼때, 헤더에 accessToken을 추가하여 인증을 처리합니다.</p><pre>const axiosAuthAPI = (url, options) =&gt; {<br>    const token = authService.getAccessToken();<br>    const axiosResult = axios.create({<br>        baseURL: url,<br>        headers: {<br>            Authorization: `Bearer ${token}`,<br>            ContentType: &#39;application/json&#39;<br>        },<br>        ...options,<br>    })<br><br>    return axiosResult;<br><br>}</pre><p>서버에서는 OncePerRequestFilter 를 통해서 구현한 JwtAuthenticationFilter 를 통해서 JWT 토큰 인증을 처리합니다.</p><p><a href="https://minkukjo.github.io/framework/2020/12/18/Spring-142/">OncePerRequestFilter와 Filter의 차이</a></p><p>현재는 JWT를 통한 로그인 처리만 되어 있지만, 추후 게시글을 통해, 2단계 인증 도입과 설계와 구현 사례를 공유드리겠습니다.</p><p><a href="https://medium.com/@AlexanderObregon/how-to-implement-two-factor-authentication-in-spring-boot-446badc64c36">How to Implement Two-Factor Authentication in Spring Boot</a></p><p><strong>최고 관리자 생성</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*Vdr4qoAumdOodoopDXbxEw.png" /><figcaption>스트릿 드랍 어드민 — 관리자 계정 생성</figcaption></figure><p>어드민 서버에서 로그인을 제외한 모든 요청은 인증을 필요로 하기 때문에 처음 실행을 할 경우, 최고 관리자가 없는 경우에 최고 관리자가 생성될 수 있도록 하였습니다.</p><p><em>어드민의 계정 생성은 최고 관리자가 로그인된 상태에서 진행되어야 합니다</em>.</p><pre>@Bean<br>public CommandLineRunner run() {<br>    return (String[] args) -&gt; {<br>        eventPublisher.publishEvent(new CreateAdministratorEvent());<br>    };<br>}</pre><pre>@Component<br>@RequiredArgsConstructor<br>public class AdministratorEventHandler {<br><br>    private final MemberService memberService;<br>    private final AdministratorConfig administratorConfig;<br><br>    @EventListener<br>    public void createNewAdministrator(CreateAdministratorEvent createAdministratorEvent) {<br>        var signUpRequestDto = SignupRequestDto.builder()<br>                .username(administratorConfig.getId())<br>                .part(Part.Admin)<br>                .password(administratorConfig.getPassword())<br>                .build();<br>        if (!memberService.existsByUsername(signUpRequestDto.getUsername())) {<br>            memberService.signUp(signUpRequestDto);<br>        }<br>    }<br><br>}</pre><p>이를 위해서 <a href="https://www.daleseo.com/spring-boot-runners/">CommandLineRunner를 통해서 이벤트를 발행</a>하고, 이벤트 핸들러를 통해서 관리자가 있는지 여부를 파악한 뒤에 가입을 하도록 처리하였습니다. AdministratorConfig에서는 설정파일을 통해서 관리자 아이디와 패스워드를 입력받습니다.</p><h3><strong>어드민 들여다보기</strong></h3><h4>프론트엔드 프로젝트 구조</h4><pre>└── streetdrop-admin-web<br>    ├── public         # 정적 파일(HTML, 이미지, 아이콘 등)을 포함하는 폴더<br>    ├── src            # 소스 코드가 위치한 폴더<br>    │   ├── api        # 서버 요청과 응답을 처리하는 axios 설정 및 함수들<br>    │   ├── components # 재사용 가능한 UI 컴포넌트들을 포함하는 폴더<br>    │   ├── constant   # 애플리케이션에서 사용하는 상수 값을 정의하는 폴더<br>    │   ├── pages      # 각 라우트에 해당하는 페이지 컴포넌트들을 포함하는 폴더<br>    │   ├── route      # 라우팅 설정을 포함하는 폴더<br>    │   ├── service    # 비즈니스 로직을 처리하는 서비스 레이어<br>    │   ├── styles     # 전역 스타일 및 CSS 파일들을 포함하는 폴더<br>    │   └── utils      # 유틸리티 함수들을 포함하는 폴더<br>    └── App.js         # 애플리케이션의 루트 컴포넌트</pre><p><a href="https://legacy.reactjs.org/docs/faq-structure.html">File Structure - React</a></p><blockquote>If you’re just starting a project, <a href="https://en.wikipedia.org/wiki/Analysis_paralysis">don’t spend more than five minutes</a> on choosing a file structure</blockquote><p>리액트 공식문서에서의 폴더 구조에 관한 내용이며, 깊게 고민하지 않고 상황에 맞추어 계속 리팩토링하고 있습니다.</p><p>우선 현재의 폴더 구조에 관해서는 우선 pages를 통해서 각 라우팅에 맞는 페이지 정보들을 담고 있으며, components를 통해서 각 페이지에서 공통으로 활용되는 컴포넌트를 관리할 수 있도록 하였습니다.</p><p>service와 utils 의 경우 인증과 같은 여러 비즈니스 로직등을 처리하기 위한 폴더이며, api는 서버의 요청과 응답을 처리하는 axios 기본 설정값이나 인터셉터, 요청 처리 함수등을 가지고 있습니다.</p><h4>어드민 대시보드</h4><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*ZT_-iVBALdyrhbw7Zl_uQw.png" /><figcaption>스트릿 드랍 어드민 대시보드</figcaption></figure><p>로그인 이후의 메인 화면은 대시보드 형태로 구성 하였습니다. 지표 선정은 서비스의 비즈니스 목표와 일치하는 성과 지표들 위주로 구성하였습니다.</p><p>전체 가입 유저 정보와 드랍 개수등을 확인할 수 있도록 구성하면서, nivo 라이브러리(그래프 라이브러리) 를 사용하여 가입 유저와 드랍 지역에 대한 그래프를 제공할 수 있도록 하였습니다.</p><p><a href="https://nivo.rocks/">Home</a></p><p>메인 화면에서는 최근 일자별 그래프를 제공하면서, 상세 페이지를 통해서 기간별 조회등을 제공할 수 있도록 하였습니다.</p><h4>어드민 아이템 관리</h4><p><strong>아이템 조회 및 삭제</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*Ui68cVwGdTzZikd_SfU4Tg.png" /><figcaption>스트릿 드랍 어드민 — 아이템 조회 및 삭제</figcaption></figure><p>스트릿 드랍에서는 위치 기반으로 주변의 게시글만 노출됩니다. 운영을 하면서 내 위치와 먼 곳의 아이템 데이터를 확인하기 어렵다는 문제를 가지고 있습니다.</p><p>따라서, 어드민에서 전체 아이템을 조회하고 삭제할 수 있는 기능을 제공하고 있습니다.</p><p><strong>아이템 생성</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*a8TV0GIym3a3lJD3MHcnkw.png" /><figcaption>스트릿 드랍 어드민 — 아이템 생성</figcaption></figure><p>아이템 생성 기능은 <em>테스트 서버와 로컬 환경에서만 활성화 되는 기능</em>입니다.</p><p>스트릿 드랍은 위치 기반 서비스이기 때문에, 어플내에서는 현재 위치에서만 새로운 콘텐츠를 생성할 수 있습니다. 따라 개발 환경에서 더미 데이터를 간단하게 생성할 수 있도록 해당 화면을 제공하고 있습니다.</p><p><strong>아이템 신고 및 금칙어 관리</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*S_r3yUKEg2gncxlzEe8zBQ.png" /><figcaption>스트릿 드랍 어드민 신고 관리 페이지</figcaption></figure><p>iOS 정책에 따르면 커뮤니티 서비스를 제공할 경우 신고 기능을 필수적으로 포함해야 합니다. 애플 심사 과정에서는 신고 프로세스와 악성 콘텐츠 모니터링 시스템을 확인합니다.</p><p>이를 위해 스트릿 드랍은 디스코드를 통해 실시간으로 제보되는 신고를 확인하고, 어드민 페이지에서 이를 처리할 수 있도록 시스템을 구축했습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*JUHn_4ymoq4i24wTWatGZA.png" /><figcaption>스트릿 드랍 어드민 금칙어 관리 페이지</figcaption></figure><p>스트릿 드랍에서는 @NotBannedWord 를 통해서 콘텐츠내의 금칙어 검사를 진행하고 있습니다.</p><pre>@Target(FIELD)<br>@Retention(RUNTIME)<br>@Constraint(validatedBy = BannedWordValidator.class)<br>public @interface NotBannedWord {<br><br>    String message() default &quot;Cannot use banned word&quot;;<br><br>    Class&lt;?&gt;[] groups() default {};<br><br>    Class&lt;? extends Payload&gt;[] payload() default {};<br>}</pre><p>어드민에서는 해당 금칙어를 관리할 수 있는 금칙어 관리 페이지를 제공하여 금칙어를 추가하거나, 삭제할 수 있게 하였습니다.</p><h4>어드민 콘텐츠 관리</h4><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*WeEG13TgyazFELiWtuHxXQ.png" /></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*pPwD7Nn6abCaAoTlvS0l7A.png" /><figcaption>스트릿 드랍 어드민 콘텐츠 관리 — 음악 추천</figcaption></figure><p>스트릿 드랍에서는 앱 내에서 검색어 추천 등 다양한 콘텐츠를 제공합니다. 이러한 콘텐츠를 관리자들이 작성할 수 있도록 콘텐츠 작성 화면을 통해 제공되고 있습니다.</p><h4>어드민 유저 관리</h4><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*68zkuZQIExat2sEGCz6b2w.png" /><figcaption>스트릿 드랍 어드민 — 유저 관리</figcaption></figure><p>가입 유저의 최근 활동 정보 및 주요 활동 지역 및 지역별 아이템 개수등을 유저 관리 화면을 통해서 제공하고 있습니다.</p><h3>마치며</h3><p>스트릿 드랍 어드민을 개발하면서, 배포 방법, 인증 설계, 프론트 개발등의 다양한 고민들을 할 수 있었습니다.</p><p>기존에는 필요한 데이터나 지표들을 확인하기 위해서, 매번 데이터 베이스에 접속하여 쿼리를 통해서 확인해야 했지만 어드민을 개발한 뒤로는 이러한 데이터나 지표에 대해서 외부에서도 손쉽게 접근이 가능했습니다.</p><p>또한, 운영을 하면서 필요한 처리들을 권한이 있는 관리자면 누구나 처리할 수 있기 때문에 서비스 운영에 대한 부담도 많이 줄일 수 있었습니다.</p><p>이 글을 통해 어드민 프로젝트를 진행하실 때 조금이나마 도움이 되었으면 좋겠습니다.</p><h4>스트릿 드랍 다운로드 하기</h4><p><a href="https://street-drop.com/">StreetDrop</a></p><h4>스트릿 드랍 Github</h4><p><a href="https://github.com/depromeet/street-drop-server">GitHub - depromeet/street-drop-server: StreetDrop 🎶 Location based music sharing social service</a></p><h4>스트릿 드랍 기술 블로그</h4><p><a href="https://docs.street-drop.com/">Street Drop</a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=b26790665dd2" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[나만의 Github Action 만들기 — Flyway Naming Checker]]></title>
            <link>https://dev-seonghun.medium.com/%EB%82%98%EB%A7%8C%EC%9D%98-github-action-%EB%A7%8C%EB%93%A4%EA%B8%B0-flyway-naming-checker-ad67b9534809?source=rss-337b221bda85------2</link>
            <guid isPermaLink="false">https://medium.com/p/ad67b9534809</guid>
            <category><![CDATA[flyway]]></category>
            <category><![CDATA[rust]]></category>
            <category><![CDATA[github]]></category>
            <category><![CDATA[github-actions]]></category>
            <category><![CDATA[ci]]></category>
            <dc:creator><![CDATA[Seonghun]]></dc:creator>
            <pubDate>Mon, 15 Apr 2024 11:37:53 GMT</pubDate>
            <atom:updated>2024-04-15T11:45:46.383Z</atom:updated>
            <content:encoded><![CDATA[<h3>나만의 Github Action 만들기 — Flyway Naming Checker</h3><p>오늘은 Flyway Naming Checker을 개발하면서 진행했던 Github Action 만들었던 내용에 대해전달해드리고자 합니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*YO_3E7-Vrc5kGEdV1RwabQ.png" /><figcaption>flyway naming checker in github market place</figcaption></figure><h3>Github Action</h3><p>GitHub Actions을 사용하면서 <strong>Github에서 다양한 워크 플로우나 지정 작업들을 실행할 수 있습니다. </strong>일반적으로는 CI/CD와 같은 동작을 수행하기 위해서 많이 사용합니다. 테스트를 실행하거나 빌드하여 배포하는 방식과 같은 정해진 동작을 수행할 수 있습니다.</p><h3>Custom Github Action</h3><p><a href="https://docs.github.com/ko/actions/creating-actions/about-custom-actions">사용자 지정 작업 정보 - GitHub Docs</a></p><p>Github Action에서는 사용자가 필요한 작업을 만들고 처리할 수도 있습니다. <strong>Docker, Javascript, 복합(Composite) 액션</strong>(쉘 스크립트나 바이너리)등을 처리할 수 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*uoQXZsCL3yiX6--Fu4MxbA.png" /><figcaption>Github Custem Action</figcaption></figure><p><strong>도커는 리눅스에서만 실행할 수 있고, JavaScript나 복합(Composite) 액션은 모든 기기에서 실행이 가능</strong>합니다. JavaScript가 가장 빠르게 실행가능하지만, 기기호환성으로 인해서 다른 라이브러리 사용등에 제약이 있었기 때문에 저는<strong> 복합 액션으로 진행하고자 하였으며, 언어는 Rust를 사용</strong>하기로 했습니다.</p><p><strong>Actiom.yml</strong></p><p>우선 Custom Github Action을 사용하려면 해당 액션에 대한 입출력, 진입점을 정의한 action.yml 이 필요합니다. 다음은 Action.yml 의 예와 간단한 설명입니다.</p><pre>name: github-action-example # action 이름<br>description: github action example # action 설명<br>author: Dylan Anthony &lt;80201773+seonghun-dev@users.noreply.github.com&gt; # action 소유자<br><br><br>inputs: # action 런타임에 사용할 변수들<br>  num-octocats: # action 런타임에 사용할 변수 - Github는 이를 환경변수로 저장합니다. (소문자 사용)<br>    description: &#39;Number of Octocats&#39; # action 런타임에 사용할 변수 설명 <br>    required: false # action 런타임에 사용할 변수 필수 여부<br>    default: &#39;1&#39; # action 런타임에 사용할 변수 기본값<br><br><br>outputs:<br>  sum: # action 출력으로 사용될 변수, 환경 변수에 저장합니다.<br>    description: &#39;The sum of the inputs&#39; # action 출력으로 사용될 변수 설명<br><br><br>runs: # 실행 할 것 및 진입점<br>  using: &quot;composite&quot; # &quot;node20&quot;, &quot;composite&quot;, &quot;docker&quot; 등을 사용할 수 있습니다.<br>  steps:<br>    - run: ${{ github.action_path }}/test/script.sh # sciprt를 실행합니다.<br>      shell: bash</pre><h3>Rust Github Action Template</h3><p><a href="https://github.com/dbanty/sample-rust-action">GitHub - dbanty/sample-rust-action</a></p><p>우선 Rust Github Action 템플릿이 있어, 이 액션을 바탕으로 개발을 진행하기로 했습니다.</p><pre>name: sample-rust-action<br>description: An example GitHub Action written in Rust, generated from [dbanty/rust-github-action-template](https://github.com/dbanty/rust-github-action-template). You can either use this GitHub template and customize it yourself, or `cargo generate dbanty/rust-github-action-template` to create a new repo from this template. Any issues should be opened in the upstream template.<br>author: Dylan Anthony &lt;dbanty@users.noreply.github.com&gt;<br>inputs:<br>  error:<br>    description: &#39;The error message to display, if any&#39;<br>    required: false<br>    default: &#39;&#39;<br>  token:<br>    description: &#39;The GitHub token to use for downloading the action, defaults to workflow token&#39;<br>    required: true<br>    default: ${{ github.token }}<br>outputs:<br>  error:<br>    description: &#39;The description of any error that occurred&#39;<br>    value: ${{ steps.run.outputs.error }}<br><br>runs:<br>  using: &#39;composite&#39;<br>  steps:<br>    - name: Set reusable variables<br>      shell: bash<br>      run: |<br>        echo &quot;action_repo=sample-rust-action&quot; &gt;&gt; $GITHUB_ENV<br>        echo &quot;action_org=dbanty&quot; &gt;&gt; $GITHUB_ENV<br>        echo &quot;binary_name=sample-rust-action&quot; &gt;&gt; $GITHUB_ENV<br><br>    - name: Add binary extension<br>      shell: bash<br>      if: runner.os == &#39;Windows&#39;<br>      run: echo &quot;binary_name=${{ env.binary_name }}.exe&quot; &gt;&gt; $GITHUB_ENV<br><br>    - name: Get Action Version<br>      id: get_action_version<br>      shell: pwsh<br>      run: |<br>        $finalComponent = Split-Path -Leaf ${{ github.action_path }}<br>        if ($finalComponent -eq &quot;${{ env.action_repo }}&quot;) {<br>          $version = &quot;&quot;<br>        } else {<br>          $version = $finalComponent<br>        }<br>        Write-Output &quot;version=$version&quot; &gt;&gt; $Env:GITHUB_OUTPUT<br><br>    - name: Download Action<br>      shell: bash<br>      run: |<br>        gh release download ${{ steps.get_action_version.outputs.version }} --repo ${{ env.action_org }}/${{ env.action_repo }} --pattern &#39;${{ runner.os }}.tgz&#39;<br>        tar -xzf ${{ runner.os }}.tgz<br>      env:<br>        GITHUB_TOKEN: ${{ inputs.token }}<br><br>    - name: Run Action<br>      shell: bash<br>      id: run<br>      run: ./${{ runner.os }}/${{ env.binary_name }} &quot;${{ inputs.error }}&quot;</pre><p>먼저 Action 템플릿의 action.yml을 분석해보면, 맞는 버전을 찾고</p><pre>gh release download ${{ steps.get_action_version.outputs.version }} --repo ${{ env.action_org }}/${{ env.action_repo }} --pattern &#39;${{ runner.os }}.tgz&#39;<br>tar -xzf ${{ runner.os }}.tgz</pre><p>를 통해서 해당 버전에 맞는 바이너리 압축 파일을 다운받고 압축을 풀게 됩니다. 다음 Action을 통해서 <strong>os에 맞는 바이너리 파일을 명령인자를 넣어주면서 실행</strong>합니다.</p><pre>- name: Run Action<br>      shell: bash<br>      id: run<br>      run: ./${{ runner.os }}/${{ env.binary_name }} &quot;${{ inputs.error }}&quot;</pre><p>해당 Github action을 릴리즈하는 Release.yml을 보면 조금 더 쉽게 이해할 수 있습니다.</p><pre>name: Release<br><br>on:<br>  workflow_dispatch:<br>    inputs:<br>      version:<br>        description: &#39;Version to release&#39;<br>        required: true<br><br>jobs:<br>  build-artifacts:<br>    strategy:<br>      fail-fast: false<br>      matrix:<br>        include:<br>          - target: x86_64-unknown-linux-musl<br>            os: ubuntu-latest<br>          - target: x86_64-apple-darwin<br>            os: macos-latest<br>          - target: x86_64-pc-windows-msvc<br>            os: windows-latest<br>            file_extension: .exe<br><br>    runs-on: ${{ matrix.os }}<br>    name: ${{ matrix.target }}<br>    env:<br>      binary_name: sample-rust-action${{ matrix.file_extension }}<br><br>    steps:<br>      - uses: actions/checkout@v4<br><br>      - uses: Swatinem/rust-cache@v2<br><br>      - name: Install host target<br>        run: rustup target add ${{ matrix.target }}<br><br>      - name: Install musl-tools<br>        if: ${{ matrix.target == &#39;x86_64-unknown-linux-musl&#39; }}<br>        run: sudo apt-get install -y musl-tools<br><br>      - name: Build<br>        run: cargo build --release --target ${{ matrix.target }}<br><br>      - name: Create Archive Folder<br>        run: mkdir ${{ runner.os }}<br><br>      - name: Copy Artifact<br>        run: cp target/${{ matrix.target }}/release/${{ env.binary_name }} ${{ runner.os }}<br><br>      - name: Create Tar Archive<br>        run: tar -czf ${{ runner.os }}.tgz ${{ runner.os }}<br><br>      - name: Store Archive<br>        uses: actions/upload-artifact@v4<br>        with:<br>          name: ${{runner.os}}<br>          path: ${{ runner.os }}.tgz<br><br>  create-release:<br>    needs: [build-artifacts]<br>    runs-on: ubuntu-latest<br>    name: Create Release<br>    permissions:<br>      contents: write<br>    steps:<br>      - uses: actions/checkout@v4<br>      - uses: actions/download-artifact@v4<br>      - name: Create Release<br>        uses: ncipollo/release-action@v1<br>        with:<br>          artifacts: &quot;Linux/Linux.tgz,macOS/macOS.tgz,Windows/Windows.tgz&quot;<br>          tag: v${{ github.event.inputs.version }}</pre><p>build-artifact의 동작에서 Linux, macOS, Window를 각각 빌드하여 .tgz로 압축하고 create-release의 동작에서는 Github 릴리즈를 하며, 해당 artifact를 올리게 됩니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*O4bYDpKFC0Rr2DlJEVObbw.png" /><figcaption>realase.yml — graph</figcaption></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*ot0xEteZgte73tdTruEDbg.png" /></figure><p>실제 이 템플릿의 Github Action을 사용하게 되면 위에 있는 릴리즈의 <strong>os에 맞는 바이너리 파일을 다운받아서 바이너리 형태로 실행합니다.</strong></p><p>이제 액션의 동작을 이해했으니 이를 바탕으로 Custom Action을 만들어보겠습니다.</p><h3>Flyway Naming Checker</h3><p>제가 만들게 된 Custom Action은 <strong>Flyway 마이그레이션 파일이 네이밍 규칙에 맞는지 확인하는 Action</strong>입니다,</p><p>스트릿 드랍에서는 데이터 베이스 마이그레이션을 위해서 Flyway를 사용하고 있습니다. SQL 마이그레이션 스크립트 기반으로 처리하고 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/873/1*TL-s0c-WHUvf9veEAEt2YQ.png" /></figure><p><a href="https://www.red-gate.com/blog/database-devops/flyway-naming-patterns-matter">Flyway: Naming Patterns Matter | Redgate</a></p><p><strong>Flyway 마이그레이션 파일은 </strong><a href="https://www.red-gate.com/blog/database-devops/flyway-naming-patterns-matter"><strong>특정한 네이밍 규칙</strong></a><strong>이 있는데, 가끔 오타나 개발자의 실수로 인해서 이 규칙에 맞지 않는 파일 작성되어서 PR 단게에서 이를 검증</strong>하고자 하였습니다.</p><p>아래는 스트릿 드랍에서 prefix가 소문자 v로 작성되서 문제가 생겼던 부분입니다. prefix가 대문자로 있어야 합니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*EbzXTzaFj1JermujRKsuNQ.png" /></figure><p>이를 PR 단계에서 Github Action을 통해서 검증하고자 하였습니다.</p><p>우선 Github Action Input으로 들어온<strong> 마이그레이션 폴더를 기반으로 파일 명을 모두 가져온 다음에, 해당 파일명이 Flyway 네이밍 규칙에 어긋나는지만 체크</strong>해주면 됩니다.</p><h4>Action.yml</h4><p>먼저 sql 파일이 들어있는 flyway 마이그레이션 폴더를 입력으로 받아와야 합니다. 따라서 action.yml input에 path를 추가하여 마이그레이션 폴더 경로를 가져올 수 있도록 하였습니다. 다음 명령행 인자로 path를 넣어주었습니다.</p><pre>name: flyway-naming-checker<br>description: Flyway Naming Checker<br>author: seonghun &lt;seonghun-dev@users.noreply.github.com&gt;<br>inputs:<br>  path:<br>    description: &#39;Write the path to match your migration script location&#39;<br>    required: true<br>    default : &#39;db/migration&#39;<br>  token:<br>    description: &#39;The GitHub token to use for downloading the action, defaults to workflow token&#39;<br>    required: true<br>    default: ${{ github.token }}<br><br>runs:<br>  using: &#39;composite&#39;<br>  steps:<br><br>    # 생략<br><br>    - name: Run Action<br>      shell: bash<br>      id: run<br>      run: ./${{ runner.os }}/${{ env.binary_name }} &quot;${{ inputs.path }}&quot; # 명령행 인자로 넣기</pre><h4>main.rs</h4><p>먼저 main() 함수가 실행되며 명령행 인자를 가져옵니다. 다음 run을 통해서 해당 run(path: &amp;str) 함수가 실행됩니다. 이 함수는 Result(&lt;&gt;, FlywayNamingCheckerError) 를 Return 하므로 에러가 발생하면 exit(1) 로 에러 메세지를 출력하면서 종료하였고, 그렇지 않은 경우 일반적인 종료처리를 하였습니다.</p><pre>fn main() {<br>    let args: Vec&lt;String&gt; = env::args().collect(); // 명령행 인자 가져옴<br>    let path = &amp;args[1]; // 마이그레이션 파일 path<br>    if let Err(err) = run(path) {<br>        eprintln!(&quot;Error: {}&quot;, err);<br>        exit(1); // 에러로 종료<br>    } else {<br>        exit(0); // 일반적인 종료<br>    }<br>}<br><br>fn run(path: &amp;str) -&gt; Result&lt;(), FlywayNaimngCheckerError&gt; {<br>    if path.is_empty() { // path가 비었는지 체크<br>        return Err(FlywayNaimngCheckerError::NoPathProvideded);<br>    }<br>    let files = get_file_names(path)?; // path에서 파일 리스트 가져옴<br>    if files.is_empty() { // 파일이 하나도 없을 경우 에러 발생<br>        return Err(FlywayNaimngCheckerError::CannotFindAnyFile);<br>    }<br>    for file in files { // 모든 파일 명에 대해서 유효성 체크<br>        is_valid_prefix(file.as_str())?;<br>        is_valid_suffix(file.as_str())?;<br>        is_valid_sepeartor(file.as_str())?;<br>        is_valid_version(file.as_str())?;<br>    }<br>    Ok(())<br>}</pre><p>exit(1)로 종료하고 에러 메세지를 프린트 하면 Github Action에서는 실패로 처리되며 다음과 같이 에러메세지가 나오게 됩니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*EZbTNwiuanmds9x2_NUNVA.png" /></figure><h4>error.rs</h4><p>FlywayNamingCheckerError는 Flyway Naming Checker의 에러를 모아둔 Enum으로 io에러의 경우에도FlywayNamingCheckerError 로 변환하여 처리하고 있습니다. ThisError Crate를 활용했습니다.</p><pre>#[derive(Debug, ThisError, Eq, PartialEq)]<br>pub enum FlywayNaimngCheckerError {<br>    #[error(&quot;cannot find any file in this path&quot;)]<br>    CannotFindAnyFile,<br><br>    #[error(&quot;file io error&quot;)]<br>    FileIoError,<br><br>    #[error(&quot;Flyway file prefix naming error found in file : {file} - cannot find prefix&quot;)]<br>    FlywayNamingCanNotFindPrefix { file: String },<br><br>    #[error(<br>        &quot;Flyway file prefix naming error found in file : {file} - expected: {expected}, found: {found}&quot;<br>    )]<br>    FlywayNamingPrefixError {<br>        file: String,<br>        expected: String,<br>        found: String,<br>    },<br>}<br><br>impl From&lt;io::Error&gt; for FlywayNaimngCheckerError {<br>    fn from(_error: io::Error) -&gt; Self {<br>        FlywayNaimngCheckerError::FileIoError<br>    }<br>}</pre><h4>file.rs</h4><p>아래는 현재 디렉토리에 있는 파일을 가져오는 get_file_names 함수입니다.</p><pre>pub fn get_file_names(path: &amp;str) -&gt; Result&lt;Vec&lt;String&gt;, FlywayNaimngCheckerError&gt; {<br>    let mut files = Vec::new();<br>    for entry in read_dir(path)? {<br>        let entry = entry?;<br>        if let Some(file_name) = entry.file_name().to_str() {<br>            files.push(file_name.to_owned());<br>        }<br>    }<br>    Ok(files)<br>}</pre><h4>naming_checker.rs</h4><p>다음 Prefix의 유효성을 체크하는 is_valid_prefix , suffix의 유효성을 체크하는 is_valid_suffix , 구분자의 유효성을 체크하는 is_valid_seperator , 버전여부를 체크하는 is_valid_version 함수를 통해서 개별로 유효성을 체크할 수 있도록 하였습니다.</p><p>아래 간단한 테스트를 구성해 해당 함수가 정상작동하는지 확인하였습니다.</p><pre>// naming_checker.rs<br><br>pub fn is_valid_prefix(file_name: &amp;str) -&gt; Result&lt;(), FlywayNaimngCheckerError&gt; {<br>    let first_char = file_name.chars().next();<br><br>    match first_char {<br>        Some(prefix) =&gt; {<br>            if !(prefix == &#39;V&#39; || prefix == &#39;U&#39; || prefix == &#39;R&#39;) {<br>                let mut expected_prefix = &quot;V&quot;;<br><br>                if prefix == &#39;u&#39; {<br>                    expected_prefix = &quot;u&quot;;<br>                }<br><br>                if prefix == &#39;r&#39; {<br>                    expected_prefix = &quot;r&quot;;<br>                }<br><br>                Err(FlywayNaimngCheckerError::FlywayNamingPrefixError {<br>                    file: file_name.to_string(),<br>                    expected: expected_prefix.to_string(),<br>                    found: prefix.to_string(),<br>                })<br>            } else {<br>                Ok(())<br>            }<br>        }<br>        None =&gt; Err(FlywayNaimngCheckerError::FlywayNamingCanNotFindPrefix {<br>            file: file_name.to_string(),<br>        }),<br>    }<br>}<br><br>pub fn is_valid_suffix(file_name: &amp;str) -&gt; Result&lt;(), FlywayNaimngCheckerError&gt; {<br>    if let Some(dot_index) = file_name.rfind(&#39;.&#39;) {<br>        let suffix = &amp;file_name[dot_index + 1..];<br>        if suffix != &quot;sql&quot; {<br>            return Err(FlywayNaimngCheckerError::FlywayNamingSufixError {<br>                file: file_name.to_string(),<br>                expected: &quot;.sql&quot;.to_owned(),<br>                found: suffix.to_owned(),<br>            });<br>        }<br>    }<br>    Ok(())<br>}<br><br>pub fn is_valid_sepeartor(file_name: &amp;str) -&gt; Result&lt;(), FlywayNaimngCheckerError&gt; {<br>    let parts: Vec&lt;&amp;str&gt; = file_name.split(&quot;__&quot;).collect();<br><br>    if parts.len() != 2 {<br>        Err(FlywayNaimngCheckerError::FlywayNamingSeparatorError {<br>            file: file_name.to_string(),<br>        })<br>    } else {<br>        Ok(())<br>    }<br>}<br><br>pub fn is_valid_version(file_name: &amp;str) -&gt; Result&lt;(), FlywayNaimngCheckerError&gt; {<br>    match file_name.chars().next() {<br>        Some(first_char) =&gt; match first_char.to_owned() {<br>            &#39;V&#39; | &#39;U&#39; =&gt; {<br>                let second_char = match file_name.chars().nth(1) {<br>                    Some(c) =&gt; c,<br>                    None =&gt; {<br>                        return Err(FlywayNaimngCheckerError::FlywayNamingCanNotFindVersion {<br>                            file: file_name.to_string(),<br>                        })<br>                    }<br>                };<br>                if second_char.is_ascii_digit() {<br>                    Ok(())<br>                } else {<br>                    Err(FlywayNaimngCheckerError::FlywayNamingVersionError {<br>                        file: file_name.to_string(),<br>                        prefix: first_char.to_string(),<br>                        found: second_char.to_string(),<br>                    })<br>                }<br>            }<br>            &#39;R&#39; =&gt; Ok(()),<br>            _ =&gt; Err(FlywayNaimngCheckerError::FlywayNamingPrefixError {<br>                file: file_name.to_string(),<br>                expected: &quot;V&quot;.to_string(),<br>                found: first_char.to_string(),<br>            }),<br>        },<br>        None =&gt; Err(FlywayNaimngCheckerError::FlywayNamingCanNotFindPrefix {<br>            file: file_name.to_string(),<br>        }),<br>    }<br>}<br><br>#[cfg(test)]<br>mod tests {<br>    use super::*;<br>    use crate::error::FlywayNaimngCheckerError;<br><br>    #[test]<br>    fn test_valid_prefix() {<br>        assert_eq!(is_valid_prefix(&quot;V1__some_migration.sql&quot;), Ok(()));<br>        assert_eq!(<br>            is_valid_prefix(&quot;X1__some_migration.sql&quot;),<br>            Err(FlywayNaimngCheckerError::FlywayNamingPrefixError {<br>                file: &quot;X1__some_migration.sql&quot;.to_string(),<br>                expected: &quot;V&quot;.to_string(),<br>                found: &quot;X&quot;.to_string(),<br>            })<br>        );<br>        assert_eq!(<br>            is_valid_prefix(&quot;v1__some_migration.sql&quot;),<br>            Err(FlywayNaimngCheckerError::FlywayNamingPrefixError {<br>                file: &quot;v1__some_migration.sql&quot;.to_string(),<br>                expected: &quot;V&quot;.to_string(),<br>                found: &quot;v&quot;.to_string(),<br>            })<br>        );<br>    }<br><br>    // 중략<br>}</pre><h4>Github MarketPlace 배포하기</h4><p>이제 Flyway 네이밍 유효성 여부를 체크할 수 있게되었습니다. 이제 Actions 탭에서 Workflows 중에서 Release를 선택하고 버전을 지정해서 배포를 진행합니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*d1e5IPsPXO2J7wykUWKKoQ.png" /><figcaption>flyway naming Checker release</figcaption></figure><p>해당 배포 Action이 완료되면 Releases탭에 방금 배포한 버전을 확인할 수 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*oBILs_HByG2PwAR5SoGDMQ.png" /><figcaption>flyway naming Checker release to github action market place</figcaption></figure><p>해당 버전에 들어가서 수정 버튼을 선택합니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*vJ5bbqMvSMTBpkITGUq2sg.png" /><figcaption>flyway naming Checker release to github action market place</figcaption></figure><p>수정 버튼을 선택하면 다음과 같은 화면이 뜨게 되는데 Publish this Action to the GitHub Marketplace를 체크하고 확인하면 Github Market Place에 배포할 수 있습니다. (Github가 action.yml 을 확인하고 다음 창을 띄웁니다.)</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*ZqkkbLv3CUWs-qoGAMTcSw.png" /><figcaption>flyway naming Checker release to github action market place</figcaption></figure><p>이제 Github Action Market Place에서 정상적으로 배포된 것을 확인할 수 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*YO_3E7-Vrc5kGEdV1RwabQ.png" /><figcaption>flyway naming checker in github market place</figcaption></figure><h3>Github Market Place</h3><p><a href="https://github.com/marketplace/actions/flyway-naming-checker">flyway-naming-checker - GitHub Marketplace</a></p><h3>Github Source Code</h3><p><a href="https://github.com/seonghun-dev/flyway-naming-checker">GitHub - seonghun-dev/flyway-naming-checker: Flyway Naming Checker</a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=ad67b9534809" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[DNS 시스템과 nslookup]]></title>
            <link>https://dev-seonghun.medium.com/dns-%EC%8B%9C%EC%8A%A4%ED%85%9C%EA%B3%BC-nslookup-c87078b335f7?source=rss-337b221bda85------2</link>
            <guid isPermaLink="false">https://medium.com/p/c87078b335f7</guid>
            <category><![CDATA[nslookup]]></category>
            <category><![CDATA[dns]]></category>
            <category><![CDATA[domains]]></category>
            <category><![CDATA[nameserver]]></category>
            <category><![CDATA[network]]></category>
            <dc:creator><![CDATA[Seonghun]]></dc:creator>
            <pubDate>Tue, 09 Apr 2024 13:43:10 GMT</pubDate>
            <atom:updated>2024-04-09T13:43:10.670Z</atom:updated>
            <content:encoded><![CDATA[<p>이번 게시글에서는 DNS 시스템과 네트워크 관리 도구중 하나인 nslookup 에 대해서 알아보려고 합니다.</p><p>저는 졸업 작품으로 NFT 게임 서비스를 개발했던 중 AWS Elastic Load Balancer (ELB)를 도입하여 AutoScaling을 구현했었습니다. 하지만, 서비스 서버에서 간헐적으로클라이언트 요청이 실패하는 문제가 발생했습니다. 이를 해결하기 위해 Postman을 사용하여 동일한 주소로 요청을 보냈을 때 대부분의 경우에는 문제가 없었지만, 간헐적으로 ‘Error: getaddrinfo ENOTFOUND api.bluehat.games’와 같은 문제가 발생했었습니다.</p><p>일반적으로 AWS ELB는 내부 요청 처리 실패 시 500 Internal Server Error 또는 502 Error를 반환합니다. ‘getaddrinfo ENOTFOUND’는 주소를 찾지 못하는 경우를 의미하므로 DNS 문제임을 파악했습니다. 하지만 이 문제는 드물게 발생했기 때문에 상황을 재현하고 해결하는 데 시간이 오래 걸렸습니다.</p><p>초기에는 ELB 내부의 DNS 매핑 문제로 생각하여 확인했습니다. 하지만, 자세히 확인해보니 Route 53에서 TTL이 60으로 설정되어 있어 매 60초마다 DNS 주소를 갱신하고 있었기 때문에 발생했던 문제였습니다. 이 글을 통해서 DNS에 관한 내용을 공유드리고자 합니다.</p><h3><strong>DNS란?</strong></h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/963/1*qDK6g4ZluQZ2lLpfxubZtw.png" /><figcaption>dns server and web server</figcaption></figure><p>DNS는 Domain Name System의 약어로, 인터넷 상에서 도메인 이름을 IP 주소로 변환하는 시스템입니다.</p><p>인터넷을 사용하면서 인터넷에 연결되는 모든 기기들은 218.32.210.9와 같은 IP 주소를 가지고 있습니다. 하지만, 숫자 주소는 사람들이 기억하거나 입력하기 어렵기 때문에, www.naver.com이나 www.google.com과 같은 사람이 알아듣기 위한 도메인 이름을 사용합니다.</p><p>이를 IP 주소로 변경하기 위해서 DNS를 사용합니다.</p><h4>DNS의 동작방식</h4><p>DNS 시스템은 계층적인 구조를 가지고 있습니다. 루트 DNS 서버는 모든 도메인에 대한 정보를 갖고 있지 않기 때문에, 다른 DNS 서버의 주소를 알려줍니다. 사용자가 도메인 이름을 입력하면, 로컬 DNS 캐시에서 먼저 찾아보고, 없으면 DNS 서버에 전송합니다. DNS 서버는 요청을 다른 DNS 서버로 전달하여 해당 도메인 이름에 대한 IP 주소를 찾아 반환하는 형태입니다.</p><p>아래는 이를 DNS가 계층적으로 동작하는 방식을 구체화 한 것입니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*sCeQ6v8iTf_ZPlFinbnR8g.png" /><figcaption>how to dns work</figcaption></figure><p>1. 사용자가 웹 브라우저에 www.example.com을 입력합니다</p><p>2. 브라우저에서 우선 캐시된 DNS 정보를 확인하고 캐시된 정보가 있다면 해당 DNS 정보로 처리합니다.</p><blockquote>Chrome 브라우저에서는 <strong>chrome://net-internals/?#dns </strong>를 통해서 캐시를 확인할 수 있습니다.</blockquote><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*SNlLvPr3OXNKEj-ZcBt-pA.png" /><figcaption>chrome dns cache</figcaption></figure><p>3. 다음 클라이언트가 사용하는 운영체제에서 DNS가 캐시되어 있는지 확인하고 캐시된 정보가 있다면 해당 DNS 정보로 처리하고 그렇지 않을 경우 다음으로 처리됩니다.</p><p>4. 클라이언트의 호스트에 설정된 로컬 DNS 서버로 www.example.com의 IP 주소를 물어봅니다. www.example.com의 IP 주소 값이 있다면, 클라이언트로 바로 해당 IP 주소 값을 반환합니다.</p><p>5. IP 주소 값이 없다면 루트 DNS 서버(TLD DNS 서버)에 다시 www.example.com의 IP 주소 확인 요청을 보냅니다. 루트 DNS 서버는 .com을 관리하는 1단계의 DNS 서버 IP 주소로 응답합니다.</p><p>6. .com을 관리하는 1단계의 DNS 서버는 example.com을 관리하는 2단계 DNS 서버 IP 주소를 반환합니다.</p><p>7. www.example.com의 도메인을 관리하는 서버는 example.com 호스팅 영역에서 www.example.com의 레코드를 찾아 웹 서버의 IP 주소를 받아옵니다.</p><p>8. 로컬 DNS가 클라이언트가 필요한 IP 주소를 캐싱하고 클라이언트의 웹 브라우저로 응답합니다.</p><p>9. 웹 브라우저는 IP 주소로 해당 서비스에 접속하여 서비스를 웹 브라우저에 표시합니다.</p><h4>DNS 레코드의 종류</h4><p>A : IPv4 주소와 연결되는 레코드입니다. 예를 들어 naver.com의 DNS 레코드를 끌어오면 A 레코드는 현재 IP 주소 218.32.210.9를 반환합니다. 기본 TTL은 14400초 입니다.</p><p>AAAA : IPv6 주소와 연결되는 레코드입니다. 예를 들어 naver.com의 DNS 레코드를 끌어오면 A 레코드는 현재 IP 주소 2001:0DB8:4567:FFFF:FFFF:FFFF:FFFF:FFFF를 반환합니다. A 레코드와 동일하게 기본 TTL은 14400초 입니다.</p><p>CNAME : 실제 IP 주소를 제공하는 레코드가 아닌, 도메인을 다른 도메인으로 연결하는 별칭같은 역할을 하는 레코드입니다.</p><p>NS : DNS를 저장하는 네임 서버의 레코드, 네임 서버의 권한을 누가 관리하고 있는지 확인할 수 있습니다. NS 레코드는 인터넷에서 해당 도메인의 IP 주소를 찾기 위한 네임 서버에 대해서 알려줍니다.</p><h3><strong>NSLOOKUP</strong></h3><p>nslookup 이란 DNS record를 조회할 수 있는 네트워크 관리 도구 중 하나입니다. 윈도우나 맥에 기본적으로 깔려있어, CMD나 터미널에서 바로 실행할 수 있습니다.</p><h4>IP 조회</h4><p>nslookup 이후 조회하고자 하는 도메인을 넣으면 ip 주소 값을 알아낼 수 있습니다.</p><pre>nslookup naver.com 8.8.8.8</pre><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*l-1aWw6tfDj3sMLVvX4ygg.png" /></figure><h4>특정 레코드 조회</h4><p>특정 레코드를 조회하려면 -type 또는 -q를 이용해서 특정 레코드를 조회할 수 있습니다. 다음은 example.com의 네임서버를 조회하는 쿼리입니다.</p><pre>nslookup -q=ns example.com</pre><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*V1NjXBRmoN_44hQJvqVlGw.png" /></figure><h4>네임 서버를 지정하여 조회하기</h4><p>네임 서버를 변경하여 조회하려면 nslookup 명령어 입력후 sever이후 DNS 서버의 Ip를 입력해주면 됩니다.(8.8.8.8은 구글 DNS 서버 주소입니다.)</p><pre>nslookup</pre><pre>server 8.8.8.8</pre><p>아래와 같이 한번에 입력해주어도 가능합니다.</p><pre>nslookup naver.com 8.8.8.8</pre><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*ll63IyoT8NQaOn71wGUigw.png" /></figure><h4>디버그 모드</h4><p>Nslookup 명령어 작성후, set Debug를 설정하게 되면 Nslookup이 디버깅 모드에 들어가게 되고, 실제로 DNS Query와 각 <strong>네임서버가 반환한 IP 주소와 해당 TTL 을 모두 가져오게 됩니다.</strong></p><p>이 옵션을 사용하면 진단 정보, 각 단계에서의 타임아웃 정보, 라운드 로빈 방식으로 여러 개의 IP 주소를 반환하는 경우 해당 IP 주소의 우선순위 등을 볼 수 있습니다.</p><pre>nslookup</pre><pre>set debug</pre><p>다음과 같이 한번에 입력해주는 것도 가능합니다.</p><pre>nslookup -debug example.com</pre><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*hHISV1tG-N9MxzPqN0Tmog.png" /></figure><h4>whatsmydns.net</h4><p>DNS 레코드 정보를 전 세계 여러 지역에 있는 여러 서버에서 확인할 수 있는 사이트 입니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*048aHc0q5AkAGRgE_U6ECg.png" /></figure><p><a href="https://www.whatsmydns.net/">DNS Propagation Checker - Global DNS Checker Tool</a></p><h4>Google Apps Toolbox Dig</h4><p>Google 관리 콘솔 도구상자에서 제공하는 DNS 조회 서비스입니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*vvgyrNvVuziwNk1erOIxkg.png" /></figure><h4>DnsViz</h4><p>DnsViz는 미국 산디아(Sandia) 국립연구소에서 제공하는 <a href="https://krnic.kisa.or.kr/jsp/resources/dns/dnssecInfo/dnssecTool.jsp">DNSSEC</a> 검증 도구입니다.</p><p>DNSSEC 검증도구이지만, 시각화 되어 나타나며 이외의 응답값, 응답시간을 알 수 있기 때문에 DNS 분석 하는데 유용하게 사용할 수 있습니다.</p><p><a href="http://dnsviz.net/">DNSViz | A DNS visualization tool</a></p><p>DNSViz는 루트 존으로부터 최상위 도메인 존, 그리고 최종 점검 대상 도메인 존까지의 서명 연결 구조도를 이미지로 나타냅니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*BrgXOpSAtjP1LUXQauE_kw.png" /></figure><p>Response 탭에서는 응답값 크기나 응답시간을 알 수 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*DQiImBPCWKiIW-khE5refQ.png" /></figure><h4>참고 자료</h4><ul><li><a href="https://www.oreilly.com/library/view/dns-and-bind/0596100574/">DNS and BIND, 5th Edition</a></li><li><a href="https://krnic.kisa.or.kr/jsp/resources/dns/dnssecInfo/dnssecTool.jsp">한국인터넷정보센터(KRNIC)</a></li><li><a href="https://www.stevenjlee.net/2021/01/09/%EB%94%B0%EB%9D%BC%ED%95%98%EA%B8%B0-dnsviz-net-%EC%97%90%EC%84%9C-dns-%EC%A1%B0%ED%9A%8C%ED%95%98%EA%B8%B0/">[따라하기] dnsviz.net 에서 DNS 조회하기 | STEVEN J. LEE</a></li><li><a href="https://www.stevenjlee.net/2020/07/08/%ec%9d%b4%ed%95%b4%ed%95%98%ea%b8%b0-dns-domain-name-server/">[이해하기] DNS (Domain Name Server) | STEVEN J. LEE</a></li></ul><p><a href="https://www.cloudflare.com/ko-kr/learning/dns/what-is-dns/">https://www.cloudflare.com/ko-kr/learning/dns/what-is-dns/</a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=c87078b335f7" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[Spring] 스프링 부트에서 에러 시나리오 테스트하기]]></title>
            <link>https://dev-seonghun.medium.com/%EC%8A%A4%ED%94%84%EB%A7%81-%EB%B6%80%ED%8A%B8%EC%97%90%EC%84%9C-%EC%97%90%EB%9F%AC-%EC%8B%9C%EB%82%98%EB%A6%AC%EC%98%A4-%ED%85%8C%EC%8A%A4%ED%8A%B8%ED%95%98%EA%B8%B0-dcd9a9c6b3f0?source=rss-337b221bda85------2</link>
            <guid isPermaLink="false">https://medium.com/p/dcd9a9c6b3f0</guid>
            <category><![CDATA[test]]></category>
            <category><![CDATA[swagger]]></category>
            <category><![CDATA[spring]]></category>
            <category><![CDATA[error]]></category>
            <dc:creator><![CDATA[Seonghun]]></dc:creator>
            <pubDate>Tue, 19 Mar 2024 11:27:22 GMT</pubDate>
            <atom:updated>2024-03-20T09:42:43.079Z</atom:updated>
            <content:encoded><![CDATA[<p>이번 포스팅에서는 스트릿 드랍에서 테스트를 진행하면서, 스트릿 드랍에서 에러 시나리오 테스트를 간편하게 진행했던 방법 공유드리려고 합니다.</p><h3>에러 시나리오 테스트<a href="https://docs.street-drop.com/blog/spring%20error%20scenario%20test#%EC%97%90%EB%9F%AC-%EC%8B%9C%EB%82%98%EB%A6%AC%EC%98%A4-%ED%85%8C%EC%8A%A4%ED%8A%B8">​</a></h3><p>스트릿 드랍에서는 유닛 테스트 코드를 통해서, 특정 엔드포엔트에 대한 응답값을 검증하고 있습니다. 그러나, 유닛 테스트만으로는 실제 사용 환경에서 발생할 수 있는 모든 상황을 충분히 검증하기 어렵습니다. 따라서 사용자의 관점에서 애플리케이션의 전체적인 작동을 확인하는 것을 목적으로 하는 E2E 테스트가 필요합니다. 이를 통해 여러 API 통신간에서 또는 실제 유저가 어플을 사용하면서 발생할 수 있는 에러를 포착할 수 있습니다.</p><p>만약 5분전에 생성된 게시글이 현재는 삭제되어, 해당 게시글을 다시 조회할 경우 404 에러 페이지가 보이는 경우를 테스트 하기 위해서는 iOS에서는 아래와 같은 시나리오를 따라서 처리해야 합니다.</p><ol><li>새로운 게시글을 생성</li><li>새롭게 작성된 특정 게시글을 삭제</li><li>어플 기획상 id로 특정 게시글 조회가 어렵기 때문에, 게시글 리스트에서는 보이지만, 삭제된 게시글을 조회 함.</li><li>404 에러 페이지가 명확히 나오는 지를 테스트</li></ol><p>서비스의 기획에 따라서 특정 에러 시나리오가 매우 간헐적으로 발생해서 이런 에러가 발생했을 때 실제로 E2E 관점에서의 에러는 매우 테스트하기 어려울 수 있습니다. (특히, 스트릿 드랍은 지역 기반으로 작동하며, 새로운 게시글이 생성되기 위해서는 지역정보와 음악정보들이 필요했기 때문에 특정 시나리오 테스트를 위한 더미 데이터를 만들고 구성하는데에 있어서도 큰 어려움이 있었습니다.)</p><h3>커스텀 헤더 추가하기<a href="https://docs.street-drop.com/blog/spring%20error%20scenario%20test#%EC%BB%A4%EC%8A%A4%ED%85%80-%ED%97%A4%EB%8D%94-%EC%B6%94%EA%B0%80%ED%95%98%EA%B8%B0">​</a></h3><p>HTTP 헤더는 클라이언트와 서버가 요청 또는 응답으로 부가적인 정보를 전송할 수 있도록 해줍니다. 키와 값으로 구성되며 User-Agent, 언어정보, 미디어 타입에 대한 여러 정보를 주고 받을 수 있습니다. 개발자는 커스텀 헤더를 추가해서 부가적인 정보를 처리하는 것이 가능합니다.</p><p>2012년 이전에는 ‘X-’ 라는 접두사를 붙이는 것이 권장되었으나 최신에서는 HTTP 스펙에서는 더 이상 해당 접두사를 사용하지 않고 있습니다. 개발자가 커스텀 헤더를 추가할때, 헤더의 목적을 쉽게 이용할 수 있도록 대시(-)를 기준으로 의미가 명확한 용어를 사용하며, 각 단어의 첫 글자를 대문자로 작성하는 것이 관례입니다. 하지만, Spring에서 Request 헤더 정보를 확인할 때, 대/소문자를 구분하지 않습니다.</p><p>스트릿 드랍에서는 “STREET-DROP-ERROR-TEST-CODE”라는 커스텀 헤더를 추가해서 에러 시나리오를 테스트하는데 활용하고 있습니다.</p><p>특정 ITEM이 삭제되어 더 이상 찾을 수 없을때, ITEM_NOT_FOUND 라는 에러코드가 발생한다고 하면, 해당 에러코드를 넣어서 API 에러를 테스트 할 수 있습니다.</p><pre>STREET-DROP-ERROR-TEST-CODE : ITEM_NOT_FOUND</pre><p>위의 시나리오와 같이 특정 1번 아이템이 삭제된 경우를 가졍하세 이를 테스트하려면, 다음과 같이 iOS에서 에러를 추가해서 요청하면 해당 요청에 따라 적합한 에러를 제공합니다. (테스트 서버에서만 활성화되어 실서버에서는 작동하지 않습니다.)</p><pre>curl -X &#39;GET&#39; \<br>  &#39;https://api.street-drop.com/items/1&#39; \<br>  -H &#39;STREET-DROP-ERROR-TEST-CODE: ITEM_NOT_FOUND&#39;</pre><p>제공된 에러 응답</p><pre>{<br>  &quot;timestamp&quot;: &quot;2024-03-16T14:42:49.978736&quot;,<br>  &quot;traceId&quot;: &quot;0af1f586-2ecd-42a8-baa6-93cd91e747f7&quot;,<br>  &quot;status&quot;: 404,<br>  &quot;errorResponseCode&quot;: &quot;ITEM_NOT_FOUND&quot;,<br>  &quot;title&quot;: &quot;Item Not Found&quot;,<br>  &quot;message&quot;: &quot;Item was deleted or can not accessible&quot;<br>}</pre><p>이를 통해서 iOS에서는 특정 에러에 대한 시나리오나 에러 화면을 바로바로 테스트 할 수 있습니다.</p><h3>스프링에서 커스텀 헤더를 통한 에러 테스트 구현<a href="https://docs.street-drop.com/blog/spring%20error%20scenario%20test#%EC%8A%A4%ED%94%84%EB%A7%81%EC%97%90%EC%84%9C-%EC%BB%A4%EC%8A%A4%ED%85%80-%ED%97%A4%EB%8D%94%EB%A5%BC-%ED%86%B5%ED%95%9C-%EC%97%90%EB%9F%AC-%ED%85%8C%EC%8A%A4%ED%8A%B8-%EA%B5%AC%ED%98%84">​</a></h3><p>구현 로직은 대략 다음과 같습니다.</p><ol><li>HTTP 요청 헤더에서 STREET-DROP-ERROR-TEST-CODE의 값을 가져옵니다.</li><li>이 헤더의 값이 에러 코드에 정의되어 있는지 확인하고 정의되어 있으면 에러를 발생시키고, 없는 경우 기존 요청을 처리합니다.</li></ol><h3>OncePerRequestFilter 사용하기<a href="https://docs.street-drop.com/blog/spring%20error%20scenario%20test#onceperrequestfilter-%EC%82%AC%EC%9A%A9%ED%95%98%EA%B8%B0">​</a></h3><p>이를 구현하기 위해서 필터와 인터셉트를 고민해볼 수 있는데, 필터의 경우 Request와 Response를 조작할 수 있지만, 인터셉트는 이를 조작할 수 없기 때문에 필터를 사용하는 거이 적합합니다.</p><p><a href="https://mangkyu.tistory.com/173">[Spring] 필터(Filter) vs 인터셉터(Interceptor) 차이 및 용도 - (1)</a></p><p>필터중에서는 Http Request 한번의 요청에 대해서 한 번만 실행하는 필터인 OncePerRequestFilter를 사용했습니다. OncePerRequestFilter 상속하여 구현하면서, doFilter 대신 doFilterInternal 메서드를 구현하면 됩니다.</p><pre>@Component<br>public class OncePerRequestFilterTestFilter extends OncePerRequestFilter {    <br>    @Override<br>    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {<br>        // 필터에서 전처리<br>        filterChain.doFilter(request, response);<br>        // 필터에서 후처리<br>    }<br>}</pre><h3>커스텀 헤더를 통한 에러 던지기<a href="https://docs.street-drop.com/blog/spring%20error%20scenario%20test#%EC%BB%A4%EC%8A%A4%ED%85%80-%ED%97%A4%EB%8D%94%EB%A5%BC-%ED%86%B5%ED%95%9C-%EC%97%90%EB%9F%AC-%EB%8D%98%EC%A7%80%EA%B8%B0">​</a></h3><p>먼저 기존에 에러코드들이 다음과 같이 정의되어 있다고 가정해보겠습니다. 아래는 발생할 수 있는 모든 에러들을 묶어둔 ErrorCode enum 입니다.</p><pre>public enum ErrorCode {<br>    BAD_REQUEST(HttpStatus.BAD_REQUEST, &quot;COMMON_BAD_REQUEST&quot;, &quot;Bad Request&quot;, &quot;The request could not be understood.&quot;),<br>    ITEM_NOT_FOUND(HttpStatus.NOT_FOUND, &quot;ITEM_NOT_FOUND&quot;, &quot;Item Not Found&quot;, &quot;Item was deleted or can not accessible&quot;);<br>    <br>    private HttpStatus status;<br>    private String errorResponseCode;<br>    private String title;<br>    private String message;<br>}</pre><p>아래는 해당 에러코드에서 맞는 enum이 있는지 체크하는 코드입니다.</p><pre>public class ErrorCodeMapper {<br>    public static Optional&lt;ErrorCode&gt; findByErrorCode(String code) {<br>        for (ErrorCode errorCode : ErrorCode.values()) {<br>            if (errorCode.getCode().equals(code)) {<br>                return Optional.of(errorCode);<br>            }<br>        }<br>        return Optional.empty();<br>    }<br>}</pre><p>우선 실서버에서 헤더를 통해서 에러를 던지게 되면, 악용되는 사례가 있을 수 있기 때문에 프로파일을 통해서 테스트 서버와, 로컬 환경에서만 테스트 하도록 프로필을 지정해줍니다.</p><pre>@Profile({&quot;dev&quot;, &quot;local&quot;})</pre><p>스프링에서 들어온 헤더를 읽으려면 HttpServletRequest request에서 getHeader 메서드를 사용해서 요청으로 들어온 헤더를 읽을 수 있습니다.</p><pre>public interface HttpServletRequest extends ServletRequest {<br>    String getHeader(String var1);<br>}</pre><p>우선 스프링에서 들어온 헤더값을 읽고, 이 헤더와 일치하는 enum 값이 있을 경우 에러를 던지고, 아닌 경우 필터를 그냥 지나치도록 개발하면 됩니다.</p><pre><br>@Profile({&quot;dev&quot;, &quot;local&quot;})<br>@Component<br>@Slf4j<br>public class ErrorTestHeaderFilter extends OncePerRequestFilter {<br><br>    public static final String ERROR_TEST_HEADER = &quot;STREET-DROP-ERROR-TEST-CODE&quot;;<br>    private final ObjectMapper objectMapper = new ObjectMapper().registerModule(new JavaTimeModule()).disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);<br><br>    @Override<br>    protected void doFilterInternal(HttpServletRequest request, @NotNull HttpServletResponse response, @NotNull FilterChain filterChain) throws ServletException, IOException {<br>        String errorTestHeader = request.getHeader(ERROR_TEST_HEADER);  // 헤더에서 STREET-DROP-ERROR-TEST-CODE에 대한 Value를 가져옴<br><br>        if (errorTestHeader != null) {<br>            Optional&lt;ErrorCode&gt; errorCode = ErrorCodeMapper.findByErrorCode(errorTestHeader); // enum에서 해당 에러코드에 일치하는 값이 있는지 찾음<br><br>            if (errorCode.isPresent()) { // 일치하는 에러코드의 값이 있을 경우<br>                throwErrorResponse(response, errorCode.get()); // 에러를 발생<br>                return;<br>            }<br>        }<br>        filterChain.doFilter(request, response);<br>    }<br><br>    private void throwErrorResponse(HttpServletResponse response, ErrorCode errorCode) throws IOException { // 에러를 발생시킬 경우<br>        response.setContentType(APPLICATION_JSON_VALUE);<br>        response.setStatus(errorCode.getStatus().value());<br><br>        ErrorResponseDto errorResponseDto = new ErrorResponseDto(errorCode); // 서버에서 정의된 에러를 발생시킬 경우의 스키마<br>        String errorResponseJson = objectMapper.writeValueAsString(errorResponseDto);<br><br>        response.getWriter().write(errorResponseJson);<br>    }<br><br>}</pre><ol><li>request.getHeader(ERROR_TEST_HEADER); 을 통해서 헤더에서 STREET-DROP-ERROR-TEST-CODE에 대한 Value를 가져옵니다.</li><li>ErrorCodeMapper.findByErrorCode(errorTestHeader); 를 통해서 맞는 에러 enum이 있는지 확인합니다.</li><li>일치하는 에러코드가 있을 경우 throwErrorResponse 내장 메서드를 통해서 에러를 발생시킵니다.</li><li>throwErrorResponse 메서드에서는 HttpServletResponse에 ContentType과 상태코드, 에러코드를 에러응답 dto로 변환하고 Json으로 작성하여 response body에 추가합니다.</li></ol><h3>실제 스트릿 드랍 에러 테스트용 필터<a href="https://docs.street-drop.com/blog/spring%20error%20scenario%20test#%EC%8B%A4%EC%A0%9C-%EC%8A%A4%ED%8A%B8%EB%A6%BF-%EB%93%9C%EB%9E%8D-%EC%97%90%EB%9F%AC-%ED%85%8C%EC%8A%A4%ED%8A%B8%EC%9A%A9-%ED%95%84%ED%84%B0">​</a></h3><p>아래는 스트릿 드랍에서 실제로 사용하는 에러 테스트용 필터입니다. 도메인 별로 에러코드를 묶어주었기 때문에, 제너릭을 일부 사용하였습니다.</p><pre><br>@Profile({&quot;dev&quot;, &quot;local&quot;})<br>@Component<br>@Slf4j<br>public class ErrorTestHeaderFilter extends OncePerRequestFilter {<br><br>    public static final String ERROR_TEST_HEADER = &quot;STREET-DROP-ERROR-TEST-CODE&quot;;<br>    private final ObjectMapper objectMapper = new ObjectMapper().registerModule(new JavaTimeModule()).disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);<br><br>    @Override<br>    protected void doFilterInternal(HttpServletRequest request, @NotNull HttpServletResponse response, @NotNull FilterChain filterChain) throws ServletException, IOException {<br>        String errorTestHeader = request.getHeader(ERROR_TEST_HEADER);<br><br>        if (errorTestHeader != null) {<br>            Optional&lt;ErrorCode&gt; errorCode = ErrorCodeMapper.findByErrorCode(errorTestHeader);<br><br>            if (errorCode.isPresent()) {<br>                throwErrorResponse(response, errorCode.get());<br>                return;<br>            }<br>        }<br>        filterChain.doFilter(request, response);<br>    }<br><br>    private &lt;T extends ErrorCodeInterface&gt; void throwErrorResponse(HttpServletResponse response, T errorCode) throws IOException {<br>        response.setContentType(APPLICATION_JSON_VALUE);<br>        response.setStatus(errorCode.getStatus().value());<br><br>        HttpErrorResponseDto httpErrorResponseDto = HttpErrorResponseDto.from(errorCode);<br>        String errorResponseJson = objectMapper.writeValueAsString(httpErrorResponseDto);<br><br>        response.getWriter().write(errorResponseJson);<br>    }<br><br>}</pre><h3>스웨거에서 에러코드 제공하기<a href="https://docs.street-drop.com/blog/spring%20error%20scenario%20test#%EC%8A%A4%EC%9B%A8%EA%B1%B0%EC%97%90%EC%84%9C-%EC%97%90%EB%9F%AC%EC%BD%94%EB%93%9C-%EC%A0%9C%EA%B3%B5%ED%95%98%EA%B8%B0">​</a></h3><p>스트릿 드랍은 Swagger를 통해서 API를 문서화 하고 있습니다. 위에서 에러 테스트 코드가 가능한 에러 코드를 제공할 때, 이를 스웨거에서 같이 제공하고자 했었습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*WQJaSUuFH9PBJbjL.png" /></figure><h3>SpringDoc — OperationCustomizer<a href="https://docs.street-drop.com/blog/spring%20error%20scenario%20test#springdoc---operationcustomizer">​</a></h3><p>SpringDoc 라이브러리를 활용하여 스웨거를 적용하고 있습니다. SpringDoc 에서는 OperationCustomizer 커스텀하여, 스웨거의 파라미터, 응답값을 수정할 수 있습니다. CustomOperationCustomizer를 만들어 Swagger Config에 다음과 같이 추가할 수 있습니다</p><pre>@Component<br>@Slf4j<br>@AllArgsConstructor<br>public class CustomOperationCustomizer implements OperationCustomizer {<br>    @Override<br>    public Operation customize(Operation operation, HandlerMethod handlerMethod) {<br>    }<br>}</pre><pre><br>@Configuration<br>@RequiredArgsConstructor<br>public class SwaggerConfig {<br><br>    private final OperationCustomizer operationCustomizer;<br><br>    @Bean<br>    public GroupedOpenApi publicApi() {<br>        return GroupedOpenApi.builder()<br>                .group(&quot;v1&quot;)<br>                .pathsToMatch(&quot;/**&quot;)<br>                .addOperationCustomizer(operationCustomizer)<br>                .build();<br>    }<br>}</pre><h3>커스텀 어노테이션 만들기 — ApiErrorResponse와 ApiErrorResponses<a href="https://docs.street-drop.com/blog/spring%20error%20scenario%20test#%EC%BB%A4%EC%8A%A4%ED%85%80-%EC%96%B4%EB%85%B8%ED%85%8C%EC%9D%B4%EC%85%98-%EB%A7%8C%EB%93%A4%EA%B8%B0----apierrorresponse%EC%99%80-apierrorresponses">​</a></h3><p>SpringDoc에서는 다음과 같이 ApiResponse 어노테이션을 통해서 응답코드와 설명을 작성할 수 있습니다.</p><pre>    @Operation(summary = &quot;Reverse Geocoding&quot;)<br>    @ApiResponse(responseCode = &quot;200&quot;, description = &quot;좌표 주소 변환 성공&quot;)<br>    public ResponseEntity&lt;ReverseGeocodeResponseDto&gt; reverseGeocode() {<br>        <br>    }</pre><p>Api 오류 코드의 경우 이를 응용하여 ApiErrorResponse와 ApiErrorResponses 어노테이션을 만들어 처리하고자 하였습니다. ApiErrorResponses의 경우 SpringDoc에서 ApiResponses로 어노테이션이 복수인 경우 감싸서 처리하고 있었기 때문에 유사하게 처리하고자 했습니다.</p><pre><br>@Target({ElementType.METHOD, ElementType.TYPE, ElementType.ANNOTATION_TYPE})<br>@Retention(RetentionPolicy.RUNTIME)<br>@Inherited<br>@Repeatable(ApiErrorResponses.class)<br>public @interface ApiErrorResponse {<br><br>    String description() default &quot;&quot;;<br><br>    String errorCode() default &quot;COMMON_INTERNAL_SERVER_ERROR&quot;;<br><br>}</pre><pre><br>@Target({ElementType.METHOD, ElementType.TYPE, ElementType.ANNOTATION_TYPE})<br>@Retention(RetentionPolicy.RUNTIME)<br>@Inherited<br>public @interface ApiErrorResponses {<br><br>    ApiErrorResponse[] value() default {};<br><br>    Extension[] extensions() default {};<br><br>}</pre><p>ApiErrorResponses는 아래와 같이 사용할 수 있습니다.</p><pre>@Operation(summary = &quot;아이템 신고하기&quot;)<br>    @ApiErrorResponses(value = {<br>            @ApiErrorResponse(errorCode = &quot;ITEM_NOT_FOUND&quot;, description = &quot;아이템을 찾을 수 없습니다.&quot;),<br>            @ApiErrorResponse(errorCode = &quot;ITEM_ALREADY_ITEM_REPORTED_ERROR&quot;, description = &quot;이미 신고한 아이템입니다.&quot;)<br>    })<br>    public ResponseEntity&lt;Void&gt; claimItem() {<br>    }</pre><h3>어노테이션값 가져와서 Swagger 수정하기<a href="https://docs.street-drop.com/blog/spring%20error%20scenario%20test#%EC%96%B4%EB%85%B8%ED%85%8C%EC%9D%B4%EC%85%98%EA%B0%92-%EA%B0%80%EC%A0%B8%EC%99%80%EC%84%9C-swagger-%EC%88%98%EC%A0%95%ED%95%98%EA%B8%B0">​</a></h3><p>CustomOperationCustomizer의 customize에서 우선 해당 어노테이션 정보를 가져옵니다.</p><pre>    @Override<br>    public Operation customize(Operation operation, HandlerMethod handlerMethod) {<br>        ApiErrorResponse apiErrorResponseAnnotation = handlerMethod.getMethodAnnotation(ApiErrorResponse.class);<br>    <br>        if (apiErrorResponseAnnotation != null) {<br>            handleApiErrorResponse(operation, apiErrorResponseAnnotation);<br>        }<br>    <br>        return operation;<br>    }</pre><p>handleApiErrorResponses는 handleApiErrorResponse와 큰 차이가 없기 때문에 handleApiErrorResponse를 우선으로 보면, ErrorCodeMapper에서 맞는 에러 코드를 찾고 해당 하는 에러코드가 있으면 errorResponseExampleCustomizer와 errorRequestHeaderCustomizer를 통해 각각 에러 응답예제와 응답헤더 예제를 생성합니다.</p><pre>    private void handleApiErrorResponse(Operation operation, ApiErrorResponse apiErrorResponseAnnotation) {<br>        ErrorCodeMapper.findByErrorCode(apiErrorResponseAnnotation.errorCode())<br>                .ifPresent(errorCode -&gt; {<br>                    var errorCodeExampleList = List.of(Map.of(errorCode, apiErrorResponseAnnotation.description()));<br>                    errorResponseExampleCustomizer.generateErrorResponseExample(operation, errorCodeExampleList);<br>                    errorRequestHeaderCustomizer.generateErrorRequestHeader(operation, errorCode);<br>                });<br>    }</pre><p>ErrorRequestHeaderCustomizer는 아래 사진에서 보이는 파란 색 부분으르 만드는 객체입니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*C4IyU76XJUYvscaP.png" /></figure><p>ErrorRequestHeaderCustomizer 에서는 Operation안의 Parameter 리스트의 값에 헤더를 추가합니다.</p><pre>@Component<br>public class ErrorRequestHeaderCustomizer {<br><br>    public void generateErrorRequestHeader(Operation operation, List&lt;ErrorCode&gt; errorCodeList) {<br>        var defaultParameters = getDefaultParameter(operation);<br>        var newErrorCodeParameters = generateErrorRequestHeader(errorCodeList);<br>        defaultParameters.add(newErrorCodeParameters);<br>        if (defaultParameters.size() == 1) {<br>            operation.setParameters(defaultParameters);<br>        }<br>    }<br><br>    public void generateErrorRequestHeader(Operation operation, ErrorCode errorCode) {<br>        var defaultParameters = getDefaultParameter(operation);<br>        var newErrorCodeParameters = generateErrorRequestHeader(singletonList(errorCode));<br>        defaultParameters.add(newErrorCodeParameters);<br>        if (defaultParameters.size() == 1) {<br>            operation.setParameters(defaultParameters);<br>        }<br>    }<br><br>    private List&lt;Parameter&gt; getDefaultParameter(Operation operation) {<br>        List&lt;Parameter&gt; parameters = operation.getParameters();<br>        if (parameters == null) {<br>            parameters = new ArrayList&lt;&gt;();<br>        }<br>        return parameters;<br>    }<br><br>    private Parameter generateErrorRequestHeader(List&lt;ErrorCode&gt; errorCode) {  // 에러 헤더 만들기<br>        var parameter = new Parameter();<br>        parameter.setName(&quot;STREET-DROP-ERROR-TEST-CODE&quot;);<br>        parameter.setIn(&quot;header&quot;);<br>        parameter.setDescription(&quot;에러를 확인하기 위한 코드입니다. 테스트 서버 환경에서 해당 에러코드를 STREET-DROP-ERROR-TEST-CODE 헤더에 추가하여 테스트할 수 있습니다.&quot;);<br>        parameter.setRequired(false);<br>        parameter.setDeprecated(false);<br>        parameter.setSchema(generateErrorRequestHeaderSchema(errorCode));<br>        return parameter;<br>    }<br><br>    private Schema&lt;?&gt; generateErrorRequestHeaderSchema(List&lt;ErrorCode&gt; errorCode) { // 에러 리스트를 Enum 형태로 선택할 수 있도록 하기<br>        var schema = new Schema&lt;&gt;();<br>        schema.setEnum(Arrays.asList(errorCode.stream().map(ErrorCode::getErrorResponseCode).toArray()));<br>        schema.setType(&quot;string&quot;);<br>        return schema;<br>    }<br>}</pre><p>ErrorResponseExampleCustomizer 는 아래 사진에서 보이는 파란 색 부분인 응답 예제를 만드는 부분입니다. SpringDoc에서는 Example을 통해서 응답예제를 만들어내는데, 이를 수정하여 예외 스키마를 만들어 낼 수 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*VcbA6WvHEqI2atyp.png" /></figure><p>ErrorResponseExampleCustomizer 에서는 Example을 변경하여 에러 예외 스키마 예시를 만들어냅니다.</p><pre>@Component<br>public class ErrorResponseExampleCustomizer {<br><br>    public void generateErrorResponseExample(Operation operation, List&lt;Map&lt;ErrorCode, String&gt;&gt; errorCodeExampleList) {<br>        ApiResponses responses = operation.getResponses();<br><br>        Map&lt;Integer, List&lt;Map&lt;ErrorCode, String&gt;&gt;&gt; errorCodeExampleByStatus = errorCodeExampleList.stream()<br>                .collect(groupingBy(errorCodeStringMap -&gt; errorCodeStringMap.keySet().iterator().next().getStatus().value()));<br><br>        errorCodeExampleByStatus<br>                .forEach(<br>                        (statusCode, value) -&gt; {<br>                            MediaType mediaType = new MediaType();<br>                            value.forEach(map -&gt;<br>                                    map.forEach(<br>                                            (errorResponse, description) -&gt; {<br>                                                Example example = generateExample(errorResponse, description);<br>                                                mediaType.addExamples(errorResponse.getErrorResponseCode(), example);<br>                                            }<br>                                    ));<br>                            Content content = generateContent(mediaType);<br>                            ApiResponse apiResponse = generateApiResponse(content);<br>                            responses.addApiResponse(statusCode.toString(), apiResponse);<br>                        });<br>    }<br><br>    private ApiResponse generateApiResponse(Content content) {<br>        ApiResponse apiResponse = new ApiResponse();<br>        apiResponse.setContent(content);<br>        return apiResponse;<br>    }<br><br>    private Content generateContent(MediaType mediaType) {<br>        Content content = new Content();<br>        content.addMediaType(&quot;application/json&quot;, mediaType);<br>        return content;<br>    }<br><br>    private Example generateExample(ErrorCode errorCode, String description) {<br>        Example example = new Example();<br>        HttpErrorResponseDto httpErrorResponseDto = HttpErrorResponseDto.from(errorCode);<br>        example.setValue(httpErrorResponseDto);<br>        example.setDescription(description);<br>        return example;<br>    }<br>}</pre><p>아래는 ApiResponses도 함께 처리하는 CustomOperationCustomizer 전체 코드입니다.</p><pre><br>@Component<br>@Slf4j<br>@AllArgsConstructor<br>public class CustomOperationCustomizer implements OperationCustomizer {<br><br>    private final ErrorRequestHeaderCustomizer errorRequestHeaderCustomizer;<br>    private final ErrorResponseExampleCustomizer errorResponseExampleCustomizer;<br><br>    @Override<br>    public Operation customize(Operation operation, HandlerMethod handlerMethod) {<br>        ApiErrorResponse apiErrorResponseAnnotation = handlerMethod.getMethodAnnotation(ApiErrorResponse.class);<br>        ApiErrorResponses apiErrorResponsesAnnotation = handlerMethod.getMethodAnnotation(ApiErrorResponses.class);<br><br>        if (apiErrorResponseAnnotation != null) {<br>            handleApiErrorResponse(operation, apiErrorResponseAnnotation);<br>        }<br><br>        if (apiErrorResponsesAnnotation != null) {<br>            handleApiErrorResponses(operation, apiErrorResponsesAnnotation);<br>        }<br><br>        return operation;<br>    }<br><br>    private void handleApiErrorResponse(Operation operation, ApiErrorResponse apiErrorResponseAnnotation) {<br>        ErrorCodeMapper.findByErrorCode(apiErrorResponseAnnotation.errorCode())<br>                .ifPresent(errorCode -&gt; {<br>                    var errorCodeExampleList = List.of(Map.of(errorCode, apiErrorResponseAnnotation.description()));<br>                    errorResponseExampleCustomizer.generateErrorResponseExample(operation, errorCodeExampleList);<br>                    errorRequestHeaderCustomizer.generateErrorRequestHeader(operation, errorCode);<br>                });<br>    }<br><br>    private void handleApiErrorResponses(Operation operation, ApiErrorResponses apiErrorResponsesAnnotation) {<br>        List&lt;Map&lt;ErrorCode, String&gt;&gt; errorCodeExampleList = Arrays.stream(apiErrorResponsesAnnotation.value())<br>                .map(apiErrorResponse -&gt; ErrorCodeMapper.findByErrorCode(apiErrorResponse.errorCode())<br>                        .map(code -&gt; Map.of(code, apiErrorResponse.description()))<br>                        .orElse(emptyMap()))<br>                .filter(map -&gt; !map.isEmpty())<br>                .toList();<br><br>        List&lt;ErrorCode&gt; resultList = errorCodeExampleList.stream().flatMap(map -&gt; map.keySet().stream()).toList();<br><br>        errorRequestHeaderCustomizer.generateErrorRequestHeader(operation, resultList);<br>        errorResponseExampleCustomizer.generateErrorResponseExample(operation, errorCodeExampleList);<br>    }<br><br>}</pre><h3>결론<a href="https://docs.street-drop.com/blog/spring%20error%20scenario%20test#%EA%B2%B0%EB%A1%A0">​</a></h3><p>커스텀 헤더와 스웨거를 통한 에러 코드 문서화 작업을 통해서, 다양한 상황에서의 에러 시나리오를 iOS 측에서도 에러 화면에 대해서 빠르게 처리할 수 있었고, 이를 기존에 사용하던 Swagger를 통해서 문서화 하면서 에러 응답을 간단하게 Swagger에서 확인할 수 있었습니다.</p><h3>참고</h3><ul><li><a href="https://velog.io/@tosspayments/HTTP-%ED%97%A4%EB%8D%94%EB%A1%9C-%EC%97%90%EB%9F%AC-%ED%85%8C%EC%8A%A4%ED%8A%B8%ED%95%98%EA%B8%B0-zuya4t6v">HTTP 헤더로 에러 테스트하기</a></li><li><a href="https://devnm.tistory.com/29">[스프링] spring swagger 같은 코드 여러 에러 응답 예시 만들기</a></li><li><a href="https://mangkyu.tistory.com/173">[Spring] 필터(Filter) vs 인터셉터(Interceptor) 차이 및 용도 - (1)</a></li></ul><h3>관련 프로젝트</h3><p><a href="https://github.com/depromeet/street-drop-server">GitHub - depromeet/street-drop-server: StreetDrop 🎶 Location based music sharing social service</a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=dcd9a9c6b3f0" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[Java, Spring] 특정 인터페이스를 구현한 클래스 찾기]]></title>
            <link>https://dev-seonghun.medium.com/java-spring-%ED%8A%B9%EC%A0%95-%EC%9D%B8%ED%84%B0%ED%8E%98%EC%9D%B4%EC%8A%A4%EB%A5%BC-%EA%B5%AC%ED%98%84%ED%95%9C-%ED%81%B4%EB%9E%98%EC%8A%A4-%EC%B0%BE%EA%B8%B0-cb8c38a586eb?source=rss-337b221bda85------2</link>
            <guid isPermaLink="false">https://medium.com/p/cb8c38a586eb</guid>
            <category><![CDATA[swagger]]></category>
            <category><![CDATA[interfaces]]></category>
            <category><![CDATA[spring]]></category>
            <category><![CDATA[servers]]></category>
            <category><![CDATA[java]]></category>
            <dc:creator><![CDATA[Seonghun]]></dc:creator>
            <pubDate>Sat, 27 Jan 2024 07:00:56 GMT</pubDate>
            <atom:updated>2024-04-15T11:34:33.842Z</atom:updated>
            <content:encoded><![CDATA[<h4>도메인 별로 처리되는 ErrorCode</h4><p>스트릿 드랍에서는 에러코드를 도메인 별로 분리하여, 처리하고 있습니다.</p><pre>@Getter<br>@AllArgsConstructor<br>public enum CommonErrorCode implements ErrorCodeInterface {<br>    /*<br>     * Basic Client Error<br>     */<br>    BAD_REQUEST(HttpStatus.BAD_REQUEST, &quot;COMMON_BAD_REQUEST&quot;, &quot;Bad Request&quot;, &quot;The request could not be understood or was missing required parameters.&quot;),<br>    METHOD_ARGUMENT_NOT_VALID(HttpStatus.BAD_REQUEST, &quot;COMMON_METHOD_ARGUMENT_NOT_VALID&quot;, &quot;Method Argument Not Valid&quot;, &quot;One or more method arguments are not valid.&quot;),<br>    UNAUTHORIZED(HttpStatus.UNAUTHORIZED, &quot;COMMON_UNAUTHORIZED&quot;, &quot;Unauthenticated&quot;, &quot;Authentication is required and has failed or has not been provided.&quot;),<br>    FORBIDDEN(HttpStatus.FORBIDDEN, &quot;COMMON_FORBIDDEN&quot;, &quot;Forbidden&quot;, &quot;Access to the requested resource is forbidden.&quot;),<br>    NOT_FOUND(HttpStatus.NOT_FOUND, &quot;COMMON_NOT_FOUND&quot;, &quot;Not Found&quot;, &quot;The requested resource could not be found.&quot;),<br>    METHOD_NOT_ALLOWED(HttpStatus.METHOD_NOT_ALLOWED, &quot;COMMON_METHOD_NOT_ALLOWED&quot;, &quot;Method Not Allowed&quot;, &quot;The method received in the request-line is known by the origin server but not supported.&quot;),<br>    CONFLICT(HttpStatus.CONFLICT, &quot;COMMON_CONFLICT&quot;, &quot;Conflict&quot;, &quot;The request could not be completed due to a conflict with the current state of the target resource.&quot;),<br><br>    /*<br>     * Basic Server Error<br>     */<br>    INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, &quot;COMMON_INTERNAL_SERVER_ERROR&quot;, &quot;Internal Server Error&quot;, &quot;An unexpected error occurred&quot;),<br>    NOT_IMPLEMENTED(HttpStatus.NOT_IMPLEMENTED, &quot;COMMON_INTERNAL_SERVER_ERROR&quot;, &quot;Not Implemented&quot;, &quot;The server does not support the functionality required to fulfill the request.&quot;);<br><br><br>    private final HttpStatus status;<br>    private final String errorResponseCode;<br>    private final String title;<br>    private final String message;<br><br>    @Override<br>    public ErrorCode toErrorCode() {<br>       return ErrorCode<br>             .builder()<br>             .status(status)<br>             .errorResponseCode(errorResponseCode)<br>             .title(title)<br>             .message(message)<br>             .build();<br>    }<br>}</pre><pre>@Getter<br>@AllArgsConstructor<br>public enum ItemErrorCode implements ErrorCodeInterface {<br>    ITEM_NOT_FOUND(HttpStatus.NOT_FOUND, &quot;ITEM_NOT_FOUND&quot;, &quot;Item Not Found&quot;, &quot;Item Not Found&quot;),<br>    ITEM_ALREADY_LIKED(HttpStatus.CONFLICT, &quot;ITEM_ALREADY_LIKED&quot;, &quot;Item Already Liked&quot;, &quot;User already item liked&quot;),<br>    ITEM_ALREADY_REPORTED(HttpStatus.CONFLICT, &quot; ITEM_ALREADY_REPORTED&quot;, &quot;Item Already Reported&quot;, &quot;User already item reported&quot;);<br><br>    private final HttpStatus status;<br>    private final String errorResponseCode;<br>    private final String title;<br>    private final String message;<br><br><br>    @Override<br>    public ErrorCode toErrorCode() {<br>        return ErrorCode<br>                .builder()<br>                .status(status)<br>                .errorResponseCode(errorResponseCode)<br>                .title(title)<br>                .message(message)<br>                .build();<br>    }<br>}</pre><p>위의 예와 같이, CommonErrorCode와 ItemErrorCode에 ErrorCodeInterface를 통해서 Enum에 상태값, 에러제목, 에러 메세지를 형식을 포함하도록 강제하고 있습니다.</p><pre>private final HttpStatus status; // HTTP 상태 코드<br>private final String errorResponseCode; // 에러 응답 코드<br>private final String title; // 에러 메세지 제목<br>private final String message; // 에러 메세지 내용</pre><p><a href="https://devnm.tistory.com/27">[스프링] error code 도메인 별 분리하기</a></p><h4>커스텀 헤더를 통한 errorResponseCode 기반의 시나리오 테스트</h4><p>스트릿 드랍에서는 커스텀 헤더를 통해서 개발 환경에서 클라이언트가 에러 시나리오를 보다 쉽게 테스트할 수 있도록 제공하고 있습니다. 위의 errorResponseCode를 추가하여 테스트할 수 있도록 구성하였습니다.</p><pre>STREET-DROP-ERROR-TEST-CODE: USER_NOT_FOUND</pre><figure><img alt="Swagger에서 에러 시나리오 테스트" src="https://cdn-images-1.medium.com/max/1024/1*_42zb5XBW0hyfrsqmdwmpg.png" /></figure><p><a href="https://velog.io/@tosspayments/HTTP-%ED%97%A4%EB%8D%94%EB%A1%9C-%EC%97%90%EB%9F%AC-%ED%85%8C%EC%8A%A4%ED%8A%B8%ED%95%98%EA%B8%B0-zuya4t6v">HTTP 헤더로 에러 테스트하기</a></p><p>스프링 필터를 통해서 구현하였고 개발과 로컬 환경에서 작업이 가능하며, 에러 테스트 헤더가 들어오면, 적합한 에러 ErrorCode Enum을 가져와서 적합한 에러를 반환합니다.</p><pre>@Profile({&quot;dev&quot;, &quot;local&quot;})<br>@Component<br>@Slf4j<br>public class ErrorTestHeaderFilter extends OncePerRequestFilter {<br><br>    public static final String ERROR_TEST_HEADER = &quot;STREET-DROP-ERROR-TEST-CODE&quot;;<br>    private final ObjectMapper objectMapper = new ObjectMapper().registerModule(new JavaTimeModule()).disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);<br><br>    @Override<br>    protected void doFilterInternal(HttpServletRequest request, @NotNull HttpServletResponse response, @NotNull FilterChain filterChain) throws ServletException, IOException {<br>        String errorTestHeader = request.getHeader(ERROR_TEST_HEADER);<br><br>        if (errorTestHeader != null) {<br>            Optional&lt;ErrorCode&gt; errorCode = ErrorCodeMapper.findByErrorCode(errorTestHeader); // 에러코드를 찾는 부분<br><br>            if (errorCode.isPresent()) {<br>                throwErrorResponse(response, errorCode.get());<br>                return;<br>            }<br>        }<br>        filterChain.doFilter(request, response);<br>    }<br><br>    private &lt;T extends ErrorCodeInterface&gt; void throwErrorResponse(HttpServletResponse response, T errorCode) throws IOException {<br>        response.setContentType(APPLICATION_JSON_VALUE);<br>        response.setStatus(errorCode.getStatus().value());<br><br>        HttpErrorResponseDto httpErrorResponseDto = HttpErrorResponseDto.from(errorCode);<br>        String errorResponseJson = objectMapper.writeValueAsString(httpErrorResponseDto);<br><br>        response.getWriter().write(errorResponseJson);<br>    }<br><br>}</pre><h4>여러 enum에서 맞는 errorResponseCode 찾기</h4><p>도메인별로 에러코드를 Enum으로 다르게 구분하였기 때문에, 에러처리 필터에서, errorResponseCode를 가지고 도메인별로 흩어져있는 enum에서 맞는 errorResponseCode를 찾아야 합니다.(ErrorCodeMapper.findByErrorCode(errorTestHeader) 에서 이 과정을 처리하고 있습니다.)</p><p>만약, HELLLO_BAD_REQUEST 라는 errorResponseCode가 들어오면 아래와 같이 여러 패키지에 있는 ErrorCode의 errorResposeCode에서 맞는 값을 찾아주어야 합니다.</p><pre>@Getter<br>@AllArgsConstructor<br>public enum HelloErrorCode implements ErrorCodeInterface {<br>    BAD_REQUEST_HELLO(HttpStatus.BAD_REQUEST, &quot;HELLLO_BAD_REQUEST&quot;, &quot;Bad Request&quot;, &quot;The request could not be understood or was missing required parameters.&quot;);<br>}</pre><pre>@Getter<br>@AllArgsConstructor<br>public enum NiceErrorCode implements ErrorCodeInterface {<br>    BAD_REQUEST_NICE(HttpStatus.BAD_REQUEST, &quot;NICE_BAD_REQUEST&quot;, &quot;Bad Request&quot;, &quot;The request could not be understood or was missing required parameters.&quot;);<br>}</pre><p>이를 위해서는 특정 Interface를 구현한 Enum을 찾아서, 모든 Enum에서 errorResponse와 맞는 값을 찾는 과정이 필요합니다. 값을 찾기 위해서는 크게 두가지 방법이 있습니다.</p><ol><li>QueryDSL이나 Lombok과 같이 컴파일 시점에서 도메인 별로 흩어져 있는 Enum 값들 하나로 모은 StreetDropErrorCode를 파일로 만들어 이를 참고하는 방식 (QType과 같은 방식으로 처리)</li><li>실행시점에서 특정 인터페이스를 구현한 클래스를 찾아서 해당 클래스에서 맞는 errorResponse 코드를 찾는 방식</li></ol><p>커스텀 헤더를 통한 errorResponseCode 기반의 시나리오 테스트가 개발환경에서만 제공되기 때문에 크게 성능에 대해서 민감하지 않으며, 1번의 경우 복잡성이 올라갈 것으로 예상해 실행시점에서 특정 인터페이스를 구현한 클래스를 찾는 방식을 선택해 구현하였습니다.</p><h3>특정 인터페이스를 구현한 클래스를 찾기</h3><p>특정 인터페이스를 구현한 클래스를 찾는 방법은 크게 3가지가 있습니다.</p><ol><li>Service Loader를 사용</li><li>Reflection을 통한 접근</li><li>스프링의 ClassPathScanningCandidateComponentProvider를 통한 접근</li></ol><h4>Service Loader의 사용</h4><p>Service Loader는 자바에서 제공하는 기능으로, 특정 인터페이스를 구현한 클래스를 동적으로 찾아내고 로드할 수 있도록 도와주는 메커니즘입니다. 이는 Java6부터 도입되었으며, 자바의 모듈 시스템이 도입되기 전에 서비스 제공자를 찾기 위해 주로 사용되었습니다.</p><pre>public interface ErrorCodeInterface {<br>}</pre><pre>public enum HelloErrorCode implements ErrorCodeInterface {<br>    BAD_REQUEST_HELLO(HttpStatus.BAD_REQUEST, &quot;HELLLO_BAD_REQUEST&quot;, &quot;Bad Request&quot;, &quot;The request could not be understood or was missing required parameters.&quot;);<br>}</pre><pre>public enum NiceErrorCode implements ErrorCodeInterface {<br>    BAD_REQUEST_NICE(HttpStatus.BAD_REQUEST, &quot;NICE_BAD_REQUEST&quot;, &quot;Bad Request&quot;, &quot;The request could not be understood or was missing required parameters.&quot;);<br>}</pre><p>위와 같이 ErrorCodeInterface와 이를 구현한 HelloErrorCode와 NiceErrorCode가 있으면</p><p>META-INF/services/com.streetdrop.error.dto.interfaces.ErrorCodeInterface</p><p>파일을 생성하고, 해당 파일안에 구현 클래스인 HelloErrorCode와 NiceErrorCode의 classpath를 작성해줍니다.</p><pre># META-INF/services/com.streetdrop.error.dto.interfaces.ErrorCodeInterface<br>com.streetdrop.hello.error.dto.HelloErrorCode;<br>com.streetdrop.nice.error.dto.NiceErrorCode;</pre><p>코드에서는 다음과 같이 서비스를 로드하여 사용할 수 있습니다</p><pre>private List&lt;StreetDropErrorCode&gt; createStreetDropErrorCodeList() {<br>        ServiceLoader&lt;ErrorCodeInterface&gt; errorCodeInterfaces = ServiceLoader.load(ErrorCodeInterface.class);<br>        for (ErrorCodeInterface errorCodeInterface : errorCodeInterfaces) {<br>            var errorResponseCode = errorCodeInterface.getErrorResponseCode();<br>            var error = errorCodeInterface.toErrorCode();<br>            var streetDropError = new StreetDropErrorCode(errorResponseCode, error);<br>            streetDropErrorCodeList.add(streetDropError);<br>        }<br>}</pre><h4>Reflection을 통한 접근</h4><p><a href="https://dev-seonghun.medium.com/unit%ED%85%8C%EC%8A%A4%ED%8A%B8%EA%B0%84-reflection%EC%9D%84-%ED%99%9C%EC%9A%A9%ED%95%98%EC%97%AC-%EC%A0%91%EA%B7%BC-%EC%A0%9C%EC%96%B4%ED%95%84%EB%93%9C-%EA%B0%92-%EB%B3%80%EA%B2%BD%ED%95%98%EA%B8%B0-5c68766b1c35">[Spring] Unit테스트간 Reflection을 활용하여 접근 제어필드 값 변경하기</a></p><p>Reflection을 통해서, JVM 상의 클래스 정보를 바탕으로 특정 인터페이스를 구현한 클래스를 찾을 수 있습니다.</p><pre>dependencies {<br>    implementation &#39;org.reflections:reflections:0.10.2&#39;<br>}</pre><p><a href="https://www.javadoc.io/doc/org.reflections/reflections/latest/org/reflections/Reflections.html#getSubTypesOf-java.lang.Class-">getSubTypesOf </a>메서드를 사용하면 특정 타입의 하위 타입을 모두 가져올 수 있습니다.</p><pre>public &lt;T&gt; Set&lt;Class&lt;? extends T&gt;&gt; getSubTypesOf(Class&lt;T&gt; type)</pre><p>다음과 같이 하위 타입을 모두 가져와 Enum인지 가져와서 사용할 수 있습니다.</p><pre>private List&lt;StreetDropErrorCode&gt; createStreetDropErrorCodeList() {<br>    List&lt;StreetDropErrorCode&gt; streetDropErrorCodeList = new ArrayList&lt;&gt;();<br>    Set&lt;Class&lt;? extends ErrorCodeInterface&gt;&gt; list = new Reflections().getSubTypesOf(ErrorCodeInterface.class);<br>    for (Class&lt;? extends ErrorCodeInterface&gt; errorCodes : list) {<br>        if (errorCodes.isEnum()){<br>            for (var errorCode : errorCodes.getEnumConstants()) {<br>                if (errorCode != null){<br>                    var errorResponseCode = errorCode.getErrorResponseCode();<br>                    var error = errorCode.toErrorCode();<br>                    var streetDropError = new StreetDropErrorCode(errorResponseCode, error);<br>                    streetDropErrorCodeList.add(streetDropError);<br>                }<br>            }<br>        }<br><br>    }<br><br>    return streetDropErrorCodeList;<br>}</pre><h4>ClassPathScanningCandidateComponentProvider을 통한 접근</h4><p><a href="https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/ClassPathScanningCandidateComponentProvider.html">ClassPathScanningCandidateComponentProvider (Spring Framework 6.1.3 API)</a></p><p>ClassPathScanningCandidateComponentProvider는 스프링 프레임워크에서 제공하는 클래스로, 지정된 기본 패키지를 시작으로 후보 컴포넌트를 찾는 역할을 합니다.이 클래스는 컴포넌트 인덱스를 사용할 수 있으면 사용하고, 그렇지 않으면 클래스패스 스캐닝을 수행합니다.</p><p>TypeFilter 를 통해서 특정 타입을 상속받은 클래스만을 식별할 수 있습니다.</p><p>먼저 ClassPathScanningCandidateComponentProvider 생성하고</p><pre>ClassPathScanningCandidateComponentProvider s = new ClassPathScanningCandidateComponentProvider(false);</pre><p>TypeFilter를 통해서 ErrorCodeInterface를 구현한 클래스를 찾습니다.</p><p>filtCandidateComponents에서의 패키지 내의 모든 클래스를 검색하고, 필터에 있는 해당 조건을 만족하는 클래스들을 찾고 가져올 수 있습니다.</p><pre>TypeFilter typeFilter = new AssignableTypeFilter(ErrorCodeInterface.class);<br>scanner.addIncludeFilter(typeFilter);<br><br><br>Set&lt;BeanDefinition&gt; components = scanner.findCandidateComponents(&quot;com.streetdrop&quot;);<br>for (BeanDefinition component : components) {<br>            Class&lt;?&gt; className = Class.forName(component.getBeanClassName());<br>}</pre><p>전체 코드는 아래와 같습니다.</p><pre>private synchronized List&lt;StreetDropErrorCode&gt; createStreetDropErrorCodeList() {<br>        ClassPathScanningCandidateComponentProvider s = new ClassPathScanningCandidateComponentProvider(false);<br><br>        TypeFilter tf = new AssignableTypeFilter(ErrorCodeInterface.class);<br>        s.addIncludeFilter(tf);<br><br>        Set&lt;BeanDefinition&gt; components = s.findCandidateComponents(&quot;com.depromeet&quot;);<br><br>        for (BeanDefinition component : components) {<br>            Class&lt;?&gt; className = Class.forName(component.getBeanClassName());<br>            <br>            if (className.isEnum()) {<br>                for (var errorCode : className.getEnumConstants()) {<br>                    if (errorCode != null) {<br>                        String errorResponseCode = (String) errorCode.getClass().getMethod(&quot;getErrorResponseCode&quot;).invoke(errorCode);<br>                        ErrorCode error = (ErrorCode) errorCode.getClass().getMethod(&quot;toErrorCode&quot;).invoke(errorCode);<br>                        var streetDropError = new StreetDropErrorCode(errorResponseCode, error);<br>                        streetDropErrorCodeList.add(streetDropError);<br>                    }<br>                }<br>            }<br>        }<br><br><br>    return streetDropErrorCodeList;<br>}</pre><h4>결론</h4><p>Service Loader를 사용</p><ul><li>장점 : Java 내부 내장, 추가적인 의존성 필요 없음</li><li>단점 : 매번 classpath를 작성하는 것이 번거롭고, 실수할 가능성이 있음</li></ul><p>Reflection을 통한 접근</p><ul><li>장점 : 라이브러리 추가와 메서드 하나만을 통해서, 빠르게 구현이 가능</li><li>단점 : Reflection이기 때문에 속도가 다소 느림, 외부 라이브러리 의존성 필요</li></ul><p>ClassPathScanningCandidateComponentProvider</p><ul><li>장점 : 빠르게 구현이 가능</li><li>단점 : 스프링에 의존성, 에러 추가 핸들링이 필요</li></ul><p>결론적으로는 ClassPathScanningCandidateComponentProvider를 선택했습니다. 테스트 코드에서 errorResponse 코드의 중복을 확인해주어야 하는데 reflection 의 경우 JVM 상의 클래스 정보를 읽어야 하기 때문에 단순히 Unit 테스트를 통해서 확인이 어려워, ClassPathScanningCandidateComponentProvider 를 활용해 구현하였습니다.</p><p><a href="https://github.com/depromeet/street-drop-server/pull/415">:recycle: Refactor : refactoring errorCode by domain by seonghun-dev · Pull Request #415 · depromeet/street-drop-server</a></p><p>관련 프로젝트</p><p><a href="https://github.com/depromeet/street-drop-server">GitHub - depromeet/street-drop-server: StreetDrop 🎶 Location based music sharing social service</a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=cb8c38a586eb" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[Rust] GlueSQL Point Datatype 추가하기]]></title>
            <link>https://dev-seonghun.medium.com/rust-gluesql-point-datatype-8b44a8dd411f?source=rss-337b221bda85------2</link>
            <guid isPermaLink="false">https://medium.com/p/8b44a8dd411f</guid>
            <category><![CDATA[sql]]></category>
            <category><![CDATA[spatial-database]]></category>
            <category><![CDATA[database]]></category>
            <category><![CDATA[rust]]></category>
            <category><![CDATA[spatial]]></category>
            <dc:creator><![CDATA[Seonghun]]></dc:creator>
            <pubDate>Sun, 07 May 2023 14:51:46 GMT</pubDate>
            <atom:updated>2023-05-07T14:56:19.738Z</atom:updated>
            <content:encoded><![CDATA[<p>저는 현재 Rust로 작성된 SQL, GlueSQL 오픈소스에 기여하고 있습니다. 최근에는 공간 데이터 타입에 작업을 진행하고 있습니다.</p><p>최근에 진행했던 첫번째 공간 데이터 타입인, Point 데이터 타입을 추가하면서의 학습했던 공간데이터 타입과 작업하면서 여러 고민했던 부분과 트러블 슈팅 사례를 공유해드리고자 합니다.</p><h4>공간 데이터 타입이란?</h4><p>공간 데이터 타입은 지리 정보를 나타내기 위한 데이터 타입입니다. 이러한 데이터 타입은 공간 데이터베이스에서 지리 정보를 저장하고 처리하는 데 사용됩니다. 공간 데이터 타입은 일반적으로 Point, Line, Polygon, Multi Point, LineString 과 같은 기하학적 객체를 표현할 수 있습니다.</p><p>공간 데이터 타입은 위치기반서비스에서 매우 유용하게 활용할 수 있습니다. MySQL 기준으로 한 점을 기준으로 100m 이내의 모든 점을 찾기 위해서 다음과 같은 SQL 구문이면 처리가 가능합니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*WLiPehz0lzMpaAhCTIEezg.png" /></figure><p>하지만 lat, lon 타입으로 지정할 경우 Haversine 공식을 사용하여 계산해야 하는데 다음과 같이 복잡한 SQL 구문이 필요합니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*DgSQ_z6lEJe9mG0GWoy_nA.png" /></figure><p>추가로 공간 인덱스를 활용할 경우, 더 효율적인 처리가 가능합니다.</p><h4>공간 데이터 타입 표준</h4><p>The Open Geospatial Consortium (OGC)는 공간 데이터를 처리하는데 필요한 지리 정보 구현 표준(Simple Feature Access — Part 2: SQL Option)을 발행하고 있습니다.</p><p><a href="https://www.ogc.org/standard/sfs/">Simple Feature Access - Part 2: SQL Option - Open Geospatial Consortium</a></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*cugbkEVzRksZN3oeDqagUA.png" /></figure><p>다음과 같이 이 문서는 공간 데이터를 다루는 데 가장 일반적으로 사용되는 기능들을 다루며, SQL 쿼리를 사용하여 공간 데이터를 저장, 검색 및 조작하는 데 필요한 문법과 함수들을 제공합니다. 저는 기본이 되는 Point 데이터 타입과 ST_X,ST_Y함수 부터 작업했습니다.</p><h4>공간 데이터 타입 입력과 출력 형식</h4><p>공간 데이터 타입은 입력과 출력 형식은 크게 3가지의 표준이 존재합니다.</p><ul><li><a href="https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry">Well-Known Text(WKT)</a> — Well-Known Text(WKT)는 텍스트 형식으로 위치 정보를 표현하는 방법입니다. POINT(10 20) 과 같은 형태로 많이 표현됩니다.</li><li><a href="https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry">Well-Known Binary(WKB) </a>— Well-Known Binary(WKB)는 WKT와 비슷한 방식으로 위치 정보를 표현하지만, 이진 형식으로 데이터를 저장하는 방법입니다.</li><li><a href="https://geojson.org/">GeoJson</a>- JSON 형식으로 작성되며, 위치 정보와 속성 정보를 포함하는 형태이며, WKT와 WKB보다 많은 정보를 담을 수 있습니다. 아래와 같은 형식으로 주로 표현됩니다.</li></ul><pre>{<br>      &quot;type&quot;: &quot;Point&quot;,<br>      &quot;coordinates&quot;: [10, 20]<br>}</pre><h4>Geometry Vs Geography</h4><p>Geometry 데이터는 평면 좌표계에서 사용되며, 주로 건물, 도로, 지하철 노선 등과 같은 지리 정보를 다룰 때 사용됩니다. 이러한 데이터는 평면적인 공간적인 차원만 고려되기 때문에, 거리나 면적을 계산할 때 직선 거리나 평면적인 면적을 사용합니다. Geometry 데이터는 평면 좌표계에서 좌표값이 일정한 유닛(예: 미터, 피트, 미리미터 등)으로 나타납니다.</p><p>Geography 데이터는 구면 좌표계에서 사용되며, 지구상의 위치 정보를 다룰 때 사용됩니다. 이러한 데이터는 지구의 곡률을 고려하여 거리나 면적을 계산합니다. Geography 데이터는 구면 좌표계에서 위도와 경도와 같은 좌표값이 나타납니다.</p><p><a href="https://docs.snowflake.com/ko/sql-reference/data-types-geospatial">지리 공간 데이터 타입 | Snowflake Documentation</a></p><h3>Point 데이터 타입 구현하기</h3><p>데이터 타입 추가는 어려움이 없었지만, GlueSQL에서 처음으로 추가하는 공간 데이터 타입이었기 때문에, 추후 추가될 공간 데이터 타입의 처리 방식도 고려해야 했기에 다소 어려운 이슈였습니다.</p><ul><li>Geometry 와 Geography 처리방식에 대한 고민</li><li>ST_X, ST_Y와 같은 함수명에 대한 고민</li></ul><h4>Geometry 와 Geography 처리방식에 대한 고민</h4><p>WKT 및 WKB 표준에서는 형식만 지정하며, WKT/WKB 오브젝트의 의미 체계(Geometry인지 Geography인지)는 참조 시스템(예: 평면 또는 구)에 따라 다릅니다.</p><p>크게 DBMS에서 이는 두가지로 처리방식이 나누어집니다. Geometry타입에 SRID 를 지정하여 처리하는 방식, Geography와 Geometry데이터 타입을 구분지어 처리하는 방식이 있습니다.</p><p><strong>Geometry타입에 SRID 를 지정하여 처리하는 방식</strong></p><p>MySQL, PostGIS, Oracle Spatial에서는 SRID를 지정하기 위해 GEOMETRY 타입의 컬럼을 정의할 때 SRID 값을 함께 지정하는 문법을 사용합니다. 이렇게 함께 명시된 SRID 값을 통해 해당 GEOMETRY 데이터가 어떤 참조 시스템(평면 또는 구)을 사용하는지 알 수 있습니다. (SRID가 4326일 경우 구일 경우를 의미합니다.)</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*0Ov9oT4FQvL_-xw8QmTlRw.png" /></figure><p><strong>Geography와 Geometry데이터 타입을 구분지어 처리하는 방식</strong></p><p>Snowflake, Microsoft SQL Server 에서는 GEOGRAPHY 데이터 타입과 GEOMETRY 데이터 타입을 구분하여 처리하고 있습니다. GEOGRAPHY를 사용할 경우 구 참조시스템을 사용하고, GEOMETRY 데이터 타입을 사용할 경우 평면 참조시스템을 사용합니다.</p><p>GlueSQL에서는 <strong>Geography와 Geometry데이터 타입을 구분지어 처리하는 방식을 사용하여 처리하도록 결정</strong>하였습니다. 측정 단위를 보다 명확하게 하고, 데이터 타입을 나눔으로 함수를 st_distance , st_distance_sphere 와 같은 거리를 측정하는 함수, 구면에서의 거리를 측정하는 함수로 나눌 필요가 없이 st_distance 함수를 통해 평면 좌표에서와 구면 좌표에서 모두 거리를 측정할 수 있었습니다.</p><p>또한, 데이터 타입의 유효성 검사에도 장점이 있었습니다. 다각형과 같은 다양한 도형이 올바른 도형인지에 대해서 유효성 검사가 필요한데, 이는 평면좌표계와 구면 좌표계에서 유효한지에 대해 결과가 달라집니다. 따라, 데이터 타입을 나눔으로써 유효성 검사를 보다 명확히하고 적합한 에러를 반환할 수 있었습니다.</p><p><a href="https://docs.snowflake.com/ko/sql-reference/data-types-geospatial#understanding-the-differences-in-input-data-validation">지리 공간 데이터 타입 | Snowflake Documentation</a></p><p><strong>ST_X, ST_Y와 같은 함수명에 대한 고민</strong></p><p>ST_X 는 각각 Geometry나 Geography 타입의 X 좌표 또는 경도를 반환하는 함수입니다. ST_Y 의 경우 Y좌표 또는 위도를 반환합니다.</p><p>이는 OGC의 Simple Feature Access — Part 2: SQL Option에 다음과 같이 표준이 명시되어 있습니다.</p><pre>METHOD ST_X()<br>   RETURNS DOUBLE PRECISION<br>   LANGUAGE SQL<br>   DETERMINISTIC<br>   CONTAINS SQL<br>   RETURNS NULL ON NULL INPUT,<br><br>METHOD ST_X (xcoord DOUBLE PRECISION)<br>   RETURNS ST_Point<br>   SELF AS RESULT<br>   LANGUAGE SQL<br>   DETERMINISTIC<br>   CONTAINS SQL<br>   CALLED ON NULL INPUT,</pre><p>하지만, <a href="https://medium.com/@dev-seonghun/rust-gluesql-querybuilder-join-expression-39a6d2b5e31f">GlueSQL에서는 SQL 뿐만이 아니라 QueryBuilder를 통해서도 쿼리를 만들어 낼 수 있습니다.</a></p><p>ST_X 와 ST_Y 를 SQL에서 사용하는데에는 큰 문제가 없지만, QueryBuilder에서 사용할 경우 table(&quot;Foo&quot;).select(&quot;location&quot;).st_x().build(); 와 같은 형식이 되어 ST_X 가 어떤 동작을 하는지 명확하게 알아내기가 다소 어려웠습니다.</p><p>따라서, 표준을 일부 포기하면서 get_x()와 get_y() 메서드를 사용하여 각각 X좌표와 Y좌표를 반환하도록 하였습니다. table(&quot;Foo&quot;).select(&quot;location&quot;).get_x().build(); 와 같이 Query Builder와 SQL에서 더 직관적인 동작을 이해할 수 있도록 하였습니다.</p><h3>Point 타입 구현</h3><p>구현에 큰 어려움은 없었습니다. 정규표현식을 사용하여 WKT를 파싱하고, Point 데이터 타입을 생성하는 부분만 구현하면 되었습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*mzPzhldEZM0dXBoSrRhBMg.png" /></figure><p>Point 타입에서는 우선적으로 WKT를 활용하여 입출력을 처리하고 추가로 WKB, GeoJson를 작업하기로 결정하였습니다. from_wkt() 메서드에서 WKT 형식의 값을 입력할수 있도록 처리하고, Display 트레잇을 통해 WKT 형식으로 데이터 타입을 출력할 수 있도록 하였습니다.</p><p>다음과 같이 cast를 통해서 from_wkt() 메서드를 부르고 wkt를 Point 타입으로 변환할 수 있게 하였습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*3_gymwwkLd6zMk5LH6oyYA.png" /></figure><p>또한 point 함수를 만들어서 WKT형식이 아니라 SQL 구문을 통해서 Point 타입을 생성할 수 있도록 구성했습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*BH7D2uqTlbDMhdKNiRRwLA.png" /></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*XhVYgQCi446zmDHLIbF2Og.png" /></figure><h4>정리하며</h4><p>이번 기여는 코드 작성보다 표준 문서와 다양한 데이터베이스의 구현과 코드를 많이 참고 했었던 것 같습니다. 기존 타입과 완전히 다른 타입이며 Point 타입 뿐만이 아니라 다양한 공간 데이터 타입이 추가될 예정이여서, 공간 참조를 어떻게 처리할지, 함수명을 어떻게 할지등에 대해서도 많은 고민을 했었던 것 같습니다.</p><p>다음 데이터 타입으로 LineString 타입을 추가하고 있는데, 추후 게시글을 통해, 타입을 추가하면서 배웠던 내용과 트러블 슈팅 내용을 공유 드리도록 하겠습니다.</p><p>관련 RP은 아래에서 확인해보실 수 있습니다.</p><p><a href="https://github.com/gluesql/gluesql/pull/1048">Implement geometric `POINT` Type and geometric functions by seonghun-dev · Pull Request #1048 · gluesql/gluesql</a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=8b44a8dd411f" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[Rust] 문자열 리터럴에서 to_string() vs to_owned()]]></title>
            <link>https://dev-seonghun.medium.com/rust-%EB%AC%B8%EC%9E%90%EC%97%B4-%EB%A6%AC%ED%84%B0%EB%9F%B4%EC%97%90%EC%84%9C-to-string-vs-to-owned-f40adc2b7ab5?source=rss-337b221bda85------2</link>
            <guid isPermaLink="false">https://medium.com/p/f40adc2b7ab5</guid>
            <category><![CDATA[rust-programming-language]]></category>
            <category><![CDATA[rustlang]]></category>
            <category><![CDATA[rust]]></category>
            <dc:creator><![CDATA[Seonghun]]></dc:creator>
            <pubDate>Tue, 02 May 2023 04:31:34 GMT</pubDate>
            <atom:updated>2023-05-02T04:31:34.868Z</atom:updated>
            <content:encoded><![CDATA[<h3>Rust 문자열</h3><p>Rust의 언어 레벨에서는 스트링 슬라이스인 str과 그 참조자 &amp;str만을 제공하고 있습니다. Rust의 표준 라이브러리에서 String 타입을 제공 하고 있습니다.</p><p>&amp;str은 고정된 값으로 스택에 데이터가 저장되어 있으며, UTF-8 문자열을 나타냅니다. 하지만 해당 포인터에 대한 소유권을 가지고 있지 않습니다.</p><p>반면에 String 타입은 힙에 데이터가 저장되며, 소유권을 가지고 있습니다. String은 크기가 가변적이며, 문자열 데이터를 동적으로 할당할 수 있습니다. 이 때문에 String 타입은 str보다 더 많은 기능을 제공하고 있습니다.</p><pre>let a: &amp;str = &quot;str&quot;;<br>let b: String = &quot;str&quot;.to_string();</pre><h4>&amp;str 에서 String으로</h4><p>Rust에서 &amp;str은 스트링 슬라이스를 나타내며, 해당 문자열 데이터의 소유권을 가지고 있지 않습니다. 따라서 &amp;str을 String으로 변환해야 할 때가 있습니다.</p><p>&amp;str에서 String으로 변환하는 방법은 크게 세 가지가 있습니다.</p><ol><li>String::from 사용하기</li></ol><p>String::from는 &amp;str에서 String으로 변환해주는 함수입니다. 이 함수는 &amp;str을 인자로 받아 String타입으로 변환하여 반환합니다.</p><p>2. to_owned 사용하기</p><p>to_owned는 ToOwned 트레이트를 구현한 타입에 대해 호출할 수 있는 함수입니다. &amp;str은 ToOwned 트레이트를 구현하므로, to_owned 함수를 사용하여 &amp;str을 String으로 변환할 수 있습니다.</p><p>3. to_string 사용하기</p><p>to_string는 Display 트레이트를 구현하는 타입에 대해 호출할 수 있는 함수입니다. &amp;str은 Display 트레이트를 구현하므로, to_string 함수를 사용하여 &amp;str을 String으로 변환할 수 있습니다.</p><p>4. into 사용하기</p><p>into 함수는 From트레이트를 구현하는 타입에 대해 호출할 수 있는 함수입니다. &amp;str은 FromStr트레이트를 구현하므로, into함수를 사용하여 &amp;str을 String으로 변환할 수 있습니다.</p><pre>let s: &amp;str = &quot;hello&quot;;<br>let owned_s_0: String = String::from(s);<br>let owned_s_1: String = s.to_owned();<br>let owned_s_2: String = s.to_string();<br>let owned_s_3: String = s.into();</pre><h3>to_string() 와 to_owned()</h3><p>&amp;str을 String으로 변환한다는 점에서 같은 결과를 내주게되지만, 의미는 일부 다릅니다. to_string과 to_owned모두 변환을 지원하기 때문에 어떤것을 쓰는게 더 좋은지에 관해서 다양한 논의글들을 찾아볼 수 있습니다.</p><ul><li><a href="https://users.rust-lang.org/t/to-string-vs-to-owned-for-string-literals/1441">`to_string()` vs `to_owned()` for string literals</a></li><li><a href="https://medium.com/@ericdreichert/converting-str-to-string-vs-to-owned-with-two-benchmarks-a66fd5a081ce">Converting &amp;str: to_string vs to_owned (with two benchmarks)</a></li></ul><p>먼저, Display 트레이트를 구현하는 타입에 대해 호출할 수 있는 함수인 to_string 과 ToOwned 트레이트를 구현한 타입에 대해 호출할 수 있는 함수 to_owned에 대해서 알아보겠습니다.</p><h3>Display를 위해 구현되는 to_string()</h3><p>to_string은 Display 트레잇을 구현하는 모든 타입에서 사용 가능한 메서드로, Display 특성을 구현하는 경우 자동으로 구현됩니다. Display 트레잇이 사용자 출력용도로 사용되기 때문에, to_string은 출력을 위한 문자열 변환에 적합한 메서드입니다.</p><h4>Trait std::fmt::Display — Display Trait의 사용예</h4><pre>use std::fmt;<br><br>struct Point {<br>    x: i32,<br>    y: i32,<br>}<br><br>impl fmt::Display for Point {<br>    fn fmt(&amp;self, f: &amp;mut fmt::Formatter&lt;&#39;_&gt;) -&gt; fmt::Result {<br>        write!(f, &quot;({}, {})&quot;, self.x, self.y)<br>    }<br>}<br><br>let origin = Point { x: 0, y: 0 };<br><br>let result: String = origin.to_string();</pre><p>위에서는 Point 타입에 대해서 Display를 구현하였을때 자동으로 to_string 메서드가 사용가능한 것을 확인해볼 수 있습니다.</p><p>&amp;str을 String으로 변환하는 과정에서 to_string() 메서드는 String 구조체의 인스턴스를 생성하고, &amp;str 값을 복사하여 새로운 String 인스턴스에 할당합니다.</p><h3>소유권을 가질 수 있도록 하는 to_owned()</h3><p>to_owned 메서드는 Rust의 ToOwned 트레잇에서 제공하는 메서드 중 하나입니다. 이 메서드는 어떤 타입의 값을 소유하는 새로운 타입으로 변환하는 함수입니다. 즉, 이 메서드를 호출하면 해당 타입의 값을 복사하여 새로운 타입의 인스턴스를 만들고 그 인스턴스를 반환합니다.</p><pre>pub trait ToOwned {<br>    type Owned: Borrow&lt;Self&gt;;<br><br>    fn to_owned(&amp;self) -&gt; Self::Owned;<br>}</pre><p>to_owned()는 단순히 메모리 버퍼를 할당하고 문자열 리터럴을 복사하여 &amp;str 을 String 으로 변환합니다.</p><h3>to_string() vs to_owned()</h3><p>Rust 커뮤니티의 대부분의 의견에서는 <strong>to_owned() </strong>사용을 권장하고 있습니다. 주된 의견을 정리해보면 다음과 같습니다.</p><ol><li>&amp;str -&gt; String에서는 성능상에서 큰 문제는 없지만(<a href="https://github.com/rust-lang/rust/pull/32586">관련 이슈</a>) &amp;&amp;str 과 같은 환경에서 specialization이 적용되지 않아 성능상에 문제가 발생할 수 있어, 안정성을 위해서는 .to_owned 의 사용이 적합하다고 합니다.</li><li>to_string이 Display를 구현한 모든 타입에서 사용할 수 있기 때문에, str이 아닌 타입이 의도치 않게 String으로 변환될 수 있는 문제가 존재합니다.</li><li>String 과 &amp;str 이 다르긴 하지만 의미상으로는 모두 문자열을 의미하기 때문에, 문자열을 문자열로 바꾸는 to_string보다 소유권을 가지도록 하는 to_owned 가 메서드 의미상 더 적합하다고 합니다.</li></ol><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=f40adc2b7ab5" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[Spring] Unit테스트간 Reflection을 활용하여 접근 제어필드 값 변경하기]]></title>
            <link>https://dev-seonghun.medium.com/unit%ED%85%8C%EC%8A%A4%ED%8A%B8%EA%B0%84-reflection%EC%9D%84-%ED%99%9C%EC%9A%A9%ED%95%98%EC%97%AC-%EC%A0%91%EA%B7%BC-%EC%A0%9C%EC%96%B4%ED%95%84%EB%93%9C-%EA%B0%92-%EB%B3%80%EA%B2%BD%ED%95%98%EA%B8%B0-5c68766b1c35?source=rss-337b221bda85------2</link>
            <guid isPermaLink="false">https://medium.com/p/5c68766b1c35</guid>
            <category><![CDATA[java]]></category>
            <category><![CDATA[reflections]]></category>
            <category><![CDATA[spring-test]]></category>
            <category><![CDATA[unit-testing]]></category>
            <category><![CDATA[spring]]></category>
            <dc:creator><![CDATA[Seonghun]]></dc:creator>
            <pubDate>Sun, 16 Apr 2023 16:23:06 GMT</pubDate>
            <atom:updated>2023-04-16T16:26:56.082Z</atom:updated>
            <content:encoded><![CDATA[<p>스프링에서 Unit 테스트를 작성하다 보면, Private, Protected 등 접근제어자가 설정된 필드에 값을 넣어주어야 하는 경우가 발생하는데, 이때 접근 제어자 때문에 값을 변경하기 어렵다는 문제가 있습니다.</p><p>이번 글에서는 자바의 Reflection객체를 통해서, 이러한 접근제어자가 설정된 필드에 값을 넣어서 테스트에 활용해주는 방법과 예시를 정리해보았습니다.</p><h4>자바의 Reflection 이란?</h4><p>c의 경우에는 전처리기 매크로(preprocessor macro)를 활용해서, 컴파일 타임에 코드를 생성할 수 있습니다. 이와 비슷하게 자바에서는 Reflection을 지원합니다. 런타임 시점에 객체의 정보를 가져오거나 수정할 수 있게 해주는 API입니다.</p><p>Reflection을 사용하면, 객체를 동적으로 생성하고, 메소드를 호출하며, 필드에 접근할 수 있습니다. 이는 자바에서 컴파일 타임에 정적으로 처리하는 것이 아니라, 런타임에 동적으로 처리하는 방식입니다.</p><p>JVM은 클래스 로더를 사용해 클래스를 로드하고 메모리에 적재합니다. Reflection API를 사용해 클래스 정보를 가져올 때, 해당 클래스의 생성자, 메소드, 필드와 같은 메타데이터를 검색하고 분석하며, 이러한 메타데이터를 활용하여 Reflection API를 호출한 코드의 요구에 따라 클래스를 조작합니다.</p><p>Reflection을 활용한 예시는 주위에서 쉽게 찾을 수 있습니다. 스프링에서 Bean을 통해 DI(Dependency Injection) 을 사용할때, 어노테이션에서 @Retention(RetentionPolicy.RUNTIME) 를 사용할때, 모두 Reflection을 통해서 구현됩니다.</p><blockquote><strong>자바의 Reflection과 관련해 읽어보면 좋은 글</strong></blockquote><ul><li><a href="https://www.oracle.com/technical-resources/articles/java/javareflection.html">Using Java Reflection</a></li><li><a href="https://docs.oracle.com/javase/tutorial/reflect/">Trail: The Reflection API</a></li><li><a href="https://stackoverflow.com/questions/1392351/java-reflection-why-is-it-so-slow">Java Reflection: Why is it so slow?</a></li></ul><h4>Unit Test간 Reflection을 활용하여 접근 제어필드 값 변경하기</h4><p>먼저 다음과 같은 모든 알림을 조회하는 Service에 대한 테스트 코드를 작성하고 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*L9QUUUYixM-iDCHD36mhJw.png" /><figcaption>Notification Service</figcaption></figure><p>이때, NotificationResponseDto를 보면 알림 생성일자인 createdAt이 반환되는 것을 확인할 수 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*91a2zN0PokJXHOwc6BU6hQ.png" /></figure><p>Notification Entity는 생성일자(createdAt)와 수정일자(updatedAt)의 필드가 존재하는BaseTimeEntity를 상속받고 있습니다. BaseTimeEntity는 JPA Auditing 기능을 사용하고 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*GgfYrSnF4gYyf_dhwQk9tA.png" /><figcaption>BaseTimeEntity</figcaption></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*yEkz5NMHrR0V_JqPnMUwhA.png" /><figcaption>Notification Entity</figcaption></figure><p>하지만, createdAt이 Private의 접근제어자가 존재하기 때문에 테스트 코드에서 해당 Entity를 생성할 때 값을 넣어줄 수 없는 문제가 발생합니다.</p><p>다음과 같이 Repository에서 반환하는 notificationList를 작성할 때, createdAt을 넣어줄 수 없습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*Q7OxONtF0-Nz1MW9IIRMCA.png" /></figure><p>따라, createdAt을 비교하고자 하면 들어오지 않은 값이므로 NullPointException 이 발생하게 됩니다.</p><p>createdAt에 값을 넣어줄 수 있는 방법은 크게 3가지가 존재합니다.</p><ol><li>JPA Entity Listener를 Bean으로 등록하여 사용</li><li>BaseTimeEntity에 @Setter 를 활용하여 접근할 수 있도록 변경</li><li>Reflection을 통해서 필드에 값을 변경</li></ol><p>BaseTimeEntity는 JPA Auditing 기능을 사용하기 때문에, JPA Entity Listener를 Bean으로 등록하여 사용할 수는 있습니다. 하지만, Audit 정보가 자동으로 적용되기 때문에 createdAt을 원하는 값으로 설정해주기는 어렵습니다.</p><p>값을 비교할때도 차이를 통해서 비교하여 테스트를 통과하게 짜야하며, <strong>테스트 결과 예측을 어렵기 만듭니다.</strong></p><p>BaseTimeEntity의 createdAt을 테스트 코드를 위해 Setter로 변경하게 된다며 메인 로직에서 직접적으로 수정되지 않는 값을 테스트를 위해 수정하기때문에, <strong>코드의 안전성을 보장하지 못합니다.</strong></p><p>Reflection 을 사용하면, 동적으로 필드에 접근하여 값을 변경할 수 있기 때문에 <strong>테스트 코드에서 사용하면 메인 로직에 영향을 끼치지 않고 테스트를 진행</strong>할 수 있어 가장 좋은 방식입니다.</p><p>스프링에서는 Reflection을 활용하여 테스트 코드를 작성할 수 있게, 유용한 도구를 제공하고 있습니다.</p><p><a href="https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/test/util/ReflectionTestUtils.html">ReflectionTestUtils (Spring Framework 6.0.8 API)</a></p><p><strong>ReflectionTestUtils</strong>는 스프링 프레임워크에서 제공하는 테스트 유틸리티 클래스로, 리플렉션(Reflection)을 사용하여 <strong>테스트 코드에서 프라이빗(private) 필드나 메서드, 생성자 등에 접근하여 값을 가져오거나 변경할 수 있는 기능을 제공</strong>하고 있습니다.</p><p>테스트 코드에서는 주로 의존성을 제거하고 단위 테스트를 수행해야 하는데, 리플렉션을 사용하여 프라이빗 필드나 메서드에 접근할 수 있으므로 테스트 대상 객체의 내부 상태를 조작하여 테스트를 수행할 수 있습니다.</p><p>ReflectionTestUtils 클래스의 주요 메서드로는 setField, setFinalField, getField, invokeMethod 등이 있습니다. setField 메서드는 주어진 객체의 필드 값을 설정하고, setFinalField 메서드는 final 필드의 값을 설정할 수 있습니다. getField 메서드는 객체의 필드 값을 가져오고, invokeMethod 메서드는 객체의 메서드를 호출할 수 있습니다.</p><p>private인 createdAt 필드의 값을 변경해주는 것이 목표이므로, ReflectionTestUtils의 setField(Object target, string name, Object value)메소드를 사용하여 변경해줄 수 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*hHX6ZmoNQaBp8_h-CgZ6zQ.png" /><figcaption>ReflectionTestUtils setField Method</figcaption></figure><p>target 은 필드를 변경할 객체를 의미하고, name 은 변경하고자 하는 필드의 이름을 의미합니다. 마지막으로 value 는 변경하고자 하는 값입니다.</p><p>따라서 target은 notificationList.get(0) 이고 변경할 필드명은 createdAt 이고, 마지막으로 필드에 대입할 값을 LocalDateTime.of()를 사용하여 넣어주었습니다.</p><p>이를 통해 createdAt 필드에 값을 넣어줄 수 있으며, 최종적인 테스트 코드는 아래와 같이 작성할 수 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*WEphLEY86g0mSIBS2PLNEA.png" /></figure><p>ReflectionTestUtils을 통해서, Private로 접근이 제어된 필드의 값을 변경하는 방법에 대해 알아볼 수 있었습니다. ReflectionTestUtils의 다른 메서드를 활용하여 접근이 제어된 필드뿐만이 아닌 메서드도 변경할 수 있어 다른 테스트 코드에도 유용하게 사용할 수 있을 것 같습니다.</p><h4>프로젝트 Repository</h4><p><a href="https://github.com/seonghun-dev/workout-backend">GitHub - seonghun-dev/workout-backend: Workout, Find All workout group</a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=5c68766b1c35" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[Create Medium Blog ReadMe Card]]></title>
            <link>https://dev-seonghun.medium.com/create-medium-blog-readme-card-611eec6581d1?source=rss-337b221bda85------2</link>
            <guid isPermaLink="false">https://medium.com/p/611eec6581d1</guid>
            <category><![CDATA[post]]></category>
            <category><![CDATA[medium]]></category>
            <category><![CDATA[markdown]]></category>
            <category><![CDATA[cards]]></category>
            <dc:creator><![CDATA[Seonghun]]></dc:creator>
            <pubDate>Thu, 23 Mar 2023 10:15:28 GMT</pubDate>
            <atom:updated>2023-03-23T10:15:28.982Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*vFADNP52wA0rP0tXtfgzcg.png" /></figure><h3>Medium Blog ReadMe Card</h3><p>This is My Github Profile, I add card which show recent medium contents.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*wxtyFCSJLoWa_6BIGzccHA.png" /></figure><h4><strong>How to Apply This Readme card?</strong></h4><p>You can get your own Readme card by changing next ?name= value to your medium profile id. And add to Github Markdown</p><p>In my case, My Readme card is below.</p><pre>[![Medium GitHub stats](https://medium-readme-stats.vercel.app/api/post?name=dev-seonghun)](https://github.com/seonghun-dev/medium-readme-stats)</pre><figure><img alt="" src="https://cdn-images-1.medium.com/max/928/1*vtTfmVHd2IzAkl91Azd4yw.png" /></figure><h4>How to develop it?</h4><p>This source code based on Velog Readme Stats, Velog is Korean Blog for Developers. SomeOne create this readme stats. So I think this project is very Interesting.</p><p><a href="https://github.com/eungyeole/velog-readme-stats">GitHub - eungyeole/velog-readme-stats: Velog 포스트로 Github를 꾸며보자!</a></p><p>But I’m not using velog. So, I create Medium Readme Stats.</p><p>First, I get Data from medium using rss. this below link you can get xml file about your medium.</p><pre>https://medium.com/@${blogname}/feed</pre><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*7r7h1nafqsRePNgZ3oh1Jw.png" /></figure><p>Parse XML file and get Some data like category, title, username and so on.</p><p>Create SVG file with some data. So you can import to github markdown.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/928/1*s4vUIsH2HQtGj8aml-WjnA.png" /></figure><h4>Reference</h4><p><a href="https://velog.io/@eungyeole/Velog-%ED%8F%AC%EC%8A%A4%ED%8A%B8%EB%A1%9C-Github%EB%A5%BC-%EA%BE%B8%EB%A9%B0%EB%B3%B4%EC%9E%90">Velog 포스트로 Github를 꾸며보자!</a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=611eec6581d1" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[NestJS] Pagination 처리하기]]></title>
            <link>https://dev-seonghun.medium.com/nestjs-pagination-%EC%B2%98%EB%A6%AC%ED%95%98%EA%B8%B0-62ddf15fe684?source=rss-337b221bda85------2</link>
            <guid isPermaLink="false">https://medium.com/p/62ddf15fe684</guid>
            <category><![CDATA[nest]]></category>
            <category><![CDATA[node]]></category>
            <category><![CDATA[nestjs]]></category>
            <category><![CDATA[typescript]]></category>
            <category><![CDATA[pagination]]></category>
            <dc:creator><![CDATA[Seonghun]]></dc:creator>
            <pubDate>Thu, 23 Mar 2023 09:39:16 GMT</pubDate>
            <atom:updated>2023-04-04T14:22:33.847Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*vFmATfiEozWXLapuWlYGpg.png" /></figure><p>저는 디프만 12기 활동간 편지 서비스, <a href="https://github.com/depromeet/ggogeet_backend/pull/43">꼬깃의 백엔드</a>를 담당하여 서비스를 개발하였습니다. API 개발간에, 활용했던 페이지네이션 처리를 위한 공통 모듈을 개발했던 내용을 간단하게 설명해드리고자 합니다.</p><p>우선 프론트엔드팀에서 페이지네이션 처리를 위해서 원하는 응답 값은 다음과 같은 형식이였습니다.</p><pre>{<br>    data: [],<br>    meta: {<br>      page: 1,<br>      take: 10,<br>      totalCount: 100,<br>      totalPage: 10,<br>      hasNextPage: true,<br>    }<br>}</pre><h3><strong>페이지 요청 처리하기</strong></h3><p>먼저 페이지의 요청을 처리하기 위해서 page는 현재 페이지, take 한번에 가져올 데이터의 수, 마지막으로 skip은 skip한 데이터의 수를 의미합니다. 다음 Enum값을 통해서 기본 값을 지정해주었습니다.</p><pre>export enum PaginationDefault {<br>  PAGE_DEFAULT = 1,<br>  TAKE_DEFAULT = 10,<br>  SKIP_DEFAULT = 0,<br>}</pre><h4>PaginationRequest 클래스</h4><p>다음 PaginationRequest 클래스를 생성해줍니다. PaginationRequest는 페이지 요청을 받기 위해서 사용하는 객체입니다. 일단 요청을 받을 값인 page와 take의 멤버 변수로 구성이 되어 있습니다. 여기서 요청을 받은 값을 메서드를 통해서, 적합한 값으로 변환시켜주어야 합니다.</p><p>저희 서비스는 NestJS+ TypeORM 조합으로 사용하고 있었으며, TypeORM에서는 skip과 take값을 통해 간단하게 페이지네이션 처리가 가능합니다.</p><p><a href="https://orkhan.gitbook.io/typeorm/docs/find-options">Find Options</a></p><p>따라서 getSkip() , getTake() 메서드를 만들어 주었습니다.</p><pre>export class PaginationRequest {<br>  @Type(() =&gt; Number)<br>  @IsOptional()<br>  page?: number = PaginationDefault.PAGE_DEFAULT;<br><br>  @Type(() =&gt; Number)<br>  @IsOptional()<br>  take?: number = PaginationDefault.TAKE_DEFAULT;<br><br>  getSkip() {<br>    return (this.page - 1) * this.take || PaginationDefault.SKIP_DEFAULT;<br>  }<br><br>  getPage() {<br>    return this.page;<br>  }<br><br>  getTake() {<br>    return this.take;<br>  }<br>}</pre><p>이를 서비스 계층의 로직에서 적용해보면 다음과 같이 적용할 수 있습니다.</p><pre>async findAll(pagination: PaginationRequest): {<br>    const [data, count] = await this.noticeRepository.findAndCount({<br>      skip: pagination.getSkip(),<br>      take: pagination.getTake(),<br>    });<br>  }</pre><p>다른, Filter나 정렬이 필요한 경우를 위해서, PaginationRequest 클래스를 상속 받아 적용할 수도 있습니다.</p><pre>export class NoticeFindDto extends PaginationRequest {}</pre><h4>@GetPagination 데코레이터</h4><p>PaginationRequest 클래스를 추가로 상속받아 다양한 처리를 하는 것이 아닌 단순히 Pagination 만 처리하기 위해서 @GetPagination 데코레이터를 추가하였습니다.</p><pre>export const GetPagination = createParamDecorator(<br>  (_data: any, ctx: ExecutionContext) =&gt; {<br>    const request = ctx.switchToHttp().getRequest();<br>    const page = request.query?.page || PaginationDefault.PAGE_DEFAULT;<br>    const take = request.query?.take || PaginationDefault.TAKE_DEFAULT;<br><br>    const pagenationRequest: PaginationRequest = {<br>      page: page,<br>      take: take,<br>      getPage: () =&gt; {<br>        return page;<br>      },<br>      getSkip: () =&gt; {<br>        return (page - 1) * take;<br>      },<br>      getTake: () =&gt; {<br>        return take;<br>      },<br>    };<br><br>    return pagenationRequest;<br>  },<br>);</pre><p>이를 코드에 적용하면 아래와 같습니다.</p><pre> findAll(@GetPagenation() pagenation: PaginationRequest) {<br>    return this.noticeService.findAll(pagenation);<br>  }</pre><h4>페이지 응답 처리하기</h4><p>이제 페이지네이션 요청을 처리하는 것은 완료했으니, 페이지네이션 응답처리가 필요합니다.</p><h4>PaginationBuilder 빌더</h4><p>저는 응답을 처리해주기 위해서 빌더패턴을 활용했습니다. skip, take, totalCount등의 값이 모두 정수이기 때문에 다른 개발자가 실수로 값을 잘못 넣을 수도 있기 때문에, 명시적으로 값을 넣을 수 있는 빌더 패턴을 사용하였습니다.</p><p>우선 실제로 값을 담을 PaginationResponse 클래스를 만들어 줍니다. 타입 스크립트 제너릭을 활용해 data에 값을 넣어줄수 있도록 하였습니다.</p><p>다음 메타데이터에는 위에서 언급했던바와 같이 프론트에서 요청하는 page, take, totalCount, totalPage, hasNextPage 의 멤버변수를 만들어줍니다. 다음 전체 totalPage, hasNextPage 를 계산하는 로직의 메서드를 추가해주었습니다.</p><pre>export class PaginationResponse&lt;T&gt; {<br>  data: T[];<br>  meta: {<br>    page: number;<br>    take: number;<br>    totalCount: number;<br>    totalPage: number;<br>    hasNextPage: boolean;<br>  };<br><br>  constructor(pagenationBuilder: PaginationBuilder&lt;T&gt;) {<br>    this.data = pagenationBuilder._data;<br>    this.meta = {<br>      page: pagenationBuilder._page,<br>      take: pagenationBuilder._take,<br>      totalCount: pagenationBuilder._totalCount,<br>      totalPage: this.getTotalPage(<br>        pagenationBuilder._totalCount,<br>        pagenationBuilder._take,<br>      ),<br>      hasNextPage: this.getHasNextPage(<br>        pagenationBuilder._page,<br>        this.getTotalPage(<br>          pagenationBuilder._totalCount,<br>          pagenationBuilder._take,<br>        ),<br>      ),<br>    };<br>  }<br><br>  private getTotalPage(totalCount: number, take: number): number {<br>    return Math.ceil(totalCount / take);<br>  }<br><br>  private getHasNextPage(page: number, totalPage: number): boolean {<br>    return page &lt; totalPage;<br>  }<br>}</pre><p>다음으로 이 PaginationRequest를 처리하기 위한, PaginationBuilder를 만들어줍니다.</p><pre>export class PaginationBuilder&lt;T&gt; {<br>  _data: T[];<br>  _page: number;<br>  _take: number;<br>  _totalCount: number;<br><br>  setData(data: T[]) {<br>    this._data = data;<br>    return this;<br>  }<br><br>  setPage(page: number) {<br>    this._page = page;<br>    return this;<br>  }<br><br>  setTake(take: number) {<br>    this._take = take;<br>    return this;<br>  }<br><br>  setTotalCount(totalCount: number) {<br>    this._totalCount = totalCount;<br>    return this;<br>  }<br><br>  build() {<br>    return new PaginationResponse(this);<br>  }<br>}</pre><p>이를 PaginationRequest와 PaginationBuilder 를 적용한 코드를 보면 아래와 같습니다.</p><pre>async findAll(<br>    pagenation: PaginationRequest,<br>  ): Promise&lt;PaginationResponse&lt;Notice&gt;&gt; {<br>    const [data, count] = await this.noticeRepository.findAndCount({<br>      skip: pagenation.getSkip(),<br>      take: pagenation.getTake(),<br>    });<br><br>    return new PaginationBuilder()<br>      .setData(data)<br>      .setPage(pagenation.page)<br>      .setTake(pagenation.take)<br>      .setTotalCount(count)<br>      .build();<br>}</pre><h3>페이지 처리 관련 문서화 — Swagger 연동</h3><p>이제 페이지네이션 처리를 완료했으니, 사용하는 Swagger와 연동작업이 필요합니다.</p><h4>@ApiPaginationRequest 데코레이터</h4><p>각각 요청마다 페이지 처리 관련 문서를 작성하기 어려우니, 간단하게 사용이 가능한 데코레이터 형식으로 작업을 진행하였습니다.먼저 PaginationRequest에서 page와 take에 대해 설명을 작성해줍니다.</p><pre>export const ApiPaginationRequst = () =&gt; {<br>  return applyDecorators(<br>    ApiQuery({<br>      name: &#39;page&#39;,<br>      required: false,<br>      type: Number,<br>      description: &#39;페이지 번호&#39;,<br>    }),<br>    ApiQuery({<br>      name: &#39;take&#39;,<br>      required: false,<br>      type: Number,<br>      description: &#39;페이지당 아이템 수&#39;,<br>    }),<br>  );<br>};</pre><p>이 데코레이터를 활용하면 아래와 같습니다.</p><pre>@ApiPaginationRequst()<br> findAll(@GetPagenation() pagenation: PaginationRequest) {<br>    return this.noticeService.findAll(pagenation);<br> }</pre><h4>@ApiPaginationResponse({ResponseDTO}) 데코레이터</h4><p><a href="https://docs.nestjs.com/openapi/operations">Documentation | NestJS - A progressive Node.js framework</a></p><p>Swagger의 공식문서를 참고하여, 데이터 내부의 ResponseDto를 받아, 데이터는 데이터로 메타데이터는 메타데이터로 표현할 수 있도록 schema를 작성해주어야 합니다.</p><p>저희는 제너릭한 타입 model을 받아 이를 배열 형식으로 표현 하므로 properties 의 data 의 type 은 array 형식이 되며, item은 model을 getSchemaPath 를 통해 가져올 수 있도록 해줍니다.</p><pre>export const ApiPaginationResponse = &lt;TModel extends Type&lt;any&gt;&gt;(<br>  model: TModel,<br>) =&gt; {<br>  return applyDecorators(<br>    ApiOkResponse({<br>      schema: {<br>        allOf: [<br>          { $ref: getSchemaPath(PaginationResponse) },<br>          {<br>            properties: {<br>              data: {<br>                type: &#39;array&#39;,<br>                items: { $ref: getSchemaPath(model) },<br>              },<br>            },<br>          },<br>        ],<br>      },<br>    }),<br>    ApiExtraModels(PaginationResponse),<br>    ApiExtraModels(model),<br>  );<br>};</pre><p>이를 적용한 코드는 아래와 같습니다.</p><pre>@ApiPaginationResponse(Notice)<br>findAll(@GetPagenation() pagenation: PaginationRequest){ {<br>    return this.noticeService.findAll(pagenation);<br>  }<br>}</pre><p>해당 PR과 Source Code는 아래에서 확인하실 수 있습니다.</p><p><a href="https://github.com/depromeet/ggogeet_backend/pull/43">Add Pagination Module by seonghun-dev · Pull Request #43 · depromeet/ggogeet_backend</a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=62ddf15fe684" width="1" height="1" alt="">]]></content:encoded>
        </item>
    </channel>
</rss>