[Android Studio] SQLite 예제 (1) MyDBHelper를 외부 클래스로 작성

---

💡  간단한 메모를 저장하고 사용하는 프로젝트 

 

  이 프로젝트에서 메모 데이터를 저장하고 사용할 테이블을 다음처럼 설계

CREATE TABLE memo (
    num INTEGER PRIMARY KEY,
    content TEXT,
    datetime INTEGER
)

 

 -  SQLite 에서는 INTEGER 타입이 primary key 이면 숫자가 자동 증가됨

---

1.  SQLiteOpenHelper 사용하기

  👾  SQLiteOpenHelper 클래스는 데이터베이스를 파일로 생성하고 코틀린 코드에서 사용할 수 있도록 데이터베이스와 연결하는 역할

 

1) 프로젝트 생성 후 [app] - [java] 디렉토리 밑에 있는 패키지에 SQLiteHelper 클래스를 생성

---

2) 클래스 정의 및 생성자

 

-  SQLite 데이터베이스를 사용하려면 SQLiteOpenHelper 클래스를 상속받아야 함

-  SQLiteOpenHelper는 생성 시에 Context, 데이터베이스명, 팩토리, 버전 정보가 필요. 팩토리는 사용하지 않아도 되므로 나머지 세 가지 정보를 내가 만든 클래스의 생성자에 파라미터로 정의한 후에 상속받은 SQLiteOpenHelper에 전달.

class SQLiteHelper(context: Context, name: String, version: Int):
    SQLiteOpenHelper(context, name, null, version)  {

---

 

3) SQLiteOpenHelper 메서드를 구현

class SQLiteHelper(context: Context, name: String, version: Int):
    SQLiteOpenHelper(context, name, null, version)  {
    override fun onCreate(p0: SQLiteDatabase?) {
        // 데이터베이스가 처음 생성될 때 호출
    }

    override fun onUpgrade(p0: SQLiteDatabase?, p1: Int, p2: Int) {
        // 데이터베이스 업그레이드 시 호출
    }

---

 

4) 아직 데이터베이스가 생성되지 않았기 때문에 onCreate() 메서드에서 테이블을 생성

  -  이 메서드 안에 테이블 생성 쿼리를 작성하고 실행. 데이터베이스가 생성되어 있으면 더 이상 실행되지 않음. onCreate() 메서드 안에 앞에서 만든 테이블 생성 쿼리를 문자열로 입력한 후, db의 execSQL() 메서드에 전달해서 실행

override fun onCreate(p0: SQLiteDatabase?) {
    val sql = "CREATE TABLE `memo` (`num` INTEGER PRIMARY KEY," +
        "`content` TEXT, `datetime` INTEGER)"
        p0?.execSQL(sql)
}

---

 

5) Memo 데이터 클래스

 

  -  SQLiteHelper 클래스의 바깥에 Memo 클래스를 하나 생성하고 정의

        ➡️  이 클래스는 SQLite 데이터베이스와 상호작용하여 메모 데이터를 관리하는 기본적인 CRUD(생성, 읽기, 업데이트, 삭제) 작업을 수행할 수 있도록 함

data class Memo(var num: Long?, var content: String, var datetime: Long)

 

num과 datetime의 타입을 데이터베이스에서는 INTEGER로 정의했는데, 여기서는 Long. 숫자의 범위가 서로 다르기 때문.
특별한 이유가 없다면 SQLite에서 INTEGER로 선언한 것은 소스 코드에서는 Long으로 사용.
그리고 num만 null을 허용한 것은 PRIMARY KEY 옵션으로 값이 자동으로 증가 되기 때문에 데이터 삽입 시에는 필요하지 않음.

 

---

2. 삽입 메서드

1) SQLiteOpenHelper를 이용해서 값을 입력할 때는 코틀린의 Map 클래스처럼 키, 값 형태로 사용되는 ContentValues 클래스를 사용

 

  👾  ContentValues에 put("컬럼명", 값)으로 저장

fun insertMemo(memo: Memo) {
    val value = ContentValues()
    value.put("content", memo.content)
    value.put("datetime", memo.datetime)
}

---

 

2) 상속받은 SQLiteOpenHelper에 이미 구현된 writableDatabase에 테이블명과 함께 앞에서 작성한 값을 전달해서 insert()하고, 사용한 후에는 close()를 호출하여 꼭 닫아줘야 함

fun insertMemo(memo: Memo) {
    val value = ContentValues()
    value.put("content", memo.content)
    value.put("datetime", memo.datetime)

    writableDatabase.insert("memo", null, value)
    writableDatabase.close()
}

 

  -  첫 번째 파라미터 : 테이블 이름 / 두 번째 파라미터 : 값이 null 일 때 입력 방지 / 세 번째 파라미터 : 삽입할 데이터를 포함하는 ContentValues 객체

---

3.  조회 메서드

1)  조회 메서드는 반환값이 있으므로 메서드의 가장 윗줄에 반환할 값을 변수로 선언하고, 가장 아랫줄에 반환하는 코드를 작성한 후 그 사이에 구현 코드를 작성하는 것이 좋음

