[Team-18] Eddy & Kai 프로젝트 설계 및 네트워크, 모델 구현

[TaeKyeongKim]

안녕하세요, 두두! Eddy, Kai 입니다. 2주간 잘 부탁드립니다 :)

🧑🏼‍💻 작업 목록

• Project 설계
• Git Convetion 정립
• Github action 테스트 자동화 구현
• Product , Product Detail Model 구현
• Network Layer 구현
• NetworkManagerTests 테스트 케이스 구현
• ProductdecodingTest, ProductdecodingDetailTest 테스트 케이스 구현

💭 학습 키워드

• CocoaPods
• Github Action
• Swift Lint
• AlamoFire
• Custom operator
• CodingKeys
• NSDecimalNumber

안녕하세요, 두두! Eddy, Kai 입니다. 2주간 잘 부탁드리겠습니다 :)

🤔 고민과 해결

• 돈에 관련된 연산을 double 이나 int 로 수행할시 소수점 값에 올림이나 내림 값이 있다면 정확한 연산이 안되므로, Money 라는 커스텀 타입의 Value 를 decimal 로 설정하여 구현 하였습니다.

💬 설계도

💬 부연 설명

• 프로젝트 파일 및 설정 파일은 미리 Merge하여 PR에서 제외하였습니다.
• 2주간 모든 기능을 구현하기보다는, 네트워킹, 코드 품질 , 설계 이렇게 3가지 요소를 집중적으로 깊게 학습하려고 합니다.

1.0 네트워킹

• 재사용할 수 있는 네트워킹 모듈 설계
• 이미지 다운로드/캐싱
• OAuth

2.0 코드 품질:

• 테스터블한 코드 작성
• 단위 테스트 자동화
• 예외 처리 및 에러 메시지 작성

3.0 설계

• MVVM
• 객체 간 커뮤니케이션 패턴

[mienne]

안녕하세요. 리뷰를 담당하게 된 두두라고 합니다🙂

제가 남기는 내용이 꼭 정답이 아니기 때문에 다르거나 틀리다고 생각하는 내용은 언제든지 의견 주세요!
아래 내용을 참고하여 리뷰 코멘트가 어떤 타입인지 참고해주시면 좋을거 같아요🙂

💭 > 이름 등 맞지 않거나 개인적인 의견
💯 > 칭찬
🔧 > 가급적 수정 되어야 할 내용
🚨 > 코드 스타일 관련 내용

[mienne]

💯 작성하신 내용 중에서 Money Primitive Type이 아니라 ValueObject으로 잘 사용하셨습니다👍

[mienne]

수고하셨습니다. 언제든지 의견 있으시면 코멘트 남겨주세요👍

[mienne]

🔧 NSDecimalNumber 확장하여 wonFormat 부분과 동일한 로직이네요!

[TaeKyeongKim]

앗.. 이부분 지웠었는데 저희 Xcode프로젝트가 꼬여서 한번 revert 하고 다시 확인했어야하는부분인데 놓쳤네요. ㅜㅠ

[mienne]

💭 NumberFormatter 많은 기능이 있습니다. 아래 작성한 부분이 요구사항과 맞지 않지만, 다른 글로벌 서비스에서 통화 표시 해야 할 때 아래와 같이 활용할 수 있습니다. NumberFormatter 실제로 많이 사용하기 때문에 어떤 것이 있는지 시간 있다면 학습해보세요!🙂

let formatter = NumberFormatter()
formatter.numberStyle = .currency
formatter.locale = Locale(identifier: "ko_KR") or Locale.current
formatter.string(for: 10000)

[TaeKyeongKim]

넵 한번 학습해보겠습니다 :)

[mienne]

💭

1. enum, OSLog 사용하기로 했다면 로깅 기능을 더 강조하여 어떤 함수에서, 몇 번째 라인을 호출하였는지 추가적으로 OSLog에서 제공하는 기능을 활용하여 아래와 같이 설계 해볼 수 있을거 같아요.
2. 새로운 프레임워크나 API 사용할 때 어떤 것을 제공하는지 문서 한번씩 읽어보는 습관을 가지면 좋아요🙂

enum LogCategory: String {
    case main = "Main"
    case networking = "Networking"
}

func logMessage(
    function: String = #function,
    file: String = #file,
    line: Int = #line,
    _ category: LogCategory = .main,
    _ type: OSLogType = .default,
    _ message: String
) {
    os_log(
        "[%{public}@/%{public}@:%{public}@] %{public}@",
        log: OSLog(subsystem: "side.dish", category: category.rawValue),
        type: type, (file as NSString).lastPathComponent,
        function, "\(line)",
        message
    )
}

[TaeKyeongKim]

오호 엄청 세밀한 기능도 가지고 있네욥~! 몇번째 라인까지 호출해주다니 ㅎㅎ
예제로 주신 코드를 살펴봤는데 새로운 표현법? 도 몇가지 보이는데 한번 알아봐야겠네요~! 좋은정보 감사합니다 :)

function: String = #function, 
 _ category: LogCategory = .main

[BumgeunSong]

오 이런 고급진 로깅이 가능하군요..!

[mienne]

🚨 실패 가능한 생성자(init?) 활용하여 Money 내에서 로직을 처리할 수 있습니다. 이 부분은 굳이 고치지 않아도 괜찮아요. 참고만해주세요🙂

