fromm 앱에 모듈화 도입하기

들어가며

안녕하세요. 저는 현재 ‘fromm’ 앱에서 iOS 개발을 하고 있는 이하연입니다.

현재 fromm 앱은 Clean Architecture와 MVVM 패턴을 기반으로 만들어져 있습니다.

최근 서비스 규모가 확장 되면서 리팩토링을 진행하게 되었고, 기존 개발 과정에서 겪었던 몇가지 어려움을 해결하기 위해 TCA Architecture와 모듈화를 도입하기로 결정하게 되었습니다. 그래서 이번 글에서는 모듈화를 하는 과정에서 느꼈던 점을 함께 공유하려고 합니다.

AS-IS 분석을 통한 이전 상황 소개

먼저, 서비스를 개발하면서 직면했던 문제점들을 말씀드리겠습니다.

서비스 개발 과정에서 가장 크게 느꼈던 문제점 중 하나는 바로 코드의 길이와 가독성 문제였습니다.

특히 ‘fromm’ 앱에서 채팅 기능을 관리하는 클래스만 봐도 코드는 무려 1170줄에 달하는데요. 이렇게 긴 코드는 가독성을 크게 저해할 뿐만 아니라, 특정 부분을 수정하거나 기능을 추가하려 할 때 전체 코드를 파악하는 데 많은 시간이 소요되어 업무 효율성이 떨어지는 문제가 있습니다.

그 다음으로 느꼈던 문제점은, 의존성 관리의 어려움 문제였습니다.

fromm 서비스가 점점 커지게 되면서, 다양한 컴포넌트나 기능들 사이에 복잡한 의존성이 형성되었습니다. 이 복잡한 의존성으로 인해 한 부분의 변화가 다른 부분에도 미치는 영향을 예측하고 관리하는 것이 점점 어려워지고 있습니다.

마지막으로 느꼈던 문제점은, 빌드 및 컴파일 시간의 문제였습니다.

현재 코드 구조상, A 기능에서 아주 작은 수정이 이루어져도 전체 앱을 빌드해야 하는 상황이 발생합니다.

매번 작은 수정사항마다 전체를 빌드하고 확인해야하는 것은 시간 소모가 크며, 이는 불필요한 시간 낭비를 초래하게 됩니다. 이러한 문제들을 해결하기 위해서는 각 기능별로 독립적인 빌드와 테스트가 가능한 구조로 개선할 필요가 있다고 생각했습니다.

모듈화란?

모듈화란 대규모 프로젝트를 더 작고 관리하기 쉬운 모듈로 나누는 소프트웨어 개발 기술입니다.

각 모듈은 독립적으로 작동하며 특정 기능을 담당하게 됩니다. 이렇게 프로젝트를 여러 모듈로 나누면, 각 모듈은 자체적으로 테스트와 디버깅이 가능하며 독립적으로 업데이트하거나 수정할 수 있습니다.

모듈화 설계 및 구현

모듈화 설계

기존에는 하나의 프로젝트 안에 Application, Domain, Data, Presentation, Common 등 함께 존재하여 관리되고 있었습니다. 이를 모듈화 하기 위해 App, Base, Feature, Data, Core Module 관계를 그려보았습니다.

먼저 App Module은 애플리케이션의 주요 진입점으로, 프로젝트의 전반적인 설정과 초기화 작업을 담당합니다.

현재 fromm 서비스의 경우, 앱 모듈이 fan-app과 arti-app으로 나누어져 있습니다.

Feature Module은 애플리케이션의 각 기능 단위로 구분되어, 특정 기능을 독립적으로 담당합니다.

이 모듈은 주로 두 부분으로 구성되고 있습니다.

• Reducer : 비즈니스 로직과 상태 관리를 담당하는 부분
• Presentation : View와 관련된 작업을 처리하는 부분 ( 주로 ViewController, View 등의 컴포넌트로 구성 )

Data Module은 데이터 관련 작업을 모아놓은 모듈로, 크게 DataModel, Client, Network 세 부분을 담당합니다.

• DataModel

애플리케이션에서 사용되는 모든 데이터 모델을 정의하고 있는 패키지입니다.

