Backpack

# Backpack

<div id="introduction"></div>

## 简介

**Backpack** 是 Nylo Website 中的内存单例存储系统。它在应用运行期间提供快速的同步数据访问。与将数据持久化到设备的 `NyStorage` 不同，Backpack 将数据存储在内存中，应用关闭时数据会被清除。

Backpack 被框架内部用于存储关键实例，如 `Nylo` 应用对象、`EventBus` 和身份验证数据。你也可以使用它来存储自己的数据，以便无需异步调用即可快速访问。

``` dart
import 'package:nylo_framework/nylo_framework.dart';

// Save a value
Backpack.instance.save("user_name", "Anthony");

// Read a value (synchronous)
String? name = Backpack.instance.read("user_name");

// Delete a value
Backpack.instance.delete("user_name");
```

<div id="basic-usage"></div>

## 基本用法

Backpack 使用**单例模式**——通过 `Backpack.instance` 访问它：

``` dart
// Save data
Backpack.instance.save("theme", "dark");

// Read data
String? theme = Backpack.instance.read("theme"); // "dark"

// Check if data exists
bool hasTheme = Backpack.instance.contains("theme"); // true
```

<div id="reading-data"></div>

## 读取数据

使用 `read<T>()` 方法从 Backpack 中读取值。它支持泛型类型和可选的默认值：

``` dart
// Read a String
String? name = Backpack.instance.read<String>("name");

// Read with a default value
String name = Backpack.instance.read<String>("name", defaultValue: "Guest") ?? "Guest";

// Read an int
int? score = Backpack.instance.read<int>("score");
```

当提供类型参数时，Backpack 会自动将 JSON 字符串反序列化为模型对象：

``` dart
// If a User model is stored as JSON, it will be deserialized
User? user = Backpack.instance.read<User>("current_user");
```

<div id="saving-data"></div>

## 保存数据

使用 `save()` 方法保存值：

``` dart
Backpack.instance.save("api_token", "abc123");
Backpack.instance.save("is_premium", true);
Backpack.instance.save("cart_count", 3);
```

### 追加数据

使用 `append()` 将值添加到存储在某个键下的列表中：

``` dart
// Append to a list
Backpack.instance.append("recent_searches", "Flutter");
Backpack.instance.append("recent_searches", "Dart");

// Append with a limit (keeps only the last N items)
Backpack.instance.append("recent_searches", "Nylo", limit: 10);
```

<div id="deleting-data"></div>

## 删除数据

### 删除单个键

``` dart
Backpack.instance.delete("api_token");
```

### 删除所有数据

`deleteAll()` 方法会移除所有值，**但保留**框架保留键（`nylo` 和 `event_bus`）：

``` dart
Backpack.instance.deleteAll();
```

<div id="sessions"></div>

## 会话

Backpack 提供会话管理功能，用于将数据组织到命名分组中。这对于将相关数据存储在一起非常有用。

### 更新会话值

``` dart
Backpack.instance.sessionUpdate("cart", "item_count", 3);
Backpack.instance.sessionUpdate("cart", "total", 29.99);
```

### 获取会话值

``` dart
int? itemCount = Backpack.instance.sessionGet<int>("cart", "item_count"); // 3
double? total = Backpack.instance.sessionGet<double>("cart", "total"); // 29.99
```

### 移除会话键

``` dart
Backpack.instance.sessionRemove("cart", "item_count");
```

### 清空整个会话

``` dart
Backpack.instance.sessionFlush("cart");
```

### 获取所有会话数据

``` dart
Map<String, dynamic>? cartData = Backpack.instance.sessionData("cart");
// {"item_count": 3, "total": 29.99}
```

<div id="nylo-instance"></div>

## 访问 Nylo 实例

Backpack 存储了 `Nylo` 应用实例。你可以使用以下方式获取它：

``` dart
Nylo nylo = Backpack.instance.nylo();
```

检查 Nylo 实例是否已初始化：

``` dart
bool isReady = Backpack.instance.isNyloInitialized(); // true
```

<div id="helper-functions"></div>

## 辅助函数

