2023년 11월부터 구름톤 유니브 1기 해커톤에서 만난 5명의 팀원과 사이드 프로젝트로 **24절기로 쓰는 일기장: 시즈닝(Seasoning)** 개발을 시작했어요. 프론트엔드 개발 파트로 참여해 약 3개월 동안의 시간 동안 MVP 기능 구현을 마쳤고 3월 초에 서비스를 런칭했습니다. ![Seasoning thumbnail](/posts/refactoring-ahead-atomic-design-and-custom-hooks/seasoning-thumbnail.webp?width=450) > 24개의 절기를 나의 입맛에 맞게, [시즈닝(Seasoning)](https://seasoning.today) 3월 한 달 동안 감사하게도 100명이 넘는 사용자가 서비스를 찾아 주었고, 이에 따라 팀에서는 기존의 기능을 수정하거나 새로운 화면을 추가하는 작업이 빈번했습니다. 감사하게도 인스타그램 홍보와 더불어 외부 홍보 부스를 마련할 기회가 주어졌기 때문에, 신규 사용자 유입을 위해서는 사용성 피드백에 즉각 대응해 최대한 빠르게 수정 사항을 적용해야 했습니다. ## 1. 리팩토링을 결정하기까지 작은 단위의 기능을 여러 화면에 걸쳐 빠르게 추가하는 일이 잦아지자, 기존 프로젝트 구조에서 불편한 점이 다수 느껴졌습니다. 그중 대부분은 이전에 기능을 구현하면서 불편함을 느꼈지만 추후 개선을 다짐하며 넘어갔던 부분들이었습니다. ### 기존 프로젝트 구조 ```js src ├── main.jsx /* 엔트리 포인트 */ ├── index.css // 전역 스타일 시트 ├── assets // 이미지, 폰트, ... ├── ... ├── components // 컴포넌트 → 사용된 페이지를 기준으로 분류 │ ├── common │ ├── feed │ ├── home │ │ ├── FortuneModal.jsx │ │ ├── YearlyContent.jsx │ │ ├── SeasonalContent.jsx │ │ └── ... │ └── ... ├── pages // 페이지 컴포넌트 │ ├── feed │ ├── home │ │ └── HomePage.jsx │ └── ... └── utils // 공통 비즈니스 로직 (API Loader, Routing, ...) ├── api ├── hooks ├── router └── ... ``` 시즈닝은 React로 개발되었고 JavaScript 기반으로 작성되었습니다. 각 페이지 컴포넌트는 `src/pages`에서 화면 기준 디렉토리를 적용해 관리하고 있으며 컴포넌트들 또한 `src/components`에서 사용되는 공통 최상단 페이지를 기준으로 분류했습니다. 컴포넌트나 페이지의 스타일링은 Styled-components로 작성해 내부 로직과 함께 하나의 파일 안에서 보관하도록 했습니다. 그 밖에 라우팅이나 API 요청을 처리하는 로직은 `src/utils` 내에서 관리하도록 했고요. ### 기존 구조의 문제점 **1. 재사용되지 않는 컴포넌트와 기능 추가에 따르는 리소스 낭비** ![Need more things](/posts/refactoring-ahead-atomic-design-and-custom-hooks/need-more-things.webp?width=320) > 하지만 사실 수정해야 하는 페이지는 저게 전부가 아니었습니다… 백엔드 팀에서 업로드된 이미지를 자체적으로 리사이징해 최적화하는 파이프라인을 구축한 후, 프로필 이미지에 대해서만 먼저 테스트 배포를 올리기로 한 적이 있었습니다. 프론트엔드 팀에서 이에 대응해 최적화된 이미지 로딩 시도가 실패하면 원본 이미지를 로딩해야 하는 기능 추가 작업이 주어졌습니다. 이에 따라 프로필 이미지가 사용되는 마이페이지와 친구 피드 페이지 등에서 수정된 프로필 이미지 로직을 일괄적으로 반영해야 했습니다. 하지만 기존의 구조로는 동일한 기능 수정을 컴포넌트가 적용된 페이지 각각에 여러 번 반영해야 하는 불편함이 존재했습니다. ![ContentEditor component 1](/posts/refactoring-ahead-atomic-design-and-custom-hooks/content-editor-component-1.webp) 기존 구조 내에서도 여러 화면에서 동일하게 사용되는 부분을 컴포넌트로 분리해 개발한 부분이 있었습니다. 예시로, 절기 게시글 작성 페이지와 절기 게시글 수정 페이지에서는 기존의 게시글 정보 _(텍스트 컨텐츠, 첨부 이미지, …)_ 를 우선 로딩해 초기 데이터로 제공하는지의 여부를 제외하면, 나머지 폼 데이터 처리와 작성 중인 게시글 컨텐츠를 편집하는 로직은 두 페이지가 거의 같은 코드를 공유하고 있었습니다. ![ContentEditor component 2](/posts/refactoring-ahead-atomic-design-and-custom-hooks/content-editor-component-2.webp) 따라서 공통으로 묶을 수 있는 기능을 `src/components/write/ContentEditor` 컴포넌트로 분리했습니다. 하지만 `ContentEditor` 컴포넌트가 수행하는 기능 중, 어느 부분까지 재사용하도록 분리해야 할지 애매하다고 느꼈습니다. 다시 말해 '컴포넌트의 재사용성'에 관한 보다 일관되고 명확한 기준이 필요했습니다. **2. 한 파일에 혼재된 기능과 뷰** 시즈닝은 Styled-components를 사용해 스타일링을 한 덕분에 각 컴포넌트에 대해서 스타일 오염에 대한 걱정 없이 관리할 수 있었고 JSX 코드상으로도 DOM을 구성하는 각 부분의 역할이 명확하게 드러나 편리했습니다. 대신 하나의 컴포넌트나 페이지 파일의 코드가 너무 길어진다는 단점이 있었습니다. ```jsx // @components/write/ImageSlider.jsx // ... /* 스타일링 */ const Layout = styled.div` ... `; const ImagesContainer = styled.div` ... `; const DotsContainer = styled.div` ... `; // ... const ImageSlider = ({ editable, images, setImages, ... }) => { /* 상태 */ const [activeDotIndex, setActiveDotIndex] = useState(0); const imageScrollRef = useRef(); /* 내부 로직 */ const handleDotClick = (index) => { ... }; const handleImageChange = (index) => { ... }; const handleImageDelete = (index) => { ... }; const handleImageScroll = () => { ... }; /* 컴포넌트 몸체 */ return ( {images.length > 0 && ( {images.map((image, index) => (

...

))} )} ... ); }; export default ImageSlider; ``` > 예시로, 간단한 캐러셀 기능을 제공하는 `ImageSlider` 컴포넌트의 경우 185줄의 코드 중 절반에 이르는 75줄이 스타일링에 관한 부분이었습니다. 더욱 문제를 느꼈던 부분은 어떤 컴포넌트의 스타일과 기능을 두 명의 프론트엔드 개발자가 다른 작업에서 동시에 접근해야 하는 경우였습니다. 기능과 뷰를 부분적으로 나누어 관리할 수 있다면 충돌에 대한 염려를 줄일 수 있는 부분이라고 생각했어요. 그뿐만 아니라 여러 컴포넌트에서 동일한 로직을 공유하는 부분들도 있었습니다. ```jsx // @pages/feed/FeedPage.jsx const FeedPage = () => { const { initialFeedData } = useLoaderData(); const [feedData, setFeedData] = useState(initialFeedData); const [lastFeedItemId, setLastFeedItemId] = useState( initialFeedData.length > 0 ? initialFeedData.at(-1).article.id : null ); // ... const fetchFeedData = async () => { // 마지막에 호출한 아이템의 id를 받아 Infinite Scroll 방식의 Pagination 수행 if (!lastFeedItemId) return; try { const feedResponse = await axios.get( // ... ); } catch (error) { // ... } }; // Intersection Observer API를 활용해 Infinite Scroll 이벤트 처리 const { focusElementRef } = useRefFocusEffect(fetchFeedData, []); return ( ... {feedData.map((data, index) => ( ))}

); }; export default FeedPage; ``` 친구 피드 아이템이나 알림을 제공하는 일부 페이지에서는 API가 페이지네이션 구조로 설계되어 있습니다. 따라서 프론트엔드 팀에서는 초기 데이터를 fetch한 후, 화면의 최하단 부분이 스크롤 되었는지의 여부를 Intersection Observer API를 이용해 감지하고 추가로 필요한 데이터를 다시 fetch하도록 Infinite Scroll 로직을 구현했습니다. 그리고 필요한 페이지들에서 활용하기 쉽게 하기 위해 커스텀 훅으로 분리했습니다. 하지만 지금까지의 프로젝트에서는 위의 예시처럼 누가 봐도 명확하게 역할이 분리되어 있는 로직이 아니라면 대부분은 뷰와 로직이 컴포넌트 내에 얽혀 있는 형태로 존재했습니다. 따라서 컴포넌트가 의존하는 뷰와 로직을 분리할 수 있다면, 공유되는 로직 또한 효율적으로 재사용하도록 개선할 수 있겠다고 생각했습니다. **3. 혼란스러운 스타일링 규칙들** ```jsx // @components/.../SomeComponent.jsx // ... const Layout = styled.div` ... `; const TitleContainer = styled.div` ... `; const OptionBox = styled.div` ... `; const IconWrapper = styled.div` ... `; // Layout? Container? Box? ``` 컴포넌트와 페이지 스타일링에서 일관적인 컨벤션이 필요하다는 것을 예전부터 느껴왔습니다. 필요에 의해 다른 네이밍을 활용하는 것은 좋다고 생각하지만, 300여개의 커밋이 쌓인 단계까지 와서는 일관적인 기준이 꼭 필요하다는 것을 체감했습니다. 두 명의 프론트엔드 개발자가 CSS 속성을 작성하며 암묵적인 기준에 따라 작업했지만, 문서화된 기준이 있었다면 더욱 헷갈리지 않고 참고하며 코드를 작성했을 것이라는 점이 아쉬웠습니다. 전체적으로 리팩토링을 수행하며 지금이라도 이를 명확하게 정리할 필요가 있다고 생각했습니다. --- 현재 프로젝트 구조에서 새로운 기능을 추가하는 데 쓰는 시간적 리소스보다 리팩토링에 드는 리소스가 적게 든다는 생각이 들었고, 주저 없이 프론트엔드 팀 내에서 리팩토링을 제안했습니다. 하지만 모든 부분을 한 번 만에 개선하기는 어렵기에 어떤 것들을 이번 리팩토링에서 먼저 적용할지 꽤 고민했습니다. 1. **재사용할 수 있는 컴포넌트 구조** 2. **재사용할 수 있는 비즈니스 로직의 분리** 결과적으로, 이번 리팩토링에서는 기반이 되는 컴포넌트와 비즈니스 로직의 재사용 가능한 구조를 정리하는 것을 핵심으로 고려하기로 했습니다. 앞으로 개선하거나 추가할 사항들에 영향을 끼치는 중요한 부분이라고 생각했기 때문입니다. 또한 서비스를 구성하는 컴포넌트와 비즈니스 로직을 리팩토링하려면 프로젝트의 세세한 부분까지 수정할 필요가 있으므로, 그 과정에서 일관된 컨벤션을 확립하고 이를 적용해 나가는 것 또한 부차적으로 신경 쓸 수 있겠다고 생각했습니다. ## 2. 아토믹 디자인에 기반한 재사용 가능한 컴포넌트 구조 ![Atomic design concept by Brad Frost](/posts/refactoring-ahead-atomic-design-and-custom-hooks/atomic-design-brad-frost.webp?width=500) > 출처: https://atomicdesign.bradfrost.com/chapter-2/#the-part-and-the-whole > “(번역) 아토믹 디자인이 제공하는 큰 이점 중 하나는 추상적인 것과 구체적인 것 사이를 빠르게 전환할 수 있는 능력입니다.” *- Brad Frost의 원문 중* 아토믹 디자인은 컴포넌트의 결합을 `atom` → `molecule` → `organism` → `template` → `page` 단위로 나누며, 작은 단위의 결합을 통해 큰 단위를 만드는 계층적 모델을 표현하는 방식입니다. '아토믹' 디자인이라는 이름은 이를 제안한 Brad Frost가 컴포넌트가 결합하는 방식을 유기체의 화학적 결합 모델을 끌어와 설명하는 것에서 이름을 붙였다고 합니다. 아토믹 디자인은 여러 계층을 거치며 컴포넌트가 효율적인 형태로 결합되는 멘탈 모델을 제공하지만 계층이 나뉘어 있다고 해서 반드시 선형적으로 수행되어야 하는 프로세스는 아닙니다. 또한 저자가 웹 애플리케이션을 예시로 들고는 있지만 모바일 앱 등 어떤 형태의 디자인 시스템을 구성할 때도 얼마든지 활용할 수 있는 방법이고요. - 참고: [Atomic Design Methology (Brad Frost) (원문)](https://atomicdesign.bradfrost.com/chapter-2/#the-part-and-the-whole) 이 포스트에서는 아토믹 디자인을 너무 자세히 설명하는 대신, 원문을 직접 참고해 보시는 것을 추천드립니다. 그리고 저는 이를 사용하기로 결정한 이유와 도입한 결과에 집중해 설명하려고 합니다. ### 효용성 검토 아토믹 디자인을 프로젝트 개발 초기부터 염두에 두고 있었으나 몇 가지 고민을 해결하지 못한 채 도입을 보류해 왔습니다. 1. 디자인 시스템이 확립되어 있지 않다면 효율적이지 못한 채 구조만 복잡하게 만들 수 있음 2. Molecule과 organism을 나누는 판단 기준이 명확하지 않을 수 있음 시즈닝 개발 초기에는 여러 화면에서 공용되는 컴포넌트 요소가 많지 않았고, 재사용을 통해 얻는 이점보다 아토믹 디자인의 계층 구조에 무리해서 맞추려다 발생하는 리소스 낭비가 더 크지 않을까 하는 염려가 컸습니다. 게다가 아토믹 디자인을 프로젝트에 도입한 사례들을 보면 많은 경우에 molecule과 organism의 애매한 판단 기준을 고민하는 경우가 많았고 한창 개발이 빠르게 이루어져야 하는 시점에서 이런 고민을 더 얹을 필요는 없다고 생각했습니다. 하지만 지금 시점에서는 많은 고민이 해소되었고 이전보다 긍정적으로 아토믹 디자인의 도입을 바라보게 되었습니다. 1. 재사용성에 기반해 적은 코드의 수정으로 여러 화면에 적용 가능 2. Atom부터 단계적으로 적용할 수 있는 테스트 코드 3. 서비스의 규모가 크지 않으면서도 다양한 기능 확장이 예상됨 개발 과정에서 디자인 팀과 지속적으로 디자인 시스템 수정을 거듭하며 현재는 재사용할 수 있는 부분들이 늘어나는 방향으로 많은 수정이 이루어졌습니다. 대부분의 기능을 구현한 시점에서 어떤 부분이 재사용되는지도 비교적 명확하게 드러나기도 했고요. 이에 따라 atom은 물론, molecule과 organism 등 단위를 나누는 데 필요한 논의가 체감할 수 있을 만큼 줄어들었다고 느꼈습니다. 또한 프로젝트를 개발하며 가장 아쉬웠던 점이 Storybook, Jest 등을 이용한 단위 테스트를 적용하지 않은 것이었는데, 아토믹 디자인을 활용한 사례에서 atom부터 단위 테스트를 적용해 차근차근 테스트 커버리지를 높인 사례를 보고 테스트 환경으로의 구축에서 징검다리 역할을 하기 좋은 구조라는 생각이 들었습니다. 컴포넌트 구조를 리팩토링하는 것은 단순히 지금까지의 코드를 수정하는 것을 넘어 프론트엔드 팀이 앞으로 마주할 기능 수정에 대해 준비하는 기회라고 느껴졌습니다. 현재 시즈닝의 기능과 앞으로 추가될 기능을 두고 판단했을 때, 아토믹 디자인에 기반한 구조가 적절한 수단이라고 판단을 내렸고 결론적으로 프로젝트에 채택했습니다. ### Atom ![Atom examples](/posts/refactoring-ahead-atomic-design-and-custom-hooks/atom-example.webp?width=450) - 컴포넌트를 구성하는 가장 작은 단위 - 혼자서는 기능을 수행하기 어려움 - 레이아웃에 관련된 요소는 제외 `Button`, `Image`, `Text` 등 위의 기준에 부합하는 작은 컴포넌트들을 **atom**으로 분류했습니다. 처음부터 atom을 생각나는 대로 떠올리며 분류하는 대신, 여러 화면에 걸쳐 순차적으로 아토믹 디자인을 적용해 가며 위의 기준을 충족하는 공통 컴포넌트를 atom으로 분리했습니다. 초기에는 `Row`, `Column` 등 자주 사용하는 레이아웃 스타일도 atom으로 분류했으나, 레이아웃에 관련된 요소는 디자인 시스템의 일부라고 판단하기 어렵다고 생각해 제외했습니다. 스타일 주입 과정에서도 코드가 너무 길어져 재사용에 대한 이점이 크지 않다고 판단했고요. ### 추가: 스타일을 외부에서 props로 주입하기 컴포넌트가 최대한 재사용되기 위해서는 적용되는 모든 상황을 고려해 기본 인터페이스를 추상화하는 것이 중요했습니다. 특히 atom 요소의 스타일을 결정하는 props 인터페이스에 대해서 많은 고민을 했는데, 이를 포함하는 상위 계층의 컴포넌트들의 인터페이스에도 영향을 주는 요소라고 생각했기 때문입니다. Atom을 적용한 여러 사례를 참고하며 컴포넌트의 형태를 결정하는 요소는 기본값으로 전달하고 컴포넌트를 사용하는 시점에 필요한 스타일을 추가로 주입하도록 하는 패턴을 다수 접했습니다. 이는 납득할 수 있는 좋은 방법이라고 느꼈으나, **"어디까지 주입하게 할 것인가?"** 에 대해서는 시즈닝의 상황에 집중해 고민할 필요가 있다고 생각했습니다. ```jsx // atoms/Text/index.jsx export default function Text({ notoserif, size = 1, weight = 400, color = `#333`, children, ...props }) { return ( {children} ); } ``` ```jsx // molecules/MyFeedItem/index.jsx import Text from '@components/atoms/Text'; // ... export default function MyFeedItem({ articleId, term, year, image, preview }) { return (

