diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 23779eb7..49e66ebf 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -36,7 +36,6 @@ assignees: '' - **Version**: - **Compiler/Toolchain**: - **Protobuf Compiler & Version**: -- **Protoc-gen-validate Version**: - **Protovalidate Version**: ## Possible Solution diff --git a/README.md b/README.md index d617a514..c56323c4 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,57 @@ -# [![The Buf logo](.github/buf-logo.svg)][buf] protovalidate-java +[![The Buf logo](.github/buf-logo.svg)][buf] + +# protovalidate-java [![CI](https://github.com/bufbuild/protovalidate-java/actions/workflows/ci.yaml/badge.svg)](https://github.com/bufbuild/protovalidate-java/actions/workflows/ci.yaml) [![Conformance](https://github.com/bufbuild/protovalidate-java/actions/workflows/conformance.yaml/badge.svg)](https://github.com/bufbuild/protovalidate-java/actions/workflows/conformance.yaml) [![BSR](https://img.shields.io/badge/BSR-Module-0C65EC)][buf-mod] -`protovalidate-java` is the Java language implementation of [`protovalidate`](https://github.com/bufbuild/protovalidate) designed to validate Protobuf messages at runtime based on user-defined validation constraints. Powered by Google's Common Expression Language ([CEL](https://github.com/google/cel-spec)), it provides a flexible and efficient foundation for defining and evaluating custom validation rules. The primary goal of `protovalidate` is to help developers ensure data consistency and integrity across the network without requiring generated code. +[Protovalidate][protovalidate] provides standard annotations to validate common constraints on messages and fields, as well as the ability to use [CEL][cel] to write custom constraints. It's the next generation of [protoc-gen-validate][protoc-gen-validate], the only widely used validation library for Protobuf. -## The `protovalidate` project +With Protovalidate, you can annotate your Protobuf messages with both standard and custom validation rules: -Head over to the core [`protovalidate`](https://github.com/bufbuild/protovalidate/) repository for: +```protobuf +syntax = "proto3"; -- [The API definition](https://github.com/bufbuild/protovalidate/tree/main/proto/protovalidate/buf/validate/validate.proto): used to describe validation constraints -- [Documentation](https://github.com/bufbuild/protovalidate/tree/main/docs): how to apply `protovalidate` effectively -- [Migration tooling](https://github.com/bufbuild/protovalidate/tree/main/docs/migrate.md): incrementally migrate from `protoc-gen-validate` -- [Conformance testing utilities](https://github.com/bufbuild/protovalidate/tree/main/docs/conformance.md): for acceptance testing of `protovalidate` implementations +package banking.v1; + +import "buf/validate/validate.proto"; -Other `protovalidate` runtime implementations include: +message MoneyTransfer { + string to_account_id = 1 [ + // Standard rule: `to_account_id` must be a UUID + (buf.validate.field).string.uuid = true + ]; -- C++: [`protovalidate-cc`](https://github.com/bufbuild/protovalidate-cc) -- Go: [`protovalidate-go`](https://github.com/bufbuild/protovalidate-go) -- Python: [`protovalidate-python`](https://github.com/bufbuild/protovalidate-python) + string from_account_id = 2 [ + // Standard rule: `from_account_id` must be a UUID + (buf.validate.field).string.uuid = true + ]; -And others coming soon: + // Custom rule: `to_account_id` and `from_account_id` can't be the same. + option (buf.validate.message).cel = { + id: "to_account_id.not.from_account_id" + message: "to_account_id and from_account_id should not be the same value" + expression: "this.to_account_id != this.from_account_id" + }; +} +``` -- TypeScript: `protovalidate-ts` +Once you've added `protovalidate-java` to your project, validation is idiomatic Java: + +```java +ValidationResult result = validator.validate(message); +if (!result.isSuccess()) { + // Handle failure. +} +``` ## Installation -To include `protovalidate-java` in your project, add the following to your build file: +> [!TIP] +> The easiest way to get started with Protovalidate for RPC APIs are the quickstarts in Buf's documentation. There's one available for [Java and gRPC][grpc-java]. + +`protovalidate-java` is listed in [Maven Central][maven], which provides installation snippets for Gradle, Maven, and other package managers. In Gradle, it's: ```gradle dependencies { @@ -35,104 +59,73 @@ dependencies { } ``` -Remember to always check for the latest version of `protovalidate-java` on the project's [GitHub releases page](https://github.com/bufbuild/protovalidate-java/releases) to ensure you're using the most up-to-date version. +## Documentation -## Usage +Comprehensive documentation for Protovalidate is available in [Buf's documentation library][protovalidate]. -### Implementing validation constraints +Highlights for Java developers include: -Validation constraints are defined directly within `.proto` files. Documentation for adding constraints can be found in the `protovalidate` project [README](https://github.com/bufbuild/protovalidate) and its [comprehensive docs](https://github.com/bufbuild/protovalidate/tree/main/docs). +* The [developer quickstart][quickstart] +* A comprehensive RPC quickstart for [Java and gRPC][grpc-java] +* A [migration guide for protoc-gen-validate][migration-guide] users -```protobuf -syntax = "proto3"; +## Additional Languages and Repositories -package my.package; +Protovalidate isn't just for Java! You might be interested in sibling repositories for other languages: -import "google/protobuf/timestamp.proto"; -import "buf/validate/validate.proto"; +- [`protovalidate-go`][pv-go] (Go) +- [`protovalidate-python`][pv-python] (Python) +- [`protovalidate-cc`][pv-cc] (C++) +- `protovalidate-es` (TypeScript and JavaScript, coming soon!) -message Transaction { - uint64 id = 1 [(buf.validate.field).uint64.gt = 999]; - google.protobuf.Timestamp purchase_date = 2; - google.protobuf.Timestamp delivery_date = 3; - - string price = 4 [(buf.validate.field).cel = { - id: "transaction.price", - message: "price must be positive and include a valid currency symbol ($ or £)", - expression: "(this.startsWith('$') || this.startsWith('£')) && double(this.substring(1)) > 0" - }]; - - option (buf.validate.message).cel = { - id: "transaction.delivery_date", - message: "delivery date must be after purchase date", - expression: "this.delivery_date > this.purchase_date" - }; -} -``` +Additionally, [protovalidate's core repository](https://github.com/bufbuild/protovalidate) provides: -### Example +- [Protovalidate's Protobuf API][validate-proto] +- [Conformance testing utilities][conformance] for acceptance testing of `protovalidate` implementations -In your Java code, create an instance of the `Validator` class and use the `validate` method to validate your messages. -```java -// Import the required packages -package build.buf; - -import build.buf.protovalidate.results.ValidationException; -import build.buf.protovalidate.results.ValidationResult; -import com.my.package.Transaction; -import com.google.protobuf.Timestamp; - -import build.buf.protovalidate.Validator; -import build.buf.protovalidate.Config; - -public class Main { - - // Create timestamps for purchase and delivery date - Timestamp purchaseDate = Timestamp.newBuilder().build(); - Timestamp deliveryDate = Timestamp.newBuilder().build(); - - // Create a transaction object using the Builder pattern - Transaction transaction = - Transaction.newBuilder() - .setId(1234) - .setPrice("$5.67") - .setPurchaseDate(purchaseDate) - .setDeliveryDate(deliveryDate) - .build(); - - // Create a validator object with the default Configuration - Validator validator = new Validator(); - // Validate the transaction object using the validator - try { - ValidationResult result = validator.validate(transaction); - - // Check if there are any validation violations - if (result.getViolations().isEmpty()) { - // No violations, validation successful - System.out.println("Validation succeeded"); - } else { - // Print the violations if any found - System.out.println(result.toString()); - } - } catch (ValidationException e) { - // Catch and print any ValidationExceptions thrown during the validation process - System.out.println("Validation failed: " + e.getMessage()); - } -} -``` +## Contribution + +We genuinely appreciate any help! If you'd like to contribute, check out these resources: + +- [Contributing Guidelines][contributing]: Guidelines to make your contribution process straightforward and meaningful +- [Conformance testing utilities](https://github.com/bufbuild/protovalidate/tree/main/docs/conformance.md): Utilities providing acceptance testing of `protovalidate` implementations -### Ecosystem +## Related Sites -- [`protovalidate`](https://github.com/bufbuild/protovalidate) core repository -- [Buf][buf] -- [CEL Spec][cel-spec] +- [Buf][buf]: Enterprise-grade Kafka and gRPC for the modern age +- [Common Expression Language (CEL)][cel]: The open-source technology at the core of Protovalidate ## Legal Offered under the [Apache 2 license][license]. -[license]: LICENSE [buf]: https://buf.build +[cel]: https://cel.dev + +[pv-go]: https://github.com/bufbuild/protovalidate-go +[pv-java]: https://github.com/bufbuild/protovalidate-java +[pv-python]: https://github.com/bufbuild/protovalidate-python +[pv-cc]: https://github.com/bufbuild/protovalidate-cc + +[license]: LICENSE +[contributing]: .github/CONTRIBUTING.md [buf-mod]: https://buf.build/bufbuild/protovalidate -[cel-spec]: https://github.com/google/cel-spec + +[protoc-gen-validate]: https://github.com/bufbuild/protoc-gen-validate + +[protovalidate]: https://buf.build/docs/protovalidate +[quickstart]: https://buf.build/docs/protovalidate/quickstart/ +[connect-go]: https://buf.build/docs/protovalidate/quickstart/connect-go/ +[grpc-go]: https://buf.build/docs/protovalidate/quickstart/grpc-go/ +[grpc-java]: https://buf.build/docs/protovalidate/quickstart/grpc-java/ +[grpc-python]: https://buf.build/docs/protovalidate/quickstart/grpc-python/ +[migration-guide]: https://buf.build/docs/migration-guides/migrate-from-protoc-gen-validate/ + +[maven]: https://central.sonatype.com/artifact/build.buf/protovalidate/overview +[pkg-go]: https://pkg.go.dev/github.com/bufbuild/protovalidate-go + +[validate-proto]: https://buf.build/bufbuild/protovalidate/docs/main:buf.validate +[conformance]: https://github.com/bufbuild/protovalidate/blob/main/docs/conformance.md +[examples]: https://github.com/bufbuild/protovalidate/tree/main/examples +[migrate]: https://buf.build/docs/migration-guides/migrate-from-protoc-gen-validate/