Nylo Website 提供了常用 Backpack 操作的全局辅助函数：

| 函数 | 描述 |
|----------|-------------|
| `backpackRead<T>(key)` | 从 Backpack 读取值 |
| `backpackSave(key, value)` | 向 Backpack 保存值 |
| `backpackDelete(key)` | 从 Backpack 删除值 |
| `backpackDeleteAll()` | 删除所有值（保留框架键） |
| `backpackNylo()` | 从 Backpack 获取 Nylo 实例 |

### 示例

``` dart
// Using helper functions
backpackSave("locale", "en");

String? locale = backpackRead<String>("locale"); // "en"

backpackDelete("locale");

// Access the Nylo instance
Nylo nylo = backpackNylo();
```

<div id="integration-with-nystorage"></div>

## 与 NyStorage 集成

Backpack 与 `NyStorage` 集成，实现持久化存储与内存存储的结合：

``` dart
// Save to both NyStorage (persistent) and Backpack (in-memory)
await NyStorage.save("auth_token", "abc123", inBackpack: true);

// Now accessible synchronously via Backpack
String? token = Backpack.instance.read("auth_token");

// When deleting from NyStorage, also clear from Backpack
await NyStorage.deleteAll(andFromBackpack: true);
```

这种模式对于身份验证令牌等数据非常有用，这些数据既需要持久化存储，又需要快速的同步访问（例如在 HTTP 拦截器中）。

<div id="examples"></div>

## 示例

### 为 API 请求存储身份验证令牌

``` dart
// In your auth interceptor
class BearerAuthInterceptor extends Interceptor {
  @override
  void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
    String? userToken = Backpack.instance.read(StorageKeysConfig.auth);

    if (userToken != null) {
      options.headers.addAll({"Authorization": "Bearer $userToken"});
    }

    return super.onRequest(options, handler);
  }
}
```

### 基于会话的购物车管理

``` dart
// Add items to a cart session
Backpack.instance.sessionUpdate("cart", "items", ["item_1", "item_2"]);
Backpack.instance.sessionUpdate("cart", "total", 49.99);

// Read cart data
Map<String, dynamic>? cart = Backpack.instance.sessionData("cart");

// Clear the cart
Backpack.instance.sessionFlush("cart");
```

### 快速功能标志

``` dart
// Store feature flags in Backpack for fast access
backpackSave("feature_dark_mode", true);
backpackSave("feature_notifications", false);

// Check a feature flag
bool darkMode = backpackRead<bool>("feature_dark_mode") ?? false;
```

简介

Backpack 是 Nylo Website 中的内存单例存储系统。它在应用运行期间提供快速的同步数据访问。与将数据持久化到设备的 NyStorage 不同，Backpack 将数据存储在内存中，应用关闭时数据会被清除。

Backpack 被框架内部用于存储关键实例，如 Nylo 应用对象、EventBus 和身份验证数据。你也可以使用它来存储自己的数据，以便无需异步调用即可快速访问。

import 'package:nylo_framework/nylo_framework.dart';

// Save a value
Backpack.instance.save("user_name", "Anthony");

// Read a value (synchronous)
String? name = Backpack.instance.read("user_name");

// Delete a value
Backpack.instance.delete("user_name");

基本用法

Backpack 使用单例模式——通过 Backpack.instance 访问它：

// Save data
Backpack.instance.save("theme", "dark");

// Read data
String? theme = Backpack.instance.read("theme"); // "dark"

// Check if data exists
bool hasTheme = Backpack.instance.contains("theme"); // true

读取数据

使用 read<T>() 方法从 Backpack 中读取值。它支持泛型类型和可选的默认值：

// Read a String
String? name = Backpack.instance.read<String>("name");

// Read with a default value
String name = Backpack.instance.read<String>("name", defaultValue: "Guest") ?? "Guest";

// Read an int
int? score = Backpack.instance.read<int>("score");

当提供类型参数时，Backpack 会自动将 JSON 字符串反序列化为模型对象：

// If a User model is stored as JSON, it will be deserialized
User? user = Backpack.instance.read<User>("current_user");

