Router가 뭐하는 친구야?

Router 가 뭐하는 친구?

이번에는 Router 가 뭐하는 친구인지 알아보게쒀요 😙

이 Router 는 네트워크 요청의 앤드포인트, 메서드, 파라미터 등을 정의해서 URLRequest 로 변환하는 역할을 합니다.

 

그럼 왜 URLRequest 가 필요할까요 ?

우리가 서버와 통신을 하기 위해서 ,

우리가 지난번에 사용한 .dataTaskPublisher(for: request) 에 필요한 url 인스턴스를 만들어주기 위함입니다.

 

 

우리가 프로젝트에서 필요한 다양한 네트워크 요청들이 있을텐데,

 

user 와 관련된 네트워크 요청만 봐도

 

유저정보 불러오기, 현재 로그인된 유저정보 불러오기, 최초 로그인시 회원가입한 유저 정보 저장하기, 유저정보 변경하기 등…

 

이렇게 다양한 요청들이 있을겁니다.! 이 모든 요청들을 어떻게 처리해야할까요?

 

 

how?

이런 다양한 케이스들을 UserRouter 에서

필요한 네트워크 요청들을 각각 구조적으로 케이스 별로 정리하기 위해, (GET, POST, PATCH, DELETE)

enum 으로 정의 하여 네트워크 요청 관련 코드를 정리해 놓았습니다.

 

Router 는 네트워크 요청의 앤드포인트, 헤더, 바디, 파라미터등을 정의해서 URLRequest 로 변환하는 역할을 합니다.

 

그럼 어떻게 URLRequest를 만드는지 한번 볼까요?

 

 

그럼 UserRouter 파일을 한번 살펴볼게요!

 

• 먼저 어떤 네트워크 요청인지 케이스를 정의해주어야합니다.

case get(nextPageToken: String)
case post(myFilm: String, bookmarkedMagazineID: String,email: String, myCamera: String, postedCommunityID: String, postedMagazineID: String, likedMagazineId: String, lastSearched: String, bookmarkedCommunityID: String, recentSearch: String, id: String, following: String, myLens : String, profileImage: String, name: String, follower: String, nickName: String, introduce: String, fcmToken : String, blocking: String, blocked: String)
case patchProfile(profileImage: String, nickName: String, introduce: String, docID: String)
case delete(docID: String)

 

• 공통으로 사용되는 baseURL과, 현재 firestore 의 user 컬렉션에 접근하기 위해 info 리스트의 UuidUser 값을 가져와 Path를 저장합니다.

   private var baseURL: URL {
        var baseUrlString : String = "https://"
        if let infolist = Bundle.main.infoDictionary {
            if let url = infolist["FireStore"] as? String {
                baseUrlString += url
            }
        }
        return URL(string: baseUrlString) ?? URL(string: "")!
    }

    // firestore 의 collection 에 접근하기 위한 path 
    private var queryItemString: String {
        var userString : String = ""
        // 보안처리를 위해 path를 infolist 에 저장. 
        if let infolist = Bundle.main.infoDictionary {
            if let str = infolist["UuidUser"] as? String { 
                userString = str
            }
        }
        return userString
    }

 

• 그다음 GET, POST, PATCH, DELETE 와 같은 다양한 HTTP 메서드를 나타내는 열거형을 만들어줍니다.
  • 이 열거형은 각각의 케이스에 따라 value 에 접근해 문자열을 리턴할 수 있습니다.

private enum HTTPMethod {
        case get
        case post
        case patchProfile
        case delete
        
        var value: String {
            switch self {
            case .get: return "GET"
            case .post: return "POST"
            case .patchProfile: return "PATCH"
            case .delete: return "DELETE"
            }
        }
    }

 

• 케이스에 따라 문자열 조합으로 URL 의 EndPoint 를 만들어줍니다.
  • ex ) https://firestore/user/1234 → 파이어스토어의 유저 컬렉션의 documentID 가 1234 인 유저정보

private var endPoint: String {
        switch self {
        case let .patchProfile(_,_,_, docID):
            return "/" + "\(queryItemString)" + "/" + "\(docID)"
        case let .delete(docID: docID):
            return "/" + "\(queryItemString)" + "/" + "\(docID)"
        default:
            return "/" + "\(queryItemString)"
        }
    }

 

 

