[flutter] 플러터(sqflite)에서의 데이터베이스 관련 코딩 가이드라인

15 Dec 2023

flutter

플러터 앱에서 데이터베이스를 다루는 것은 매우 중요합니다. 데이터베이스를 효율적으로 다루기 위해서는 몇 가지 가이드라인을 따르는 것이 좋습니다. 이 가이드에서는 sqflite를 사용하여 플러터에서 데이터베이스를 다룰 때 주의할 점과 권장되는 방법에 대해 설명하겠습니다.

코드 가독성과 모듈화

데이터베이스 관련 코드는 가능한 한 가독성 있게 작성해야 합니다. 명확한 변수명과 주석을 활용하여 다른 개발자들이 코드를 이해하는 데 도움이 되도록 작성해야 합니다. 또한, 데이터베이스 관련 기능(테이블 생성, 데이터 삽입/수정/삭제)은 모듈화하여 코드의 재사용성을 높이는 것이 좋습니다.

// 예시: 데이터베이스 헬퍼 클래스
class DatabaseHelper {
  // 데이터베이스 초기화 및 업그레이드
  // ...

  // 특정 테이블에 데이터 삽입
  // ...

  // 데이터 조회 쿼리
  // ...
}

비동기 처리와 에러 핸들링

sqflite를 사용하여 데이터베이스를 다룰 때, 대부분의 작업은 비동기로 처리됩니다. 그렇기 때문에 데이터베이스 관련 코드는 비동기 함수로 작성되어야 합니다. 또한, 데이터베이스 작업 중 발생할 수 있는 에러에 대한 핸들링이 중요합니다. try-catch나 Future.catchError를 통해 적절히 에러를 처리하는 것이 좋습니다.

Future<void> insertData(Data data) async {
  try {
    await _database.insert(table, data.toMap());
  } catch (e) {
    // 에러 처리
  }
}

모델 클래스 정의

데이터베이스에서 사용할 데이터의 형식을 정의하는 모델 클래스는 필수입니다. 이를 통해 데이터의 구조를 명확히 정의하고, 데이터베이스와의 상호 변환을 쉽게 할 수 있습니다.

// 예시: 모델 클래스 정의
class Data {
  int id;
  String name;
  // ...
  Map<String, dynamic> toMap() {
    // ...
  }
}

데이터베이스 접근 및 쿼리

데이터베이스에 접근하고 쿼리를 실행하는 부분은 코드가 복잡해지기 쉬우므로 신중하게 다뤄져야 합니다. sqflite에서 제공하는 함수들을 활용하여 효율적이고 안전한 데이터베이스 접근 코드를 작성해야 합니다.

Future<List<Data>> getDataList() async {
  final List<Map<String, dynamic>> maps = await _database.query(table);
  return List.generate(maps.length, (i) {
    return Data(
      id: maps[i]['id'],
      name: maps[i]['name'],
      // ...
    );
  });
}

결론

플러터(sqflite)에서의 데이터베이스 다루기는 신중한 접근이 필요합니다. 가독성과 모듈화, 비동기 처리와 에러 핸들링, 모델 클래스 정의 등을 고려하여 데이터베이스 관련 코드를 작성하는 것이 중요합니다. 이러한 가이드라인을 따르면 코드의 유지보수성과 확장성을 높일 수 있습니다.

목차

코드 가독성과 모듈화

비동기 처리와 에러 핸들링

모델 클래스 정의

데이터베이스 접근 및 쿼리

결론