[안드로이드 코틀린] 프로젝트 - 네이버 책 api 통신

2023.7.28

 

1. 네이버 책 api 통신에 필요한 것

- 네이버 오픈소스

https://developers.naver.com/main/

- 책 api 정보

https://developers.naver.com/docs/serviceapi/search/book/book.md#%ED%8C%8C%EB%9D%BC%EB%AF%B8%ED%84%B0

 

- Application > 애플리케이션 등록

 

- 내 애플리케이션

    - Clinet ID(클라이언트 id), Client Secret(클라이언트 시크릿)은 api 코드 작성에 필요함

 

2. 준비

- MainActivity.kt / activity_main.xml

- item_book.xml (리사이큘러뷰 아이템)

- BookSearchAdapter.kt (리사이큘러뷰 어댑터)

- NaverBookApi.kt (interface)

- NaverBookItem.kt (data class)

- NaverBookResponse.kt (data class)

 

 

3. 코드 작성 전

- AndroidManifest.xml

    - <uses-permission android:name="android.permission.INTERNET" /> 추가

<?xml version="1.0" encoding="utf-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" />

    ...

</manifest>

 

- build.gradle(:app)

dependencies {

    ...

    // 이미지 glide
    implementation 'com.github.bumptech.glide:glide:4.12.0'
    annotationProcessor 'com.github.bumptech.glide:compiler:4.12.0'

    // 리사이큘러뷰
    implementation("androidx.recyclerview:recyclerview:1.2.1")
    implementation("androidx.recyclerview:recyclerview-selection:1.1.0")

    // api 통신
    implementation 'com.google.code.gson:gson:2.8.8'
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
}

 

- settings.gradle

    - 사실 이건 잘 모르겠다. 의존성 충돌이 나서 추가했다.

    - https://angelplayer.tistory.com/263

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()

        // 의존성 충돌 에러 방지
        maven { url "https://jitpack.io" }
        jcenter() // Warning: this repository is going to shut down soon
    }
}

 

 

4. xml 작성

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    tools:context=".MainActivity">

    <EditText
        android:id="@+id/edtSearch"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginTop="60dp"
        android:ems="10"
        android:inputType="text"/>

    <Button
        android:id="@+id/btnSearch"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginTop="20dp"
        android:text="Button" />

    <androidx.recyclerview.widget.RecyclerView
        android:id="@+id/recyclerViewBook"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:visibility="visible"
        app:layout_constraintTop_toBottomOf="@+id/btnSearch" />

</LinearLayout>

 

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:background="#F6CAC7"
    android:layout_margin="10dp">

    <ImageView
        android:id="@+id/imageViewBook"
        android:layout_width="82dp"
        android:layout_height="116dp"
        android:layout_margin="5dp"
        android:src="@drawable/book"/>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        android:gravity="center_vertical"
        android:layout_marginLeft="5dp"
        android:layout_marginRight="5dp">

        <TextView
            android:id="@+id/textViewTitle"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="책제목"
            android:textSize="16sp"
            android:textStyle="bold"
            android:maxLines="2"
            android:ellipsize="end"/>

        <TextView
            android:id="@+id/textViewAuthor"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="저자 |"
            android:textSize="14sp"/>

        <TextView
            android:id="@+id/textViewPublisher"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="출판사 |"
            android:textSize="14sp"/>

        <TextView
            android:id="@+id/textViewPublishedDate"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="출간일 |"
            android:textSize="14sp"/>

    </LinearLayout>
</LinearLayout>

 

 

5. kt 작성

- NaverBookResponse.kt

data class NaverBookResponse(
    val items: List<NaverBookItem>
)

 

- NaverBookItem.kt

    - 가져와야할 정보 이름은 api 사이트에 가면 있다. 

    - 출간일을 가져오기 싶을 때 네이버 책 api의 이름은 pubdate인데, 이것을 마음대로 바꾸면 값을 가져오지 못한다.

data class NaverBookItem(
    val title: String,              // 제목
    val author: String,             // 저자
    val publisher: String,          // 츨판사
    val pubdate: String,            // 출간일
    val image: String,              // 섬네일 이미지 URL
    val description: String         // 책 소개
    // ISBN
)

 

- NaverBookApi.kt

