Feat/#13 retrofit base api

.github/workflows/android-pull-request-ci.yml

@@ -25,6 +25,24 @@ jobs:
       - name: set up Android SDK
         uses: android-actions/setup-android@v2
 
+      - name: Access Near DEV_URL
+        env:
+          NEAR_DEV_URL: ${{ secrets.NEAR_DEV_URL }}
+        run: |
+          echo "NEAR_DEV_URL=\"NEAR_DEV_URL\"" >> local.properties
+
+      - name: Access Near PROD_URL
+        env:
+          NEAR_DEV_URL: ${{ secrets.NEAR_PROD_URL }}
+        run: |
+          echo "NEAR_PROD_URL=\"NEAR_PROD_URL\"" >> local.properties
+
+      - name: Access Near TEMP_TOKEN
+        env:
+          NEAR_DEV_URL: ${{ secrets.TEMP_TOKEN }}
+        run: |
+          echo "TEMP_TOKEN=\"TEMP_TOKEN\"" >> local.properties
+
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
 

Near/app/build.gradle.kts

@@ -1,3 +1,5 @@
+import com.android.build.gradle.internal.cxx.configure.gradleLocalProperties
+
 plugins {
     alias(libs.plugins.android.application)
     alias(libs.plugins.kotlin.android)
@@ -28,6 +30,12 @@ android {
                 getDefaultProguardFile("proguard-android-optimize.txt"),
                 "proguard-rules.pro",
             )
+            buildConfigField("String", "NEAR_URL", getProperty("NEAR_PROD_URL"))
+            buildConfigField("String", "TEMP_TOKEN", getProperty("TEMP_TOKEN")) // TODO 추후 삭제 필요
+        }
+        debug {
+            buildConfigField("String", "NEAR_URL", getProperty("NEAR_DEV_URL"))
+            buildConfigField("String", "TEMP_TOKEN", getProperty("TEMP_TOKEN")) // TODO 추후 삭제 필요
         }
     }
     compileOptions {
@@ -38,6 +46,7 @@ android {
         jvmTarget = "11"
     }
     buildFeatures {
+        buildConfig = true
         compose = true
     }
 }
