[경북대 Android 권성찬] 3주차 과제_STEP 3

README.md

@@ -1 +1,37 @@
 # android-map-search
+
+# 1단계
+## 기능 요구 사항
+- 검색어를 입력하면 검색 결과가 15개 이상 표시된다.
+- 검색 결과 목록은 세로 스크롤이 된다.
+- 입력한 검색어는 X를 눌러서 삭제할 수 있다.
+- 검색 결과 목록에서 하나의 항목을 선택할 수 있다.
+- 선택된 항목은 검색어 저장 목록에 추가된다.
+- 저장된 검색어 목록은 가로 스크롤이 된다.
+- 저장된 검색어는 X를 눌러서 삭제할 수 있다.
+- 저장된 검색어는 앱을 재실행하여도 유지된다.
+
+## 프로그래밍 요구 사항
+- 검색 데이터는 카카오로컬 API를 사용한다.
+- 카카오 API 사용을 위한 앱 키를 외부에 노출하지 않는다.
+- 가능한 MVVM 아키텍처 패턴을 적용하도록 한다.
+- 코드 컨벤션을 준수하며 프로그래밍한다.
+
+## 구현할 기능 목록
+- KAKAO Search Service 구현
+- SearchResultRepository 리스트를 KAKAO Search Service를 통해 불러오도록 변경
+
+# 2단계
+
+## 구현할 기능 목록
+- 카카오 맵 API와 연동하여 맵을 보여주는 기능 추가
+- 검색 창 선택시 검색 화면으로 전환하는 기능 추가
+- 뒤로가기 콜백 처리
+
+# 3단계
+
+## 구현할 기능 목록
+- 웹 서버와 통신하는 HTTP Connection 래퍼 클래스 작성
+- HTTP Connection을 이용해 카카오 API에서 데이터를 받아오는 클래스 작성
+- 받아온 Json 데이터를 DTO로 파싱하는 기능 구현
+- 기존 Retrofit 기반 웹 서비스 객체를 직접 구현한 클래스로 대체

app/build.gradle.kts

@@ -1,20 +1,29 @@
+import com.android.build.gradle.internal.cxx.configure.gradleLocalProperties
+
 plugins {
     id("com.android.application")
     id("org.jetbrains.kotlin.android")
+    kotlin("plugin.serialization") version "1.9.0"
 }
 