保存数据

使用 save() 方法保存值：

Backpack.instance.save("api_token", "abc123");
Backpack.instance.save("is_premium", true);
Backpack.instance.save("cart_count", 3);

追加数据

使用 append() 将值添加到存储在某个键下的列表中：

// Append to a list
Backpack.instance.append("recent_searches", "Flutter");
Backpack.instance.append("recent_searches", "Dart");

// Append with a limit (keeps only the last N items)
Backpack.instance.append("recent_searches", "Nylo", limit: 10);

删除数据

删除单个键

Backpack.instance.delete("api_token");

删除所有数据

deleteAll() 方法会移除所有值，但保留框架保留键（nylo 和 event_bus）：

Backpack.instance.deleteAll();

会话

Backpack 提供会话管理功能，用于将数据组织到命名分组中。这对于将相关数据存储在一起非常有用。

更新会话值

Backpack.instance.sessionUpdate("cart", "item_count", 3);
Backpack.instance.sessionUpdate("cart", "total", 29.99);

获取会话值

int? itemCount = Backpack.instance.sessionGet<int>("cart", "item_count"); // 3
double? total = Backpack.instance.sessionGet<double>("cart", "total"); // 29.99

移除会话键

Backpack.instance.sessionRemove("cart", "item_count");

清空整个会话

Backpack.instance.sessionFlush("cart");

获取所有会话数据

Map<String, dynamic>? cartData = Backpack.instance.sessionData("cart");
// {"item_count": 3, "total": 29.99}

访问 Nylo 实例

Backpack 存储了 Nylo 应用实例。你可以使用以下方式获取它：

Nylo nylo = Backpack.instance.nylo();

检查 Nylo 实例是否已初始化：

bool isReady = Backpack.instance.isNyloInitialized(); // true

辅助函数

Nylo Website 提供了常用 Backpack 操作的全局辅助函数：

函数	描述
`backpackRead<T>(key)`	从 Backpack 读取值
`backpackSave(key, value)`	向 Backpack 保存值
`backpackDelete(key)`	从 Backpack 删除值
`backpackDeleteAll()`	删除所有值（保留框架键）
`backpackNylo()`	从 Backpack 获取 Nylo 实例

示例

// Using helper functions
backpackSave("locale", "en");

String? locale = backpackRead<String>("locale"); // "en"

backpackDelete("locale");

// Access the Nylo instance
Nylo nylo = backpackNylo();

与 NyStorage 集成

Backpack 与 NyStorage 集成，实现持久化存储与内存存储的结合：

// Save to both NyStorage (persistent) and Backpack (in-memory)
await NyStorage.save("auth_token", "abc123", inBackpack: true);

// Now accessible synchronously via Backpack
String? token = Backpack.instance.read("auth_token");

// When deleting from NyStorage, also clear from Backpack
await NyStorage.deleteAll(andFromBackpack: true);

这种模式对于身份验证令牌等数据非常有用，这些数据既需要持久化存储，又需要快速的同步访问（例如在 HTTP 拦截器中）。

示例

为 API 请求存储身份验证令牌

// In your auth interceptor
class BearerAuthInterceptor extends Interceptor {
  @override
  void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
    String? userToken = Backpack.instance.read(StorageKeysConfig.auth);

    if (userToken != null) {
      options.headers.addAll({"Authorization": "Bearer $userToken"});
    }

    return super.onRequest(options, handler);
  }
}

基于会话的购物车管理

// Add items to a cart session
Backpack.instance.sessionUpdate("cart", "items", ["item_1", "item_2"]);
Backpack.instance.sessionUpdate("cart", "total", 49.99);

// Read cart data
Map<String, dynamic>? cart = Backpack.instance.sessionData("cart");

// Clear the cart
Backpack.instance.sessionFlush("cart");

快速功能标志

// Store feature flags in Backpack for fast access
backpackSave("feature_dark_mode", true);
backpackSave("feature_notifications", false);

// Check a feature flag
bool darkMode = backpackRead<bool>("feature_dark_mode") ?? false;