@@ -63,9 +72,10 @@ dependencies {
     implementation(libs.hilt.android)
     kapt(libs.hilt.android.compiler)
     implementation(libs.hilt.navigation.compose)
-    // Retrofit
+    // Retrofit & OkHttp
     implementation(libs.retrofit)
-    implementation(libs.retrofit.converter.gson)
+    implementation(libs.retrofit.kotlin.serialization.converter)
+    implementation(libs.logging.interceptor)
     // Glide
     implementation(libs.glide)
     kapt(libs.glide.compiler)
@@ -79,3 +89,5 @@ dependencies {
     // Serialization
     implementation(libs.kotlin.serialization.json)
 }
+
+fun getProperty(propertyKey: String): String = gradleLocalProperties(rootDir, providers).getProperty(propertyKey)

Near/app/src/main/AndroidManifest.xml

@@ -2,6 +2,8 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:tools="http://schemas.android.com/tools">
 
+    <uses-permission android:name="android.permission.INTERNET" />
+
     <application
         android:name=".NearApplication"
         android:allowBackup="true"

Near/app/src/main/java/com/alarmy/near/data/di/RepositoryModule.kt

@@ -1,7 +1,9 @@
 package com.alarmy.near.data.di
 
+import com.alarmy.near.data.repository.DefaultFriendRepository
 import com.alarmy.near.data.repository.ExampleRepository
 import com.alarmy.near.data.repository.ExampleRepositoryImpl
+import com.alarmy.near.data.repository.FriendRepository
 import dagger.Binds
 import dagger.Module
 import dagger.hilt.InstallIn
@@ -14,4 +16,8 @@ interface RepositoryModule {
     @Binds
     @Singleton
     abstract fun bindExampleRepository(exampleRepositoryImpl: ExampleRepositoryImpl): ExampleRepository
+
+    @Binds
+    @Singleton
+    abstract fun bindFriendRepository(friendRepository: DefaultFriendRepository): FriendRepository
 }

Near/app/src/main/java/com/alarmy/near/data/mapper/FriendMapper.kt

@@ -0,0 +1,16 @@
+package com.alarmy.near.data.mapper
+
+import com.alarmy.near.model.Friend
+import com.alarmy.near.network.response.FriendEntity
+
+fun FriendEntity.toModel(): Friend =
+    Friend(
+        friendId = friendId,
+        position = position,
+        source = source,
+        name = name,
+        imageUrl = imageUrl,
+        fileName = fileName,
+        checkRate = checkRate,
+        lastContactAt = lastContactAt,
+    )

Near/app/src/main/java/com/alarmy/near/data/repository/DefaultFriendRepository.kt

@@ -0,0 +1,23 @@
+package com.alarmy.near.data.repository
+
+import com.alarmy.near.data.mapper.toModel
+import com.alarmy.near.model.Friend
+import com.alarmy.near.network.service.FriendService
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.flow
+import javax.inject.Inject
+
+class DefaultFriendRepository
+    @Inject
+    constructor(
+        private val friendService: FriendService,
+    ) : FriendRepository {
+        override fun fetchFriends(): Flow<List<Friend>> =
+            flow {
+                emit(
+                    friendService.fetchFriends().map {
+                        it.toModel()
+                    },
+                )
+            }
+    }

Near/app/src/main/java/com/alarmy/near/data/repository/FriendRepository.kt

@@ -0,0 +1,8 @@
+package com.alarmy.near.data.repository
+
+import com.alarmy.near.model.Friend
+import kotlinx.coroutines.flow.Flow
+
+interface FriendRepository {
+    fun fetchFriends(): Flow<List<Friend>>
+}

Near/app/src/main/java/com/alarmy/near/model/Friend.kt

@@ -0,0 +1,12 @@
+package com.alarmy.near.model
+
+data class Friend(
+    val friendId: String,
+    val position: Int,
+    val source: String,
+    val name: String,
+    val imageUrl: String? = null,
+    val fileName: String? = null,
+    val checkRate: Int,
+    val lastContactAt: String? = null,
+)

Near/app/src/main/java/com/alarmy/near/network/auth/TokenInterceptor.kt

@@ -0,0 +1,21 @@
+package com.alarmy.near.network.auth
+
+import com.alarmy.near.BuildConfig
+import okhttp3.Interceptor
+import okhttp3.Response
+import javax.inject.Inject
+
+class TokenInterceptor
+    @Inject
+    constructor() : Interceptor {
+        override fun intercept(chain: Interceptor.Chain): Response {
+            val request = chain.request()
+            return chain.proceed(
+                request =
+                    request
+                        .newBuilder()
+                        .addHeader("Authorization", "Bearer ${BuildConfig.TEMP_TOKEN}")
+                        .build(),
+            )
+        }
+    }

Near/app/src/main/java/com/alarmy/near/network/di/NetworkModule.kt

@@ -0,0 +1,62 @@
+package com.alarmy.near.network.di
+
+import com.alarmy.near.BuildConfig
+import com.alarmy.near.network.auth.TokenInterceptor
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+import kotlinx.serialization.json.Json
+import okhttp3.MediaType.Companion.toMediaType
+import okhttp3.OkHttpClient
+import okhttp3.logging.HttpLoggingInterceptor
+import retrofit2.Retrofit
+import retrofit2.converter.kotlinx.serialization.asConverterFactory
+import javax.inject.Singleton
+
+@Module
+@InstallIn(SingletonComponent::class)
+object NetworkModule {
+    private val json =
+        Json {
+            encodeDefaults = true
+            ignoreUnknownKeys = true
+            prettyPrint = true
+            isLenient = true
+        }
+
+    private val jsonConverterFactory = json.asConverterFactory("application/json".toMediaType())
+
+    @Provides
+    @Singleton
+    fun provideOkHttpClient(
+        loggingInterceptor: HttpLoggingInterceptor,
+        tokenInterceptor: TokenInterceptor,
+    ): OkHttpClient =
+        OkHttpClient
+            .Builder()
+            .addInterceptor(loggingInterceptor)
+            .addInterceptor(tokenInterceptor)
+            .build()
+
+    @Provides
+    @Singleton
+    fun provideLoggingInterceptor(): HttpLoggingInterceptor =
+        HttpLoggingInterceptor().let {
+            if (BuildConfig.DEBUG) {
+                it.setLevel(HttpLoggingInterceptor.Level.BODY)
+            } else {
+                it.setLevel(HttpLoggingInterceptor.Level.NONE)
+            }
+        }
+
+    @Provides
+    @Singleton
+    fun provideRetrofit(okHttpClient: OkHttpClient): Retrofit =
+        Retrofit
+            .Builder()
+            .baseUrl(BuildConfig.NEAR_URL)
+            .client(okHttpClient)
+            .addConverterFactory(jsonConverterFactory)
+            .build()
+}

Near/app/src/main/java/com/alarmy/near/network/di/ServiceModule.kt

@@ -0,0 +1,17 @@
+package com.alarmy.near.network.di
+
+import com.alarmy.near.network.service.FriendService
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+import retrofit2.Retrofit
+import javax.inject.Singleton
+
+@Module
+@InstallIn(SingletonComponent::class)
+object ServiceModule {
+    @Provides
+    @Singleton
+    fun provideFriendService(retrofit: Retrofit): FriendService = retrofit.create(FriendService::class.java)
+}

Near/app/src/main/java/com/alarmy/near/network/response/FriendEntity.kt

@@ -0,0 +1,15 @@
+package com.alarmy.near.network.response
+
+import kotlinx.serialization.Serializable
+
+@Serializable
+data class FriendEntity(
+    val friendId: String,
+    val position: Int,
+    val source: String,
+    val name: String,
+    val imageUrl: String? = null,
+    val fileName: String? = null,
+    val checkRate: Int,
+    val lastContactAt: String? = null,
+)

Near/app/src/main/java/com/alarmy/near/network/service/FriendService.kt

@@ -0,0 +1,9 @@
+package com.alarmy.near.network.service
+
+import com.alarmy.near.network.response.FriendEntity
+import retrofit2.http.GET
+
+interface FriendService {
+    @GET("/friend/list")
+    suspend fun fetchFriends(): List<FriendEntity>
+}

Near/app/src/main/java/com/alarmy/near/presentation/feature/home/HomeScreen.kt

@@ -67,7 +67,7 @@ internal fun HomeRoute(
     onAlarmClick: () -> Unit = {},
     onMyPageClick: () -> Unit = {},
 ) {
-    val uiState = viewModel.uiStateFlow.collectAsStateWithLifecycle()
+    val uiState = viewModel.friendsFlow.collectAsStateWithLifecycle()
     HomeScreen(
         onContactClick = {},
         onAlarmClick = {},

Near/app/src/main/java/com/alarmy/near/presentation/feature/home/HomeViewModel.kt

@@ -2,52 +2,36 @@ package com.alarmy.near.presentation.feature.home
 
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
-import com.alarmy.near.data.repository.ExampleRepository
+import com.alarmy.near.data.repository.FriendRepository
+import com.alarmy.near.model.Friend
 import com.alarmy.near.presentation.feature.home.model.HomeUiState
 import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.SharingStarted
+import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.asStateFlow
-import kotlinx.coroutines.flow.catch
-import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.stateIn
-import kotlinx.coroutines.launch
 import javax.inject.Inject
 
 @HiltViewModel
 class HomeViewModel
     @Inject
     constructor(
-        private val exampleRepository: ExampleRepository,
+        private val friendRepository: FriendRepository,
     ) : ViewModel() {
         // Example: 여러번 초기화되는 StateFlow
         private val _uiStateFlow = MutableStateFlow(HomeUiState.Loading)
         val uiStateFlow = _uiStateFlow.asStateFlow()
 
-        // Example: 한 번만 초기화되는 StateFlow
-        private val exampleStateFlow =
-            exampleRepository
-                .getData()
-                .map {
-                    // Mapping to UIState
-                }.stateIn(
+        val friendsFlow: StateFlow<List<Friend>> =
+            friendRepository
+                .fetchFriends()
+                .stateIn(
                     scope = viewModelScope,
                     started = SharingStarted.WhileSubscribed(5_000),
-                    initialValue = HomeUiState.Loading,
+                    initialValue = emptyList(),
                 )
 
-        fun fetchContacts() {
-            viewModelScope.launch {
-                exampleRepository
-                    .getData()
-                    .catch {
-                        // handle error
-                    }.collect {
-                        // updateUI
-                    }
-            }
-        }
-
         fun removeContact(id: Long) {
             // contactRepository.removeContact(id)
         }