import retrofit2.Call
import retrofit2.http.GET
import retrofit2.http.Header
import retrofit2.http.Query

interface NaverBookApi {
    @GET("v1/search/book.json")
    fun searchBooks(
        @Header("X-Naver-Client-Id") clientId: String,          // 네이버 책 api 클라이언트 id
        @Header("X-Naver-Client-Secret") clientSecret: String,  // 네이버 책 api 클라이언트 시크릿
        @Query("query") query: String,      // 검색어. UTF-8로 인코딩되어야함
        @Query("display") display: Int,     // 한 번에 표시할 검색 결과 개수(기본값: 10, 최댓값: 100)
        @Query("start") start: Int,         // 검색 시작 위치(기본값: 1, 최댓값: 1000)
        @Query("sort") sort: String         // 검색 결과 정렬 방법(sim: 정확도순으로 내림차순 정렬(기본값),date: 출간일순으로 내림차순 정렬)
    ): Call<NaverBookResponse>
}

 

- BookSearchAdapter.kt

import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import android.widget.ImageView
import android.widget.TextView
import androidx.recyclerview.widget.RecyclerView
import com.bumptech.glide.Glide

class BookSearchAdapter(private var bookList: List<NaverBookItem>) : RecyclerView.Adapter<BookSearchAdapter.BookViewHolder>() {

    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): BookViewHolder {
        val itemView = LayoutInflater.from(parent.context).inflate(R.layout.item_book, parent, false)
        return BookViewHolder(itemView)
    }

    override fun onBindViewHolder(holder: BookViewHolder, position: Int) {
        val book = bookList[position]       // position번째 리스트 정보를 book 변수에 전달
        holder.bind(book)       // 리사이큘러뷰에 출력하기 위한 함수 호출
    }

    override fun getItemCount(): Int = bookList.size

    // 새로운 데이터로 기존 bookList를 갱신하고 리사이클러뷰를 갱신하는 함수
    fun updateData(newList: List<NaverBookItem>) {
        bookList = newList
        notifyDataSetChanged()   // 어댑터에 데이터 변경 알림
    }

    class BookViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
        // 위젯 연결
        private val titleTextView: TextView = itemView.findViewById(R.id.textViewTitle)
        private val authorTextView: TextView = itemView.findViewById(R.id.textViewAuthor)
        private val publisherTextView: TextView = itemView.findViewById(R.id.textViewPublisher)
        private val publishedDateTextView: TextView = itemView.findViewById(R.id.textViewPublishedDate)
        private val bookImageView: ImageView = itemView.findViewById(R.id.imageViewBook)

        // 리사이큘러뷰에 출력
        fun bind(book: NaverBookItem) {
            titleTextView.text = book.title                                      // 제목
            authorTextView.text = "저자 | " + book.author                         // 저자
            publisherTextView.text = "출판사 | " + book.publisher                 // 츨판사
            publishedDateTextView.text = "출간일 | " + formatDate(book.pubdate)   // 출간일

            // 섬네일 이미지 URL
            Glide.with(itemView.context)
                .load(book.image)
                .into(bookImageView)
        }

        // 출간일 변경 함수 (ex. 20230728 -> 0223년 07월 28일)
        fun formatDate(dateStr: String): String {
            val year = dateStr.substring(0, 4)
            val month = dateStr.substring(4, 6)
            val day = dateStr.substring(6, 8)

            return "${year}년 ${month}월 ${day}일"
        }
    }
}

 

- MainActivity.kt

    - 원래는 Fragment에 작성했는데 코드 설명을 Activity로 해서 코드 실수가 있을 수도 있다. (id 같은..)

    - 클라이언트 id와 시크릿은 첫단계 네이버 애플리케이션 등록을 통해 가져올 수 있다.

import android.content.Context
import android.os.Bundle
import androidx.fragment.app.Fragment
import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import android.widget.EditText
import android.widget.ImageButton
import android.widget.ImageView
import androidx.recyclerview.widget.LinearLayoutManager
import androidx.recyclerview.widget.RecyclerView
import retrofit2.Call
import retrofit2.Callback
import retrofit2.Response
import retrofit2.Retrofit
import retrofit2.converter.gson.GsonConverterFactory

class MainActivity : AppCompatActivity() {

