🐝Hive - локальное хранилище: Введение

1. Методы

2. Мини приложение

Hive — это легковесная база данных для Flutter и Dart, которую можно использовать прямо на устройстве пользователя, например, на смартфоне. Она помогает хранить данные локально, то есть прямо на устройстве, без подключения к интернету. Представь её как коробку, в которой можно аккуратно сложить вещи (данные), и ты всегда можешь легко найти и взять то, что тебе нужно.

Зачем нужен Hive?

1. Хранение данных локально — Hive полезен, когда нужно сохранять данные, чтобы они были доступны всегда, даже без интернета.

2. Высокая производительность — Hive очень быстро работает, что важно для приложений, где нужно хранить и быстро загружать много данных.

3. Простота в использовании — Hive легко интегрировать в Flutter-проект, и с ним просто работать даже для начинающих.

Теперь, давай разберём основные методы и свойства Hive.

Основные термины

1. Box (Коробка) — это контейнер, в котором хранятся данные. Ты можешь представлять box как шкафчик, где все данные организованы и лежат на своих местах.

2. Key (Ключ) — это название или метка, по которой ты можешь достать нужные данные из box. Например, если у тебя есть ключ “имя”, ты можешь по нему найти значение “Алексей”.

Методы и свойства Hive

openBox

Future<Box> openBox(String boxName) async {
  return await Hive.openBox(boxName);
}

Объяснение: Эта функция открывает коробку (box) с определённым именем. Представь это как открытие коробки с записями, куда мы можем класть данные и позже их оттуда доставать. Если коробка ещё не была создана, Hive создаст её автоматически.

---

2. closeBox

Future<void> closeBox(Box box) async {
  await box.close();
}

Объяснение: Эта функция закрывает открытую коробку. Представь, что ты закончил использовать коробку с записями и теперь хочешь её закрыть, чтобы данные были в сохранности и не занимали память.

---

3. putData

Future<void> putData(Box box, String key, dynamic value) async {
  await box.put(key, value);
}

Объяснение: Эта функция кладёт (сохраняет) данные в коробку по определённому ключу. Представь, что ты пишешь заметку и вкладываешь её в коробку с меткой (ключом) — так потом легко найти нужную запись.

---

4. getData

dynamic getData(Box box, String key) {
  return box.get(key);
}

Объяснение: Эта функция достаёт (читает) данные из коробки по ключу. Например, если ты сохранил заметку с ключом "имя", то с помощью этой функции можешь достать её, просто указав ключ.

---

5. putAllData

Future<void> putAllData(Box box, Map<String, dynamic> data) async {
  await box.putAll(data);
}

Объяснение: Эта функция позволяет сохранить несколько записей одновременно. Представь, что ты хочешь положить сразу несколько заметок в коробку, и у каждой есть своё имя (ключ). Ты просто передаёшь их в виде списка (Map).

---

6. getDataAt

dynamic getDataAt(Box box, int index) {
  return box.getAt(index);
}

Объяснение: Эта функция достаёт данные по индексу. Это как в коробке: можно взять любую запись, зная её номер (индекс) в коробке, например, первую или пятую запись.

---

7. deleteData

Future<void> deleteData(Box box, String key) async {
  await box.delete(key);
}

Объяснение: Эта функция удаляет запись из коробки по ключу. Например, ты хочешь вытащить и выбросить определённую заметку — просто указываешь её ключ, и она удаляется.

---

8. clearBox

Future<void> clearBox(Box box) async {
  await box.clear();
}

Объяснение: Эта функция очищает все данные в коробке. Это как если бы ты решил выбросить все заметки из коробки и оставить её полностью пустой.

---

9. containsKey

bool containsKey(Box box, String key) {
  return box.containsKey(key);
}

Объяснение: Эта функция проверяет, есть ли в коробке заметка с определённым ключом. Представь, что ты ищешь заметку, но не знаешь точно, есть она или нет — с этой функцией можно это быстро проверить.

---

10. getBoxLength

int getBoxLength(Box box) {
  return box.length;
}

Объяснение: Эта функция возвращает количество записей в коробке. Это как если бы ты захотел узнать, сколько всего заметок хранится в коробке.

---

11. isBoxEmpty

bool isBoxEmpty(Box box) {
  return box.isEmpty;
}

Объяснение: Эта функция проверяет, пустая ли коробка. Это полезно, если тебе нужно знать, остались ли записи, прежде чем добавлять новые или читать старые.

---

12. isBoxNotEmpty

bool isBoxNotEmpty(Box box) {
  return box.isNotEmpty;
}

Объяснение: Эта функция проверяет, не пустая ли коробка. Это то же самое, что и проверка на наличие записей, только с обратным результатом — true, если в коробке есть записи.

---

13. getBox

Box getBox(String boxName) {
  return Hive.box(boxName);
}

Объяснение: Эта функция даёт доступ к уже открытому box по его имени. Если коробка уже открыта, её не нужно открывать снова. Просто используешь эту функцию, чтобы к ней подключиться.

---

14. getOpenBoxNames

List<String> getOpenBoxNames() {
  return Hive.boxNames.toList();
}

Объяснение: Эта функция возвращает список всех открытых коробок. Это как список всех именованных коробок, которые ты используешь, чтобы видеть, какие из них сейчас доступны.

---

15. deleteBoxFromDisk