대표적으로 API에서 받아온 응답 데이터를 모델링한 Response 모델과 로컬 데이터베이스의 모델 객체를 의미하는 Entity 모델이 포함되어 있습니다.

• Client

모든 클라이언트들의 인터페이스와 그에 대한 기본 구현을 포함하고 있는 패키지입니다.

• NetworkProvider

외부 API 호출에 필요한 Service 인터페이스와 CacheManager를 포함하고 있습니다.

Core Module은 팬앱, 아티앱에서 공통으로 사용하는 UI 컴포넌트 및 리소스 등을 담당합니다.

모듈화 구현

자 이제 인트로 화면에서 로그인 버튼을 누르면 나타나는 “로그인 ID를 입력하는 모듈(Feature 모듈)”을 만들어보겠습니다.

Platform 패키지는 두 앱에서 공통으로 사용하는 모듈들을 포함하고 있습니다.

NetworkProvider 모듈은 외부 API 호출에 필요한 Service 인터페이스와 데이터 캐싱을 관리하는 CacheManager가 존재하며 이를 통해 애플리케이션은 외부 시스템과의 효율적인 통신를 수행할 수 있습니다.

// swift-tools-version: 5.6
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
    name: "Platform",
    platforms: [.iOS(.v14)],
    products: [
        .library(
            name: "NetworkProvider",
            targets: ["NetworkProvider"]),
        .library(
            name: "FrommUI",
            targets: ["FrommUI"])
    ],
    dependencies: [
        ...
    ],
    targets: [
        ...
        .target(
            name: "NetworkProvider",
            dependencies: [
                "Alamofire",
                .product(name: "UserKit", package: "UserKit"),
                .product(name: "CommonKit", package: "CommonKit"),
            ]
        ),
        .target(
            name: "FrommUI",
            dependencies: [
                ...
            ]
        )
    ]
)

Client 패키지에는 인터페이스와 특정 인터페이스의 구현이 각각 구분되어 모듈화 되어있습니다.

AuthClient는 로그인 작업에 필요한 계정 존재 여부를 확인하거나, 비밀번호를 재설정하거나, 로그인하는 등의 작업들을 정의한 인터페이스입니다. AuthClientLive는 AuthClient 인터페이스를 구현한 실제 클래스로, 각 메소드에서 네트워크 요청을 수행하고 그 결과를 처리합니다.

import PackageDescription

let package = Package(
    name: "Client",
    platforms: [.iOS(.v14)],
    products: [
        .library(name: "AuthClient", targets: ["AuthClient"]),
        .library(name: "AuthClientLive", targets: ["AuthClientLive"])
    ],
    dependencies: [
        .package(path: "../../Pacakge/DataModel"),
        .package(path: "../../Pacakge/Platform"),
        .package(url: "https://github.com/pointfreeco/swift-dependencies", from: "1.1.5"),
    ],
    targets: [
        .target(
            name: "AuthClient",
            dependencies: [
                .product(name: "AuthDataModels", package: "DataModel"),
                .product(name: "Dependencies", package: "swift-dependencies"),
                .product(name: "DependenciesMacros", package: "swift-dependencies"),
            ]
        ),
        .target(
            name: "AuthClientLive",
            dependencies: [
                "AuthClient",
                .product(name: "NetworkProvider", package: "Platform"),
            ]
        )
    ]
)

이제 frommArti-app 패키지를 생성한 뒤 만들려고 하는 Feature 모듈(ArtiSignInUsername)을 추가해줍니다. 이 패키지는 로컬 경로에 위치한 ‘Client’, ‘CommonKit’, ‘Platform’ 패키지들과 GitHub에서 가져온 ‘swift-composable-architecture’ 패키지와 의존성을 가지고 있음을 알 수 있습니다.

그리고 4가지 의존성을 지니고 있는 ArtiSignInUsername 모듈을 좀 더 살펴보면, 각 패키지 중에서 이 Feature 모듈에 필요한 AuthClient, CommonKit, ComposableArchitecture, ‘FrommUI’만 의존성을 가지고 있음을 확인할 수 있습니다. 이렇게 의존 관계를 파악하기 수월해졌으며 관리하기 용이해졌습니다.