fun selectMemo(): MutableList<Memo> {
    val list = mutableListOf<Memo>()
    
    return list
}

---

2) 메모의 전체 데이터를 조회하는 쿼리를 작성

val sql = "SELECT * FROM memo"

---

3) 읽기 전용 데이터베이스를 변수에 담음

val rd = readableDatabase

---

 

4) 데이터베이스의 rawQuery() 메서드에 앞에서 작성해둔 쿼리를 담아서 실행하면 커서 cursor 형태로 반환

 val cursor = rd.rawQuery(sql, null)

 

커서 Cursor

데이터셋을 처리할 때 현재 위치를 포함하는 데이터 요소. 커서를 사용하면 쿼리를 통해 반환된 데이터셋을 반복문으로 반복하며 하나씩 처
리할 수 있음. 반복할 때마다 커서가 현재 위치를 가르키고 있어 [데이터 읽기 -> 다음 줄 이동]의 단순 로직으로 데이터를 쉽게 처리할 수 있음.

---

 

5) 커서의 moveToNext() 메서드가 실행되면 다음 줄에 사용할 수있는 레코드가 있는지 여부를 반환하고, 해당 커서를 다음 위치로 이동. 레코드가 없으면 반복문을 빠져나감. 모든 레코드를 읽을 때까지 반복.

while(cursor.moveToNext()) { }

---

 

6) 반복문을 돌면서 테이블에 정의된 3개의 컬럼에서 값을 꺼낸 후 각각 변수에 담음

val num = cursor.getLong(0)
val content = cursor.getString(1)
val datetime = cursor.getLong(2)

 

---

 

7) 앞에서 변수에 저장해두었던 값들로 Memo 클래스를 생성하고 반환할 목록에 더함

list.add(Memo(num, content, datetime))

---

 

8) while 문의 블록 밖에서 커서와 읽기 전용 데이터베이스를 모두 닫아 줌

cursor.close()
rd.close()

---

    fun selectMemo(): MutableList<Memo> {
        val list = mutableListOf<Memo>()
        val sql = "SELECT * FROM memo"
        val rd = readableDatabase

        val cursor = rd.rawQuery(sql, null)
        while(cursor.moveToNext()) {
            val num = cursor.getLong(0)
            val content = cursor.getString(1)
            val datetime = cursor.getLong(2)
            list.add(Memo(num, content, datetime))
        }
        cursor.close()
        rd.close()
        return list
    }

 

---

4. 수정 메서드

1) INSERT와 동일하게 ContentValues를 사용해서 수정할 값을 저장

 fun updateMemo(memo: Memo) {
        val values = ContentValues()
        values.put("content", memo.content)
        values.put("datetime", memo.datetime)
 }

---

 

2) writableDatabase의 update() 메서드를 사용하여 수정한 다음 close()를 호출

update() 메서드의 파라미터는 총 4개인데 (테이블명, 수정할 값, 수정할 조건)
수정할 조건은 PRIMARY KEY로 지정된 컬럼을 사용하며 여기에서는 PRIMARY KEY인 컬럼이 num이기 때문에 'num = 숫자'가 됨.
세 번째 값을 'num = ?'의 형태로 입력하고, 네 번째 ?에 매핑할 값을 arrayOf("${memo.num}")의 형태로 전달할 수도 있음. 여기서는 세 번째에 조건과 값을 모두 할당했기 때문에 네 번째에 null을 사용

fun updateMemo(memo: Memo) {
    val values = ContentValues()
    values.put("content", memo.content)
    values.put("datetime", memo.datetime)

    val wd = writableDatabase
    wd.update("memo", values, "num = ${memo.num}", null)
    wd.close()
}

 

---

5. 삭제 메서드

SQLiteOpenHelper 클래스를 사용하면 insert(), update() 메서드의 사용법만 알면 쿼리를 몰라도 데이터베이스를 사용할 수 있음. 하지만 복잡한 데이터베이스를 다룰 때는 쿼리를 직접 작성하면 데이터를 더 정밀하게 다룰 수 있으므로 쿼리를 공부하는 것이 중요. 삭제 메서드 (DELETE)는 쿼리를 직접 입력해서 데이터를 삭제하는 코드로 작성.

1) 데이터 삭제 메서드를 작성

  -  조건식은 '컬럼명 = 값'의 형태가 됨. 삭제 쿼리를 작성하고 변수에 저장

 fun deleteMemo(memo: Memo) {
        val sql = "DELETE FROM memo WHERE num=${memo.num}"
 }

---

 

2) writableDatabase의 execSQL() 메서드로 쿼리를 실행한 후 close()를 호출. execSQL() 메서드로 쿼리를 직접 실행할 수 있음

fun deleteMemo(memo: Memo) {
        val sql = "DELETE FROM memo WHERE num=${memo.num}"
        val wd = writableDatabase
        wd.execSQL(sql)
        wd.close()
}

 

 

 

 

 

[ 내용 참고 : IT 학원 강의 ]