├── .gitignore ├── BUILD ├── LICENSE ├── README.md ├── WORKSPACE └── src ├── BUILD ├── address.proto ├── person.proto └── zip_code.proto /.gitignore: -------------------------------------------------------------------------------- 1 | bazel-bin 2 | bazel-genfiles 3 | bazel-out 4 | bazel-proto_library 5 | bazel-testlogs 6 | -------------------------------------------------------------------------------- /BUILD: -------------------------------------------------------------------------------- 1 | # An intentionally empty BUILD file. 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # proto_library 2 | 3 | This Bazel demonstrates how to use Bazel's built-in support for 4 | [Protocol Buffers](https://developers.google.com/protocol-buffers/). 5 | 6 | ```bash 7 | $ bazel build //src:person_java_proto_lite 8 | Target //src:person_java_proto up-to-date: 9 | bazel-bin/src/libperson_proto-lite.jar 10 | ... 11 | $ bazel build //src:person_java_proto 12 | Target //src:person_java_proto up-to-date: 13 | bazel-bin/src/libperson_proto-speed.jar 14 | ... 15 | $ bazel build //src:person_cc_proto 16 | Target //src:person_java_proto up-to-date: 17 | bazel-bin/src/libperson_proto.so 18 | ... 19 | $ bazel build //src:person_proto 20 | Target //src:person_java_proto up-to-date: 21 | bazel-genfiles/src/person_proto-descriptor-set.proto.bin 22 | ``` 23 | 24 | ## Supporting Bazel 2.x and earlier 25 | 26 | Before Bazel 3.0, `java_lite_proto_library` had an implicit dependency on `@com_google_protobuf_javalite//:javalite_toolchain`. In order to support 27 | Bazel 2.x and earlier, you need to provide this dependency. Because the 28 | java lite toolchain has been included in the main protobuf repo since v3.11, 29 | it is recommended to use v3.11 at a minimum in order to support both Bazel 3.x 30 | and Bazel 2.x. To do this, add this to your WORKSPACE file: 31 | 32 | ``` 33 | # The 'com_google_protobuf_javalite' package is required for Bazel 2.x and below. 34 | http_archive( 35 | name = "com_google_protobuf_javalite", 36 | sha256 = "832c476bb442ca98a59c2291b8a504648d1c139b74acc15ef667a0e8f5e984e7", 37 | strip_prefix = "protobuf-3.11.3", 38 | urls = ["https://github.com/protocolbuffers/protobuf/archive/v3.11.3.zip"], 39 | ) 40 | ``` 41 | -------------------------------------------------------------------------------- /WORKSPACE: -------------------------------------------------------------------------------- 1 | workspace(name = "com_github_cgrushko_proto_library") 2 | 3 | load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") 4 | 5 | # rules_cc defines rules for generating C++ code from Protocol Buffers. 6 | http_archive( 7 | name = "rules_cc", 8 | sha256 = "35f2fb4ea0b3e61ad64a369de284e4fbbdcdba71836a5555abb5e194cf119509", 9 | strip_prefix = "rules_cc-624b5d59dfb45672d4239422fa1e3de1822ee110", 10 | urls = [ 11 | "https://mirror.bazel.build/github.com/bazelbuild/rules_cc/archive/624b5d59dfb45672d4239422fa1e3de1822ee110.tar.gz", 12 | "https://github.com/bazelbuild/rules_cc/archive/624b5d59dfb45672d4239422fa1e3de1822ee110.tar.gz", 13 | ], 14 | ) 15 | 16 | # rules_java defines rules for generating Java code from Protocol Buffers. 17 | http_archive( 18 | name = "rules_java", 19 | sha256 = "ccf00372878d141f7d5568cedc4c42ad4811ba367ea3e26bc7c43445bbc52895", 20 | strip_prefix = "rules_java-d7bf804c8731edd232cb061cb2a9fe003a85d8ee", 21 | urls = [ 22 | "https://mirror.bazel.build/github.com/bazelbuild/rules_java/archive/d7bf804c8731edd232cb061cb2a9fe003a85d8ee.tar.gz", 23 | "https://github.com/bazelbuild/rules_java/archive/d7bf804c8731edd232cb061cb2a9fe003a85d8ee.tar.gz", 24 | ], 25 | ) 26 | 27 | # rules_proto defines abstract rules for building Protocol Buffers. 28 | http_archive( 29 | name = "rules_proto", 30 | sha256 = "2490dca4f249b8a9a3ab07bd1ba6eca085aaf8e45a734af92aad0c42d9dc7aaf", 31 | strip_prefix = "rules_proto-218ffa7dfa5408492dc86c01ee637614f8695c45", 32 | urls = [ 33 | "https://mirror.bazel.build/github.com/bazelbuild/rules_proto/archive/218ffa7dfa5408492dc86c01ee637614f8695c45.tar.gz", 34 | "https://github.com/bazelbuild/rules_proto/archive/218ffa7dfa5408492dc86c01ee637614f8695c45.tar.gz", 35 | ], 36 | ) 37 | 38 | load("@rules_cc//cc:repositories.bzl", "rules_cc_dependencies") 39 | rules_cc_dependencies() 40 | 41 | load("@rules_java//java:repositories.bzl", "rules_java_dependencies", "rules_java_toolchains") 42 | rules_java_dependencies() 43 | rules_java_toolchains() 44 | 45 | load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains") 46 | rules_proto_dependencies() 47 | rules_proto_toolchains() 48 | -------------------------------------------------------------------------------- /src/BUILD: -------------------------------------------------------------------------------- 1 | load("@rules_cc//cc:defs.bzl", "cc_library") 2 | load("@rules_java//java:defs.bzl", "java_library") 3 | load("@rules_proto//proto:defs.bzl", "proto_library") 4 | 5 | # Convention: 6 | # A java_proto_library that wraps a proto_library named foo_proto 7 | # should be called foo_java_proto. 8 | # 9 | # Note that you only need a java_proto_library for the protos 10 | # you directly use in your code - a java_proto_library converts 11 | # an entire proto graph. 12 | java_proto_library( 13 | name = "person_java_proto", 14 | deps = [":person_proto"], 15 | ) 16 | 17 | # Convention: 18 | # A java_lite_proto_library that wraps a proto_library named foo_proto 19 | # should be called foo_java_proto_lite. 20 | java_lite_proto_library( 21 | name = "person_java_proto_lite", 22 | deps = [":person_proto"], 23 | ) 24 | 25 | # Convention: 26 | # A cc_proto_library that wraps a proto_library named foo_proto 27 | # should be called foo_cc_proto. 28 | cc_proto_library( 29 | name = "person_cc_proto", 30 | deps = [":person_proto"], 31 | ) 32 | 33 | # Conventions: 34 | # 1. One proto_library rule per .proto file. 35 | # 2. A file named foo.proto will be in a rule named foo_proto. 36 | proto_library( 37 | name = "person_proto", 38 | srcs = ["person.proto"], 39 | deps = [ 40 | ":address_proto", 41 | # Well known protos should be included as deps in the 42 | # proto_library rules of the source files importing them. 43 | # A list of all @com_google_protobuf well known protos can 44 | # seen with: 45 | # `bazel query 'kind(proto_library, @com_google_protobuf//:all)'` 46 | "@com_google_protobuf//:any_proto", 47 | ], 48 | ) 49 | 50 | proto_library( 51 | name = "address_proto", 52 | srcs = ["address.proto"], 53 | deps = [":zip_code_proto"], 54 | ) 55 | 56 | proto_library( 57 | name = "zip_code_proto", 58 | srcs = ["zip_code.proto"], 59 | ) 60 | -------------------------------------------------------------------------------- /src/address.proto: -------------------------------------------------------------------------------- 1 | syntax = "proto3"; 2 | 3 | package demo; // Requried to generate valid code. 4 | 5 | // Always import protos with a full path relative to the WORKSPACE file. 6 | import "src/zip_code.proto"; 7 | 8 | message Address { 9 | string city = 1; 10 | ZipCode zip_code = 2; 11 | } 12 | -------------------------------------------------------------------------------- /src/person.proto: -------------------------------------------------------------------------------- 1 | syntax = "proto3"; 2 | 3 | package demo; // Requried to generate valid code. 4 | 5 | // Always import protos with a full path relative to the WORKSPACE file. 6 | import "src/address.proto"; 7 | 8 | // Well known protos should be imported with full path relative to 9 | // @com_google_protobuf. 10 | import "google/protobuf/any.proto"; 11 | 12 | message Person { 13 | string name = 1; 14 | int32 id = 2; 15 | string email = 3; 16 | Address address = 4; 17 | google.protobuf.Any favorite_thing = 5; 18 | } 19 | -------------------------------------------------------------------------------- /src/zip_code.proto: -------------------------------------------------------------------------------- 1 | syntax = "proto3"; 2 | 3 | package demo; // Requried to generate valid code. 4 | 5 | message ZipCode { 6 | string code = 1; 7 | } 8 | --------------------------------------------------------------------------------