{TermsToChinese[term]} {TermsToKorean[term]}

{year}년 ); } ``` 예시로, `Text` 컴포넌트는 `font-size`, `font-weight`, 그리고 `color` 속성을 통해 형태를 결정짓습니다. 아주 가끔은 `line-height` 속성이나 `font-family` 속성이 다르게 정해져야 하는 경우도 있었고요. 따라서 `Text` atom의 기본 속성은 위처럼 정해 놓고, 이를 제외한 속성에서 변경이 필요한 경우는 `style = {{ ... }}`처럼 props로 주입하는 방식이 효과적이라고 느꼈습니다. ### 추가: Styled-components 파일 분리하기 - 참고: [복잡한 Styled-components 구조 개선해 보기 | Velog(@hayoung474)](https://velog.io/@hayoung474/Front-End-복잡한-styled-components-구조-개선해보기) 기존에 Styled-components를 사용해 각 컴포넌트에 독립적인 스타일링을 적용하는 방식은 분명 편리한 점이 있었습니다. 문제는 각 컴포넌트 파일의 길이가 너무 길어지고 뷰(스타일)와 로직을 구분하기 어려웠다는 부분이었어요. 그리고 이를 해결할 만한 좋은 방법을 정리한 포스트를 찾았습니다. ```jsx // SomeComponent/style.js import styled from 'styled-components'; export const Layout = styled.div` ... `; export const Header = styled.header` ... `; // ... ``` ```jsx // SomeComponent/index.jsx import * as S from './style.js'; import OtherComponent from '...'; export default function SomeComponent() { // ... return ( ... ... ); } ``` - `style.js`: 컴포넌트의 스타일 요소 - `index.jsx`: 컴포넌트의 몸체 위 방법처럼 스타일 요소를 별개의 파일로 분리한 후 import해 사용함으로써 길이가 긴 스타일 요소들을 떼어내 한 컴포넌트의 코드 길이가 지나치게 길어지는 것을 방지할 수 있었습니다. JSX 상에서 다른 컴포넌트와 `S` prefix가 붙은 스타일 요소를 구분하기 쉬운 것은 또 하나의 장점이었고요. 아토믹 디자인을 적용하며 컴포넌트별로 디렉토리를 만들었기 때문에, 그 안에서 스타일 요소(`style.js`)를 분리하는 방식은 컴포넌트 파일(`index.jsx`)에서 불러오기에도 직관적이라고 느껴졌습니다. 또한 이후 커스텀 훅을 이용해 로직을 재사용하도록 개선하는 과정에서도 앞서 컴포넌트 파일의 관심사 영역을 분리한 것이 도움이 됐습니다. ### Molecule ![Molecule examples](/posts/refactoring-ahead-atomic-design-and-custom-hooks/molecule-example.webp?width=650) - 고유한 특성을 가지기 시작하는 단위 - _(고유한 실행 컨텍스트 내에서)_ 하나의 기능을 수행하는 컴포넌트 `ArticleHeader`, `NavigationHeader`, `TabBar` 등 고유한 특성을 가지는 단위 컴포넌트들을 **molecule**로 분류했습니다. 또한 molecule을 구성하는 단계에서 자연스럽게 atom을 활용해 조립하듯이 컴포넌트를 구현했습니다. 앞선 아토믹 디자인 도입 사례들을 통해 molecule은 **Single Responsibility Principle** _(단일 책임 원칙)_ 에 의해 '하나의 역할'을 수행하도록 해야 하며 이것이 atom과 molecule을 구분하는 이상적인 기준이라는 내용을 접할 수 있었는데요, 저는 이러한 역할이 **'고유한 실행 컨텍스트'** 내에서 존재해야 설득력이 있다고 생각했습니다. 예시로 `Button` 컴포넌트의 경우, 클릭 이벤트 발생 시 전달한 핸들러 함수가 실행되는 순간 고유의 기능을 수행한다고 본다면 atom과 molecule 중 어떤 것으로 분류할지 헷갈릴 수 있지만, 클릭 이벤트 자체는 특정 컨텍스트와 결부해 수행된다고는 보기 어려웠습니다. 따라서 이러한 애매한 상황들을 구분하기에 쉬워졌습니다. ### 추가: Semantic Tags - 참고: [HTML Semantic Elements | W3Schools (영어 원문)](https://www.w3schools.com/html/html5_semantic_elements.asp) 아토믹 디자인을 통해 컴포넌트 구조를 다시 정리해 나가며, 역할이 뚜렷한 컴포넌트들은 **HTML Semantic Elements** _(이하 semantic tag)_ 를 이용해 명시했습니다. 예시로 `-Carousel`이나 `-List` 등의 컴포넌트는 ul로, `-ListItem`은 li로 명시해 리스트 성격을 갖고 있음을 나타냈습니다. 마찬가지로 `NavigationHeader`나 `ArticleHeader` 등은 header 요소로 명시했습니다. Semantic tag는 SEO _(검색 엔진 최적화)_ 를 위해 활용할 수 있는 방법으로 가장 잘 알려졌지만, 모바일 기기의 브라우저에서 읽기 도구 등이 웹 페이지를 더 잘 표시할 수 있도록 돕는 좋은 방법이기도 합니다. (참고: [Building websites for Safari Reader Mode and other reading apps](https://medium.com/@mandy.michael/building-websites-for-safari-reader-mode-and-other-reading-apps-1562913c86c9)) 이번 서비스에서는 기획상 SEO가 요구되는 부분은 없었으나, 웹 접근성을 향상하는 동시에 화면을 구성하는 요소들의 성격을 명확하게 표현할 수 있는 좋은 방법이라고 생각해서 컴포넌트 작성 시 적극적으로 고려했습니다. ### Organism - 좀 더 복잡한 인터페이스 조각 - Molecule을 내부에 반복적으로 가지는 컴포넌트 - Molecule을 Item으로 가지는 List, Grid - Carousel 복잡한 기존 페이지들을 리팩토링하기에 앞서 꼭 결정하고자 했던 것 중 하나는 **molecule과 organism을 나누는 기준**이었습니다. 그리고 고민 끝에 **내부에 molecule을 반복적으로 포함하고 있는 경우**에 한해서 organism으로 표현하기로 결정했습니다. 시즈닝을 구성하는 각 기존 페이지 대부분은 molecule의 조합으로도 구성할 수 있었고, 굳이 재사용되는 부분이 아니라면 organism까지 나누지 않고 molecule만으로 컴포넌트의 기능을 모두 구현하는 게 효율적이라고 생각했기 때문입니다. ![Organism example by TabBar](/posts/refactoring-ahead-atomic-design-and-custom-hooks/differences-between-molecule-and-organism-example-1-tabbar.webp?width=700) 예시로 위의 `TabBar`는 각 페이지로 전환하는 4개의 `TabBarItem`을 갖고 있지만, 각 `TabBarItem`을 molecule로 만들어 `TabBar`에 포함되도록 하는 대신 스타일 요소로 취급하도록 했습니다. `TabBarItem`이 단순히 Link 역할만 수행할뿐더러, 다른 컴포넌트에서 재사용될 가능성이 작다고 판단했습니다. ![Organism example by FeedItem](/posts/refactoring-ahead-atomic-design-and-custom-hooks/differences-between-molecule-and-organism-example-2-feeditem.webp) 비슷한 예시로, `MyFeedItem`과 `FriendsFeedItem`은 절기 등의 상태 정보를 나타내는 상단 부분만 다르고 이미지를 포함한 콘텐츠 영역은 동일하게 공유하는데요, 따라서 해당 부분을 molecule인 `FeedItem`으로 분리하고 두 상위 컴포넌트에서 활용했습니다. 다만, 내부에 `FeedItem`을 포함하고 있다는 이유만으로 `MyFeedItem`과 `FriendsFeedItem`을 organism으로 분류하기보다는, 세 컴포넌트 모두를 molecule로 분류했습니다. `FeedItem`을 내부에 가지고 있지만 반복적으로 가지고 있지는 않기 때문에, List와 같은 성격의 컴포넌트와는 구분되어야 한다고 생각했습니다. ![Organism example by MenuList](/posts/refactoring-ahead-atomic-design-and-custom-hooks/differences-between-molecule-and-organism-example-3-menulist.webp) 앞선 상황과 다르게, 마이페이지와 계정 설정 페이지 등에서 사용되는 `MenuList`는 `MenuListItem`을 내부에 반복적으로 포함하고 있는 형태입니다. `MenuListItem`은 클릭 시 다른 페이지로 넘어가거나 특정 액션을 수행하는 등 기능을 `type` props에 따라 다르게 수행하도록 할 필요가 있었고 재사용성을 고려해 molecule로 구현했습니다. 이에 따라 내부에 molecule을 포함하고 있는 컴포넌트인 `MenuList`는 organism으로 구현해 아토믹 디자인 구조상에서 좀 더 복잡한 상위 인터페이스라는 점을 명확히 구분하고자 했어요. 이렇게 molecule과 organism을 구분하는 과정에서 더 복잡한 인터페이스를 판단하는 기준을 **반복적인 내부 컴포넌트를 가지고 있는 경우**로만 한정하며, 의사 결정이 훨신 쉬워졌습니다. ### 추가: 컴포넌트 네이밍 컴포넌트의 이름을 정하는 경우 '사용되는 용도'와 '컴포넌트의 형태'를 결합한 이름으로 고려했으며, 최대한 혼동하는 경우를 줄이고자 보편적으로 사용되는 용어 위주로 정리했습니다. 최대한 약속된 이름을 사용하는 것이 컴포넌트의 역할을 명확히 나타내는 방법이라고 생각했습니다. ![Component naming example by Carousel](/posts/refactoring-ahead-atomic-design-and-custom-hooks/component-naming-example-carousel.webp) 예를 들면 위의 화면에서 이미지를 가로로 스와이프할 수 있도록 하고 현재 표시되는 이미지의 순서를 인디케이터로 나타내는 컴포넌트는 기존에 `ImageSlider`라는 이름으로 불렀지만, 아토믹 디자인을 적용하며 `Carousel`이라는 이름을 사용하도록 변경했습니다. 이 부분에서는 [Apple Human Interface Guideline (HIG)](https://developer-rno.apple.com/design/human-interface-guidelines/components/all-components)에 제시된 기본 컴포넌트들의 이름을 다수 참고했습니다. ### Template ![Template examples](/posts/refactoring-ahead-atomic-design-and-custom-hooks/template-page-example.webp) - 레이아웃 배치만을 위한 단위 - 하나의 page는 라우팅 기준 (최소) 하나의 template을 내부에 포함 - 상태 관리 등 비즈니스 로직은 일괄 제외 페이지의 내용을 그리는 데 필요한 레이아웃과 스타일을 배치하고 조립하기 위해 **template** 내에서 앞서 구현한 atom과 molecule, organism을 호출했습니다. 최상위 인터페이스인 page 하위에 template을 분리해 컴포넌트를 배치하는 구조는 주입되는 데이터에 대해 다양하게 존재할 수 있는 케이스를 고려하고 하위 계층의 컴포넌트를 다시 수정할 수 있는 기회를 돕습니다. Template과 page는 특정 페이지에 해당하는 내용만을 표현하기 위해 사용되는 단위이므로 대부분의 상황에서 1대 1로 대응된다는 특성이 있습니다. 단, '홈' 페이지의 `/home?category=year`처럼 Search Parameter에 따라 다르게 렌더링되는 영역이 존재하는 경우에는 template을 중첩해 1:N 관계로 표현했어요. ### 추가: HoC 패턴으로 공통 바깥 레이아웃을 분리 ![Higher order components pattern examples](/posts/refactoring-ahead-atomic-design-and-custom-hooks/template-using-hoc-pattern.webp) 친구 목록 페이지나 계정 설정 페이지처럼 하나의 뎁스를 추가해서 진입하는 경우 위처럼 Navigation Layout을 사용하는데요, 1대 1로 대응되는 template의 특성을 유지하면서도 겹치는 코드를 줄일 필요가 있었습니다. 하지만 동일한 원리를 적용해 모달의 공통 바깥 레이아웃 영역을 template으로 분리하도록 하면 하위 계층인 molecule에 해당하는 컴포넌트에서 상위 계층인 template을 포함하는 코드가 되고, 이는 의존성이 역전된 구조라고 생각했습니다. ```jsx // hoc/withNavigation/index.jsx import * as S from './style'; import NavigationHeader from '@components/molecules/NavigationHeader'; export default function withNavigation( navigationTitle = 'Empty Title', WrappedContent, CustomBackButton ) { return (props) => { return ( ); }; } ``` ```jsx // templates/NoticeTemplate/index.jsx // ... import withNavigation from '@components/hoc/withNavigation'; function NoticeTemplate({ noticeData }) { return ( { /* ... */ } ); } export default withNavigation('공지사항', NoticeTemplate); // 함께 감싸서 export ``` 따라서 이런 경우 HoC(Higher-order Component) 패턴을 사용해 `hoc/withNavigation`으로 공통 레이아웃 영역을 분리한 후, template 내에서 함께 export해서 사용했습니다. 모달의 경우도 레이아웃의 바깥 영역을 공통으로 사용했기 때문에 동일한 패턴으로 `hoc/withModalBackground`로 모달을 감싸는 배경 레이아웃과 클릭 이벤트를 처리하는 함수 등을 분리해 활용했습니다. ### Page - 최종적으로 표현되는 UI를 완성하는 단위 - 컨텐츠, 컨텍스트, 비즈니스 로직을 Template에 주입 하나의 페이지에 대응되는 인터페이스 조각들을 template에서 지정했다면, **page**에서는 해당 페이지에 필요한 실제 데이터, 상태 등을 관리하고 template에 주입하도록 했습니다. 또한 전달 과정에서는 React의 Context API를 사용해 페이지 별 전역 context를 활용했습니다. *(Context 부분은 아래에서 한 번 더 다루려고 합니다.)* ### 아토믹 디자인 적용 후 개선된 프로젝트 구조 ```js src ├── main.jsx ├── index.css ├── assets ├── ... ├── components // 컴포넌트: 아토믹 디자인에 기반해 atom, molecule, organism, template을 분류 │ ├── atoms │ ├── molecules │ ├── organisms │ ├── templates │ └── hoc ├── pages // 페이지 컴포넌트: 아토믹 디자인 기반 page를 분류 │ ├── feed │ ├── home │ └── ... └── utils ├── api ├── hooks ├── router └── ... ``` 하루 1~2시간의 시간을 들여 꾸준히 아토믹 디자인을 적용해 나간 지 한 달 반여 만에 PR을 올릴 수 있었습니다. 결과적으로 아토믹 디자인을 적용하기 전에 비해 컴포넌트의 디렉토리 구조가 훨씬 보기 쉬워졌습니다. 물론 보기 쉬운 것보다 더 와닿은 장점들이 많았습니다. 마침 아토믹 디자인 적용 작업이 완료되고 나서 바로 기능 추가 요청이 있었습니다. 매 절기 기록장이 열릴 때마다 전송했던 '절기 알림' 기능을 뉴스레터 메일에서 카카오 친구 채널톡으로 변경하기로 하고, 서비스 내에 카카오 채널 친구 추가를 유도하는 팝업과 페이지를 추가하기로 했습니다. 이에 따른 수정 작업은 정말 오래 걸리지 않았습니다. 네비게이션 타이틀을 사용하는 페이지였기 때문에 `hoc/withNavigation`으로 감싸 주었고, 설정 메뉴 리스트를 제공하기 위해 `organisms/MenuList`에 필요한 데이터를 주입하는 것으로 마무리할 수 있었습니다. 새로 추가해야 하는 페이지와 기능이 간단한 이유도 있었겠지만, 적어도 이전에 비해 이미 디자인 시스템 안에 있는 컴포넌트를 활용하는 작업이 놀라울 정도로 직관적이라는 사실을 체감했습니다. ## 3. 커스텀 훅을 이용한 재사용 가능한 비즈니스 로직의 분리 - 참고: [Hook의 개요 | React Documentation (legacy)](https://ko.legacy.reactjs.org/docs/hooks-intro.html) React 16.8 버전과 함께 Hooks가 등장하며 React에서 컴포넌트를 작성하는 패러다임이 크게 바뀐 적이 있었습니다. 기존에는 클래스형 컴포넌트만을 통해서 컴포넌트의 생명 주기를 다룰 수 있었기 때문에 함수형 컴포넌트의 용도는 단순한 UI를 표현하는 정도로 제한되었습니다. 하지만 Hooks의 등장으로 함수형 컴포넌트를 이용해 생명 주기를 포함한 상태 관리 로직을 쉽게 구현할 수 있게 됐습니다. 가장 중요한 포인트는 컴포넌트 내의 기능을 생명 주기가 아닌, 비슷한 기능을 수행하는 로직을 기준으로 추상화할 수 있게 되었으므로 로직을 분리하는 것이 훨씬 자연스러워졌다는 점입니다. ### 관심사의 분리 왜 로직을 분리하는 것이 좋을까요? 이는 컴퓨터 과학의 소프트웨어 설계 원칙 중 하나인 **관심사의 분리**_(Separation of Concerns)_ 에 기반합니다. ![Separation of concerns example by higher order components](/posts/refactoring-ahead-atomic-design-and-custom-hooks/separation-of-concerns-example-hoc.webp?width=550) 위의 회원 가입 폼을 예시로 들어 보면, 유저가 입력하는 정보는 닉네임 · 이메일 · 비밀번호가 있으며 React에서는 각 값에 대응하는 `` 필드의 이벤트를 핸들링하는 함수가 필요합니다. 만약 비밀번호가 지켜야 하는 규칙이 존재한다면 이를 검증하는 로직도 필요할 거고요. 또 마지막에 이러한 데이터들을 모아 FormData를 전송하는 함수도 필요합니다. 예시에서는 아주 기본적인 회원 정보만을 포함했지만, 만약 동일한 페이지에서 프로필 사진을 설정하는 기능이 추가된다면 해당 코드는 기존 회원 가입 폼에 대한 코드와 함께 존재할 것입니다. 이렇듯 더 많은 기능이 존재할수록 코드의 특정 부분만을 수정하는 작업은 복잡해질 것임이 틀림없습니다. 만약 페이지 컴포넌트 내에서 비슷한 내용을 처리하는 로직이 서로 구분되어 있다면 어떨까요? 회원 가입 폼의 비밀번호 필드에 대한 규칙을 수정한다고 해도, 프로필 사진을 관리하는 부분은 영향을 받지 않을 것입니다. 또한 프로필 사진을 관리하는 동일한 코드가 다른 페이지에서도 사용된다면 이를 재사용하기 위해서 분리하는 것은 더욱 자연스럽게 다가옵니다. 16.8 버전 이전 React에서 주로 사용했던 클래스형 컴포넌트는 로직을 재사용하기에는 적절치 않은 구조였습니다. 컴포넌트 사이에서 공유하는 로직을 사용하기 위해서는 컴포넌트를 입력받아 다른 컴포넌트를 반환하는 HoC 패턴 등을 강제적으로 사용해야 했습니다. ```jsx // withFormHandler.js function withFormHandler(WrappedComponent) { return class extends Component { state = { username: '', email: '' }; handleInputChange = (event) => { ... }; handleSubmit = (event) => { ... }; render() { return ( ); } }; } ``` ```jsx // SignUpForm.js import withFormHandler from '...'; class SignUpForm extends React.Component { render() { const { formData, handleInputChange, handleSubmit } = this.props; return (