[#3] 지역코드 조회 API Service 추가 #4

ksw4015 · 2024-09-26T09:30:09Z

변경사항

Hilt를 사용하기 위한 App class를 추가하였습니다.
Retrofit과 요청 Url에 공통 Query를 추가하기 위한 Interceptor class를 추가하였습니다.
지역코드 조회 API 서비스를 추가하였습니다. (AreaCodeApi)
응답에서 필요한 Data로 Mapping하기 위한 Mapper class를 추가하였습니다.
SplashActivity의 checkPermission 로직을 ViewModel을 만들어 옮겼습니다.

멘토님께

Api 응답이 복잡해서 Model class가 많습니다. 😓
Error응답은 xml 형식으로만 제공하여 따로처리하는 코드를 작성하지 못했습니다. 😭

추가정보

응답 json data 추가합니다.

{
  "response": {
    "header": {
      "resultCode": "0000",
      "resultMsg": "OK"
    },
    "body": {
      "items": {
        "item": [
          {
            "rnum": 1,
            "code": "1",
            "name": "서울"
          },
          {
            "rnum": 2,
            "code": "2",
            "name": "인천"
          },
          {
            "rnum": 3,
            "code": "3",
            "name": "대전"
          },
          {
            "rnum": 4,
            "code": "4",
            "name": "대구"
          },
          {
            "rnum": 5,
            "code": "5",
            "name": "광주"
          },
          {
            "rnum": 6,
            "code": "6",
            "name": "부산"
          },
          {
            "rnum": 7,
            "code": "7",
            "name": "울산"
          },
          {
            "rnum": 8,
            "code": "8",
            "name": "세종특별자치시"
          },
          {
            "rnum": 9,
            "code": "31",
            "name": "경기도"
          },
          {
            "rnum": 10,
            "code": "32",
            "name": "강원특별자치도"
          }
        ]
      },
      "numOfRows": 10,
      "pageNo": 1,
      "totalCount": 17
    }
  }
}

*move checkPermission function to viewmodel

f-lab-Toru

Review completed

f-lab-Toru · 2024-09-29T12:47:11Z

app/build.gradle.kts

@@ -39,6 +48,7 @@ android {
        jvmTarget = "17"


JavaVersion.VERSION_17.toString() 을 콜하면 "17" 이런 식으로 버전을 하드코딩하지 않아도 됩니다 :)

f-lab-Toru · 2024-09-29T12:48:09Z

app/build.gradle.kts

+val properties = Properties().apply {
+    load(FileInputStream(rootProject.file("local.properties")))
+}
+
 android {
    namespace = "kr.ksw.visitkorea"
    compileSdk = 34


여담인데, 35가 곧 배포될 예정이라서 compile / target sdk version up 을 34로 유지하는 건 앞으로 1년 정도만 허용될 거예요. (지금 당장은 하지 않아도 됨)

f-lab-Toru · 2024-09-29T12:48:59Z

app/src/main/AndroidManifest.xml

@@ -7,6 +7,7 @@
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>

    <application
+        android:name=".App"


app 패키지를 따로 만들고, VisitKorea.kt 이런 식으로 Application 클래스 이름을 바꾸면 좀더 보기 좋지 않을까 하는 생각이 듭니다.

f-lab-Toru · 2024-09-29T12:50:17Z

app/src/main/java/kr/ksw/visitkorea/data/remote/dto/AreaCodeDTO.kt

+
+data class AreaCodeDTO(
+    val code: String,
+    val name: String


의견이 분분한 부분인데, trailing comma 를 넣어 줘도 좋을 거 같습니다.

f-lab-Toru · 2024-09-29T12:50:49Z

app/src/main/java/kr/ksw/visitkorea/data/di/DataModule.kt

+@InstallIn(SingletonComponent::class)
+object DataModule {
+
+    private const val BASE_URL = "https://apis.data.go.kr/B551011/KorService1/"


BASE_URL 과 같은 상수는 DataModule 에 둬도 좋지만, 상수가 많아진다면 상수를 관리하는 object 를 하나 둬도 괜찮을 거 같아요.

f-lab-Toru · 2024-09-29T12:52:43Z

app/src/test/java/kr/ksw/visitkorea/data/repository/FakeAreaCodeRepository.kt

+import kr.ksw.visitkorea.data.remote.model.CommonItem
+import kr.ksw.visitkorea.data.remote.model.CommonResponse
+
+class FakeAreaCodeRepository : AreaCodeRepository {


이전 회사에서 쓰던 방법인데, fake body json 을 파일로 하나 만들어 두고 그걸 읽어서 mock response 를 만들 수도 있습니다. 고려해 보세요. :)

f-lab-Toru · 2024-09-29T12:53:08Z

app/src/test/java/kr/ksw/visitkorea/data/remote/AreaCodeApiTest.kt

+
+    @Test
+    fun `getSigunguCode request success, valid area code`() = runTest {
+//        val areaCodeItems = fakeAreaCodeRepository.getSigunguCode("1").getOrNull()


사용되지 않을 부분을 주석처리했다면 없애도 좋을 거 같아요

f-lab-Toru · 2024-09-29T12:54:17Z

app/src/main/java/kr/ksw/visitkorea/data/remote/model/ApiResponse.kt

@@ -0,0 +1,5 @@
+package kr.ksw.visitkorea.data.remote.model
+
+data class ApiResponse<T>(


data class 의 마지막 item 들에는 trailing comma 를 넣어 주는 것이 좋습니다. 아래의 다른 data class 들도 마찬가지로요 :)

f-lab-Toru · 2024-09-29T12:55:11Z

app/src/main/java/kr/ksw/visitkorea/data/remote/model/CommonResponse.kt

@@ -0,0 +1,6 @@
+package kr.ksw.visitkorea.data.remote.model
+
+data class CommonResponse<T>(


제네릭을 이용한 Response class 를 만드는 건 좋습니다. 그리고 이런 형태가 반복적으로 사용된다면 data/remote 가 아닌 common 과 같은 패키지를 하나 만들어서 관리해도 좋을 거 같아요.

f-lab-Toru · 2024-09-29T12:58:51Z

app/src/main/java/kr/ksw/visitkorea/presentation/splash/SplashViewModel.kt

+    private val _sideEffect = MutableSharedFlow<SplashSideEffect>(replay = 0)
+    val sideEffect: SharedFlow<SplashSideEffect> = _sideEffect.asSharedFlow()
+
+    fun checkPermission(activity: ComponentActivity) {


퍼미션 체크를 ViewModel 에서 하고 있는 것은 좋습니다.
checkPermission() 의 argument 가 activity 인데, context로 교체 가능하다면, AndroidViewModel 을 상속하는 걸 고려해 보는 건 어떨까요? 그러면 activity 를 쓰지 않아도 되어서 activity 와의 약한 coupling 이 제거될 수 있을 거 같아요.

ksw4015 · 2024-09-30T10:50:10Z

Review 사항 일부 적용했습니다. AndroidViewModel로 변경하려했으나, registerForActivityResult가 Application이 아닌 ComponentActivity의 함수라 일단 유지하려고 합니다.

f-lab-Toru

리뷰 하나 더 남겼습니다.

f-lab-Toru · 2024-10-01T15:05:23Z

app/src/main/java/kr/ksw/visitkorea/presentation/splash/SplashActivity.kt

-                Manifest.permission.ACCESS_COARSE_LOCATION,
-                Manifest.permission.ACCESS_FINE_LOCATION
-            ))
+    private fun observeSideEffect() {


observeSideEffect() 라는 메소드명은 side effect 의 관찰에만 너무 중점을 두고 있는 느낌이라, observePermissionGrantResult 이런 식으로 바꿔도 좋을 것 같습니다.

네 알겠습니다!

ksw4015 added 5 commits September 25, 2024 10:57

feat: add application class (hilt)

4f2c365

feat: add common reopnse model and AreaCodeApi service

07d3ac6

test: add AreaCodeRepository test

f028279

Merge branch 'feature/data' into feature/3

270908e

feat: add SplashViewModel

5f6c352

*move checkPermission function to viewmodel

ksw4015 self-assigned this Sep 26, 2024

ksw4015 requested a review from f-lab-Toru September 26, 2024 09:31

f-lab-Toru reviewed Sep 29, 2024

View reviewed changes

style: add trailing comma to data class, rename App class

ab83389

ksw4015 requested a review from f-lab-Toru September 30, 2024 12:57

f-lab-Toru reviewed Oct 1, 2024

View reviewed changes

ksw4015 merged commit 4ea285a into main Oct 1, 2024
1 check failed

ksw4015 deleted the feature/3 branch October 7, 2024 10:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#3] 지역코드 조회 API Service 추가 #4

[#3] 지역코드 조회 API Service 추가 #4

ksw4015 commented Sep 26, 2024

f-lab-Toru left a comment

f-lab-Toru Sep 29, 2024

f-lab-Toru Sep 29, 2024

f-lab-Toru Sep 29, 2024

f-lab-Toru Sep 29, 2024

f-lab-Toru Sep 29, 2024

f-lab-Toru Sep 29, 2024

f-lab-Toru Sep 29, 2024

f-lab-Toru Sep 29, 2024

f-lab-Toru Sep 29, 2024

f-lab-Toru Sep 29, 2024

ksw4015 commented Sep 30, 2024

f-lab-Toru left a comment

f-lab-Toru Oct 1, 2024

ksw4015 Oct 1, 2024

		@@ -0,0 +1,5 @@
		package kr.ksw.visitkorea.data.remote.model

		data class ApiResponse<T>(

		@@ -0,0 +1,6 @@
		package kr.ksw.visitkorea.data.remote.model

		data class CommonResponse<T>(

[#3] 지역코드 조회 API Service 추가 #4

[#3] 지역코드 조회 API Service 추가 #4

Conversation

ksw4015 commented Sep 26, 2024

변경사항

멘토님께

추가정보

f-lab-Toru 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

ksw4015 commented Sep 30, 2024

f-lab-Toru left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment