Flutter Google APIs gRPC通信插件googleapis_grpc的使用

发布于 1周前 作者 itying888 来自 Flutter

Flutter Google APIs gRPC通信插件googleapis_grpc的使用

googleapis_grpc 是一个自动生成的gRPC Google API插件。它与 googleapis 类似，但有一些关键的区别：

  • 使用gRPC而不是REST API
  • 提供更多API（例如Google地图路由v2）

由于某些API非常庞大（高达100兆字节），因此它们被禁用。禁用的API列表包括：

  • cloud
  • ads
  • devtools
  • analytics
  • container

如果需要启用这些API，只需在 Makefile 中注释掉相应的 rm -rf 行即可。

安装

# Dart
dart pub add googleapis_grpc

# Flutter
flutter pub add googleapis_grpc

入门指南

每个Google API都在自己的库中。你可以在 lib/ 文件夹中找到它们。例如，如果你想使用Google地图路由v2 API，可以参考 example/ 文件夹中的示例。

示例代码

import 'dart:io' show exit;

// 导入你需要的API
import 'package:googleapis_grpc/google_maps_routing_v2.dart';

// 安装 `grpc` 包以便通过网络进行查询
import 'package:grpc/grpc.dart';

void main() async {
  // 创建一个客户端通道
  final channel = ClientChannel(
    'routes.googleapis.com', // 谷歌地图路由服务的域名
    options: const ChannelOptions(credentials: ChannelCredentials.secure()), // 使用安全连接
  );

  // 创建一个路由客户端
  final client = RoutesClient(
    channel,
    options: CallOptions(
      metadata: {
        'X-Goog-Api-Key': 'YOUR_API_KEY', // 你的API密钥
        'X-Goog-FieldMask': '*', // 字段掩码
      },
    ),
  );

  // 创建一个请求对象
  final request = ComputeRoutesRequest(
    origin: Waypoint(
      address: 'Tour eiffel Paris', // 起点地址
    ),
    destination: Waypoint(
      address: 'Montmartre Paris', // 终点地址
    ),
  );

  // 发送请求并获取响应数据
  final data = await client.computeRoutes(request);
  print(data); // 打印响应数据

  exit(0); // 退出程序
}

注意事项

如果你缺少任何类型，可能需要导入以下包：

import 'package:googleapis_grpc/google_type.dart';

更多关于Flutter Google APIs gRPC通信插件googleapis_grpc的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

Harmonyos Next教程
1 回复

更多关于Flutter Google APIs gRPC通信插件googleapis_grpc的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，关于在Flutter中使用googleapis_grpc插件进行gRPC通信与Google APIs交互，以下是一个简要的代码示例。这个示例将展示如何设置并使用googleapis_grpc进行gRPC调用。

首先，确保你的Flutter项目已经添加了必要的依赖。你需要在pubspec.yaml文件中添加对googleapis和grpc相关依赖的引用。不过，请注意，googleapis_grpc可能不是一个直接可用的包名，通常我们会使用具体的Google API gRPC客户端包，比如google_sign_in结合gRPC服务（如果有的话）。这里假设有一个假设的Google API gRPC客户端包example_googleapis_grpc。

dependencies:
  flutter:
    sdk: flutter
  example_googleapis_grpc: ^x.y.z  # 替换为实际的包名和版本号
  grpc: ^x.y.z  # 替换为实际的gRPC包版本

然后，运行flutter pub get来安装依赖。

接下来，我们假设有一个简单的gRPC服务定义，比如一个计算服务，我们可以生成Dart代码并使用它。由于实际的Google API gRPC服务通常已经提供了生成的Dart客户端代码，这里我们将重点放在如何使用这些生成的代码上。

假设我们有一个example_pb.dart和example_grpc.dart文件，它们是由proto文件生成的。

示例代码

import 'package:flutter/material.dart';
import 'package:grpc/grpc.dart';
import 'package:example_googleapis_grpc/example_pb.dart';
import 'package:example_googleapis_grpc/example_grpc.dart';

void main() => runApp(MyApp());

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

class MyGrpcClient extends StatefulWidget {
  @override
  _MyGrpcClientState createState() => _MyGrpcClientState();
}

class _MyGrpcClientState extends State<MyGrpcClient> {
  String result = '';

  @override
  void initState() {
    super.initState();
    _makeGrpcCall();
  }

  Future<void> _makeGrpcCall() async {
    final channel = ClientChannel('your.grpc.server:port',
        options: ChannelOptions(
          credentials: ChannelCredentials.insecure(),
        ));

    final stub = ExampleServiceClient(channel);

    try {
      final request = ExampleRequest()..someField = 'value';
      final response = await stub.exampleMethod(request);

      setState(() {
        result = 'Response: ${response.someResponseField}';
      });
    } catch (e) {
      setState(() {
        result = 'Error: ${e.message}';
      });
    } finally {
      channel.shutdown().then((_) => print('Channel shutdown'));
    }
  }

  @override
  Widget build(BuildContext context) {
    return Text(result);
  }
}

解释

  1. 依赖管理：在pubspec.yaml中添加了example_googleapis_grpc和grpc依赖。
  2. UI构建：使用Flutter的Material Design组件来构建一个简单的UI。
  3. gRPC客户端：在_MyGrpcClientState类中，我们创建了一个gRPC通道并实例化了一个gRPC服务客户端stub。
  4. gRPC调用：通过stub调用gRPC服务方法，并处理响应或异常。
  5. 资源管理：确保在调用完成后关闭gRPC通道。

请注意，ExampleServiceClient, ExampleRequest, 和 ExampleResponse 是根据实际的proto文件生成的类。你需要根据你的proto文件生成的实际类名来替换这些占位符。

此外，实际使用中你可能需要处理认证（如OAuth2），这通常涉及到使用google_sign_in或其他认证库来获取访问令牌，并将其附加到gRPC请求中。这超出了这个基本示例的范围，但通常涉及到拦截器或自定义的ClientChannel配置。

回到顶部