Network [#55] BaseURL 설정 및 네트워크 세팅 #56

Heyjooo · 2024-01-14T05:06:02Z

👻 PULL REQUEST

💻 작업한 내용

Info 설정
Config 파일 구현
Nerwork Error 파일 구현
BaseResponse 생성

💡 참고사항

Config 파일을 아래와 같이 작성해주었습니다. 사용할 때는 Config.baseURL 과 같이 사용하시면 됩니다 !

Don-tBe-iOS/DontBe-iOS/DontBe-iOS/Network/Foundation/Config.swift

Lines 10 to 40 in 274dc86

    
           enum Config { 
        
               enum Keys { 
        
                   enum Plist { 
        
                       static let nativeAppKey = "NATIVE_APP_KEY" 
        
                       static let baseURL = "BASE_URL" 
        
                   } 
        
               } 
        
               private static let infoDictionary: [String: Any] = { 
        
                   guard let dictionary = Bundle.main.infoDictionary else { 
        
                       fatalError("plist cannot found.") 
        
                   } 
        
                   return dictionary 
        
               }() 
        
           } 
        
           extension Config { 
        
               static let nativeAppKey: String = { 
        
                   guard let key = Config.infoDictionary[Keys.Plist.nativeAppKey] as? String else { 
        
                       fatalError("Base URL is not set in plist for this configuration") 
        
                   } 
        
                   return key 
        
               }() 
        
               static let baseURL: String = { 
        
                   guard let key = Config.infoDictionary[Keys.Plist.baseURL] as? String else { 
        
                       fatalError("Base URL is not set in plist for this configuration") 
        
                   } 
        
                   return key 
        
               }() 
        
           }

서버명세서에 적혀있는 status code �토대로 Network error를 작성해주었습니다.
https://github.com/TeamDon-tBe/Don-tBe-iOS/blob/274dc865c024d09fd0c019bbfdc195c6b1abd180/DontBe-iOS/DontBe-iOS/Network/Foundation/NetworkError.swift#L10-L29C2

공통적으로 쓰이는 response 부분을 base response로 묶어주었습니다.

Don-tBe-iOS/DontBe-iOS/DontBe-iOS/Network/Foundation/BaseResponse.swift

Lines 10 to 15 in 274dc86

    
           struct BaseResponse<T: Decodable>: Decodable { 
        
               let status: Int 
        
               let success: Bool 
        
               let message: String 
        
               let data: T? 
        
           }

📟 관련 이슈

Resolved: [Network] BaseURL 설정 및 네트워크 세팅 #55

github-actions · 2024-01-14T05:06:22Z

DontBe-iOS/DontBe-iOS.xcodeproj/project.pbxproj

 				2AC9FB1B2B4DE77400D31071 /* AgreementListCustomView.swift in Sources */,
 				2F17418A2B500CC20089FC4D /* HomeBottomsheetView.swift in Sources */,
 				3C01692A2B4DC82D0075334B /* DontBePopupView.swift in Sources */,
 				2A2671FF2B4C3AF0009D214F /* Publisher+UIControl.swift in Sources */,
 				3C4993672B4F2644002A99CF /* MyPageContentViewController.swift in Sources */,
 				3CEE4CC22B503F9E00F506AF /* DontBeCustomInfoView.swift in Sources */,
+				2A2845402B531F0A0023F9B5 /* BaseResponse.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};


해당 코드 패치에는 다음과 같은 변경 사항이 있습니다:

파일 추가:

SocialLoginService.swift, BaseResponse.swift, SocialLoginResponseDTO.swift, SocialLoginRequestDTO.swift 파일이 소스에 추가되었습니다.

그룹 추가:

SocialLogin 그룹이 Network 그룹 안에 추가되었습니다.

DTO와 Service 그룹이 SocialLogin 그룹 안에 추가되었습니다.

수정 사항 및 개선 제안은 제공하지 않았습니다.

github-actions · 2024-01-14T05:06:37Z

DontBe-iOS/DontBe-iOS/Application/AppDelegate.swift

@@ -20,7 +20,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
            NSAttributedString.Key.foregroundColor: UIColor.donBlack
        ] 

-        KakaoSDK.initSDK(appKey: Bundle.main.object(forInfoDictionaryKey: Config.Keys.Plist.nativeAppKey) as? String ?? "")
+        KakaoSDK.initSDK(appKey: Config.nativeAppKey)
        return true
    }



해당 코드 패치에 대한 간단한 코드 리뷰를 도와드리겠습니다. 버그 위험 및 개선 제안 사항을 언급하도록 하겠습니다:

해당 코드 패치는 AppDelegate 클래스 내의 application(_:didFinishLaunchingWithOptions:) 메서드에서 수행됩니다.

이 코드 패치에서는 KakaoSDK를 초기화하는 작업이 수행됩니다.

변경된 부분은 KakaoSDK.initSDK(appKey:) 메서드의 인수로 사용되는 앱 키입니다.

기존 코드에서는 NSBundle.main.object(forInfoDictionaryKey: Config.Keys.Plist.nativeAppKey)를 사용하여 앱 키 값을 가져왔지만, 변경된 코드에서는 Config.nativeAppKey를 사용합니다.

버그 위험:

해당 코드 패치에 명시적인 버그 위험이 보이지 않습니다.

개선 제안:

클래스 멤버인 Config.nativeAppKey은 미리 정의되어 있어야 합니다. nativeAppKey가 정의되지 않은 경우에 대비하는 방법을 고려해보세요.

Config.nativeAppKey가 nil이거나 유효하지 않을 경우에 대한 처리를 추가해보세요.

다른 문제점이나 개선할 수 있는 사항은 제공된 정보만으로는 파악하기 어렵습니다. 전체 코드 범위 등 추가 정보를 제공한다면 더 자세한 도움을 드릴 수 있습니다.

github-actions · 2024-01-14T05:06:59Z

DontBe-iOS/DontBe-iOS/Application/SceneDelegate.swift

                self.window?.rootViewController = navigationController
            } else if loadUserData()?.isOnboardingFinished == false {
                let navigationController = UINavigationController(rootViewController: OnboardingViewController())
                self.window?.rootViewController = navigationController
            } else {
-                let navigationController = UINavigationController(rootViewController: LoginViewController(viewModel: LoginViewModel()))
+                let navigationController = UINavigationController(rootViewController: LoginViewController(viewModel: LoginViewModel(networkProvider: SocialLoginService())))
                self.window?.rootViewController = navigationController
            }
            self.window?.makeKeyAndVisible()


아래는 코드 패치입니다. 지적해야 할 버그 위험 또는 개선 제안이 있다면 환영합니다:

@@ -19,20 +19,18 @@ class SceneDelegate: UIResponder, UIWindowSceneDelegate {
self.window?.rootViewController = SplashViewController()
self.window?.makeKeyAndVisible()

DispatchQueue.main.asyncAfter(deadline: DispatchTime.now() + 2.0) {
-// let navigationController = UINavigationController(rootViewController: LoginViewController(viewModel: LoginViewModel()))
-// let navigationController = UINavigationController(rootViewController: DontBeTabBarController())

DispatchQueue.main.asyncAfter(deadline: DispatchTime.now() + 1.0) {
if loadUserData()?.isSocialLogined == true && loadUserData()?.isJoinedApp == true && loadUserData()?.isOnboardingFinished == true {
let navigationController = UINavigationController(rootViewController: DontBeTabBarController())
self.window?.rootViewController = navigationController
} else if loadUserData()?.isJoinedApp == false {

let navigationController = UINavigationController(rootViewController: LoginViewController(viewModel: LoginViewModel()))

let navigationController = UINavigationController(rootViewController: LoginViewController(viewModel: LoginViewModel(networkProvider: SocialLoginService()))) self.window?.rootViewController = navigationController } else if loadUserData()?.isOnboardingFinished == false { let navigationController = UINavigationController(rootViewController: OnboardingViewController()) self.window?.rootViewController = navigationController } else {

let navigationController = UINavigationController(rootViewController: LoginViewController(viewModel: LoginViewModel()))

let navigationController = UINavigationController(rootViewController: LoginViewController(viewModel: LoginViewModel(networkProvider: SocialLoginService()))) self.window?.rootViewController = navigationController } self.window?.makeKeyAndVisible()

코드 리뷰를 진행하겠습니다.

DispatchTime 조정: 비동기적으로 실행되는 블록의 실행 시간을 2.0초에서 1.0초로 변경했습니다.

LoginViewController 인스턴스화: LoginViewController 생성자에 viewModel 매개변수 외에도 networkProvider를 추가함으로써, LoginViewModel의 의존성을 SocialLoginService로 변경했습니다. 이렇게 함으로써 더 큰 유연성을 갖출 수 있습니다.

중복 코드 제거: 원래 코드에서 두 개의 동일한 브랜치에서 LoginViewController 인스턴스화를 사용했으므로 이를 통합하여 중복을 없앴습니다.

주석 처리된 코드 제거: LoginViewController와 DontBeTabBarController를 사용하는 네비게이션 컨트롤러를 생성하는 라인의 주석 처리된 코드를 삭제했습니다.

이 코드 패치를 통해 일부 버그 위험을 해결하고 코드 구조를 개선했습니다.

github-actions · 2024-01-14T05:07:09Z

DontBe-iOS/DontBe-iOS/Global/Resources/Info.plist

+		<true/>
+	</dict>
+	<key>BASE_URL</key>
+	<string>$(BASE_URL)</string>
 	<key>UIUserInterfaceStyle</key>
 	<string>Light</string>
 	<key>LSApplicationQueriesSchemes</key>


해당 코드 패치에서는 NSAppTransportSecurity와 BASE_URL이 추가되었습니다.

향상사항:

NSAppTransportSecurity 딕셔너리에 NSAllowsArbitraryLoads 키가 추가되어, 앱이 모든 네트워크 연결을 허용하도록 설정됩니다. 이것은 보안상의 위험을 초래할 수 있으므로, 가능하면 특정 도메인만 허용하도록 변경하는 것이 좋습니다.

BASE_URL 키에는 $(BASE_URL) 문자열이 값으로 지정되어 있는데, 이는 변수 또는 환경변수의 값을 참조하는 것으로 보입니다. 값으로 실제 사용할 URL을 지정해야 합니다.

문제점:

문제점은 없어 보입니다.

요약:

네트워크 보안과 관련된 설정(NSAppTransportSecurity)을 조정할 필요가 있습니다.

BASE_URL 값을 서버의 주소로 지정해야 합니다.

github-actions · 2024-01-14T05:07:17Z

DontBe-iOS/DontBe-iOS/Network/Foundation/BaseResponse.swift

+    let success: Bool
+    let message: String
+    let data: T?
+}


해당 코드 패치는 큰 결함이 없어 보입니다. 다만, 한 가지 개선점을 제안드릴게요. 굳이 BaseResponse 구조체를 Decodable 프로토콜을 채택하도록 구현할 필요는 없습니다. 왜냐하면 BaseResponse의 속성 중 일부가 이미 Decodable이기 때문이에요. 따라서, 아래와 같이 수정하는 것이 더 간단하고 명확할 겁니다.

struct BaseResponse<T>: Decodable where T: Decodable { let status: Int let success: Bool let message: String let data: T? }

이와 같이 수정하면 현재의 코드와 동일한 동작을 하지만, BaseResponse가 불필요하게 자기 자신을 추가적으로 해석하지 않아도 되므로 개선됩니다.

github-actions · 2024-01-14T05:07:30Z

DontBe-iOS/DontBe-iOS/Network/Foundation/Config.swift

+        }
+        return key
+    }()
+}


이 코드 패치는 Config라는 열거형과 Keys 안에 Plist라는 열거형이 정의되어 있습니다. 그리고 nativeAppKey와 baseURL이라는 두 개의 속성도 추가되었습니다.

주의해야 할 부분은 nativeAppKey와 baseURL의 값을 가져오는 부분입니다. Config에 해당하는 infoDictionary에서 Keys.Plist.nativeAppKey와 Keys.Plist.baseURL에 해당하는 값을 가져옵니다. 하지만 해당 값이 없는 경우, fatalError를 발생시키며 "Base URL is not set in plist for this configuration"라는 메시지를 표시합니다.

개선 사항으로는 fatalError 대신 선택적인 반환을 사용하여 앱이 비정상 종료되지 않게 처리할 수 있습니다. 또한, 선택적인 반환을 위해 옵셔널 타입을 사용하면 유효하지 않은 속성이 있더라도 코드 실행을 계속할 수 있습니다.

아래는 개선된 코드의 예시입니다:

extension Config { static var nativeAppKey: String? { return Config.infoDictionary[Keys.Plist.nativeAppKey] as? String } static var baseURL: String? { return Config.infoDictionary[Keys.Plist.baseURL] as? String } }

이렇게 구현하면 nativeAppKey와 baseURL은 옵셔널 타입으로 선언되기 때문에 값이 없을 경우에도 안전하게 처리할 수 있습니다.

yeonsu0-0

굿!! 고생했습니다 👍👻

boogios

P3
어려운 로그인 부분 구현하느라 고생하셨습니다!!! 코드 너무 깔끔하네요~~

boogios · 2024-01-14T07:58:09Z

DontBe-iOS/DontBe-iOS/Network/Foundation/NetworkError.swift

+        case .internalServerError: return "SERVER_ERROR"
+        case .unknownError: return "UNKNOWN_ERROR"
+        }
+    }


P3
에러 코드 정리 고생하셨어요~~

boogios · 2024-01-14T08:01:55Z

DontBe-iOS/DontBe-iOS/Presentation/Onboarding/Views/OnboardingView.swift

@@ -134,7 +136,7 @@ extension OnboardingView {
        }

        DispatchQueue.main.async {
-            if loadUserData()?.isNotFirstUser == true {
+            if self.isFirstUser == false {


P3
체크하는 방식 너무 좋네요!

Heyjooo added 3 commits January 14, 2024 03:39

[Network] #55 - Base url 및 Network Error 설정

08e2269

[Network] #55 - BaseResponse, Config, NetworkError 설정 및 소셜로그인 API 연결

f2709fd

[Feat] #55 - 로그인 -> 온보딩 갈 때 firstUser 인가에 따른 UI 수정 로직 변경

274dc86

Heyjooo added 🍀희주 Network labels Jan 14, 2024

Heyjooo requested review from boogios and yeonsu0-0 January 14, 2024 05:06

Heyjooo self-assigned this Jan 14, 2024

github-actions bot reviewed Jan 14, 2024

View reviewed changes

yeonsu0-0 approved these changes Jan 14, 2024

View reviewed changes

boogios approved these changes Jan 14, 2024

View reviewed changes

Heyjooo merged commit 6317b25 into develop Jan 14, 2024
1 check passed

Heyjooo deleted the network/#55/baseURL branch January 14, 2024 08:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Network [#55] BaseURL 설정 및 네트워크 세팅 #56

Network [#55] BaseURL 설정 및 네트워크 세팅 #56

Heyjooo commented Jan 14, 2024

github-actions bot Jan 14, 2024

github-actions bot Jan 14, 2024

github-actions bot Jan 14, 2024

github-actions bot Jan 14, 2024

github-actions bot Jan 14, 2024

github-actions bot Jan 14, 2024

yeonsu0-0 left a comment

boogios left a comment

boogios Jan 14, 2024

boogios Jan 14, 2024

	enum Config {
	enum Keys {
	enum Plist {
	static let nativeAppKey = "NATIVE_APP_KEY"
	static let baseURL = "BASE_URL"
	}
	}

	private static let infoDictionary: [String: Any] = {
	guard let dictionary = Bundle.main.infoDictionary else {
	fatalError("plist cannot found.")
	}
	return dictionary
	}()
	}

	extension Config {
	static let nativeAppKey: String = {
	guard let key = Config.infoDictionary[Keys.Plist.nativeAppKey] as? String else {
	fatalError("Base URL is not set in plist for this configuration")
	}
	return key
	}()

	static let baseURL: String = {
	guard let key = Config.infoDictionary[Keys.Plist.baseURL] as? String else {
	fatalError("Base URL is not set in plist for this configuration")
	}
	return key
	}()
	}

	struct BaseResponse<T: Decodable>: Decodable {
	let status: Int
	let success: Bool
	let message: String
	let data: T?
	}

Network [#55] BaseURL 설정 및 네트워크 세팅 #56

Network [#55] BaseURL 설정 및 네트워크 세팅 #56

Conversation

Heyjooo commented Jan 14, 2024

👻 PULL REQUEST

💻 작업한 내용

💡 참고사항

📟 관련 이슈

github-actions bot Jan 14, 2024

Choose a reason for hiding this comment

github-actions bot Jan 14, 2024

Choose a reason for hiding this comment

github-actions bot Jan 14, 2024

Choose a reason for hiding this comment

github-actions bot Jan 14, 2024

Choose a reason for hiding this comment

github-actions bot Jan 14, 2024

Choose a reason for hiding this comment

github-actions bot Jan 14, 2024

Choose a reason for hiding this comment

yeonsu0-0 left a comment

Choose a reason for hiding this comment

boogios left a comment

Choose a reason for hiding this comment

boogios Jan 14, 2024

Choose a reason for hiding this comment

boogios Jan 14, 2024

Choose a reason for hiding this comment