• URLQueryItem을 사용해서 각각의 URLRequest 에 필요한 파라미터를 저장합니다.
  • URLQueryItem 은 URL 쿼리 문자열에서 특정 매개변수를 나타내는 클래스입니다. URL쿼리 문자열은 URL 의 일부이고, “?” 다음 키 - 값 쌍으로 구성되는 데이터입니다.
  • 파라미터가 여러개 필요할 수 있기때문에 URLQueryItem 배열로 선언해 줍니다.

var parameters: [URLQueryItem]? {
        switch self {
        case let .get(nextPageToken):
            let params: [URLQueryItem] = [URLQueryItem(name: "pageToken", value: nextPageToken)]
            return params
        case let .post(myFilm, bookmarkedMagazineID, email, myCamera, postedCommunityID, postedMagazineID, likedMagazineId, lastSearched, bookmarkedCommunityID, recentSearch, id, following, myLens , profileImage, name, follower, nickName, introduce , fcmToken, blocking, blocked):
            var params: [URLQueryItem] = [URLQueryItem(name: "documentId", value: id)]
            return params
        case let .patchProfile(profileImage, _, _, _):
            let param1 = URLQueryItem(name: "updateMask.fieldPaths", value: "profileImage")
            let param2 = URLQueryItem(name: "updateMask.fieldPaths", value: "nickName")
            let param3 = URLQueryItem(name: "updateMask.fieldPaths", value: "introduce")
            var params: [URLQueryItem] = []
            if profileImage == "" {
                params = [param2, param3]
            } else {
                params = [param1, param2, param3]
            }
            return params
        default :
            let params: [URLQueryItem]? = nil
            return params
        }
    }

http:// kkkk?uid=1234 이런식이죠 !

ex) 어떤 유저가 유저정보를 변경한다고 하면, 어떤 유저인지 id path를 parameter 로 전달해주어야 합니다.

 

• method 프로퍼티는 각 case에 따라 HTTP 메서드를 반환합니다.

private var method: HTTPMethod {
        switch self {
        case .get :
            return .get
        case .post :
            return .post
        case .delete:
            return .delete
        default:
            return .patchString
        }
    }

 

• data 프로퍼티는 각 case 에 따라 API 요청에 대한 데이터를 반환합니다.
  • 이때 UserQuery안에 insertUserQuery와 같은 메서드는 전에 파이어베이스 도입기때 만들어준 StructuredQuery 를 Data 타입으로 변환하여 리턴하는 메서드입니다.

private var data: Data? {
        switch self {
        case let .post(myFilm, bookmarkedMagazineID, email, myCamera, postedCommunityID,postedMagazineID: postedMagazineID,likedMagazineId,lastSearched,bookmarkedCommunityID, recentSearch, id, following,myLens,profileImage,name,follower,nickName, introduce, fcmToken, blocking, blocked):
            return UserQuery.insertUserQuery(myFilm: myFilm,bookmarkedMagazineID: bookmarkedMagazineID,email: email,myCamera: myCamera,postedCommunityID: postedCommunityID, postedMagazineID: postedMagazineID, likedMagazineId: likedMagazineId, lastSearched: lastSearched, bookmarkedCommunityID: bookmarkedCommunityID, recentSearch: recentSearch, id: id, following: following, myLens: myLens, profileImage: profileImage, name: name, follower: follower, nickName: nickName, introduce: introduce, fcmToken: fcmToken, blocking: blocking, blocked: blocked)
        case let .patchProfile(profileImage, nickName, introduce, _):
            return UserQuery.updateUserProfile(profileImage: profileImage, nickName: nickName, introduce: introduce)
        default:
            return nil
        }
    }

 

asURLRequest () **

• 자 마지막으로 , , ! ! asURLRequest 함수를 사용해서 URLRequest 인스턴스를 만들어 리턴해줄겁니다.!

func asURLRequest() throws -> URLRequest {
        let url = baseURL.appendingPathComponent(endPoint)
        
        var component = URLComponents(url: url, resolvingAgainstBaseURL: false)!
        
        if let param = parameters {
            component.queryItems = param
        }
        
        var request = URLRequest(url: component.url!)
        
        request.httpMethod = method.value
        request.addValue("application/json", forHTTPHeaderField: "Content-Type")
        
        if let data = data {
            request.httpBody = data
        }
        
        return request
    }

 

하나 하나 살펴볼게요! 😅

 

1. baseURL 에 endPoint 를 추가해서 URL 인스턴스를 생성합니다.

let url = baseURL.appendingPathComponent(endPoint)

 

2. URL 을 기반으로 URLComponents 인스턴스를 생성합니다.

var component = URLComponents(url: url, resolvingAgainstBaseURL: false)!

 

 

