Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 73 additions & 14 deletions docs/cn/bazel_support.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,79 @@
## bRPC 作为Bazel第三方依赖
1. bRPC 依赖于一些开源库, 但这些库并没有提供bazel支持, 所以需要你手动将一部分依赖加入到你的构建项目中.
2. 将 /example/build_with_bazel/*.BUILD 和 brpc_workspace.bzl 该文件移动到你的项目根目录下, 将
```c++
load("@//:brpc_workspace.bzl", "brpc_workspace")
brpc_workspace();
## bRPC 作为 Bazel 第三方依赖

推荐在 Bazel 项目中使用 bzlmod(`MODULE.bazel`)依赖本地 bRPC 源码。
`example/build_with_bazel_module` 中有一个可运行的示例。

先在你的 `.bazelrc` 中添加 bRPC 使用的 registry:

```shell
common --registry=https://bcr.bazel.build
common --registry=https://baidu.github.io/babylon/registry
common --registry=https://raw.githubusercontent.com/apache/brpc/master/registry
```

然后在 `MODULE.bazel` 中添加 bRPC,并指向本地 bRPC 源码:

```python
module(
name = "my_brpc_app",
version = "0.1.0",
)

bazel_dep(name = "protobuf", version = "27.3", repo_name = "com_google_protobuf")
bazel_dep(name = "brpc", version = "1.17.0", repo_name = "apache_brpc")

local_path_override(
module_name = "brpc",
path = "/path/to/brpc",
)
```

`bazel_dep` 用来声明模块名和仓库映射,`local_path_override` 让 Bazel 使用本地源码,而不是从 registry 解析 bRPC。

之后在目标中链接 bRPC:

```python
cc_binary(
name = "server",
srcs = ["server.cpp"],
deps = [
"@apache_brpc//:brpc",
],
)
```
内容添加到你的WORKSPACE中.

3. 链接请使用
```c++
...
deps = [
如果服务使用 protobuf,可以从 bRPC 加载 `brpc_proto_library`:

```python
load("@apache_brpc//bazel/tools:brpc_proto_library.bzl", "brpc_proto_library")

brpc_proto_library(
name = "cc_echo_proto",
srcs = ["echo.proto"],
)
```

## 旧版 WORKSPACE 用法

仍在使用 `WORKSPACE` 的项目可以参考 `example/build_with_bazel`。

1. 将 `example/build_with_bazel/*.BUILD` 和
`example/build_with_bazel/brpc_workspace.bzl` 移动到你的项目根目录下。
2. 在 `WORKSPACE` 中添加:

```python
load("@//:brpc_workspace.bzl", "brpc_workspace")

brpc_workspace()
```

3. 在目标中链接 `apache_brpc`:

```python
deps = [
"@apache_brpc//:bthread",
"@apache_brpc//:brpc",
"@apache_brpc//:butil",
"@apache_brpc//:bvar",
]
...
```
]
```
47 changes: 47 additions & 0 deletions docs/cn/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,47 @@ $ ./echo_client
$ mkdir build && cd build && cmake -DBUILD_UNIT_TESTS=ON .. && make && make test
```

### 使用bazel编译brpc

brpc也可以直接使用[Bazel](https://bazel.build)编译,不需要先执行`config_brpc.sh`。推荐使用Bazelisk或`.bazelversion`中固定的Bazel版本(`7.2.1`),这是当前仓库默认验证的版本。bzlmod(`MODULE.bazel`)构建会拉取其中声明的第三方库,例如protobuf、gflags、leveldb、openssl,但仍需要可用的C++工具链和平台SDK。Bazel构建已在Linux CI中覆盖,brpc库目标也在macOS CI中覆盖。

克隆brpc并进入项目目录:
```shell
$ git clone https://github.com/apache/brpc.git
$ cd brpc
```

然后编译brpc库:
```shell
$ bazel build -- //:brpc
```

如果需要一并编译样例:
```shell
$ bazel build -- //:brpc //example/...
```

修改编译器为clang,添加选项`--action_env=CC=clang --action_env=CXX=clang++`。

可选功能通过`--define`开启,例如`--define with_glog=true`、`--define with_thrift=true`、`--define with_bthread_tracer=true`、`--define with_debug_lock=true`。完整的`--define`选项列表见`bazel/config/BUILD.bazel`。

**用bazel运行样例**

```shell
$ bazel run //example:echo_c++_server &
$ bazel run //example:echo_c++_client
```

**用bazel运行测试**

```shell
$ bazel test //test/...
```

**在自己的项目中把brpc作为bazel依赖**

参考[Bazel Support](bazel_support.md)了解如何在其他Bazel项目中依赖brpc,`example/build_with_bazel_module`中有一个可运行的bzlmod样例。

## Fedora/CentOS

### 依赖准备
Expand Down Expand Up @@ -182,6 +223,9 @@ $ sh run_tests.sh
### 使用cmake编译brpc
参考[这里](#使用cmake编译brpc)

### 使用bazel编译brpc
参考[这里](#使用bazel编译brpc)

### 使用vcpkg编译brpc

[vcpkg](https://github.com/microsoft/vcpkg) 是一个全平台支持的包管理器,你可以使用以下步骤vcpkg轻松编译brpc:
Expand Down Expand Up @@ -309,6 +353,9 @@ $ sh run_tests.sh
### 使用cmake编译brpc
参考[这里](#使用cmake编译brpc)

### 使用bazel编译brpc
参考[这里](#使用bazel编译brpc)

## Docker
使用docker 编译brpc:

Expand Down
88 changes: 75 additions & 13 deletions docs/en/bazel_support.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,82 @@
## bRPC as a Bazel third-party dependency
1. bRPC relies on a number of open source libraries that do not provide bazel support, so you will need to manually add some of these dependencies to your build project.
2. Move the BUILD file /example/build_with_bazel/*.BUILD and brpc_workspace.bzl to the root of your project, and add the contents of
```c++
load("@//:brpc_workspace.bzl", "brpc_workspace")
brpc_workspace();

The recommended way to depend on a local bRPC checkout from a Bazel project is
to use bzlmod (`MODULE.bazel`). See `example/build_with_bazel_module` for a
runnable example.

Add the registries used by bRPC to your `.bazelrc`:

```shell
common --registry=https://bcr.bazel.build
common --registry=https://baidu.github.io/babylon/registry
common --registry=https://raw.githubusercontent.com/apache/brpc/master/registry
```

Add bRPC to your `MODULE.bazel`, and point it to your local bRPC checkout:

```python
module(
name = "my_brpc_app",
version = "0.1.0",
)

bazel_dep(name = "protobuf", version = "27.3", repo_name = "com_google_protobuf")
bazel_dep(name = "brpc", version = "1.17.0", repo_name = "apache_brpc")

local_path_override(
module_name = "brpc",
path = "/path/to/brpc",
)
```

The `bazel_dep` keeps the module name and repository mapping, while
`local_path_override` makes Bazel use the local checkout instead of resolving
bRPC from a registry.

Then link bRPC from your targets:

```python
cc_binary(
name = "server",
srcs = ["server.cpp"],
deps = [
"@apache_brpc//:brpc",
],
)
```
to your WORKSPACE

3. link apache_brpc like:
```c++
...
deps = [
If your service uses protobuf, load `brpc_proto_library` from bRPC:

```python
load("@apache_brpc//bazel/tools:brpc_proto_library.bzl", "brpc_proto_library")

brpc_proto_library(
name = "cc_echo_proto",
srcs = ["echo.proto"],
)
```

## Legacy WORKSPACE usage

For projects that still use `WORKSPACE`, see `example/build_with_bazel`.

1. Move `example/build_with_bazel/*.BUILD` and
`example/build_with_bazel/brpc_workspace.bzl` to the root of your project.
2. Add the following to your `WORKSPACE`:

```python
load("@//:brpc_workspace.bzl", "brpc_workspace")

brpc_workspace()
```

3. Link `apache_brpc` from your targets:

```python
deps = [
"@apache_brpc//:bthread",
"@apache_brpc//:brpc",
"@apache_brpc//:butil",
"@apache_brpc//:bvar",
]
...
```
]
```
47 changes: 47 additions & 0 deletions docs/en/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,47 @@ Examples link brpc statically, if you need to link the shared version, remove `C
$ mkdir build && cd build && cmake -DBUILD_UNIT_TESTS=ON .. && make && make test
```

### Compile brpc with bazel

brpc can also be built directly with [Bazel](https://bazel.build) without running `config_brpc.sh` first. Use Bazelisk or the Bazel version pinned in `.bazelversion` (`7.2.1`), which is the default version validated by this repository. The bzlmod (`MODULE.bazel`) build fetches the third-party libraries declared there, such as protobuf, gflags, leveldb, and openssl, but you still need a working C++ toolchain and platform SDK. Bazel builds are covered by Linux CI; the brpc library target is also covered by macOS CI.

Clone brpc, cd into the repo and run:
```shell
$ git clone https://github.com/apache/brpc.git
$ cd brpc
```

Then build the brpc library:
```shell
$ bazel build -- //:brpc
```

To also build the examples:
```shell
$ bazel build -- //:brpc //example/...
```

To change compiler to clang, add `--action_env=CC=clang --action_env=CXX=clang++`.

Optional features are toggled with `--define`, e.g. `--define with_glog=true`, `--define with_thrift=true`, `--define with_bthread_tracer=true`, `--define with_debug_lock=true`. See `bazel/config/BUILD.bazel` for the full list of `--define` switches.

**Run example with bazel**

```shell
$ bazel run //example:echo_c++_server &
$ bazel run //example:echo_c++_client
```

**Run tests with bazel**

```shell
$ bazel test //test/...
```

**Use brpc as a bazel dependency in your own project**

See [Bazel Support](bazel_support.md) for how to depend on brpc from another Bazel project, and `example/build_with_bazel_module` for a runnable bzlmod example.

### Compile brpc with vcpkg

[vcpkg](https://github.com/microsoft/vcpkg) is a package manager that supports all platforms,
Expand Down Expand Up @@ -186,6 +227,9 @@ $ sh run_tests.sh
### Compile brpc with cmake
Same with [here](#compile-brpc-with-cmake)

### Compile brpc with bazel
Same with [here](#compile-brpc-with-bazel)

## Linux with self-built deps

### Prepare deps
Expand Down Expand Up @@ -318,6 +362,9 @@ $ sh run_tests.sh
### Compile brpc with cmake
Same with [here](#compile-brpc-with-cmake)

### Compile brpc with bazel
Same with [here](#compile-brpc-with-bazel)

# Supported deps

## GCC: 5.0-11.2
Expand Down
Loading