xref: /aosp_15_r20/external/cronet/third_party/protobuf/examples/BUILD.bazel (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1*6777b538SAndroid Build Coastguard Worker# This BUILD file shows how to use protobuf with bazel. Before you can use
2*6777b538SAndroid Build Coastguard Worker# proto_library/<lang>_proto_library rules in a BUILD file, you need to
3*6777b538SAndroid Build Coastguard Worker# include protobuf repo as remote repositories in your WORKSPACE file. See
4*6777b538SAndroid Build Coastguard Worker# the WORKSPACE file in the same directory with this BUILD file for an
5*6777b538SAndroid Build Coastguard Worker# example.
6*6777b538SAndroid Build Coastguard Worker
7*6777b538SAndroid Build Coastguard Workerload("@rules_cc//cc:defs.bzl", "cc_binary", "cc_proto_library")
8*6777b538SAndroid Build Coastguard Workerload("@rules_java//java:defs.bzl", "java_binary", "java_lite_proto_library", "java_proto_library")
9*6777b538SAndroid Build Coastguard Workerload("@rules_pkg//:mappings.bzl", "pkg_files", "strip_prefix")
10*6777b538SAndroid Build Coastguard Workerload("@rules_proto//proto:defs.bzl", "proto_library")
11*6777b538SAndroid Build Coastguard Worker
12*6777b538SAndroid Build Coastguard Worker# For each .proto file, a proto_library target should be defined. This target
13*6777b538SAndroid Build Coastguard Worker# is not bound to any particular language. Instead, it defines the dependency
14*6777b538SAndroid Build Coastguard Worker# graph of the .proto files (i.e., proto imports) and serves as the provider
15*6777b538SAndroid Build Coastguard Worker# of .proto source files to the protocol compiler.
16*6777b538SAndroid Build Coastguard Worker#
17*6777b538SAndroid Build Coastguard Worker# Remote repository "com_google_protobuf" must be defined to use this rule.
18*6777b538SAndroid Build Coastguard Workerproto_library(
19*6777b538SAndroid Build Coastguard Worker    name = "addressbook_proto",
20*6777b538SAndroid Build Coastguard Worker    srcs = ["addressbook.proto"],
21*6777b538SAndroid Build Coastguard Worker    deps = ["@com_google_protobuf//:timestamp_proto"],
22*6777b538SAndroid Build Coastguard Worker)
23*6777b538SAndroid Build Coastguard Worker
24*6777b538SAndroid Build Coastguard Worker# The cc_proto_library rule generates C++ code for a proto_library rule. It
25*6777b538SAndroid Build Coastguard Worker# must have exactly one proto_library dependency. If you want to use multiple
26*6777b538SAndroid Build Coastguard Worker# proto_library targets, create a separate cc_proto_library target for each
27*6777b538SAndroid Build Coastguard Worker# of them.
28*6777b538SAndroid Build Coastguard Worker#
29*6777b538SAndroid Build Coastguard Worker# Remote repository "com_google_protobuf_cc" must be defined to use this rule.
30*6777b538SAndroid Build Coastguard Workercc_proto_library(
31*6777b538SAndroid Build Coastguard Worker    name = "addressbook_cc_proto",
32*6777b538SAndroid Build Coastguard Worker    deps = [":addressbook_proto"],
33*6777b538SAndroid Build Coastguard Worker)
34*6777b538SAndroid Build Coastguard Worker
35*6777b538SAndroid Build Coastguard Worker# cc_library/cc_binary targets can depend on cc_proto_library targets.
36*6777b538SAndroid Build Coastguard Workercc_binary(
37*6777b538SAndroid Build Coastguard Worker    name = "add_person_cpp",
38*6777b538SAndroid Build Coastguard Worker    srcs = ["add_person.cc"],
39*6777b538SAndroid Build Coastguard Worker    deps = [":addressbook_cc_proto"],
40*6777b538SAndroid Build Coastguard Worker)
41*6777b538SAndroid Build Coastguard Worker
42*6777b538SAndroid Build Coastguard Workercc_binary(
43*6777b538SAndroid Build Coastguard Worker    name = "list_people_cpp",
44*6777b538SAndroid Build Coastguard Worker    srcs = ["list_people.cc"],
45*6777b538SAndroid Build Coastguard Worker    deps = [":addressbook_cc_proto"],
46*6777b538SAndroid Build Coastguard Worker)
47*6777b538SAndroid Build Coastguard Worker
48*6777b538SAndroid Build Coastguard Worker# Similar to cc_proto_library but for Java.
49*6777b538SAndroid Build Coastguard Worker#
50*6777b538SAndroid Build Coastguard Worker# Remote repository "com_google_protobuf_java" must be defined to use this rule.
51*6777b538SAndroid Build Coastguard Workerjava_proto_library(
52*6777b538SAndroid Build Coastguard Worker    name = "addressbook_java_proto",
53*6777b538SAndroid Build Coastguard Worker    deps = [":addressbook_proto"],
54*6777b538SAndroid Build Coastguard Worker)
55*6777b538SAndroid Build Coastguard Worker
56*6777b538SAndroid Build Coastguard Workerjava_binary(
57*6777b538SAndroid Build Coastguard Worker    name = "add_person_java",
58*6777b538SAndroid Build Coastguard Worker    srcs = ["AddPerson.java"],
59*6777b538SAndroid Build Coastguard Worker    main_class = "AddPerson",
60*6777b538SAndroid Build Coastguard Worker    deps = [":addressbook_java_proto"],
61*6777b538SAndroid Build Coastguard Worker)
62*6777b538SAndroid Build Coastguard Worker
63*6777b538SAndroid Build Coastguard Workerjava_binary(
64*6777b538SAndroid Build Coastguard Worker    name = "list_people_java",
65*6777b538SAndroid Build Coastguard Worker    srcs = ["ListPeople.java"],
66*6777b538SAndroid Build Coastguard Worker    main_class = "ListPeople",
67*6777b538SAndroid Build Coastguard Worker    deps = [":addressbook_java_proto"],
68*6777b538SAndroid Build Coastguard Worker)
69*6777b538SAndroid Build Coastguard Worker
70*6777b538SAndroid Build Coastguard Worker# Java lite.
71*6777b538SAndroid Build Coastguard Worker#
72*6777b538SAndroid Build Coastguard Worker# Remote repository "com_google_protobuf_javalite" must be defined to use this
73*6777b538SAndroid Build Coastguard Worker# rule.
74*6777b538SAndroid Build Coastguard Workerjava_lite_proto_library(
75*6777b538SAndroid Build Coastguard Worker    name = "addressbook_java_lite_proto",
76*6777b538SAndroid Build Coastguard Worker    deps = [":addressbook_proto"],
77*6777b538SAndroid Build Coastguard Worker)
78*6777b538SAndroid Build Coastguard Worker
79*6777b538SAndroid Build Coastguard Worker# Java lite API is a subset of the regular Java API so if you only uses this
80*6777b538SAndroid Build Coastguard Worker# subset in your code, you can actually compile your code against both (i.e.,
81*6777b538SAndroid Build Coastguard Worker# share code between server build and Android build).
82*6777b538SAndroid Build Coastguard Worker#
83*6777b538SAndroid Build Coastguard Worker# The lite version has a smaller code size, and you can see that by comparing
84*6777b538SAndroid Build Coastguard Worker# the resulted .jar file:
85*6777b538SAndroid Build Coastguard Worker#
86*6777b538SAndroid Build Coastguard Worker#   $ bazel build :add_person_java_deploy.jar :add_person_java_lite_deploy.jar
87*6777b538SAndroid Build Coastguard Worker#   $ ls -l bazel-bin/*_deploy.jar
88*6777b538SAndroid Build Coastguard Worker#   -r-xr-xr-x 1 xiaofeng eng 1230797 Sep  8 12:24 bazel-bin/add_person_java_deploy.jar
89*6777b538SAndroid Build Coastguard Worker#   -r-xr-xr-x 1 xiaofeng eng  236166 Sep  8 12:24 bazel-bin/add_person_java_lite_deploy.jar
90*6777b538SAndroid Build Coastguard Worker#
91*6777b538SAndroid Build Coastguard Worker# In the above example, the lite .jar file is 6 times smaller. With proper
92*6777b538SAndroid Build Coastguard Worker# proguard inlining/stripping, the difference can be much more larger than
93*6777b538SAndroid Build Coastguard Worker# that.
94*6777b538SAndroid Build Coastguard Workerjava_binary(
95*6777b538SAndroid Build Coastguard Worker    name = "add_person_java_lite",
96*6777b538SAndroid Build Coastguard Worker    srcs = ["AddPerson.java"],
97*6777b538SAndroid Build Coastguard Worker    main_class = "AddPerson",
98*6777b538SAndroid Build Coastguard Worker    deps = [":addressbook_java_lite_proto"],
99*6777b538SAndroid Build Coastguard Worker)
100*6777b538SAndroid Build Coastguard Worker
101*6777b538SAndroid Build Coastguard Workerjava_binary(
102*6777b538SAndroid Build Coastguard Worker    name = "list_people_java_lite",
103*6777b538SAndroid Build Coastguard Worker    srcs = ["ListPeople.java"],
104*6777b538SAndroid Build Coastguard Worker    main_class = "ListPeople",
105*6777b538SAndroid Build Coastguard Worker    deps = [":addressbook_java_lite_proto"],
106*6777b538SAndroid Build Coastguard Worker)
107*6777b538SAndroid Build Coastguard Worker
108*6777b538SAndroid Build Coastguard Worker# Files included in all source distributions
109*6777b538SAndroid Build Coastguard Workerpkg_files(
110*6777b538SAndroid Build Coastguard Worker    name = "dist_files",
111*6777b538SAndroid Build Coastguard Worker    srcs = [
112*6777b538SAndroid Build Coastguard Worker        "AddPerson.java",
113*6777b538SAndroid Build Coastguard Worker        "BUILD.bazel",
114*6777b538SAndroid Build Coastguard Worker        "CMakeLists.txt",
115*6777b538SAndroid Build Coastguard Worker        "ListPeople.java",
116*6777b538SAndroid Build Coastguard Worker        "Makefile",
117*6777b538SAndroid Build Coastguard Worker        "README.md",
118*6777b538SAndroid Build Coastguard Worker        "WORKSPACE",
119*6777b538SAndroid Build Coastguard Worker        "add_person.cc",
120*6777b538SAndroid Build Coastguard Worker        "add_person.dart",
121*6777b538SAndroid Build Coastguard Worker        "add_person.py",
122*6777b538SAndroid Build Coastguard Worker        "addressbook.proto",
123*6777b538SAndroid Build Coastguard Worker        "go/cmd/add_person/add_person.go",
124*6777b538SAndroid Build Coastguard Worker        "go/cmd/add_person/add_person_test.go",
125*6777b538SAndroid Build Coastguard Worker        "go/cmd/list_people/list_people.go",
126*6777b538SAndroid Build Coastguard Worker        "go/cmd/list_people/list_people_test.go",
127*6777b538SAndroid Build Coastguard Worker        "go/go.mod",
128*6777b538SAndroid Build Coastguard Worker        "go/go.sum",
129*6777b538SAndroid Build Coastguard Worker        "list_people.cc",
130*6777b538SAndroid Build Coastguard Worker        "list_people.dart",
131*6777b538SAndroid Build Coastguard Worker        "list_people.py",
132*6777b538SAndroid Build Coastguard Worker        "pubspec.yaml",
133*6777b538SAndroid Build Coastguard Worker    ],
134*6777b538SAndroid Build Coastguard Worker    prefix = "examples/",
135*6777b538SAndroid Build Coastguard Worker    strip_prefix = strip_prefix.from_root(""),
136*6777b538SAndroid Build Coastguard Worker    visibility = ["//visibility:public"],
137*6777b538SAndroid Build Coastguard Worker)
138