Future<void> deleteBoxFromDisk(String boxName) async {
  await Hive.deleteBoxFromDisk(boxName);
}

Объяснение: Эта функция удаляет коробку с устройства, включая все её данные. Представь, что ты удаляешь коробку полностью, как физически выбрасываешь её с данными.

---

16. registerAdapter

void registerAdapter<T>(TypeAdapter<T> adapter) {
  Hive.registerAdapter(adapter);
}

Объяснение: Эта функция позволяет зарегистрировать адаптер для сохранения сложных объектов. Когда ты хочешь сохранить что-то более сложное, чем обычный текст или числа, нужно объяснить Hive, как с этим работать. "Адаптер" — это как инструкция для коробки, которая показывает, как хранить и доставать такие объекты.

Мини приложение

Давай создадим простое Flutter-приложение с Hive, которое хранит и отображает список заметок. Мы разберем весь путь: от настройки Hive до реализации функций для добавления, удаления и отображения заметок.

Шаг 1. Создание проекта

1. Открой терминал и создайте новый Flutter-проект:

   bashКопировать кодflutter create hive_demo
   cd hive_demo

2. Открой проект в любимом редакторе, например, в Visual Studio Code.

Шаг 2. Установка зависимостей

Добавим в pubspec.yaml необходимые зависимости:

1. Открой файл pubspec.yaml.

2. В разделе dependencies добавь hive и hive_flutter для работы с Hive и интеграции с Flutter.

dependencies:
  flutter:
    sdk: flutter
  hive: последняя версия
  hive_flutter: последняя версия

1. Сохрани изменения, затем запусти команду в терминале, чтобы установить зависимости:

   flutter pub get

Шаг 3. Инициализация Hive

Инициализируем Hive в приложении.

1. Открой файл lib/main.dart.

2. Импортируй пакеты hive и hive_flutter.

3. Инициализируй Hive в main функции перед запуском приложения.

import 'package:flutter/material.dart';
import 'package:hive/hive.dart';
import 'package:hive_flutter/hive_flutter.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Hive.initFlutter(); // Инициализация Hive для работы с Flutter
  await Hive.openBox('notesBox'); // Открываем коробку для хранения заметок

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Hive Demo',
      theme: ThemeData(),
      home: NotesScreen(),
    );
  }
}

Шаг 4. Создание пользовательского интерфейса

Создадим экран NotesScreen, который будет отображать список заметок и позволит добавлять и удалять их.

1. Создай файл lib/notes_screen.dart.

2. Импортируй необходимые пакеты и создай StatefulWidget.

import 'package:flutter/material.dart';
import 'package:hive/hive.dart';
import 'package:hive_flutter/hive_flutter.dart';

class NotesScreen extends StatefulWidget {
  @override
  _NotesScreenState createState() => _NotesScreenState();
}

class _NotesScreenState extends State<NotesScreen> {
  final TextEditingController _controller = TextEditingController();
  final Box notesBox = Hive.box('notesBox');

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Hive Notes App'),
      ),
      body: Column(
        children: [
          Expanded(
            child: ValueListenableBuilder(
              valueListenable: notesBox.listenable(),
              builder: (context, box, _) {
                // Проверяем, если нет данных в Box
                if (box.isEmpty) {
                  return Center(
                    child: Text('No notes yet!'),
                  );
                }

                // Если данные есть, отображаем их списком
                return ListView.builder(
                  itemCount: box.length,
                  itemBuilder: (context, index) {
                    final note = box.getAt(index);
                    return ListTile(
                      title: Text(note),
                      trailing: IconButton(
                        icon: Icon(Icons.delete),
                        onPressed: () => deleteNote(index),
                      ),
                    );
                  },
                );
              },
            ),
          ),
          Padding(
            padding: const EdgeInsets.all(16.0),
            child: Row(
              children: [
                Expanded(
                  child: TextField(
                    controller: _controller,
                    decoration: InputDecoration(
                      labelText: 'Add a new note',
                      border: OutlineInputBorder(),
                    ),
                  ),
                ),
                SizedBox(width: 10),
                ElevatedButton(
                  onPressed: addNote,
                  child: Text('Add'),
                ),
              ],
            ),
          ),
        ],
      ),
    );
  }

  void addNote() {
    final note = _controller.text;

    if (note.isNotEmpty) {
      notesBox.add(note);
      _controller.clear();
    }
  }

  void deleteNote(int index) {
    notesBox.deleteAt(index);
  }
}

Шаг 5. Объяснение кода

• TextEditingController: используется для считывания текста из текстового поля, чтобы добавлять новые заметки.

• Box notesBox: мы открываем box, который будет хранить все заметки.

• ValueListenableBuilder: это виджет, который обновляется автоматически, когда данные в box изменяются (например, при добавлении или удалении заметки).

  • notesBox.listenable() делает box наблюдаемым, так что он оповещает ValueListenableBuilder о любых изменениях.

• ListView.builder: отображает список всех заметок.

• Кнопка удаления: для каждой заметки есть кнопка, чтобы удалить её по индексу.

• Функция addNote(): добавляет текст из TextField как новую заметку в box. После добавления поле очищается.

• Функция deleteNote(): удаляет заметку по индексу.

Шаг 6. Запуск приложения

Запусти приложение командой:

flutter run

Теперь у тебя будет простое приложение для заметок, использующее Hive для локального хранения данных.