diff --git a/README.md b/README.md index 1c4f785..cfd08d3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@ -[中文版](README_cn.md) + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/apache/brpc) · [上游 README](https://github.com/apache/brpc/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 + +[English version](README.md) [![Linux Build Status](https://github.com/apache/brpc/actions/workflows/ci-linux.yml/badge.svg)](https://github.com/apache/brpc/actions/workflows/ci-linux.yml) [![MacOs Build Status](https://github.com/apache/brpc/actions/workflows/ci-macos.yml/badge.svg)](https://github.com/apache/brpc/actions/workflows/ci-macos.yml) @@ -6,112 +12,119 @@ ![brpc logo (light)](docs/images/logo.png#gh-light-mode-only) ![brpc logo (dark)](docs/images/logo-white.png#gh-dark-mode-only) -[bRPC](https://brpc.apache.org/) is an Industrial-grade RPC framework using C++ Language, which is often used in high performance system such as Search, Storage, Machine learning, Advertisement, Recommendation etc. +[bRPC](https://brpc.apache.org/)是用C++语言编写的工业级RPC框架，常用于搜索、存储、机器学习、广告、推荐等高性能系统。 -### "bRPC" means "better RPC". +### "bRPC"的含义是"better RPC" -You can use it to: -* Build a server that can talk in multiple protocols (**on same port**), or access all sorts of services - * restful http/https, [h2](https://httpwg.org/specs/rfc9113.html)/[gRPC](https://grpc.io). using http/h2 in bRPC is much more friendly than [libcurl](https://curl.haxx.se/libcurl/). Access protobuf-based protocols with HTTP/h2+json, probably from another language. - * [redis](docs/en/redis_client.md) and [memcached](docs/en/memcache_client.md), thread-safe, more friendly and performant than the official clients. - * [rtmp](https://github.com/apache/brpc/blob/master/src/brpc/rtmp.h)/[flv](https://en.wikipedia.org/wiki/Flash_Video)/[hls](https://en.wikipedia.org/wiki/HTTP_Live_Streaming), for building [streaming services](https://github.com/brpc/media-server). - * hadoop_rpc (may be opensourced) - * [rdma](https://en.wikipedia.org/wiki/Remote_direct_memory_access) support - * [thrift](docs/en/thrift.md) support, thread-safe, more friendly and performant than the official clients. - * all sorts of protocols used in Baidu: [baidu_std](docs/en/baidu_std.md), [streaming_rpc](docs/en/streaming_rpc.md), hulu_pbrpc, [sofa_pbrpc](https://github.com/baidu/sofa-pbrpc), nova_pbrpc, public_pbrpc, ubrpc and nshead-based ones. - * Build [HA](https://en.wikipedia.org/wiki/High_availability) distributed services using an industrial-grade implementation of [RAFT consensus algorithm](https://raft.github.io) which is opensourced at [braft](https://github.com/brpc/braft) -* Servers can handle requests [synchronously](docs/en/server.md) or [asynchronously](docs/en/server.md#asynchronous-service). -* Clients can access servers [synchronously](docs/en/client.md#synchronus-call), [asynchronously](docs/en/client.md#asynchronous-call), [semi-synchronously](docs/en/client.md#semi-synchronous-call), or use [combo channels](docs/en/combo_channel.md) to simplify sharded or parallel accesses declaratively. -* Debug services [via http](docs/en/builtin_service.md), and run [cpu](docs/en/cpu_profiler.md), [heap](docs/en/heap_profiler.md) and [contention](docs/en/contention_profiler.md) profilers. -* Get [better latency and throughput](docs/en/overview.md#better-latency-and-throughput). -* [Extend bRPC](docs/en/new_protocol.md) with the protocols used in your organization quickly, or customize components, including [naming services](docs/en/load_balancing.md) (dns, zk, etcd), [load balancers](docs/en/load_balancing.md) (rr, random, consistent hashing) +你可以使用它： -# Try it! +* 搭建能在**一个端口**支持多协议的服务, 或访问各种服务 + * restful http/https, [h2](https://httpwg.org/specs/rfc9113.html)/[gRPC](https://grpc.io)。使用bRPC的http实现比[libcurl](https://curl.haxx.se/libcurl/)方便多了。从其他语言通过HTTP/h2+json访问基于protobuf的协议. + * [redis](docs/cn/redis_client.md)和[memcached](docs/cn/memcache_client.md), 线程安全，比官方client更方便。 + * [rtmp](https://github.com/apache/brpc/blob/master/src/brpc/rtmp.h)/[flv](https://en.wikipedia.org/wiki/Flash_Video)/[hls](https://en.wikipedia.org/wiki/HTTP_Live_Streaming), 可用于搭建[流媒体服务](https://github.com/brpc/media-server). + * hadoop_rpc(可能开源) + * 支持[rdma](https://en.wikipedia.org/wiki/Remote_direct_memory_access) + * 支持[thrift](docs/cn/thrift.md) , 线程安全，比官方client更方便 + * 各种百度内使用的协议: [baidu_std](docs/cn/baidu_std.md), [streaming_rpc](docs/cn/streaming_rpc.md), hulu_pbrpc, [sofa_pbrpc](https://github.com/baidu/sofa-pbrpc), nova_pbrpc, public_pbrpc, ubrpc和使用nshead的各种协议. + * 基于工业级的[RAFT算法](https://raft.github.io)实现搭建[高可用](https://en.wikipedia.org/wiki/High_availability)分布式系统，已在[braft](https://github.com/brpc/braft)开源。 +* Server能[同步](docs/cn/server.md)或[异步](docs/cn/server.md#异步service)处理请求。 +* Client支持[同步](docs/cn/client.md#同步访问)、[异步](docs/cn/client.md#异步访问)、[半同步](docs/cn/client.md#半同步)，或使用[组合channels](docs/cn/combo_channel.md)简化复杂的分库或并发访问。 +* [通过http界面](docs/cn/builtin_service.md)调试服务, 使用[cpu](docs/cn/cpu_profiler.md), [heap](docs/cn/heap_profiler.md), [contention](docs/cn/contention_profiler.md) profilers. +* 获得[更好的延时和吞吐](docs/cn/overview.md#更好的延时和吞吐). +* 把你组织中使用的协议快速地[加入bRPC](docs/cn/new_protocol.md)，或定制各类组件, 包括[命名服务](docs/cn/load_balancing.md#命名服务) (dns, zk, etcd), [负载均衡](docs/cn/load_balancing.md#负载均衡) (rr, random, consistent hashing) -* Read [overview](docs/en/overview.md) to know where bRPC can be used and its advantages. -* Read [getting started](docs/en/getting_started.md) for building steps and play with [examples](https://github.com/apache/brpc/tree/master/example/). -* Docs: - * [Performance benchmark](docs/en/benchmark.md) - * [bvar](docs/en/bvar.md) - * [bvar_c++](docs/en/bvar_c++.md) - * [bthread](docs/en/bthread.md) - * [bthread or not](docs/en/bthread_or_not.md) - * [thread-local](docs/en/thread_local.md) - * [Execution Queue](docs/en/execution_queue.md) - * [bthread tracer](docs/en/bthread_tracer.md) - * [bthread tagged task group](docs/en/bthread_tagged_task_group.md) +# 试一下! + +* 通过[概述](docs/cn/overview.md)了解哪里可以用bRPC及其优势。 +* 阅读[编译步骤](docs/cn/getting_started.md)了解如何开始使用, 之后可以运行一下[示例程序](https://github.com/apache/brpc/tree/master/example/). +* 文档: + * [性能测试](docs/cn/benchmark.md) + * [bvar](docs/cn/bvar.md) + * [bvar_c++](docs/cn/bvar_c++.md) + * [bthread](docs/cn/bthread.md) + * [bthread or not](docs/cn/bthread_or_not.md) + * [thread-local](docs/cn/thread_local.md) + * [Execution Queue](docs/cn/execution_queue.md) + * [bthread tracer](docs/cn/bthread_tracer.md) + * [bthread tagged task group](docs/cn/bthread_tagged_task_group.md) * Client - * [Basics](docs/en/client.md) - * [Error code](docs/en/error_code.md) - * [Combo channels](docs/en/combo_channel.md) - * [Access http/h2](docs/en/http_client.md) - * [Access gRPC](docs/en/http_derivatives.md#h2grpc) - * [Access thrift](docs/en/thrift.md#client-accesses-thrift-server) - * [Access UB](docs/en/ub_client.md) - * [Streaming RPC](docs/en/streaming_rpc.md) - * [Access redis](docs/en/redis_client.md) - * [Access memcached](docs/en/memcache_client.md) - * [Backup request](docs/en/backup_request.md) - * [Dummy server](docs/en/dummy_server.md) + * [基础功能](docs/cn/client.md) + * [错误码](docs/cn/error_code.md) + * [组合channels](docs/cn/combo_channel.md) + * [访问http/h2](docs/cn/http_client.md) + * [访问gRPC](docs/cn/http_derivatives.md#h2grpc) + * [访问thrift](docs/cn/thrift.md#client端访问thrift-server) + * [访问UB](docs/cn/ub_client.md) + * [Streaming RPC](docs/cn/streaming_rpc.md) + * [访问redis](docs/cn/redis_client.md) + * [访问memcached](docs/cn/memcache_client.md) + * [Backup request](docs/cn/backup_request.md) + * [Dummy server](docs/cn/dummy_server.md) * Server - * [Basics](docs/en/server.md) - * [Serve http/h2](docs/en/http_service.md) - * [Serve gRPC](docs/en/http_derivatives.md#h2grpc) - * [Serve thrift](docs/en/thrift.md#server-processes-thrift-requests) - * [Serve Nshead](docs/en/nshead_service.md) - * [Debug server issues](docs/en/server_debugging.md) - * [Server push](docs/en/server_push.md) - * [Avalanche](docs/en/avalanche.md) - * [Auto ConcurrencyLimiter](docs/en/auto_concurrency_limiter.md) - * [Media Server](https://github.com/brpc/media-server) - * [json2pb](docs/en/json2pb.md) - * [Builtin Services](docs/en/builtin_service.md) - * [status](docs/en/status.md) - * [vars](docs/en/vars.md) - * [connections](docs/en/connections.md) - * [flags](docs/en/flags.md) - * [rpcz](docs/en/rpcz.md) - * [cpu_profiler](docs/en/cpu_profiler.md) - * [heap_profiler](docs/en/heap_profiler.md) - * [contention_profiler](docs/en/contention_profiler.md) - * Tools - * [rpc_press](docs/en/rpc_press.md) - * [rpc_replay](docs/en/rpc_replay.md) - * [rpc_view](docs/en/rpc_view.md) - * [benchmark_http](docs/en/benchmark_http.md) - * [parallel_http](docs/en/parallel_http.md) - * Others - * [IOBuf](docs/en/iobuf.md) - * [Streaming Log](docs/en/streaming_log.md) - * [FlatMap](docs/en/flatmap.md) - * [Coroutine](docs/en/coroutine.md) - * [Circuit Breaker](docs/en/circuit_breaker.md) - * [RDMA](docs/en/rdma.md) - * [Bazel Support](docs/en/bazel_support.md) - * [Wireshark baidu_std dissector plugin](docs/en/wireshark_baidu_std.md) - * [bRPC introduction](docs/cn/brpc_intro.pptx)(training material) - * [A tutorial on building large-scale services](docs/en/tutorial_on_building_services.pptx)(training material) - * [bRPC internal](docs/en/brpc_internal.pptx)(training material) - * RPC in depth - * [New Protocol](docs/en/new_protocol.md) - * [Atomic instructions](docs/en/atomic_instructions.md) - * [IO](docs/en/io.md) - * [Threading Overview](docs/en/threading_overview.md) - * [Load Balancing](docs/en/load_balancing.md) - * [Locality-aware](docs/en/lalb.md) - * [Consistent Hashing](docs/en/consistent_hashing.md) - * [Memory Management](docs/en/memory_management.md) - * [Timer keeping](docs/en/timer_keeping.md) - * [bthread_id](docs/en/bthread_id.md) - * Use cases - * [User cases](community/cases.md) + * [基础功能](docs/cn/server.md) + * [搭建http/h2服务](docs/cn/http_service.md) + * [搭建gRPC服务](docs/cn/http_derivatives.md#h2grpc) + * [搭建thrift服务](docs/cn/thrift.md#server端处理thrift请求) + * [搭建Nshead服务](docs/cn/nshead_service.md) + * [高效率排查server卡顿](docs/cn/server_debugging.md) + * [推送](docs/cn/server_push.md) + * [雪崩](docs/cn/avalanche.md) + * [自适应限流](docs/cn/auto_concurrency_limiter.md) + * [流媒体服务](https://github.com/brpc/media-server) + * [json2pb](docs/cn/json2pb.md) + * [内置服务](docs/cn/builtin_service.md) + * [status](docs/cn/status.md) + * [vars](docs/cn/vars.md) + * [connections](docs/cn/connections.md) + * [flags](docs/cn/flags.md) + * [rpcz](docs/cn/rpcz.md) + * [cpu_profiler](docs/cn/cpu_profiler.md) + * [heap_profiler](docs/cn/heap_profiler.md) + * [contention_profiler](docs/cn/contention_profiler.md) + * 工具 + * [rpc_press](docs/cn/rpc_press.md) + * [rpc_replay](docs/cn/rpc_replay.md) + * [rpc_view](docs/cn/rpc_view.md) + * [benchmark_http](docs/cn/benchmark_http.md) + * [parallel_http](docs/cn/parallel_http.md) + * 其他 + * [IOBuf](docs/cn/iobuf.md) + * [Streaming Log](docs/cn/streaming_log.md) + * [FlatMap](docs/cn/flatmap.md) + * [协程](docs/cn/coroutine.md) + * [熔断](docs/cn/circuit_breaker.md) + * [RDMA](docs/cn/rdma.md) + * [Bazel构建支持](docs/cn/bazel_support.md) + * [Wireshark baidu_std协议解析插件](docs/cn/wireshark_baidu_std.md) + * [bRPC外功修炼宝典](docs/cn/brpc_intro.pptx)(培训材料) + * [搭建大型服务入门](docs/en/tutorial_on_building_services.pptx)(培训材料) + * [bRPC内功修炼宝典](docs/en/brpc_internal.pptx)(培训材料) + * 深入RPC + * [New Protocol](docs/cn/new_protocol.md) + * [Atomic instructions](docs/cn/atomic_instructions.md) + * [IO](docs/cn/io.md) + * [Threading Overview](docs/cn/threading_overview.md) + * [Load Balancing](docs/cn/load_balancing.md) + * [Locality-aware](docs/cn/lalb.md) + * [Consistent Hashing](docs/cn/consistent_hashing.md) + * [Memory Management](docs/cn/memory_management.md) + * [Timer keeping](docs/cn/timer_keeping.md) + * [bthread_id](docs/cn/bthread_id.md) + * Use cases inside Baidu + * [百度地图api入口](docs/cn/case_apicontrol.md) + * [联盟DSP](docs/cn/case_baidu_dsp.md) + * [ELF学习框架](docs/cn/case_elf.md) + * [云平台代理服务](docs/cn/case_ubrpc.md) -# Contribute code -Please refer to [here](CONTRIBUTING.md). +# 贡献代码 -# Feedback and Getting involved -* Report bugs, ask questions or give suggestions by [Github Issues](https://github.com/apache/brpc/issues) -* Subscribe to the mailing list(dev-subscribe@brpc.apache.org) to get updated with the project +请参考[这里](CONTRIBUTING.md#chinese-version)。 -# Code of Conduct -We follow the code of conduct from Apache Software Foundation, please refer it here [Link](https://www.apache.org/foundation/policies/conduct) +# 反馈和参与 + +* bug、疑惑、修改建议都欢迎提在[Github Issues](https://github.com/apache/brpc/issues)中 +* 订阅邮件列表(dev-subscribe@brpc.apache.org)获得项目最新信息 + + +# 行为准则 +我们遵守Apache软件基金会的行为准则, 请参考如下 [链接](https://www.apache.org/foundation/policies/conduct)