[Android] SQLite

 💡 우아한테크코스 활동 중에 사용한 SQLite에 대하여 학습하였습니다 !

 

SQLite

• SQLite는 데이터베이스 관리 시스템으로 서버가 아닌 응용 프로그램에 넣어 사용하는 가벼운 데이터베이스입니다.
• 로컬 데이터를 관리해야 하는 다양한 애플리케이션에서 사용되며, 아래와 같은 예시에 주로 활용됩니다 !
  • 사용자 설정 정보
  • 즐겨찾기
  • 캐시 데이터
  • 사용자의 오프라인 생성 데이터
• 안드로이드에 내장되어 있으며, 어플이 종료되거나 디바이스 전원이 꺼지더라도 삭제되지 않습니다.

DBConstant

• SQLite 데이터베이스를 사용할 때, 데이터베이스 관련 상수들을 정의하는 역할을 하는 Constant입니다.
• 주요 코드의 가독성을 높이고, 실수를 방지하면서 쉽게 참조할 수 있도록 하기 위해 사용합니다.
• 아래는 우아한테크코스 활동 중에 선언한 오목 데이터베이스를 위한 Constant 입니다.

object OmockDBConstant {
    const val X_COORDINATE = "x_column"
    const val Y_COORDINATE = "y_row"
    const val TABLE_NAME = "omok_coordinates"
}

• 각 오목에 대한 x,y 좌표를 저장하기 위한 상수와 테이블 생성을 위한 테이블 명을 선언하였습니다.

SQLiteOpenHelper

• SQLiteOpenHelper를 상속하여 데이터베이스 생성, 업그레이드 및 관리를 수행할 수 있습니다.
• 아래 두 가지 메서드를 오버라이드 합니다.
  • onCreate() : 데이터베이스가 처음 생성 될 때 호출됩니다.
  • onUpgrade() : 데이터베이스 스키마가 변경될 때 호출됩니다.

class DBHelper(context: Context) :
    SQLiteOpenHelper(context, DATABASE_NAME, null, DATABASE_VERSION) {

    override fun onCreate(db: SQLiteDatabase?) {
        val createTableQuery =
            "CREATE TABLE omok_coordinates (" +
                "_id INTEGER PRIMARY KEY AUTOINCREMENT," +
                "${OmockDBConstant.X_COORDINATE} INTEGER," +
                "${OmockDBConstant.Y_COORDINATE} INTEGER" +
                ");"
        db?.execSQL(createTableQuery)
    }

    override fun onUpgrade(
        db: SQLiteDatabase?,
        oldVersion: Int,
        newVersion: Int,
    ) {
        db?.execSQL("DROP TABLE IF EXISTS omok_coordinates")
        onCreate(db)
    }

    companion object {
        private const val DATABASE_NAME = "omok.db"
        private const val DATABASE_VERSION = 4
    }
}

• onCreate() 시에 테이블 쿼리를 생성하고, execSQL을 활용하여 SQL 쿼리를 실행합니다.
  • 테이블 쿼리 생성 시 고유 id(PRIMARY KEY)와 상수로 선언한 x,y 좌표를 Int 값으로 선언하였습니다.

DAO

• DAO란 Data Access Object의 약자로 데이터베이스의 data에 접근하기 위한 객체입니다.
• DB에 접근하기 위한 로직을 분리하기 위해 사용하였습니다.
• DAO에 총 3가지 메서드를 선언하였습니다.
• 쿼리에 대한 접근만 허용하는 경우 DB를 readableDatabase로 생성합니다.
• 쿼리에 대한 수정, 삭제, 추가가 이루어지는 경우 writableDatabase로 생성합니다.

class OmokDAO(context: Context) {
    private val dbHelper = DBHelper(context)
	
		....
		
		companion object {
        private const val DATABASE_NAME = "omok.db"
        private const val DATABASE_VERSION = 4
    }
}

Insert

• insertCoordinate(x,y) : x,y 좌표를 받아서 db에 저장하는 메서드입니다.

fun insertCoordinate(
    x: Int,
    y: Int,
) {
    val db = dbHelper.writableDatabase
    val values =
        ContentValues().apply {
            put(OmockDBConstant.X_COORDINATE, x)
            put(OmockDBConstant.Y_COORDINATE, y)
        }
    db.insert(OmockDBConstant.TABLE_NAME, null, values)
    db.close()
}

Select

• getAllCoordinates() : DB에 저장 된 모든 x,y 좌표를 불러오는 메서드입니다.
  • 커서를 사용하여 모든 데이터를 읽어올 때까지 반복합니다.

fun getAllCoordinates(): List<Pair<Int, Int>> {
    val db = dbHelper.readableDatabase
    val cursor: Cursor =
        db.rawQuery(
            "SELECT ${OmockDBConstant.X_COORDINATE},${OmockDBConstant.Y_COORDINATE} FROM omok_coordinates",
            null,
        )
    val coordinates = mutableListOf<Pair<Int, Int>>()
    with(cursor) {
        while (moveToNext()) {
            val column = getInt(getColumnIndexOrThrow(OmockDBConstant.X_COORDINATE))
            val row = getInt(getColumnIndexOrThrow(OmockDBConstant.Y_COORDINATE))
            coordinates.add(Pair(column, row))
        }
    }
    cursor.close()
    db.close()
    return coordinates
}

Delete

• resetAllCoordinates() : 모든 좌표를 제거하는 메서드입니다.

fun resetAllCoordinates() {
    val db = dbHelper.writableDatabase
    db.delete(OmockDBConstant.TABLE_NAME, null, null)
    db.close()
}

Activity에서 DAO 접근

• 이제 작성한 DAO를 액티비티에서 생성해서 사용할 수 있습니다.

private val dao = OmokDAO(this@MainActivity)

• 위처럼 선언하여 사용할 수 있으며, DAO에 생성한 쿼리를 실행하는 함수로 간단하게 사용할 수 있습니다.

//insert
dao.insertCoordinate(columIndex, rowIndex)
//select
dao.getAllCoordinates().forEach { (columnIndex, rowIndex) -> }
//delete
dao.resetAllCoordinates()

정리

• SQLite는 애플리케이션 내에서 서버와 연결 없이 데이터를 로컬에 영구 저장해야 하는 경우 유용하게 사용할 수 있습니다.
• 경량형 데이터베이스 관리 시스템으로 간편하게 사용할 수 있다는 장점이 있습니다.
• 단점으로는 동시성 보장과 대규모 데이터 처리에 부적합하다는 것입니다.
  • 동시에 쓰기 작업을 처리하는 데 제약이 있음
  • 다수의 쓰기 작업을 통한 성능 저하가 있음
  • 대규모 애플리케이션에는 효율적이지 않음