آموزش ساخت دفترچه یادداشت در فلاتر + کار با دیتابیس SQLite

در این آموزش برنامه نویسی فلاتر به طراحی دفترچه یادداشت با استفاه از دیتابیس SQLite میپردازیم و عملیات های مختلف را روی این پایگاه داده

سلام با یکی دیگه از آموزش های برنامه نویسی فلاتردر خدمت شما دوستان هستیم.

در این مطلب قصد داریم یک مینی پروژه با فریمورک فلاتر با موضوع اپلیکیشن یادداشت برداری درست کنیم.

مهم ترین بخش توسعه این پروژه ذخیره سازی یادداشت ها می باشد.

در فلاتر سه روش کلی برای پیاده سازی بخش ذخیره اطلاعات که شامل موارد زیر هست.

روش دوم را قبلا باهم دیگه کار کردیم.

اما در این پروژه میخوایم که از روش اول یعنی استفاده از دیتابیس و به دلیل اینکه یادگیری آن بسیار مهم هست را استفاده کنیم.

آشنایی با دیتابیس SQLite

SQLite یک سیستم مدیریت پایگاه داده رابطه‌ای (RDBMS) است که به خاطر سادگی، سرعت و اندازه کوچک‌اش شناخته شده است.

برخلاف بسیاری از پایگاه‌های داده دیگر، SQLite نیازی به یک سرور جداگانه ندارد و به صورت مستقیم در برنامه‌ها تعبیه می‌شود.

این ویژگی باعث شده تا SQLite در طیف وسیعی از کاربردها، از برنامه‌های موبایل و دسکتاپ گرفته تا سیستم‌های تعبیه‌شده و وب‌سایت‌ها، بسیار محبوب باشد.

برای شروع پروژه جدیدی در محیط برنامه نویسی خود ایجاد کنید.

بعد از ساخت پروژه, تمام کدها را پاک کنید تا از اول شروع به کد نویسی کنیم.

شروع برنامه نویسی فلاتر

کد صفحه main شما باید یک همچین حالتی داشته باشه.

 import 'package:flutter/material.dart';

void main() {
  runApp(MaterialApp(
    title: "Notes App",
    home: NotesList(),
  ));
}

class NotesList extends StatefulWidget {
  @override
  _NotesListState createState() => _NotesListState();
}

class _NotesListState extends State<NotesList> {
  @override
  Widget build(BuildContext context) {
    return Container();
  }
}

حالا نیاز داریم چندتا کتابخونه و پلاگین اضافه کنیم به برنامه.

ساخت اولین پروژه با Flutter

ما از سه پکیج زیر در طول پروژه استفاده می کنیم.

این کتابخانه ها را در فایل pubspec.yaml اضافه کنید تا به ادامه کارمون بپردازیم.

خب برای اینکه کارمون تمیز و اصولی باشه طبق تصویر زیر پکیج های که هست و در پروژه ایجاد کنید.

ساخت اپلیکیشن دفترچه یادداشت
دیتابیس فلاتر

این پکیج ها باید داخل پوشه lib باشند.

من فایل main خودم و به پکیج ui منتقل کردم.

داخل پکیج مدل کلاس مدل خودمون و میسازیم. برای اینکار روی پوشه models راست کلیک کنید و New > Dart File را انتخاب کنید.

کدهای کلاستون و به این شکل بنویسید.

 
class Note {
  String _text, _date; //our note contain text,create date and an Id
  int _id;

  Note.update(this._text, this._date, this._id);

  Note(this._text, this._date);

  Note.map(dynamic obj) {
    this._text = obj['name'];
    this._date = obj['date'];
    this._id = obj['id'];
  } 

  Note.fromMap(Map<String, dynamic> map) {
    this._text = map['name'];
    this._id = map['id'];
    this._date = map['date'];
  }

  Map<String, dynamic> toMap() {
    Map<String, dynamic> map = new Map<String, dynamic>();

    map['name'] = this._text;
    map['date'] = this._date;

    if (id != null) map['id'] = this._id;

    return map;
  }

  get name => _text;

  set name(value) {
    _text = value;
  }

  get date => _date;

  set date(value) {
    _date = value;
  }

  int get id => _id;

  set id(int value) {
    _id = value;
  }
}

جلوتر این کدها را توضیح میدم پس نترسید اگر دقیقا نمیدونید این کدها چی هستند.

حالا داخل پکیج util کلاسی به نام Constants بسازید.

در این کلاس رشته های ثابت خودمون و تعریف میکنیم مثل نام جدول و ستون ها.

 
class Constants {
  static final String TABLE_NAME = "noteTable";
  static final String COLUM_TEXT = "text";
  static final String COLUM_DATE = "date";
  static final String COLUM_ID = "id";
  static final int DB_VERSION = 1;
  static final String DBNAME = "notes.db";
}