struct Money {
    
    var value : Decimal
    
    init(_ input: String) {
        self.value = Decimal(string: input.components(separatedBy: [",","원"]).joined()) ?? 0.0
    }
    
    init?(_ input: String?) {
        guard let input = input else { return nil }
        self.init(input)
    }
    
    // ...
}

[mienne]

💭 상수가 아닌 변수로 선언한 목적이 무엇일까요?

[TaeKyeongKim]

이부분은 제가 무지하게 프로퍼티 를 만든것같습니다 ㅜㅠ

[mienne]

💭 NetworkManager 구조체로 사용하신 이유가 무엇일까요?

[BumgeunSong]

저는 class를 특별히 쓸 이유가 없으면, 일단은 struct로 만들고 시작하려고 합니다. Stack allocation의 효율성이나 Immutable하다는 장점이 있어서요! 이 경우도 아직까지는 딱히 class를 써야하는 이유가 보이지 않아서 struct로 시작했습니다.

[mienne]

🔧 catch 문에서도 로그 처리 뿐만 아니라 completion 호출해야 합니다🙂

[mienne]

💭 NetworkManager 객체를 CategoryManager 내부에서 생성하는 것이 아니라 CategoryManager 생성하는 시점에서 �생성자 주입을 통해서 처리할 수 없을까요?

[BumgeunSong]

아직은 모델부분 밖에 구현이 되지 않은 상태라, 전체 뷰까지의 입출력 흐름이 완성되면 그때 추상화와 의존성 주입을 적용해보려고 합니다!

[mienne]

🔧일반적으로 API 응답 성공, 실패 등 재시도나 에러 페이지, 로딩 인디케이터 숨김 등 상황에 따라 UI 분기 처리하기 때문에 API 성공, 실패 상관없이 UI 요소(로딩 인디케이터 등)가 있다면 탈출 클로저 항상 호출하는 습관을 가져주세요!

지금 코드만 봤을 때 화면에서 성공, 실패에 따라 화면에서 별도로 처리하지 않기 때문에 호출하지 않아도 되나 위 내용은 꼭 기억하시길 바랍니다🙂

[BumgeunSong]

그러네요! 탈출 클로저 호출 잊지 않도록 하겠습니다. 감사합니다 🙏

[mienne]

💭 테스트 코드에서 API 호출하는 함수가 많지 않기 때문에 현재 상황에서 wait 함수 사용해도 괜찮으나, 만약 API 호출하는 함수가 100개, 1000개 넘어가는 상황에서 모두 테스트 해야 한다면 어떻게 될까요? 실제 네트워크 호출하지 않고 테스트 할 수 있는 방법은 없을까요?

[BumgeunSong]

찾아보니 Network 요청하는 객체 (URLSession)에 mock을 추가해서 서버 응답 데이터와 비슷하게 주도록 하는 방법이 있는 거 같습니다. mock, stub을 만드는 방법 항상 알고 싶었던 부분인데 좀 더 공부해볼게요!

[mienne]

💭 이 부분은 요구사항을 많이 벗어나는 이야기입니다. 어떠한 의도로 코멘트 남기는지 먼저 밝혀요. Money 라는 객체로 설계 하셨고, 내용 작성할 때도 설계 많이 염두하신거 같아서 이러한 방법으로도 설계 할 수 있다는 의미로 코멘트 남겨요. 오해없으시길 바랍니다!

NumberFormatter 제공하는 통화를 사용할 수 있지만, Money 객체를 Custom 하게 사용하는 경우가 많아서 원 으로 하드코딩으로 가지지 않고 설계 확장할 수 있습니다. 객체 설계할 때 하드코딩 최대한 하지 않고 어떻게 하면 확장 가능한 설계가 할 수 있을지 생각해보고 프로젝트 진행하면서 많이 연습해보세요!!🙂

protocol CurrencyType {

    static var code: String { get }
    static var symbol: String { get }
    static var name: String { get }
}

enum KRW: CurrencyType {

    static var code: String { return "KOR" }
    static var symbol: String { return "원" }
    static var name: String { return "Won" }
}

enum USD: CurrencyType {

    static var code: String { return "USD" }
    static var symbol: String { return "$" }
    static var name: String { return "US Dollar" }
}

struct Money<C: CurrencyType> {

    typealias C = CurrencyType

    var amount: Decimal
    
    var amountFormatter: String {
        "\(amount)\(C.symbol)"
    }

    init(_ amount: Decimal) {
        self.amount = amount
    }
}

let usdMoney = Money<USD>(amount: 1000)
let korMoney = Money<KRW>(amount: 1000) 

[TaeKyeongKim]

와... 원 하드코딩한 부분이 계속 신경 쓰였는데 보여주신대로 Currency 프로토콜 과 Money 를 제네릭하게 사용하면 나중에 확장도 쉽고 이해하기도 훨신 쉬워질것같아요! 이 부분은 꼭 참고해서 반영하도록 해야할것같아요. 감사합니다 :)

[mienne]

제네릭 타입을 사용하지 않더라고 enum으로 타입을 정의하고 Money 생성자를 통하서 셋팅할 수 있습니다. 이 두 개의 차이점이 무엇인지 생각해보세요..! 단 프로젝트
진행 방해되지 않을 선에서만 생각을👀

[BumgeunSong]

크으.. 예시코드까지! 최고입니다 👍