날씨 앱 [STEP 1] 도라, 밤삭 #28

bamsak · 2023-11-23T06:52:29Z

날씨 앱

리뷰어

팀원:busts_in_silhouette:

프로필 사진
in Github	@bamsak	@KSK9820
in SeSAC	밤삭	도라

프로젝트 파일 구조

├── Extension
│   └── Bundle+Extension.swift
├── Model
│   ├── CurrentWeather.swift
│   ├── NetworkError.swift
│   ├── WeatherURL.swift
│   └── WeeklyWeather.swift
├── Protocol
│   ├── URLFormattable.swift
│   └── URLProtocol.swift
├── Utility
│   ├── NetworkManager.swift
│   └── WeatherURLFormatter.swift
└── ViewController.swift

프로젝트 설명

구현 내용

파싱한 JSON 데이터와 매핑할 모델 설계
- 현재 날씨 DTO CurrentWeather
- 주간 날씨 DTO WeeklyWeather
CodingKeys 프로토콜 활용
API 서버와 통신할 인스턴스 역할을 수행할 타입 구현
- NetworkManager
범용성과 재사용성, 유연성을 고려한 네트워킹 타입 구현
라이브러리 없이 URLSession을 활용하여 구현

각 역할 설명

Protocol

URLProtocol
- 해당 프로토콜을 채택하는 타입이 static 타입 프로퍼티로 url을 변환하기 위한 String 타입을 타입 프로퍼티로 가지고 있게 정의한 프로토콜 입니다.
URLFormattable
- URLFormattable을 채택하는 타입이 URLProtocol을 따르는 타입을 Generic으로 받아(타입 제한) URLProtocol의 static 타입 프로퍼티의 값을 가지고 URL타입으로 변환 시켜주는 역할을 하게 해주는 프로토콜 입니다.
- associatedtype을 사용하여 해당 프로토콜을 채택한 객체의 Generic으로 URLProtocol의 타입을 받아 의존을 객체간 직접 의존이 아닌 Protocol에 의존성을 갖게 했습니다.

Model

NetworkManager
- URLFormatable 프로토콜을 따르는 객체 와 URLSession을 내부 프로퍼티로 갖고 초기화 시점에 의존성 주입을 통해 초기화 하도록 하였습니다.
```
let networkManager = NetworkManager(urlFormatter: WeatherURLFormatter<WeatherURL>())
```
- 위의 방식처럼 초기화 시점에 urlFormatter를 주입해주어 URLProtocol과 URLFormattable을 채택한 타입에 따라 생성되는 URL에 네트워크 통신이 가능하도록 하였습니다.
- NetworkManager 객체를 통해 API와 URLSession으로 통신할 수 있습니다.

Extension

Bundle
- xcconfig 파일을 통해 API KEY를 숨기고 info.plist를 통해 xcconfig 파일에서 정의한 API KEY값에 접근해서 사용할 수 있게 했습니다.

Trouble Shooting

URLFormattable, URLFormatter, URLProtocol

첫번째 구현 방식

struct URLFormatter: URLFormattable {
    typealias T = WeatherURL