پس با توجه به کدهای بالا اسم دیتابیس ما notes.db هست و اسم جدول مورد نظر هم noteTable که سه ستون ایدی,تاریخ و تکست داره.

خب تو ادامه بحث پیاده سازی باید بدونید که Sqflite از الگوی singleton استفاده میکنه.

در این الگو از کلاس موردنظر فقط و فقط یک آبجکت میشه ساخت.

خب با این طرز فکر جلو میریم و داخل پکیج database فایلی به نام database_helper میسازیم.

در این فایل کلاسی تحت عنوان DatabaseHelper ایجاد میکنیم و کدهای زیر را در آن قرار میدهیم.

 
import 'dart:async';
import 'dart:io';
import 'package:sqflite/sqflite.dart';
import 'package:path_provider/path_provider.dart';
import 'package:path/path.dart';
import 'package:todo_app/utils/constants.dart';
import 'package:todo_app/models/note.dart';
class DatabaseHelper{
static final DatabaseHelper _INSTANCE = new DatabaseHelper.make();

factory DatabaseHelper() =&gt; _INSTANCE;

static Database _db;

DatabaseHelper.make();
}

اما توضیح کد بالا:

_INSTANCE: گفتیم فقط یک instance از کلاس خودمون میتونیم بسازیم و این کار با استفاده از _INSTANCE انجام می دهیم.

factory: برای اینکه کانستراکتور کلاس بتونه یک instance را همیشه برگرداند.

DatabaseHelper.make(): یکی دیگه از کانستراکتور های کلاس ما هست که برای ساخت آبجکت از آن استفاده میکنیم.

Database _db: درواقع نمونه ای از دیتابیس ما است که در طول برنامه عملیات های خودمون و با آن انجام می دهیم.

نکته مهمی که به آن باید توجه کنید این هست که عملیات های دیتابیس در بک گراند انجام می شوند پس باید از حتما از کلمات کلیدی async,await,Future استفاده کنیم.

برای مقداردهی دیتابیس از کدهای زیر استفاده میکنیم.

 Future<Database> get db async {
  if (_db != null) return _db; 
  _db = await initDB();
  return _db;
}
------------------------------------------------------------------
initDB() async {
  Directory directory = await getApplicationDocumentsDirectory();
  String path = join(directory.path, Constants.DBNAME);
  var myDb =
      openDatabase(path, version: Constants.DB_VERSION, onCreate: _onCreate);

  return myDb;
}

متد اول متد get هست و آبجکت دیتابیس را برمیگرداند.

متد initDB هم یکبار اجرا می شود و دیتابیس ما را در مسیر مشخص شده ایجاد میکند.

حالا نوبت به پیاده سازی متد _onCreate میرسد.

این متد شامل کوئری های ایجاد دیتابیس و جدول می باشد.

 
void _onCreate(Database db, int version) async {
  await db.execute(
      "CREATE TABLE ${Constants.TABLE_NAME} (${Constants.COLUM_ID} INTEGER PRIMARY KEY, "
      "${Constants.COLUM_TEXT} TEXT, ${Constants.COLUM_DATE} TEXT );");
}

برای اضافه کردن اطلاعات به دیتابیس از متد زیر استفاده میکنیم.

 
Future<int> insertNote(Note note) async {
  var dbClient = await db;
  int count = await dbClient.insert(Constants.TABLE_NAME, note.toMap());

  return count;
}

این متد به عنوان پارامتر ورودی یک آبجکت از کلاس Note را دریافت و در دیتابیس ذخیره میکند.

مقدار count در متد آیدی منحصر به فرد اطلاعاتی میباشد که در دیتابیس ذخیره کردیم.

برای اینکه بتونیم یک ردیف به خصوص از اطلاعات را بعدا دریافت کنیم به این ایدی نیاز داریم.

در کلاس Note متدی داشتیم به نام toMap, این متد کار تبدیل آبجکت های کلاس به Map را انجام می دهد.

در Flutter تمام اطلاعات بصورت یک جفت key-value ذخیره می شود, اطلاعات دیتابیس هم به همین صورت هست.

پس برای اینکه آبجکت کلاس ما بتواند در دیتابیس ذخیره شود باید به map تبدیل شود.

خب برگردیم به دیتابیس خودمون, برای دریافت لیست تمام اطلاعات ذخیره شده از متد زیر استفاده می کنیم.

 
Future<List> getAllNotes() async {
  var dbClient = await db;
  var result = await dbClient.rawQuery(
      "SELECT * FROM ${Constants.TABLE_NAME} ORDER BY ${Constants.COLUM_TEXT} ASC");

  return result.toList();
}

یادتون باشه متد بالا اطلاعات و بصورت Map برمیگردونه.

برای ادامه کار متدی میسازیم که تعداد کل اطلاعات ذخیره شده در دیتابیس را نمایش دهد.

