flutter_grpc_kit 0.1.0
flutter_grpc_kit: ^0.1.0 copied to clipboard
gRPC channel wiring, unary executor with auth refresh, and debug logging for Dart/Flutter apps.
flutter_grpc_kit #
Reusable gRPC building blocks for Flutter apps:
GrpcExecutor— unary RPC helper with auth token metadata, optional extra headers, and single-flight token refresh onUNAUTHENTICATEDGrpcChannelFactory/GrpcEndpoint— parse gateway URLs and own aClientChannelGrpcServiceClient— base class for generated stub wrappersGrpcLoggingInterceptor— PrettyDio-style boxed logs in debug
For flutter_alice network inspection, add grpc_alice_interceptor.
Contributions welcome — see CONTRIBUTING.md.
Install #
dependencies:
flutter_grpc_kit: ^0.1.0
grpc: ^5.1.0
protobuf: ^6.0.0
Optional Alice inspector:
dependencies:
grpc_alice_interceptor: ^0.1.1
flutter_alice: ^2.0.1
From Git:
dependencies:
flutter_grpc_kit:
git:
url: https://github.com/andreishemetov/flutter_grpc_kit.git
ref: v0.1.0
For local development, use a path dependency to this repo.
Quick start #
import 'package:flutter_grpc_kit/flutter_grpc_kit.dart';
final factory = GrpcChannelFactory(gatewayUrl: 'https://grpc.example.com');
final executor = GrpcExecutor(
authHandler: myAuthHandler,
metadata: {'x-app-version': '1.0.0'},
);
final interceptors = [
GrpcLoggingInterceptor(),
];
// Pass interceptors when constructing generated clients:
// MyServiceClient(factory.channel, interceptors: interceptors);
final result = await executor.run<MyEntity, MyResponse>(
(options) => client.getSomething(request, options: options),
transform: MyEntity.fromResponse,
);
result.fold(
onSuccess: (value) => /* ... */,
onFailure: (error) => /* ... */,
);
Implement AuthHandler in your app. Pass extra per-call headers via GrpcExecutor.metadata.
Example app #
The example/ app calls the public
hello.HelloService/SayHello API over TLS. From the repo
root:
cd example
flutter run
Tap SayHello to call https://grpcb.in on port 443. A successful request
with the default name displays Reply: hello world. Calls time out after 10
seconds instead of leaving the UI in a loading state. Use the network icon in
the app bar to inspect recorded calls with Alice.
The Android emulator must have working DNS. If it reports a
Failed host lookup: 'grpcb.in' error, cold-boot the emulator or launch it with
an explicit DNS server:
emulator -avd <your-avd-name> -dns-server 8.8.8.8
To use the optional local server instead, run dart run bin/server.dart from
the example directory and set the app endpoint to:
http://127.0.0.1:50051on iOS Simulator or desktophttp://10.0.2.2:50051on Android Emulator
Development #
flutter pub get
flutter test
dart analyze
cd example && flutter pub get && dart analyze && flutter test
Pull requests run the same checks via GitHub Actions. In branch protection, require CI / analyze (or analyze).
License #
MIT — see LICENSE.