    func makeURL(urlType: T, with queryDict: [String: String]) -> URL? {
        let urlString = "\(urlType)"
        var urlComponents = URLComponents(string: urlString)
        let queryItems = queryDict.map {
            URLQueryItem(name: $0.key, value: $0.value)
        }
        urlComponents?.queryItems = queryItems
        return urlComponents?.url
    }
}
let urlFormatter: any URLFormattable = URLFormatter<WeatherURL>()
urlFormatter.makeURL(urlType: .current // 이 부분에서 타입 제약을 주라는 컴파일러의 오류 메세지가 나옴

이렇게 하다보니 WeatherURL에만 국한된 프로토콜로 사용할 수 밖에 없었고.
URLFormattable 프로토콜 타입으로 객체 생성 후, makeURL을 호출했을 시,
파라미터의 urlType을 객체 초기화 시 any URLFormattable 타입으로 만들어지기 때문에 컴파일러가 추론할 수 없는 문제 발생하였습니다.

두번째 구현 방식

protocol URLFormattable {
		func makeURL(path: String, with queries: [String: String]) -> URL?
}

//컴파일러가 인식을 못 하니까 타입을 제네릭으로 줌
struct URLFormatter<T: URLProtocol>: URLFormattable {
    func makeURL(path: String, with queries: [String: String]) -> URL? {
        let urlString = "\(T.url)"	
	var urlComponents = URLComponents(string: urlString)
	urlComponents?.path = "\(path)"
	let queryItems = queries.map {
	      URLQueryItem(name: $0.key, value: $0.value)
	}
	urlComponents?.queryItems = queryItems
	return urlComponents?.url
   }
}

struct WeatherURLFormatter: URLFormattable {
    private let defaultPath: String
    private let formatter: URLFormattable

    init(defaultPath: String = "/data/2.5/",
         formatter: URLFormattable = URLFormatter<WeatherURL>()) {
        self.defaultPath = defaultPath
        self.formatter = formatter
    }

    func makeURL(path: String, with queries: [String : String]) -> URL? {
        let weatherAPIPath = defaultPath + "\(path)"
        return formatter.makeURL(path: weatherAPIPath, with: queries)
    }
}

WeatherURLFormatter객체 내부에 프로퍼티로 URLFormatter객체를 생성하여 만드는 방식으로 변경

최종 구현 방식

protocol URLFormattable {
     associatedtype T: URLProtocol

     var defaultPath: String {get}

     func makeURL(path: String, with queries: [String: String]) -> URL?
 }

extension URLFormattable {
     func makeURL(path: String, with queries: [String: String]) -> URL? {
         let urlString = "\(T.url)"
         var urlComponents = URLComponents(string: urlString)
         urlComponents?.path = "\(defaultPath)\(path)"
         let queryItems = queries.map {
             URLQueryItem(name: $0.key, value: $0.value)
         }
         urlComponents?.queryItems = queryItems
         return urlComponents?.url
     }
 }

struct WeatherURLFormatter<T: URLProtocol>: URLFormattable {
    
    var defaultPath: String
    
    init(defaultPath: String = "/data/2.5/") {
        self.defaultPath = defaultPath
    }
    
}

기존에는 WeatherURLFormatter객체 내부에 URLFormatter라는 객체를 프로퍼티로 가진 후, 해당 프로토콜에 정의된 메소드를 구현 시 URLFormatter 프로퍼티의 메소드를 호출하는 방식으로 구현을 했는데,
makeURL을 protocol의 extension으로 기본 구현하여 associateType을 통해 URLProtocol의 타입 프로퍼티에 접근 가능한 방식을 통하여
URLFormattable프로토콜을 채택한 타입이 Generic을 통해 URLProtocol타입에 대응할 수 있도록 하는 방식으로 변경하였습니다.

궁금한 점

이번 프로젝트가 API 통신인 만큼 Network Test 코드를 작성해 보고싶었습니다.
그리하여 NetworkManager를 채택하는 Protocol을 만들고, URLSession을 상속받는 MockURLSession과 URLSessionDataTask를 상속받는 MockURLSessionDataTask를 만들어 테스트 코드를 작성해보려고 했는데, 두 클래스의 init() 생성자가 iOS 13버전 이후로 deprecated 되었다는 컴파일러의 에러를 확인하였습니다.
다른 방법을 확인해본 결과 URLSession관련 Protocol과 URLSessionDataTask관련 Protocol을 만들어 각각 해당 프로토콜을 따르게 한후, 각각의 Mock을 만들어서 UnitTest를 작성하는 방법을 찾았는데, UnitTest만을 위하여 해당 프로토콜을 만드는 것이 적당한 방법인지 아직 판단이 서질 않습니다.
또한 다른 NetworkManager가 만들어지지 않을 것 같은 판단이 드는데, 이러한 경우에도 NetworkManager가 채택할 Protocol을 구현하여 NetworkManager가 해당 Protocol을 따르게 한 후, 의존 관계를 역전 시켜주는 것이 좋은 지 고민이 됩니다.

…sion을 통한 기본구현메소드로 변경

…r타입으로 변경

… 옵셔널로 변경

zdodev

안녕하세요. @bamsak , @KSK9820 !

날씨 앱 Step1 잘 진행해보셨네요!

모델 타입을 꼼꼼하게 구현하시고,
apikey 보안에 대해서 생각해보신 점이 좋았습니다.👍

먼저 질문에 대한 제 생각을 적어보았습니다.

정답은 없는 것 같습니다. 개인의 생각에 따라 꼭 필요한 프로토콜이 될 수도 있고, 불필요할 수도 있지 않을까 싶습니다.
다만, 네트워크에 의존하지 않는 테스트 코드를 작성하기 위해 프로토콜 정의가 필요하다면 불필요한 작업이 아니라고 생각합니다!
오히려 외부 의존성이 필요한 기능(네트워크, DB, 라이브러리 등)에 직접 의존하지 않고 테스트 할 수 있는 방법을 연구하는 것도 좋을 것 같습니다!
protocol을 사용하여 의존 관계를 역전할 필요는 없다고 생각합니다. 과도한 추상화는 프로그램 복잡도가 증가하고 가독성이 떨어질 수 있어 무조건적으로 사용하는 것은 지양하는 편입니다!

이외에도 여러 궁금증과 코멘트를 남겨보았습니다.
같이 의견 나눠보면 좋을 것 같습니다.😁

zdodev · 2023-11-23T16:02:36Z

WeatherForecast/WeatherForecast/Protocol/URLFormattable.swift

+import Foundation
+
+protocol URLFormattable {
+    associatedtype T: URLProtocol


URLFormattable 타입이 연관값으로 URLProtocol 을 가지게 하였을 때, 어떤 이점이 있을까요?
url과 defaultPath을 별개로 생각하고 서로 각각 재사용하기 위함인지 궁금합니다!

protocol URLFormattable { associatedtype T: APIBaseURLProtocol func makeURL(path: String, with queries: [String: String]) -> URL? } extension URLFormattable { func makeURL(path: String, with queries: [String: String]) -> URL? { let urlString = "\(T.baseURLString)" ...... protocol APIBaseURLProtocol { static var baseURLString: String { get } }

struct WeatherURLFormatter: URLFormattable { typealias T = WeatherURL } enum WeatherURL: APIBaseURLProtocol { static let baseURLString = "https://api.openweathermap.org" .....

현재는 이렇게 수정했습니다!
URLFormattable을 채택하는 타입이 associatedtype의 typealias로 어떤 타입을 가지고 있게 하냐에 따라 URL을 포맷팅 해주는 역할을 프로토콜로 추상화를 통해 구현해보고 싶었습니다.
또한, 현 프로젝트에서는 하나의 API만 쓰이지만,
조금 더 확장성을 생각하여 어떠한 API에도 URL을 포맷팅해주는 역할을 구현해보고 싶었습니다.
그러기 위해 generic을 사용해야 했는데, 프로토콜에서는 associatedtype을 통해 해당 프로토콜이 채택하는 타입이 generic과 유사하게 활용하는 방법을 택했습니다.
Protocol extension을 통해 메소드 기본 구현하는 과정에서 포맷팅할 String 값에 접근하는 방법으로
associatedtype에 APIBaseURLProtocol로 제약을 주었습니다.
이 과정에서 APIBaseURLProtocol를 따르는 객체는 타입프로퍼티로 해당 API의 baseURLString을 가지고 있게하고, URLFormattable extension의 makeURL메소드가 baseURLString값에 접근하여,
URL을 포맷팅해주는 기능을 구현하면 되겠다고 생각했습니다.
defaultPath는 재사용성이 없다고 판단하여 현재는 제거했습니다!

zdodev · 2023-11-23T16:02:42Z

WeatherForecast/WeatherForecast/Protocol/URLFormattable.swift

+protocol URLFormattable {
+    associatedtype T: URLProtocol
+
+    var defaultPath: String {get}


다른 프로토콜과 컨벤션을 맞춰보는 것은 어떨까요?

공백 수정하였습니다!

zdodev · 2023-11-23T16:03:10Z

WeatherForecast/WeatherForecast/Protocol/URLProtocol.swift

+protocol URLProtocol {
+    static var url: String { get }
+}


Swift에서 제공하는 URLProtocol 타입과 이름을 동일하게 지정한 이유가 있을까요?
호스트 주소 url까지 추상화한 이유를 알 수 있을까요?

zdodev · 2023-11-23T16:04:03Z

WeatherForecast/WeatherForecast/Utility/NetworkManager.swift

+        self.session = session
+    }
+
+    func getData<T: Decodable>(path: String, with queries: [String: String], completion: @escaping (Result<T, Error>) -> Void) {


URLSession을 이용하여 네트워크 요청 구문(generic, jsondecoder)을 잘 작성해보셨네요.👍

zdodev · 2023-11-23T16:04:20Z

WeatherForecast/WeatherForecast/Utility/NetworkManager.swift

+                return completion(.failure(NetworkError.unknownError(description: error.localizedDescription)))
+            }
+
+            guard let response = response as? HTTPURLResponse else {return}


다른 guard 문에서 작성한 공백 컨벤션을 맞춰보는 것은 어떨까요?

공백 수정하였습니다~!

zdodev · 2023-11-23T16:05:24Z

WeatherForecast/WeatherForecast/Model/CurrentWeather.swift

+    var coord: Coord?
+    var weather: [Weather]?
+    var base: String?
+    var main: Main?
+    var visibility: Int?
+    var wind: Wind?
+    var clouds: Clouds?
+    var rain: Rain?
+    var snow: Snow?
+    var dt: Int?
+    var sys: Sys?
+    var timezone: Int?
+    var id: Int?
+    var name: String?
+    var cod: Int?


모든 프로퍼티를 옵셔널로 처리하신 이유가 궁금합니다.

STEP1 진행 중이라 어떤 값들이 nil 값으로 들어올지 몰라 모든 프로퍼티를 옵셔널로 처리해두었습니다. 프로젝트 진행하며 확실한 값들은 옵셔널 처리를 하지 않는 방향으로 수정하겠습니다!

zdodev · 2023-11-23T16:05:36Z

WeatherForecast/WeatherForecast/Model/CurrentWeather.swift

+    var lon: Double
+    var lat: Double


API 문서에서 제공하는 단축어를 그대로 사용하기 보다는 전체 단어로 프로퍼티 이름을 지정해보는 것은 어떨까요?
의견이 궁금합니다!

해당 부분 수정했습니다.
이 외의 단축어도 함께 수정하였습니다.

zdodev · 2023-11-23T16:05:53Z

WeatherForecast/WeatherForecast/Model/WeeklyWeather.swift

+
+import Foundation
+
+struct WeeklyWeather: Decodable {


API의 모든 파라미터에 대한 모델을 구현해보셨네요.👍

zdodev · 2023-11-23T16:06:08Z

WeatherForecast/WeatherForecast/Model/NetworkError.swift

+
+import Foundation
+
+enum NetworkError: Error, CustomStringConvertible {


네트워크 에러 타입을 구현해보셨네요.👍

zdodev · 2023-11-23T16:07:54Z

WeatherForecast/WeatherForecast/Model/CurrentWeather.swift

+struct Weather: Decodable {
+    var id: Int?
+    var main: String?
+    var description: String?
+    var icon: String?
+}


모든 모델에 대한 타입이 전역적으로 선언되어 있네요.
Swift Nested Types에 대해서 한번 알아보고 개선해봐도 좋을 것 같습니다.
지금도 좋습니다!

WeeklyWeather, CurrentWeather 각각 따로 사용하는 모델은 Nested Type으로 변경하고,
공통으로 사용하는 모델은 NameSpace로 분리하도록 변경 했습니다!

zdodev

안녕하세요. 도라, 밤삭!

프로젝트를 더 개선해보셨네요. 좋습니다!👍
궁금증에 대한 의견을 달아주신 점도 좋았습니다!

Step1 진행하시느라 고생하셨습니다.
이번 스텝은 여기서 마무리하도록 하겠습니다.🎉

zdodev · 2023-11-26T15:02:26Z

WeatherForecast/WeatherForecast/Model/CurrentWeather.swift

+struct Coordinate: Decodable {
+    var longitude: Double
+    var latitude: Double
+
+    enum CodingKeys: String, CodingKey {
+        case longitude = "lon"
+        case latitude = "lat"
+    }


프로퍼티 이름을 잘 바꿔보셨네요.👍

zdodev · 2023-11-26T15:05:18Z

WeatherForecast/WeatherForecast/Model/CommonWeatherDTO.swift

+
+import Foundation
+
+enum CommonWeatherDTO {


전역적으로 선언된 모델을 모아서 구현해보셨네요.👍

bamsak and others added 21 commits November 20, 2023 10:11

[Config] gitignore초기 설정

9b0c95b

[Feat] open weather API 현재 날씨 모델 DTO 구현

cec943d

[Feat] open weather API 5일 일기 예보 DTO 구현

1b301c0

[Config] gitignore에 config파일 추가

c1e7240

[Feat] API KEY config파일로 숨김처리

ec52a35

[Feat] api key, Bundle extension으로 호출기능 추가

d31b8ae

[Feat] API URL enum으로 분류

2f1c1cf

[Feat] URLComponents를 사용하여 query와 함께 url을 생성해주는 객체 프로토콜로 추상화 하여 구현

371524a

[Feat] URLComponents를 사용하여 query와 함께 url을 생성해주는 객체 프로토콜로 추상화 하여 구현

7e14062

[Refactor] URLFormattable associatedType 제거후, makeURL 파라미터 변경

387f5d9

[Refactor] typealias 방식에서 Generic으로 변경

5930331

[Feat] Open Weather API의 URL생성하는 역할을 할 WeatherURLFormatter 구현

a48aaa6

[Refactor] URLFormatter를 다른 객체 프로퍼티로 가지고 있는 방식에서 URLFormattable exten…

c4e89e3

…sion을 통한 기본구현메소드로 변경

[Chore] WeatherURLFormatter에 typealias제거

837e103

[Feat] enum WeatherURL에 path를 case로 분류하여 리턴하도록 함

eeb340e

[Feat] API 통신하는 NetworkManager 객체 생성

637baea

[Feat] 네트워크 통신 Error를 구분하는 enum 구현

7088789

[Refactor] 알 수 없는 통신 에러 unknownError 케이스 추가

7bde414

[Feat] URLSession으로 통신하는 NetworkManager 구현

a919abe

[Chore] dataTask메소드에 urlRequest로 넘기는 방식으로 변경 및 Result Generic 기본 Erro…

919fd4b

…r타입으로 변경

[Refactor] NetworkError CustomStringConvertible 채택 프로토콜 변경 및 DTO 프로퍼티…

1c35a11

… 옵셔널로 변경

zdodev requested changes Nov 23, 2023

View reviewed changes

bamsak added 3 commits November 24, 2023 12:41

[Chore] DTO 프로퍼티 이름, 단축어에서 원본 단어로 수정

d24f6e8

[Chore] API DTO Nested Type으로 변경 및 공통된 DTO는 NameSpace를 통해 분리

a426c0e

[Refactor] defaultPath제거 및 URLProtocol이름 수정, APIKey String?타입으로 변경

4d9649c

zdodev approved these changes Nov 26, 2023

View reviewed changes

zdodev merged commit 72da202 into tasty-code:2_Bamsak Nov 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

날씨 앱 [STEP 1] 도라, 밤삭 #28

날씨 앱 [STEP 1] 도라, 밤삭 #28

bamsak commented Nov 23, 2023 •

edited

Loading

zdodev left a comment

zdodev Nov 23, 2023

bamsak Nov 24, 2023

zdodev Nov 23, 2023

KSK9820 Nov 24, 2023

zdodev Nov 23, 2023

zdodev Nov 23, 2023

zdodev Nov 23, 2023

KSK9820 Nov 24, 2023

zdodev Nov 23, 2023

KSK9820 Nov 24, 2023

zdodev Nov 23, 2023

KSK9820 Nov 24, 2023

zdodev Nov 23, 2023

zdodev Nov 23, 2023

zdodev Nov 23, 2023

bamsak Nov 24, 2023

zdodev left a comment

zdodev Nov 26, 2023

zdodev Nov 26, 2023


		import Foundation

		enum NetworkError: Error, CustomStringConvertible {

날씨 앱 [STEP 1] 도라, 밤삭 #28

날씨 앱 [STEP 1] 도라, 밤삭 #28

Conversation

bamsak commented Nov 23, 2023 • edited Loading

날씨 앱

리뷰어

팀원:busts_in_silhouette:

프로젝트 파일 구조

프로젝트 설명

구현 내용

각 역할 설명

Protocol

Model

Extension

Trouble Shooting

URLFormattable, URLFormatter, URLProtocol

궁금한 점

zdodev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zdodev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bamsak commented Nov 23, 2023 •

edited

Loading