3. parameter 가 nil 이 아닐경우(get 메소드일경우엔 파라미터가 없음) , URLComponent 의 queryItems 속성에 파라미터를 할당합니다.

 if let param = parameters {
            component.queryItems = param
    }

 

 

4. URLRequest 인스턴스를 생성하고. HTTP 메서드와, 헤더 필드를 설정해줍니다.

var request = URLRequest(url: component.url!)
        
request.httpMethod = method.value
request.addValue("application/json", forHTTPHeaderField: "Content-Type")

 

5. data (query) 가 nil 이 아닌 경우에는, HTTP Body 에 데이터를 할당합니다.

if let data = data {
            request.httpBody = data
        }

 

 

6. 생성된 URLRequest 인스턴스를 반환합니다.

return request

 

이렇게 해서 모든 네트워크 작업들에 필요한 URLRequest 를 생성해줄 수 있게 되는겁니다!

 

Why Router?

그런데 왜 이렇게 Router 를 따로 관리하는 걸까요 ?

만약 Router에 URL 관련 코드들을 정리해두지 않았다면 어땠을까요 ?

 

// UserService 
static func getUser(nextPageToken: String) -> AnyPublisher<UserResponse, Error> {
        do {
            // 바로 request 이부분 
            let request = try UserRouter.get(nextPageToken: nextPageToken).asURLRequest()
            return URLSession
                .shared
                .dataTaskPublisher(for: request)
                .map{ $0.data}
                .decode(type: UserResponse.self, decoder: JSONDecoder())
                .eraseToAnyPublisher()
        } catch {
            return Fail(error: HTTPError.requestError).eraseToAnyPublisher()
        }
    }

바로 서비스 파일내에 dataTaskPublisher에 필요한 request(URLRequest) 를 각 메서드마다 선언해주어야 했겠죠 !

 

이 짧은 코드 대신

let request = try UserRouter.get(nextPageToken: nextPageToken).asURLRequest()

 

이렇게 긴 코드를 모든 메서드에 선언해주어야합니다! 😳

let baseURL: = "https://"
let endPoint = "Users"

let url = baseURL.appendingPathComponent(endPoint)
let component = URLComponents(url: url, resolvingAgainstBaseURL: false)!
let request = URLRequest(url: component.url!)
request.httpMethod = "GET"
request.addValue("application/json", forHTTPHeaderField: "Content-Type")

 

Router 를 따로 만들어 주지 않았을때의 대참사…

 

어떤 이득?

그래서 Router 를 따로 빼주었을때 제가 느낀 장점들입니다 🤩

1. 코드의 가독성: Router를 사용하면 네트워크 요청 관련 코드가 구조적으로 정리되어 가독성이 높아집니다. 각 요청이 케이스로 명확하게 정의되어 있어 쉽게 파악할 수 있죠!
2. 재사용성: Router를 사용하면 동일한 엔드포인트와 메서드를 가진 다른 부분에서도 동일한 코드를 재사용할 수 있습니다. 새로운 request를 추가할 때도 새로운 케이스를 추가하기만 하면 되므로 효율적입니다!
3. 오류 방지: 비슷한 작업을 반복하더라도, URL은 토씨하나 틀리면 다 안되기 때문에 ,,,, Router를 사용하면 엔드포인트, 메서드, 매개변수 등을 일관된 방식으로 정의하기 때문에 실수를 방지할 수 있습니다.

 

느낀점

사실 위의 대참사 코드는 처음 제 코드였습니다.. 그러다 알아차렸죠 이건좀 ,,

URL 관련 코드들을 한군데서 예쁘게! 잘! 관리하고 싶었습니다..

또 이렇게 하다보면 잔실수들도 많아질 것 같고, 앱 규모가 커지면서 한눈에 알아보기도 참 별로일것 같았죠!

그래서 많은 자료들을 검색해보고 공부해서 Router 를 따로 만들어서

URLRequest 를 만들어 줄 수 있는 방법을 공부해보고 적용시켜보았습니다: ) 뿌우듯

그때 쪼금 고통이었지만 지금 돌아보면

네트워크 요청 케이스만 한 백개쯤되는 우리팀의 개발 시간을 그래도 20 시간은 단축 시키지 않았을까요 ? 이건 좀 오반가… 쨋든!

여기까지 URLRequest를 만드는 과정과, Router 파일에 대한 고찰,,? 고민? 뭐 암튼 알아보았습니다.

휴 .. 별거아니네요 ^^ 😆

 

 

 

오늘도 해결완~ 🥳