Flutter服务端点注解插件serverpod_endpoints_annotation的使用

当然，以下是如何在Flutter项目中使用serverpod_endpoints_annotation插件的示例代码案例。serverpod_endpoints_annotation是一个用于定义服务端点的注解插件，它通常与serverpod一起使用，后者是一个用于构建Flutter后端服务的框架。

1. 添加依赖

首先，确保在你的pubspec.yaml文件中添加了serverpod和serverpod_endpoints_annotation的依赖：

dependencies:
  flutter:
    sdk: flutter
  serverpod: ^x.y.z  # 请替换为最新版本号
  serverpod_endpoints_annotation: ^x.y.z  # 请替换为最新版本号

然后在你的Flutter项目根目录下运行flutter pub get来安装依赖。

2. 创建服务端点

接下来，我们需要创建一个Dart文件来定义服务端点。在这个例子中，我们将创建一个简单的用户登录端点。

// lib/endpoints/auth_endpoints.dart
import 'package:serverpod/serverpod.dart';
import 'package:serverpod_endpoints_annotation/serverpod_endpoints_annotation.dart';

part 'auth_endpoints.g.dart';  // 自动生成代码的文件

@Endpoint()
class AuthEndpoints extends EndpointController {
  @EndpointMethod(name: 'login')
  Future<Map<String, dynamic>> login(
      @RequestParam(name: 'username') String username,
      @RequestParam(name: 'password') String password) async {
    // 这里你可以添加你的登录逻辑，比如验证用户名和密码
    // 在这个例子中，我们假设所有登录都成功

    // 假设验证成功，返回一个简单的token
    String token = 'dummy_token_${username.hashCode}';

    return {
      'success': true,
      'token': token,
    };
  }
}

3. 生成代码

serverpod_endpoints_annotation插件使用代码生成来创建服务端点的实际实现。你需要运行构建运行器来生成这些文件。

在你的项目根目录下，运行以下命令：

flutter pub run build_runner build

这将生成auth_endpoints.g.dart文件，它包含了AuthEndpoints类的实现。

4. 配置ServerPod

现在，你需要在你的ServerPod配置中包含这个端点。

// lib/server.dart
import 'package:serverpod/serverpod.dart';
import 'endpoints/auth_endpoints.dart';

void main() {
  // 创建ServerPod实例
  ServerPod server = ServerPod(
    name: 'MyServerPod',
    endpoints: [
      AuthEndpoints(),  // 注册我们的AuthEndpoints
    ],
  );

  // 启动服务器
  server.start();
}

5. 运行服务器

最后，你可以运行你的服务器。确保你已经配置好了Dart环境，然后在命令行中运行：

dart lib/server.dart

现在，你的服务器应该正在运行，并且login端点应该已经可用。你可以通过HTTP请求来测试这个端点，例如使用curl或Postman。

6. 客户端调用示例

这里是一个简单的Flutter客户端调用示例，使用http包来发送请求到我们的登录端点：

import 'package:flutter/material.dart';
import 'package:http/http.dart' as http;

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Login Example'),
        ),
        body: Center(
          child: LoginButton(),
        ),
      ),
    );
  }
}

class LoginButton extends StatefulWidget {
  @override
  _LoginButtonState createState() => _LoginButtonState();
}

class _LoginButtonState extends State<LoginButton> {
  void _login() async {
    String url = 'http://localhost:8080/endpoint/login'; // 你的服务器URL
    Map<String, String> body = {
      'username': 'testuser',
      'password': 'testpass',
    };

    http.Response response = await http.post(Uri.parse(url), body: body);

    if (response.statusCode == 200) {
      Map<String, dynamic> data = jsonDecode(response.body);
      if (data['success']) {
        print('Login successful! Token: ${data['token']}');
      } else {
        print('Login failed!');
      }
    } else {
      print('Server error: ${response.statusCode}');
    }
  }

  @override
  Widget build(BuildContext context) {
    return ElevatedButton(
      onPressed: _login,
      child: Text('Login'),
    );
  }
}

这个客户端示例展示了如何通过HTTP POST请求调用我们的登录端点，并处理响应。

通过这些步骤，你应该能够在Flutter项目中使用serverpod_endpoints_annotation插件来定义和调用服务端点。