Nanopb项目中使用Bazel构建系统的完整指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00413/article/details/148523542

Nanopb项目中使用Bazel构建系统的完整指南

nanopb Protocol Buffers with small code size 项目地址: https://gitcode.com/gh_mirrors/na/nanopb

前言

Nanopb是一个轻量级的Protocol Buffers实现，特别适合嵌入式系统使用。Bazel则是一个高效的构建系统，以其快速、可靠和可复现的构建特性而闻名。本文将详细介绍如何在Nanopb项目中使用Bazel构建系统，帮助开发者更好地集成和使用Nanopb。

Bazel构建系统简介

Bazel是Google开源的构建工具，具有以下特点：

支持多语言构建
增量构建效率高
构建结果可复现
支持远程缓存和分布式构建

对于Nanopb这样的协议缓冲区实现工具，使用Bazel可以带来更好的构建体验和更高的构建效率。

基础配置

1. 添加Nanopb依赖

首先需要在项目的MODULE.bazel文件中声明Nanopb依赖：

# MODULE.bazel
bazel_dep(name = "nanopb", version = "0.4.9")
git_override(
    module_name = "nanopb",
    remote = "https://github.com/nanopb/nanopb.git",
    commit = "<commit>",
)

这里需要注意：

版本号"0.4.9"应根据实际需求调整
commit字段应替换为具体的Git提交哈希值

2. 基本构建规则

在BUILD.bazel文件中，我们可以使用cc_nanopb_proto_library规则来生成Nanopb代码：

# BUILD.bazel
load("@nanopb//extra/bazel:nanopb_cc_proto_library.bzl", "cc_nanopb_proto_library")

proto_library(
    name = "descriptor",
    srcs = ["generator/proto/google/protobuf/descriptor.proto"],
)

cc_nanopb_proto_library(
    name = "descriptor_nanopb",
    protos = [":descriptor"],
    visibility = ["//visibility:private"],
)

cc_library(
    name = "uses_generated_descriptors",
    deps = [":descriptor_nanopb"],
    hdrs = ["my_header.h"],
)

这个配置完成了以下工作：

定义了一个proto_library目标
使用cc_nanopb_proto_library生成Nanopb代码
创建一个cc_library来使用生成的代码

高级用法

1. 使用自定义选项文件

Nanopb允许通过.options文件自定义生成代码的行为。在Bazel构建中，可以通过nanopb_options_files参数指定：

cc_nanopb_proto_library(
    name = "descriptor_nanopb",
    protos = [":descriptor"],
    nanopb_options_files = ["descriptor.options"],
    visibility = ["//visibility:private"],
)

2. 多文件处理

当有多个.proto文件需要处理时，可以这样组织：

proto_library(
    name = "protos",
    srcs = glob(["*.proto"]),
)

cc_nanopb_proto_library(
    name = "nanopb_protos",
    protos = [":protos"],
    nanopb_options_files = glob(["*.options"]),
)