بریا مثال اگر دو ردیف اطلاعات در دیتابیس داریم این متد عدد 2 را برمیگرداند.

این کار در موارد مختلفی کاربرد. برای مثال زمانی که این متد عدد 0 را برمیگرداند میتونیم به کاربر پیام بدیم که هنوز هیچ اطلاعاتی وارد نکردید.

Future<int> getCount() async {
  var dbClient = await db;
  int count = Sqflite.firstIntValue(await dbClient
      .rawQuery("SELECT COUNT(*) FROM ${Constants.TABLE_NAME}"));
  return count;
}

اما مهم ترین بخش این پروژه فلاتر گرفتن اطلاعات یک ردیف مشخص از رکورد های دیتابیس می باشد.

برای این کار در قسمت قبلی گفتیم که نیاز به آیدی رکورد موردنظر خودمون داریم.

با داشتن آیدی و ارسال آن به متد زیر به عنوان پارامتر ورودی اطلاعات رکورد مورد نظرا را دریافت میکنیم.

Future<note> getSingleItem(int id) async {
  var dbClient = await db;
  var result = await dbClient.rawQuery(
      "SELECT * FROM ${Constants.TABLE_NAME} WHERE ${Constants.COLUM_ID} = $id");
  if (result == null) return null;
  return new Note.fromMap(result.first);
}

اگر یادتون باشه در کدهای کلاس Note یک کانستراکتور به نام Note.fromMap() داشتیم.

و همونطور هم که گفتیم در فلاتر اطلاعات بصورت Map در دیتابیس ذخیره میشه و طبیعتا هم موقع دریافت به صورت Map هستند.

این متد کار تبدیل Map به آبجکت معمولی از کلاس Note و انجام میده.

 Note.fromMap(Map<string, dynamic=""> map) {
  this._text = map['name'];
  this._id = map['id'];
  this._date = map['date'];
}

برای پیاده سازی متد مخصوص پاک کردن اطلاعات هم دوباره ما نیاز به آیدی رکورد خودمون داریم.

طبق متد زیر میبینید که علاوه بر آیدی دستور ما شامل نام جدول هم هست.

 
Future<int> deleteItem(int id) async {
  var dbClient = await db;
  int count = await dbClient.delete(Constants.TABLE_NAME,
      where: "${Constants.COLUM_ID} = ?", whereArgs: [id]);
  return count;
}

و اما آخرین کار مهمی که باید یاد بگیریم در دیتابیس انجام بدیم بروزرسانی اطلاعات هست.

برای بروزرسانی اطلاعات یک رکورد از دستور update استفاده میکنیم.

این متد هم از یک آیدی به عنوان پارامتر استفاده می کند.

 Future<int> updateItem(Note note) async {
  var dbClient = await db;
  int count = await dbClient.update(Constants.TABLE_NAME, note.toMap(),
      where: "${Constants.COLUM_ID} = ?", whereArgs: [note.id]);

  return count;
}

خب ما در این دو قسمت تونستیم کار با دیتابیس و به همراه دستورات اصلی یادبگیریم.

امیدوارم که این آموزش برنامه نویسی فلاتر مورد رضایت شما قرار گرفته باشد.

دیدگاه‌ها (7)

  • hosseini

    خیلی ممنون
    عالی بود.
    منتظر قسمت بعد هستم.

    • diba

      سلام ممنون از اموزش خوبتون یه سوال الان متدoncreate رو باید تو فایل main بنویسیم؟

        • diba

          Future get db async {
          if (_db != null) return _db;
          _db = await initDB();
          return _db;
          }
          الان این کلاس خودش اجرا میشه یا باید فراخوانی بشه؟

      • diba

        Future get db async {
        if (_db != null) return _db;
        _db = await initDB();
        return _db;
        }
        الان این کلاس خودش اجرا میشه یا باید فراخوانی بشه؟

        • diba

          Future get db async {
          if (_db != null) return _db;
          _db = await initDB();
          return _db;
          }
          الان این کلاس خودش اجرا میشه یا باید فراخوانی بشه؟
          من الان مقدار خروجی متد grtCount رو که فراخوانی میکنم همچین چیزی دریافت میکنم instance of &#39;Future&#39;

          • Hesam نویسنده

            این کلاس نیست این متد هست, شما از کلاس کلی باید نمونه بسازید و از متد insert یا بقیه متد در کلاسی که میخواید استفاده کنید.
            برای درک بهتر میتونید مطلب کار با sqfilte که داخل سایت هست و مطالعه کنید.
            همچنین داخل دوره های آموزشی تمام این مباحث پوشش داده شده.

          دیدگاه خود را بنویسید

          ایمیل شما نمایش داده نمی‌شود. دیدگاه پس از تأیید نمایش داده می‌شود.