+fun getApiKey(key: String): String = gradleLocalProperties(rootDir, providers).getProperty(key)
+
 android {
-    namespace = "campus.tech.kakao.map"
+    namespace = "ksc.campus.tech.kakao.map"
     compileSdk = 34
 
     defaultConfig {
-        applicationId = "campus.tech.kakao.map"
+        applicationId = "ksc.campus.tech.kakao.map"
         minSdk = 26
         targetSdk = 34
         versionCode = 1
         versionName = "1.0"
 
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+
+        resValue("string", "KAKAO_API_KEY", getApiKey("KAKAO_API_KEY"))
+        buildConfigField("String", "KAKAO_REST_API_KEY", getApiKey("KAKAO_REST_API_KEY"))
+
     }
 
     buildTypes {
@@ -36,11 +45,14 @@ android {
 
     buildFeatures {
         viewBinding = true
+        buildConfig = true
     }
 }
 
 dependencies {
 
+    implementation ("androidx.activity:activity-ktx:1.2.2")
+    implementation ("androidx.fragment:fragment-ktx:1.3.3")
     implementation("androidx.core:core-ktx:1.12.0")
     implementation("androidx.appcompat:appcompat:1.6.1")
     implementation("com.google.android.material:material:1.11.0")
@@ -51,6 +63,7 @@ dependencies {
     implementation("com.squareup.retrofit2:converter-gson:2.11.0")
     implementation("com.kakao.maps.open:android:2.9.5")
     implementation("androidx.activity:activity:1.8.0")
+    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.3")
     testImplementation("junit:junit:4.13.2")
     androidTestImplementation("androidx.test.ext:junit:1.1.5")
     androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")

app/src/main/AndroidManifest.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="ksc.campus.tech.kakao.map"
     xmlns:tools="http://schemas.android.com/tools">
 
     <uses-permission android:name="android.permission.INTERNET" />
@@ -15,7 +16,7 @@
         android:theme="@style/Theme.Map"
         tools:targetApi="31">
         <activity
-            android:name=".MainActivity"
+            android:name=".views.MainActivity"
             android:exported="true">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />

app/src/main/java/ksc/campus/tech/kakao/map/models/KakaoSearchService.kt

@@ -0,0 +1,124 @@
+package ksc.campus.tech.kakao.map.models
+
+import android.util.Log
+import ksc.campus.tech.kakao.map.models.dto.KeywordSearchResponse
+import ksc.campus.tech.kakao.map.models.mynetwork.MyNetworkCallbacks
+import ksc.campus.tech.kakao.map.models.mynetwork.MyHttpHelper
+
+object KakaoSearchService {
+    private val categoryGroupCodeToDescription: HashMap<String, String> = hashMapOf(
+        Pair("MT1", "대형마트"),
+        Pair("CS2", "편의점"),
+        Pair("PS3", "어린이집, 유치원"),
+        Pair("SC4", "학교"),
+        Pair("AC5", "학원"),
+        Pair("PK6", "주차장"),
+        Pair("OL7", "주유소, 충전소"),
+        Pair("SW8", "지하철역"),
+        Pair("BK9", "은행"),
+        Pair("CT1", "문화시설"),
+        Pair("AG2", "중개업소"),
+        Pair("PO3", "공공기관"),
+        Pair("AT4", "관광명소"),
+        Pair("AD5", "숙박"),
+        Pair("FD6", "음식점"),
+        Pair("CE7", "카페"),
+        Pair("HP8", "병원"),
+        Pair("PM9", "약국")
+    )
+
+    /**
+     * 요청이 유효한지 검증하기 위해 사용.
+     *
+     * 현재 진행중인 쿼리가 유저가 마지막으로 보낸 쿼리인지 검증한다.
+     *
+     * 유저가 새로운 쿼리를 보낼 때마다 [lastSearchId] 값이 1씩 증가한다.
+    */
+    private var lastSearchId: Int = 0
+
+    private fun isQueryValid(query: String): Boolean = query.isNotBlank()
+
+
+    private fun parseCategory(category: String) =
+        category.split('>').last().trim().replace(",", ", ")
+
+    private fun responseToResultArray(response: KeywordSearchResponse?): List<SearchResult>{
+        if(response == null)
+            return mutableListOf()
+        val result = mutableListOf<SearchResult>()
+
+        for (doc in response.documents) {
+            result.add(
+                SearchResult(
+                    doc.id,
+                    doc.placeName,
+                    doc.addressName,
+                    categoryGroupCodeToDescription.getOrDefault(
+                        doc.categoryGroupCode,
+                        parseCategory(doc.categoryName)
+                    )
+                )
+            )
+        }
+        return result
+    }
+
+
+    fun batchSearchByKeyword(
+        query: String,
+        apiKey: String,
+        batchCount: Int,
+        onResponse: ((results: List<SearchResult>) -> Unit)?
+    ) {
+        lastSearchId++
+
+        batchSearchByKeyword(lastSearchId, query, apiKey, 1, batchCount, onResponse)
+    }
+
+
+    private fun batchSearchByKeyword(
+        searchId: Int,
+        query: String,
+        apiKey: String,
+        page: Int,
+        batchCount: Int,
+        onResponse: ((results: List<SearchResult>) -> Unit)?
+    ) {
+        if (page > batchCount)
+            return
+
+        if (!isQueryValid(query))
+            return
+
+        val myService = MyHttpHelper()
+        myService.run("KakaoAK $apiKey", query, page, object:MyNetworkCallbacks<KeywordSearchResponse>{
+            override fun onResponse(response: KeywordSearchResponse) {
+                val result = responseToResultArray(response)
+                if (lastSearchId != searchId) {
+                    return
+                }
+                onResponse?.invoke(result)
+                if (!response.meta.isEnd) {
+                    batchSearchByKeyword(
+                        searchId,
+                        query,
+                        apiKey,
+                        page + 1,
+                        batchCount,
+                        onResponse
+                    )
+                }
+            }
+
+            override fun onError(errorMessage: String) {
+                Log.e("KSC", "request failed")
+                Log.e("KSC", "Message: $errorMessage")
+            }
+
+            override fun onTimeout() {
+                Log.e("KSC", "connection timeout")
+            }
+
+        })
+    }
+}

app/src/main/java/ksc/campus/tech/kakao/map/models/SearchDbHelper.kt

@@ -0,0 +1,88 @@
+package ksc.campus.tech.kakao.map.models
+
+import android.content.ContentValues
+import android.content.Context
+import android.database.Cursor
+import android.database.sqlite.SQLiteDatabase
+import android.database.sqlite.SQLiteOpenHelper
+import android.provider.BaseColumns
+import ksc.campus.tech.kakao.map.models.contracts.SearchKeywordContract
+import ksc.campus.tech.kakao.map.models.contracts.SearchResultContract
+
+data class SearchResult(val id: String, val name: String, val address: String, val type: String)
+
+class SearchDbHelper(context: Context) :
+    SQLiteOpenHelper(context, DATABASE_NAME, null, DATABASE_VERSION) {
+    override fun onCreate(db: SQLiteDatabase?) {
+        db?.execSQL(SearchKeywordContract.CREATE_QUERY)
+    }
+
+    override fun onUpgrade(db: SQLiteDatabase?, oldVersion: Int, newVersion: Int) {
+        if (oldVersion <= 1) {
+            db?.execSQL(SearchKeywordContract.CREATE_QUERY)
+        }
+        if (oldVersion in 2..2) {
+            db?.execSQL(SearchKeywordContract.DROP_QUERY)
+            db?.execSQL(SearchKeywordContract.CREATE_QUERY)
+        }
+        if(oldVersion in 1 .. 3){
+            db?.execSQL(SearchResultContract.DROP_QUERY)
+        }
+    }
+
+    fun insertOrReplaceKeyword(keyword: String) {
+        val db = writableDatabase
+        val contentValues = ContentValues().apply {
+            put(SearchKeywordContract.COLUMN_KEYWORD, keyword)
+        }
+
+        db.replace(SearchKeywordContract.TABLE_NAME, null, contentValues)
+    }
+
+    fun deleteKeyword(keyword: String) {
+        val db = writableDatabase
+        db.delete(
+            SearchKeywordContract.TABLE_NAME,
+            "${SearchKeywordContract.COLUMN_KEYWORD} = ?",
+            arrayOf(keyword)
+        )
+    }
+
+    private fun getAllSearchKeywordFromCursor(cursor: Cursor?): List<String> {
+        val result = mutableListOf<String>()
+
+        try {
+            while (cursor?.moveToNext() == true) {
+                result.add(cursor.getString(1))
+            }
+        } catch (e: Exception) {
+            e.printStackTrace()
+        } finally {
+            if (cursor != null && !cursor.isClosed) {
+                cursor.close()
+            }
+        }
+
+        return result
+    }
+
+    fun queryAllSearchKeywords(): List<String> {
+        val db = readableDatabase
+        val cursor = db.rawQuery("SELECT * FROM ${SearchKeywordContract.TABLE_NAME}", null)
+
+        return getAllSearchKeywordFromCursor(cursor)
+    }
+
+    companion object {
+        private var instance: SearchDbHelper? = null
+        const val DATABASE_VERSION = 3
+        const val DATABASE_NAME = "MapSearch2"
+
+        fun getInstance(context: Context): SearchDbHelper {
+            if (instance == null) {
+                instance = SearchDbHelper(context)
+            }
+            return instance as SearchDbHelper
+        }
+    }
+}

app/src/main/java/ksc/campus/tech/kakao/map/models/contracts/SearchKeywordContract.kt

@@ -0,0 +1,15 @@
+package ksc.campus.tech.kakao.map.models.contracts
+
+import android.provider.BaseColumns
+
+object SearchKeywordContract : BaseColumns {
+    const val TABLE_NAME = "SEARCH_KEYWORD"
+    const val COLUMN_KEYWORD = "keyword"
+
+    const val CREATE_QUERY = "CREATE TABLE IF NOT EXISTS $TABLE_NAME (" +
+            "${BaseColumns._ID} INTEGER PRIMARY KEY AUTOINCREMENT, " +
+            "$COLUMN_KEYWORD TEXT," +
+            "UNIQUE($COLUMN_KEYWORD))"
+
+    const val DROP_QUERY = "DROP TABLE IF EXISTS $TABLE_NAME"
+}

app/src/main/java/ksc/campus/tech/kakao/map/models/contracts/SearchResultContract.kt

@@ -0,0 +1,18 @@
+package ksc.campus.tech.kakao.map.models.contracts
+
+import android.provider.BaseColumns._ID
+
+object SearchResultContract {
+    const val TABLE_NAME = "SEARCH_RESULT"
+    const val COLUMN_NAME = "name"
+    const val COLUMN_ADDRESS = "address"
+    const val COLUMN_TYPE = "type"
+
+    const val CREATE_QUERY = "CREATE TABLE IF NOT EXISTS $TABLE_NAME (" +
+            "$_ID INTEGER PRIMARY KEY AUTOINCREMENT, " +
+            "$COLUMN_NAME TEXT, " +
+            "$COLUMN_ADDRESS TEXT, " +
+            "$COLUMN_TYPE TEXT)"
+
+    const val DROP_QUERY = "DROP TABLE IF EXISTS $TABLE_NAME"
+}