    // 네이버 api 통신을 위한 변수
    private val clientId = "클라이언트 id"   		// 클라이언트 id
    private val clientSecret = "클라이언트 시크릿"        // 클라이언트 시크릿
    private val baseUrl = "https://openapi.naver.com/"  // 네이버 기본 api url

    // 위젯 변수
    lateinit var edtSearch: EditText
    lateinit var btnSearch: ImageButton
    lateinit var recyclerViewBook: RecyclerView

    // 리사이클러뷰 어댑터 변수
    lateinit var bookAdapter: BookSearchAdapter

    // 받아온 정보 저장할 리스트 변수
    val bookList: MutableList<NaverBookItem> = mutableListOf()

    override onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        
        // 위젯 연결
        edtSearch = findViewById<EditText>(R.id.edtSearch)
        btnSearch = findViewById<ImageButton>(R.id.btnSearch)
        recyclerViewBook = findViewById<RecyclerView>(R.id.recyclerViewBook)

        // RecyclerView 어댑터 생성 및 설정
        bookAdapter = BookSearchAdapter(emptyList())
        recyclerViewBook.layoutManager = LinearLayoutManager(context)      //LinearLayoutManager: 아이템들을 수직 방향으로 나열
        recyclerViewBook.adapter = bookAdapter
        recyclerViewBook.setHasFixedSize(true)      // setHasFixedSize(true): 리사이클러뷰 크기 고정

        // 리스너 연결
        btnSearch.setOnClickListener {  // 검색 버튼
            val query = edtSearch.text.toString().trim()    // editText에 검색한 검색어
            if (query.isNotEmpty()) {  // 검색하지 않고 버튼 클릭(검색어가 비어있음)
                searchBooks(query)     // api를 통해 책 정보 얻는 함수 호출
            }
        }
    }

    // 네이버 책 api 사용해 정보를 얻기 위한 함수
    fun searchBooks(query: String) {

        // Retrofi 객체 생성 (객체 이용하여 api 인터페이스를 생성, 해당 인터페이스를 사용해 api 호출)
        val retrofit = Retrofit.Builder()
            .baseUrl(baseUrl)
            .addConverterFactory(GsonConverterFactory.create())
            .build()

        val naverBookApi = retrofit.create(NaverBookApi::class.java)    // NaverBookApi 인터페이스를 사용해 api 인터페이스 생성
        val call = naverBookApi.searchBooks(clientId, clientSecret, query, 100, 1, "sim")     // query(검색어)를 기반으로 api 호출

        call.enqueue(object : Callback<NaverBookResponse> {     // api 응답 처리
            override fun onResponse(call: Call<NaverBookResponse>, response: Response<NaverBookResponse>) {     // api 응답 성공
                if (response.isSuccessful) {    // 응답 성공할 경우
                    val bookResponse = response.body()  // 응답 데이터 가져오기
                    val items = bookResponse?.items     // 가져온 데이터 아이템
                    if(items != null) {     // 아이템이 비어있지 않을 경우
                        bookAdapter.updateData(items)   // RecyclerView의 데이터를 업데이트
                    }
                } else {    // 실패할 경우
                    println("API call failed: ${response.code()}")  // 응답 실패 코드
                }
            }

            override fun onFailure(call: Call<NaverBookResponse>, t: Throwable) {       // api 응답 실패
                println("API call failed: ${t.message}")
            }
        })
    }
}

 

 

결과

 

 

+ editText에 입력할 때 키보드 엔터 또는 done 버튼 누르면 키보드 내리기

- xml의 EditText에 추가

android:imeOptions="actionDone"
android:singleLine="true"

 

- MainActivity.kt

    - onCreate() 안에 작성

    - 위젯 id: edtSearch (위젯 변수 선언과 연결을 생략했다)

    - fragment용으로 작성해서 Activity에서는 에러가 날 수 있다.

edtSearch.setOnKeyListener { _, keyCode, event ->
    if (event.action == KeyEvent.ACTION_DOWN && keyCode == KeyEvent.KEYCODE_ENTER) {    // 키보드 done 버튼 또는 엔터키 누를 경우
        // 키패드 내리기
        val imm = requireActivity().getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
        imm.hideSoftInputFromWindow(edtSearch.windowToken, 0)
        true
    } else {
        false
    }
}