[Android/Kotlin] 네이버 지도 API 검색

📌 지도 검색 관련 문서: https://developers.naver.com/docs/serviceapi/search/local/local.md

 

❗주의
네이버 지도 api를 통해 검색하려면 네이버 지도 api만 신청하는 게 아니라 따로 검색 api도 신청해야 한다.
처음에 이걸 모르고 구현하다가 한참을 헤맸음;

 

API 신청

1. Naver Developers에서 애플리케이션 등록

https://developers.naver.com/apps/#/register

 

2. 사용 API에서 검색 API 선택

 

3. 등록

 

코틀린 파일 작성

1. data class

정보 저장 위한 클래스

data class Place(
    @SerializedName("title") val title: String,
    @SerializedName("description") val description: String,
    @SerializedName("address") val address: String,
    @SerializedName("roadAddress") val roadAddress: String
)

 

2. DTO

JSON으로 api 요청 시 반환 받았을 때 items에 담겨있는 정보를 받아오기 위함

data class PlaceListDTO (
    @SerializedName("items") val places: List<Place>
)

 

3. 인터페이스

맨처음 링크 첨부한 문서 참고해서 본인이 필요한 내용 작성하면 됨

JSON으로 반환받는 url 사용했음

클라이언트 아이디와 시크릿은 검색 API 신청하면 나오는 거 사용, Header 값으로 넘겨준다

❗Response로 받아올 땐 suspend 함수 사용

interface NaverMapService {

    // 네이버 지도 장소 검색 api
    @GET("/v1/search/local.json")
    suspend fun getMapSearch(
        @Query("query") query: String,      // 검색어
        @Query("display") display: Int = 5,    // 검색 결과 출력 건수
        @Header("X-Naver-Client-Id") clientId: String = "내 클라이언트 아이디",    // 검색 클라이언트 아이디
        @Header("X-Naver-Client-Secret") clientSecret: String = "내 클라이언트 시크릿",     // 검색 클라이언트 시크릿
    ): Response<PlaceListDTO>

}

 

4. retrofit2 설정

private val gson = GsonBuilder().setLenient().create()
private val retrofit: Retrofit = Retrofit.Builder()
    .baseUrl("https://openapi.naver.com")
    .addConverterFactory(ScalarsConverterFactory.create())
    .addConverterFactory(GsonConverterFactory.create(gson))
    .build()

val mapService = retrofit.create(NaverMapService::class.java)

 

5. Activity 코드

❗suspend 함수 사용 시 lifecycleScope 사용

class PlaceSearchActivity : AppCompatActivity() {

	// 4. retrofit2 설정 부분
    private val binding by lazy { ActivityPlaceSearchBinding.inflate(layoutInflater) }
    private val gson = GsonBuilder().setLenient().create()
    private val retrofit: Retrofit = Retrofit.Builder()
        .baseUrl("https://openapi.naver.com")
        .addConverterFactory(ScalarsConverterFactory.create())
        .addConverterFactory(GsonConverterFactory.create(gson))
        .build()

    val mapService = retrofit.create(NaverMapService::class.java)

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        binding.recyclerviewSearchPlace.layoutManager = LinearLayoutManager(this)
        setSearchView()	// 검색어 입력하는 부분 설정

        setContentView(binding.root)
    }

    private fun setSearchView() {
    	// 검색어 입력 부분
        binding.searchViewPlace.setOnQueryTextListener(object : SearchView.OnQueryTextListener {
            override fun onQueryTextSubmit(query: String?): Boolean {
                lifecycleScope.launch {
                	// 값 받아오기
                    val mapSearchList = mapService.getMapSearch(query!!)
                    binding.recyclerviewSearchPlace.adapter = PlaceSearchAdapter(mapSearchList.body()!!.places)
                    binding.recyclerviewSearchPlace.isVisible = true
                }
                return false
            }

            override fun onQueryTextChange(newText: String?): Boolean {
                return false
            }
        })
    }

}