// swift-tools-version: 5.9
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
    name: "frommArti-app",
    defaultLocalization: "en",
    platforms: [
        .iOS(.v14)
    ],
    
    products: [
        .library(name: "ArtiCoordinator", targets: ["ArtiCoordinator"]),
        .library(name: "ArtiSignInUsername", targets: ["ArtiSignInUsername"])
    ],
    
    dependencies: [
        .package(path: "../../Pacakge/Client"),
        .package(path: "../../Pacakge/CommonKit"),
        .package(path: "../../Pacakge/Platform"),
        .package(url: "https://github.com/pointfreeco/swift-composable-architecture",
                 from: "1.6.0"),
    ],
    
    targets: [
        .target(
            name: "ArtiCoordinator",
            dependencies: [
                "ArtiSignInUsername",
            ]
        ),
        .target(
            name: "ArtiSignInUsername",
            dependencies: [
                .product(name: "AuthClient", package: "Client"),
                .product(name: "CommonKit", package: "CommonKit"),
                .product(name: "ComposableArchitecture", package: "swift-composable-architecture"),
                .product(name: "FrommUI", package: "Platform"),
            ]
        ),
        .testTarget(
            name: "ArtiSignInUsernameTests",
            dependencies: ["ArtiSignInUsername"]
        )
    ]
)

마지막으로 ArtiSignInUsername 모듈의 비즈니스 로직과 View 관련 코드를 작성해주면 됩니다.

import AuthClient
import ComposableArchitecture

public struct SignInUsernameFeature: Reducer {
    public struct State: Equatable { ... }

    public enum Action: BindableAction { ... }

    @Dependency(\.authClient.checkExistAccount) var isExistUser

    public var body: some ReducerOf<Self> { ... }

    private func changeInputState(
        username: String
    ) -> State.InputState { ... }

import Combine
import CommonKit
import ComposableArchitecture
import UIKit

public final class SignInUsernameViewController: UIViewController {
    struct ViewState: Equatable { ... }
    }
    
    enum ViewAction { ... }
    
    let store: StoreOf<SignInUsernameFeature>
    
    let viewStore: ViewStore<ViewState, ViewAction>

    private lazy var layout: SignInUsernameLayout = .init(rootView: view)

    ... 
}

extension SignInUsernameFeature.Action {
    init(action: SignInUsernameViewController.ViewAction) {
        ...
    }
}

만약 ArtiSignInUsername에 변경사항 후 문제가 없는지 확인하고 싶다면 해당 모듈만 빌드할 수 있습니다.

이제 전체 서비스를 빌드하여 기존 인트로 화면에서 ArtiSignInUsername 모듈이 잘 동작되는 지 확인하면 됩니다.

import ArtiSignInUsername

public final class IntroViewController: UIViewController {
        ...
        private func pushToSigninUsername() {
        let vc = SignInUsernameViewController()
        navigationController?.pushViewController(vc, animated: true)
    }
}

모듈화 도입이 가져온 영향과 결론

그렇다면, 이제 ‘fromm’ 앱에서 모듈화 도입을 통한 여러가지 변화를 살펴보겠습니다.

우선, ‘fromm’ 앱의 코드 관리와 개선 작업이 더욱 효과적으로 이루어지게 되었습니다. 각 모듈은 독립적으로 빌드되고 테스트될 수 있어, 특정 모듈의 변경사항이 다른 모듈에 영향을 주지 않습니다. 이로 인해 앱의 안정성이 향상되고, 개별 모듈에 대한 개선 작업이 더욱 수월해졌습니다.

또한, 작은 변경사항 발생 시에도 전체 앱을 빌드할 필요 없이 해당 모듈만 빌드함으로써 컴파일 속도가 크게 향상되었습니다. 이로써 개발 시간을 단축시키고 업무 효율을 크게 향상시켰습니다.

마지막으로, 모듈화를 통해 각 모듈은 자신이 필요로 하는 의존성만을 가지게 되어, 불필요한 의존성의 포함이 방지되었습니다.

이렇게 fromm 앱에 모듈화 도입으로, 개발 과정을 효율적이고 관리하기 쉬운 방향으로 리팩토링 진행중에 있습니다. 아직은 적용 단계이기 때문에 부족한 점이 많지만 조금이나마 도움이 되셨기를 바라면서 이만 글을 마치겠습니다. 끝까지 읽어주셔서 감사합니다.