openplanning

Hướng dẫn và ví dụ Flutter SharedPreferences

  1. Cài đặt thư viện
  2. Ghi, đọc và xoá từ SharedPreferences
  3. Ví dụ
  4. Bài thực hành
Trước hết để làm rõ SharedPreferences là gì hãy xem một tình huống:
Bạn đang chơi một trò chơi được viết trên Flutter, trước khi chơi trò chơi đó bạn lựa chọn các thông số của trò chơi chẳng hạn độ sáng, mức độ âm lượng, và độ khó. SharedPreferences cho phép bạn lưu lại thiết lập này trên thiết bị của bạn và nó sẽ được sử dụng trong lần chơi tiếp theo.
Hive là một thư viện tương tự shared_preferences nhưng mạnh mẽ hơn, nó được thiết kế giống như một cơ sở dữ liệu No-SQL. Nếu bạn cần lưu trữ các dữ liệu lớn tại địa phương thì Hive là một lựa chọn tốt.
  • Flutter hive
flutter_secure_storage cũng là một thư viện tương tự shared_preferences, được sử dụng để lưu các dữ liệu nhạy cảm trên thiết bị của người dùng một cách an toàn, chẳng hạn "Access Token"....
  • Flutte flutter_secure_storage

1. Cài đặt thư viện

pubspec.yaml
dependencies: 
  shared_preferences: ^2.2.3
Nhập khẩu SharedPreferences trong mã Dart:
import 'package:shared_preferences/shared_preferences.dart';

2. Ghi, đọc và xoá từ SharedPreferences

Ghi các giá trị vào SharedPreferences:
// Obtain shared preferences.
final prefs = await SharedPreferences.getInstance();

// Save an integer value to 'my_int_val' key.
await prefs.setInt('my_int_val', 10);

// Save an boolean value to 'my_bool_val' key.
await prefs.setBool('my_bool_val', true);

// Save an double value to 'my_double_val' key.
await prefs.setDouble('my_double_val', 1.5);

// Save an String value to 'my_note' key.
await prefs.setString('my_note', 'Go to the Beach');

// Save an list of strings to 'characters' key.
await prefs.setStringList('characters', ['Tom', 'Jerry', 'Donald']);
Đọc các giá trị đã được lưu trong SharedPreferences.
// Obtain shared preferences.
final prefs = await SharedPreferences.getInstance();

// Get an integer value from 'my_int_val' key.
int? intVal = await prefs.getInt('my_int_val');

// Get a boolean value from 'my_bool_val' key.
bool? boolVal = await prefs.getBool('my_bool_val');

// Get a double value from 'my_double_val' key.
double? doubleVal = await prefs.getDouble('my_double_val');

// Get a String value from 'my_note' key.
String? note = await prefs.getString('my_note');

// Get a list of strings from 'characters' key.
List<String>? characters = await prefs.getStringList('characters');
Xoá một khoá ra khỏi SharedPreferences
// Obtain shared preferences.
final prefs = await SharedPreferences.getInstance();

// Remove value for the 'my_int_val' key.
bool removed = await prefs.remove('my_int_val');
Chú ý: Hai ứng dụng Flutter khác nhau sẽ sử dụng 2 SharedPreferences khác nhau kể cả khi chúng đang cùng chạy trên một thiết bị, vì vậy bạn không cần phải lo lắng về việc xung đột "KEY" (khoá) của SharedPreferences giữa hai ứng dụng khác nhau.
Hai ứng dụng Flutter Web với tên miền khác nhau hoặc cổng (port) khác nhau cũng sử dụng 2 SharedPreferences khác nhau.

3. Ví dụ

Trong ví dụ này, bạn sẽ nhập vào một "Ghi chú" và nhấn nút "Save" để lưu nội dung vào khoá "my_note" của SharedPreferences. Tiếp theo, đóng ứng dụng Flutter.
Mở lại ứng dụng Flutter, nội dung "ghi chú" của bạn sẽ được đọc từ SharedPreferences và hiển thị trên màn hình.
Chú ý quan trọng:
Hai ứng dụng Flutter Web chạy trên 2 tên miền khác nhau hoặc hai cổng khác nhau sẽ sử dụng 2 SharedPreferences khác nhau. Vì vậy, để đảm bảo test thành công ví dụ này trên môi trường Web của Android Studio bạn cần phải chỉ định một cổng cố định cho Flutter Web.
main.dart
import 'package:flutter/material.dart';
import 'package:shared_preferences/shared_preferences.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      debugShowCheckedModeBanner: false,
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key});

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final TextEditingController controller = TextEditingController();
  String? myNote;

  @override
  void initState() {
    super.initState();
    //
    readMyNoteInSharedPreferences();
  }

  Future<void> readMyNoteInSharedPreferences() async {
    final prefs = await SharedPreferences.getInstance();
    myNote = await prefs.getString("my_note");
    setState(() {});
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: const Text('Flutter SharedPreferences Demo'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text('My Note: $myNote'),
            const SizedBox(height: 10),
            TextField(
              controller: controller,
              decoration: const InputDecoration(
                border: OutlineInputBorder(),
                labelText: 'My Note',
                hintText: 'Enter a Note',
              ),
            ),
            const SizedBox(height: 10),
            ElevatedButton(
              onPressed: _saveMyNote,
              child: const Text("Save"),
            ),
          ],
        ),
      ),
    );
  }

  Future<void> _saveMyNote() async {
    final prefs = await SharedPreferences.getInstance();
    String text = controller.text;
    // Save a String to 'my_note' key of SharedPreferences.
    await prefs.setString("my_note", text);
    //
    ScaffoldMessenger.of(context).hideCurrentSnackBar();
    ScaffoldMessenger.of(context).showSnackBar(
      const SnackBar(content: Text("Saved!")),
    );
  }
}

Các hướng dẫn lập trình Flutter

Show More