Flutter后端服务管理插件serverpod_cli的使用

Flutter后端服务管理插件serverpod_cli的使用

什么是Serverpod？

Serverpod 是一个开源的、可扩展的应用服务器，专门为Flutter社区编写，使用Dart语言开发。它可以帮助开发者快速搭建和管理后端服务，特别适合与Flutter前端应用配合使用。

serverpod_cli简介

serverpod_cli 是Serverpod的核心工具之一，用于管理和操作Serverpod项目。通过这个CLI工具，你可以轻松地创建、配置、运行和部署Serverpod服务。它提供了许多便捷的命令来简化开发流程，例如生成代码、启动开发服务器、管理数据库等。

安装serverpod_cli

在使用serverpod_cli之前，你需要确保已经安装了Dart SDK，并且配置好了环境变量。接下来，可以通过以下命令安装serverpod_cli：

dart pub global activate serverpod_cli

安装完成后，你可以通过以下命令验证是否安装成功：

serverpod --version

创建一个新的Serverpod项目

使用serverpod_cli创建一个新的Serverpod项目非常简单。假设我们要创建一个名为my_app_server的项目，可以使用以下命令：

serverpod create my_app_server

执行上述命令后，serverpod_cli会自动为你生成一个完整的Serverpod项目结构，包括必要的文件和目录。生成的项目结构如下：

my_app_server/
├── lib/
│   └── endpoint/
│       └── my_app_endpoint.dart
├── generated/
│   └── ...
├── protos/
│   └── my_app.proto
├── config/
│   ├── database.yaml
│   ├── endpoints.yaml
│   └── secrets.yaml
├── test/
├── web/
└── pubspec.yaml

配置数据库

Serverpod支持多种数据库，如PostgreSQL、SQLite等。你可以在config/database.yaml文件中配置数据库连接信息。例如，使用PostgreSQL数据库时，配置文件可能如下所示：

development:
  type: postgresql
  host: localhost
  port: 5432
  database: my_app_dev
  username: my_user
  password: my_password

production:
  type: postgresql
  host: db.example.com
  port: 5432
  database: my_app_prod
  username: my_user
  password: my_password

生成代码

Serverpod使用Protocol Buffers（Protobuf）来定义API接口和服务端点。你需要在protos/目录下创建.proto文件来定义你的数据模型和服务接口。例如，创建一个简单的用户模型：

syntax = "proto3";

package my_app;

message User {
  int64 id = 1;
  string email = 2;
  string name = 3;
}

定义好模型后，你可以使用serverpod_cli生成相应的Dart代码：

serverpod generate

这将自动生成与.proto文件对应的Dart类，并将其放置在generated/目录中。

启动开发服务器

在开发过程中，你可以使用serverpod_cli启动开发服务器。这将启动一个本地的Serverpod实例，方便你在开发时进行调试和测试。

serverpod run

启动后，Serverpod会监听默认的8080端口。你可以通过浏览器或Postman等工具访问API接口，或者在Flutter客户端中进行调用。

管理数据库迁移

Serverpod支持数据库迁移功能，帮助你管理数据库结构的变化。你可以使用serverpod_cli生成和应用迁移脚本。

生成迁移脚本

serverpod migration create add_users_table

这将在migrations/目录下生成一个新的迁移文件，例如20231001120000_add_users_table.sql。你可以在该文件中编写SQL语句来创建或修改数据库表。

应用迁移

serverpod migration apply

这将应用所有未执行的迁移脚本，更新数据库结构。

连接Flutter客户端

为了让你的Flutter应用与Serverpod后端通信，你需要在Flutter项目中添加serverpod_client依赖。首先，在pubspec.yaml中添加依赖：

dependencies:
  serverpod_client: ^x.x.x  # 替换为最新版本

然后，初始化客户端并连接到Serverpod服务器：

import 'package:serverpod_client/serverpod_client.dart';

void main() async {
  // 初始化客户端，指定服务器地址
  final client = Client('http://localhost:8080');

  // 调用服务端点
  final user = await client.myAppEndpoint.getUser(1);

  print('User: ${user.name}');
}

示例项目

为了帮助你更好地理解如何使用serverpod_cli，下面是一个完整的示例项目，展示了如何创建一个简单的用户管理系统。

1. 创建Serverpod项目

serverpod create user_management_server

2. 定义用户模型

在protos/user_management.proto中定义用户模型：

syntax = "proto3";

package user_management;

message User {
  int64 id = 1;
  string email = 2;
  string name = 3;
  string password = 4;
}

3. 生成代码

serverpod generate

4. 创建用户管理服务

在lib/endpoint/user_management_endpoint.dart中实现用户管理的服务端点：

import 'package:serverpod/serverpod.dart';
import 'package:user_management_server/generated/user_management_endpoint.dart';

class UserManagementEndpoint extends GeneratedUserManagementEndpoint {
  @override
  Future<User> createUser(User user) async {
    // 保存用户到数据库
    final userRepository = context.getRepository<User>();
    final newUser = await userRepository.insert(user);
    return newUser;
  }

  @override
  Future<User?> getUser(int id) async {
    // 查询用户
    final userRepository = context.getRepository<User>();
    return await userRepository.findOne(id);
  }
}

5. 启动开发服务器

serverpod run

6. 在Flutter客户端中调用API

在Flutter项目中添加serverpod_client依赖，并调用服务端点：

import 'package:serverpod_client/serverpod_client.dart';
import 'package:user_management_client/generated/user_management_endpoint.dart';

void main() async {
  // 初始化客户端
  final client = Client('http://localhost:8080');

  // 创建新用户
  final newUser = User((b) => b
    ..email = 'example@example.com'
    ..name = 'John Doe'
    ..password = 'password123');
  final createdUser = await client.userManagementEndpoint.createUser(newUser);

  print('Created user: ${createdUser.name}');

  // 获取用户
  final user = await client.userManagementEndpoint.getUser(createdUser.id);
  print('Fetched user: ${user?.name}');
}