文件列表:

.devcontainer/ (0, 2023-12-05)
.devcontainer/devcontainer.json (1036, 2023-12-05)
.vscode/ (0, 2023-12-05)
.vscode/launch.json (630, 2023-12-05)
.vscode/settings.json (47, 2023-12-05)
LICENSE (1497, 2023-12-05)
melos.yaml (1367, 2023-12-05)
packages/ (0, 2023-12-05)
packages/json_rpc_codegen/ (0, 2023-12-05)
packages/json_rpc_codegen/CHANGELOG.md (302, 2023-12-05)
packages/json_rpc_codegen/LICENSE (13, 2023-12-05)
packages/json_rpc_codegen/analysis_options.yaml (46, 2023-12-05)
packages/json_rpc_codegen/lib/ (0, 2023-12-05)
packages/json_rpc_codegen/lib/json_rpc_codegen.dart (429, 2023-12-05)
packages/json_rpc_codegen/lib/src/ (0, 2023-12-05)
packages/json_rpc_codegen/lib/src/annotations/ (0, 2023-12-05)
packages/json_rpc_codegen/lib/src/annotations/defaults.dart (841, 2023-12-05)
packages/json_rpc_codegen/lib/src/annotations/json_rpc.dart (713, 2023-12-05)
packages/json_rpc_codegen/lib/src/base/ (0, 2023-12-05)
packages/json_rpc_codegen/lib/src/base/client_base.dart (1162, 2023-12-05)
packages/json_rpc_codegen/lib/src/base/peer_base.dart (2575, 2023-12-05)
packages/json_rpc_codegen/lib/src/base/server_base.dart (2434, 2023-12-05)
packages/json_rpc_codegen/pubspec.yaml (607, 2023-12-05)
packages/json_rpc_codegen/test/ (0, 2023-12-05)
packages/json_rpc_codegen/test/unit/ (0, 2023-12-05)
packages/json_rpc_codegen/test/unit/base/ (0, 2023-12-05)
packages/json_rpc_codegen/test/unit/base/client_base_test.dart (1687, 2023-12-05)
packages/json_rpc_codegen/test/unit/base/peer_base_test.dart (3535, 2023-12-05)
packages/json_rpc_codegen/test/unit/base/server_base_test.dart (3426, 2023-12-05)
packages/json_rpc_codegen_builder/ (0, 2023-12-05)
... ...

# json_rpc_codegen [](https://github.com/Skycoder42/json_rpc_codegen/actions/workflows/json_rpc_codegen_ci.yaml) [](https://github.com/Skycoder42/json_rpc_codegen/actions/workflows/json_rpc_codegen_builder_ci.yaml) [](https://pub.dev/packages/json_rpc_codegen) [](https://pub.dev/packages/json_rpc_codegen_builder) A dart code generator that generates typed client and server code for the json_rpc_2 package. ## Table of Contents ## Features - Code generator for the [json_rpc_2](https://pub.dev/packages/json_rpc_2) package (The official JSON-RPC 2.0 implementation for dart) - Creates Client and Server classes, as well as Mixins - You can directly use the Client/Server classes for simple usecases - If you need to work with Peers, or if you want to have a single server/client instance that provides/consumes multiple definitions, you can creates those by using the base class and the mixins - Supports all basic dart types and custom JSON serializables as well - Can handle primitive types (bool, int, ...) - Can handle infinitely nested containes (List, Set, Map, ...) - Can handle infinitely nested records - Can handle advanced dart types (DateTime, Uri) - Can handle custom types via `fromJson` and `toJson` methods - Methods can define typed named or positional parameters - All types supported - With server-sided JSON validation - Default-Values are supported (Client or Server-Sided) ## Installation As this is a builder package, you need to also install the annotations and build_runner: ```yaml dependencies: json_rpc_codegen: dev_dependencies: build_runner: json_rpc_codegen_builder: ``` ## Usage The API usage is very basic. You create an abstract dart class that describes the interface, and the code generator will do the rest for you: ```dart import 'package:json_rpc_codegen/json_rpc_codegen.dart'; part 'my_class.g.dart'; enum Stage { all, pre, post } @jsonRpc abstract class _MyClass { void startServerTask({ required int id, required String taskName, bool verbose = false, double? scale, }); @clientDefaults double getProgress(int id, [Stage stage = Stage.all]); } ``` This will generate a bunch of code for both, the client and the server implementation. Have a look at the documentation on how to control which of these classes get generated. By default, the following will be generated: - `MyClassClientMixin`: A Mixin on the `ClientBase` class that has all the client implementations of the interface - `MyClassServerMixin`: A Mixin on the `ServerBase` class that has all the server implementations of the interface - `MyClassClient`: A class that uses the `MyClassClientMixin`, ready for use - `MyClassServer`: A class that uses the `MyClassServerMixin`, ready for use In most cases, you will want to use `MyClassClient` and `MyClassServer` directly. However, if you want to combine multiple interfaces into one, or if you are working with `Peer`s, you may want to use the mixins instead. Here is a simplified example, of how the generated classes look: ```dart class MyClassClient { void startServerTask({ required int id, required String taskName, // all optional parameters are nullable, as the defaults are managed by the server bool? verbose, double? scale, }); // non-void methods become futures to wait for the result Future getProgress( int id, [ // client defaults are set on the client instead Stage stage = Stage.all, ]); } // The server is abstract, as you need to implement the logic of the server methods abstract class MyClassServer { // All server methods use FutureOr and can be synchronous or asynchronous @protected FutureOr startServerTask( int id, String taskName, // server defaults are set by the implementation bool verbose, double? scale, ); @protected FutureOr getProgress( int id, // client defaults are required on the server side Stage stage, ); } ``` To use the client, simply create a new instance, just as you would with the standard `json_rpc_2` client. For the server, create your own server class that extends the generated server to implement the server methods. Then you can use this class just like the `json_rpc_2`, but without you having to take care of any registrations. ## Documentation The documentation is available at https://pub.dev/documentation/json_rpc_codegen/latest/. A full example can be found at https://pub.dev/packages/json_rpc_codegen_builder/example.

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：