github.com/cloudwego/kitex@v0.9.0/README_cn.md (about)

     1  # CloudWeGo-Kitex
     2  
     3  [English](README.md) | 中文
     4  
     5  [![Release](https://img.shields.io/github/v/release/cloudwego/kitex)](https://github.com/cloudwego/kitex/releases)
     6  [![WebSite](https://img.shields.io/website?up_message=cloudwego&url=https%3A%2F%2Fwww.cloudwego.io%2F)](https://www.cloudwego.io/)
     7  [![License](https://img.shields.io/github/license/cloudwego/kitex)](https://github.com/cloudwego/kitex/blob/main/LICENSE)
     8  [![Go Report Card](https://goreportcard.com/badge/github.com/cloudwego/kitex)](https://goreportcard.com/report/github.com/cloudwego/kitex)
     9  [![OpenIssue](https://img.shields.io/github/issues/cloudwego/kitex)](https://github.com/cloudwego/kitex/issues)
    10  [![ClosedIssue](https://img.shields.io/github/issues-closed/cloudwego/kitex)](https://github.com/cloudwego/kitex/issues?q=is%3Aissue+is%3Aclosed)
    11  ![Stars](https://img.shields.io/github/stars/cloudwego/kitex)
    12  ![Forks](https://img.shields.io/github/forks/cloudwego/kitex)
    13  [![Slack](https://img.shields.io/badge/slack-join_chat-success.svg?logo=slack)](https://cloudwego.slack.com/join/shared_invite/zt-tmcbzewn-UjXMF3ZQsPhl7W3tEDZboA)
    14  
    15  Kitex[kaɪt'eks] 字节跳动内部的 Golang 微服务 RPC 框架，具有**高性能**、**强可扩展**的特点，在字节内部已广泛使用。如今越来越多的微服务选择使用 Golang，如果对微服务性能有要求，又希望定制扩展融入自己的治理体系，Kitex 会是一个不错的选择。
    16  
    17  ## 框架特点
    18  
    19  - **高性能**
    20  
    21    使用自研的高性能网络库 [Netpoll](https://github.com/cloudwego/netpoll)，性能相较 go net 具有显著优势。
    22  
    23  - **扩展性**
    24  
    25    提供了较多的扩展接口以及默认扩展实现，使用者也可以根据需要自行定制扩展，具体见下面的框架扩展。
    26  
    27  - **多消息协议**
    28  
    29    RPC 消息协议默认支持 **Thrift**、**Kitex Protobuf**、**gRPC**。Thrift 支持 Buffered 和 Framed 二进制协议；Kitex Protobuf 是 Kitex 自定义的 Protobuf 消息协议，协议格式类似 Thrift；gRPC 是对 gRPC 消息协议的支持，可以与 gRPC 互通。除此之外，使用者也可以扩展自己的消息协议。
    30  
    31  - **多传输协议**
    32  
    33    传输协议封装消息协议进行 RPC 互通，传输协议可以额外透传元信息，用于服务治理，Kitex 支持的传输协议有 **TTHeader**、**HTTP2**。TTHeader 可以和 Thrift、Kitex Protobuf 结合使用；HTTP2 目前主要是结合 gRPC 协议使用，后续也会支持 Thrift。
    34  
    35  - **多种消息类型**
    36  
    37    支持 **PingPong**、**Oneway**、**双向 Streaming**。其中 Oneway 目前只对 Thrift 协议支持，双向 Streaming 只对 gRPC 支持，后续会考虑支持 Thrift 的双向 Streaming。
    38  
    39  - **服务治理**
    40  
    41    支持服务注册/发现、负载均衡、熔断、限流、重试、监控、链路跟踪、日志、诊断等服务治理模块，大部分均已提供默认扩展，使用者可选择集成。
    42  
    43  - **代码生成**
    44  
    45    Kitex 内置代码生成工具，可支持生成 **Thrift**、**Protobuf** 以及脚手架代码。
    46  
    47  ## 详细文档
    48  
    49    - [**快速开始**](https://www.cloudwego.io/zh/docs/kitex/getting-started/)
    50  
    51    - **用户指南**
    52    
    53      - **基本特性**
    54      
    55        包含消息类型、编解码协议、直连访问、连接池、超时控制、请求重试、负载均衡、熔断、埋点粒度控制、日志以及 HttpResolver，详见[文档](https://www.cloudwego.io/zh/docs/kitex/tutorials/basic-feature/)。 
    56      
    57      - **治理特性**
    58        
    59        支持服务发现、监控、链路跟踪、自定义访问控制等治理特性，详见[文档](https://www.cloudwego.io/zh/docs/kitex/tutorials/service-governance/)。
    60        
    61      - **高级特性**
    62      
    63        支持泛化调用、Server SDK 化等高级特性，详见[文档](https://www.cloudwego.io/zh/docs/kitex/tutorials/advanced-feature/)。
    64      
    65      - **代码生成**
    66      
    67        提供代码生成工具与 Combine Service 说明，详见[文档](https://www.cloudwego.io/zh/docs/kitex/tutorials/code-gen/)。
    68      
    69      - **框架扩展**
    70      
    71        提供基本扩展 - 自定义 Middleware、Suite 扩展（封装自定义治理模块）、服务注册扩展、服务发现扩展、负载均衡扩展、监控扩展、日志扩展、编解码(协议)扩展、传输模块扩展、Transport Pipeline-Bound 扩展、元信息传递扩展、诊断模块扩展等支持，详见[文档](https://www.cloudwego.io/zh/docs/kitex/tutorials/framework-exten/)。
    72      
    73    - **参考**
    74  
    75      - 关于应用层传输协议 TTHeader、异常说明与版本管理，请参考[文档](https://www.cloudwego.io/zh/docs/kitex/reference/)。
    76  
    77    - **FAQ**
    78      - 请参考 [FAQ](https://www.cloudwego.io/zh/docs/kitex/faq/)。
    79  ## 框架性能
    80  
    81  性能测试只能提供相对参考，工业场景下，有诸多因素可以影响实际的性能表现。
    82  
    83  我们提供了 [kitex-benchmark](https://github.com/cloudwego/kitex-benchmark) 项目用来长期追踪和比较 Kitex 与其他框架在不同情况下的性能数据以供参考。
    84  
    85  ## 相关项目
    86  
    87  - [Netpoll](https://github.com/cloudwego/netpoll)：自研的高性能网络库，Kitex 默认集成的。
    88  - [kitex-contrib](https://github.com/kitex-contrib)：Kitex 的部分扩展库，使用者可以根据需求通过 Option 集成进 Kitex 中。
    89  - [kitex-examples](https://github.com/cloudwego/kitex-examples): Kitex 功能示例代码集。
    90  - [biz-demo](https://github.com/cloudwego/biz-demo): Kitex 业务示例。
    91  
    92  ## 相关文章
    93  
    94  - [高性能 RPC 框架 CloudWeGo-Kitex 内外统一的开源实践](https://www.cloudwego.io/zh/blog/2022/09/20/%E9%AB%98%E6%80%A7%E8%83%BD-rpc-%E6%A1%86%E6%9E%B6-cloudwego-kitex-%E5%86%85%E5%A4%96%E7%BB%9F%E4%B8%80%E7%9A%84%E5%BC%80%E6%BA%90%E5%AE%9E%E8%B7%B5/)
    95  - [字节跳动 Go RPC 框架 Kitex 性能优化实践](https://www.cloudwego.io/zh/blog/2021/09/23/%E5%AD%97%E8%8A%82%E8%B7%B3%E5%8A%A8-go-rpc-%E6%A1%86%E6%9E%B6-kitex-%E6%80%A7%E8%83%BD%E4%BC%98%E5%8C%96%E5%AE%9E%E8%B7%B5/)
    96  - [字节跳动在 Go 网络库上的实践](https://www.cloudwego.io/zh/blog/2021/10/09/%E5%AD%97%E8%8A%82%E8%B7%B3%E5%8A%A8%E5%9C%A8-go-%E7%BD%91%E7%BB%9C%E5%BA%93%E4%B8%8A%E7%9A%84%E5%AE%9E%E8%B7%B5/)
    97  - [RPC 框架 Kitex 实践入门：性能测试指南](https://www.cloudwego.io/zh/blog/2021/11/24/rpc-%E6%A1%86%E6%9E%B6-kitex-%E5%AE%9E%E8%B7%B5%E5%85%A5%E9%97%A8%E6%80%A7%E8%83%BD%E6%B5%8B%E8%AF%95%E6%8C%87%E5%8D%97/)
    98  
    99  ## 贡献代码
   100  
   101  [Contributing](CONTRIBUTING.md)。
   102  
   103  ## 开源许可
   104  
   105  Kitex 基于[Apache License 2.0](LICENSE) 许可证，其依赖的三方组件的开源许可见 [Licenses](licenses)。
   106  
   107  ## 联系我们
   108  - Email: conduct@cloudwego.io
   109  - 如何成为 member: [COMMUNITY MEMBERSHIP](https://github.com/cloudwego/community/blob/main/COMMUNITY_MEMBERSHIP.md)
   110  - Issues: [Issues](https://github.com/cloudwego/kitex/issues)
   111  - Slack: 加入我们的 [Slack 频道](https://join.slack.com/t/cloudwego/shared_invite/zt-tmcbzewn-UjXMF3ZQsPhl7W3tEDZboA)
   112  - 飞书用户群（[注册飞书](https://www.feishu.cn/)进群）
   113  
   114    ![LarkGroup](images/lark_group_cn.png)
   115  
   116  ## Landscapes
   117  
   118  <p align="center">
   119  <img src="https://landscape.cncf.io/images/left-logo.svg" width="150"/>&nbsp;&nbsp;<img src="https://landscape.cncf.io/images/right-logo.svg" width="200"/>
   120  <br/><br/>
   121  CloudWeGo 丰富了 <a href="https://landscape.cncf.io/">CNCF 云原生生态</a>。
   122  </p>