使用 tower gRPC

在 TiKV 里面,我们使用的是 grpc-rs,这是我们自己维护的一个 Rust gRPC 库,主要是使用 Future 这个特性,封装了 Google 的 C gRPC,对外提供了一套易于使用的同步编程的接口。

但 grpc-rs 并不是 pure Rust,而且 C gRPC 的性能其实并不好,加上在生产环境中碰到过几次 C gRPC panic,我们一直有打算完全拥抱 Rust 社区,用一个纯 Rust 的 gRPC 实现(以前也想过自己造轮子,但发现坑太大,就算了)。现阶段,有两个现成的,一个是 grpc-rust,而另一个则是 tower-grpc。grpc-rust 在最开始我们开发 grpc-rs 的时候,尝试过一段时间,不过接上去之后异常的不稳定,所以放弃了,后来也一直没有尝试,现在不知道改善了没有。

而 tower-grpc,虽然是一个非常新的实现,现在也不完善,但可以算是根正苗红了。首先它是 Rust 社区里面知名的几个开发者一起做的,譬如 mio 的作者carllerche,hyper 的作者 seanmonstar,另外它基于 tokio,这也可能是 Rust 网络编程的一个规范。所以如果我们能尽早的拥抱 tower-grpc,我们就可以跟 Rust 社区结合的更加紧密,帮助完善 tower 以及 tokio 相关的生态。

现阶段,对于 Protobuf,TiKV 使用的是 rust-protobuf,而 tower-grpc 使用的是 prost,所以我们并不能很容易的完全迁移到 tower 进行测试,主要是要把 TiKV 里面大量的使用 rust-protobuf 的代码改成使用 prost,这个其实是一个非常重的体力活。

不过还是可以先尝试一下的,使用 tower-grpc 还是比较简单的。首先,当然编译 TiKV 的 gRPC 协议,在 kvproto 里面,我们先 clone 下来,创建一个 tower 的目录:

git clone https://github.com/pingcap/kvproto.git
cd kvproto
mkdir tower

然后参考 Cargo.toml,创建出 Cargo.toml,不过这里需要注意,我使用的是 rustc 1.29.0-nightly (4f3c7a472 2018-07-17) 这个版本的,所以并不能编译 tower-grpc,需要显示的将 tower-grpc 的代码 clone 下来,在 tower-grpc/src/lib.rs 里面显示的加上:

#![feature(extern_prelude)]
#![feature(crate_in_paths)]

才能编译通过,所以这里,我们自己的 Cargo 文件使用的是本地的 tower-grpc。然后创建一个 build.rs

extern crate tower_grpc_build;

fn main() {
    tower_grpc_build::Config::new()
        .enable_server(true)
        .enable_client(true)
        .build(&["../proto/tikvpb.proto"], &["../proto", "../include"])
        .unwrap_or_else(|e| panic!("protobuf compilation failed: {}", e));
    // Same for pdpb.proto and other proto files
}

在随便的创建个 src/lib.rs 文件,然后 cargo build,生成的 proto 相关的 rs 文件会放在类似 target/debug/build/tower-9000a2ba77585c7e/out 的目录下面,现在可以先手动 copy 出去使用,后面其实不需要这么麻烦。

对于生成的文件,譬如 metapb.rs,类似这样

#[derive(Clone, PartialEq, Message)]
pub struct Cluster {
    #[prost(uint64, tag="1")]
    pub id: u64,
    /// max peer count for a region.
    /// pd will do the auto-balance if region peer count mismatches.
    ///
    /// more attributes......
    #[prost(uint32, tag="2")]
    pub max_peer_count: u32,
}

它并不能直接 import 使用,需要在外面再次 include,如下

pub mod metapb {
    include!("proto/metapb.rs");
}

然后我们再次创建一个工程,参考 client.rs,我们弄一个自己的 TiKV client,给 TiKV 发送 raw_put 命令:

pub fn main() {
    let _ = ::env_logger::init();

    let uri: http::Uri = format!("http://127.0.0.1:20161").parse().unwrap();

    let h2_settings = Default::default();
    let mut make_client = client::Connect::new(Dst, h2_settings, DefaultExecutor::current());

    let say_hello = make_client.make_service(())
        .map(move |conn| {
            use tikvpb::client::Tikv;
            use tower_http::add_origin;

            let conn = add_origin::Builder::new()
                .uri(uri)
                .build(conn)
                .unwrap();

            Tikv::new(conn)
        })
        .and_then(|mut client| {
            use kvrpcpb::{Context, RawPutRequest};
            use metapb::{RegionEpoch, Peer};

            let ctx = Context{
                region_id: 2,
                region_epoch: Some(RegionEpoch{
                    conf_ver: 1,
                    version: 1,
                }),
                peer: Some(Peer{
                    id: 3,
                    store_id: 1,
                    is_learner: false,
                }),
                term: 6,
                priority: 0,
                isolation_level: 0,
                not_fill_cache: false,
                sync_log: false,
                handle_time: false,
                scan_detail: false,
            };

            client.raw_put(Request::new(RawPutRequest {
                context: Some(ctx),
                key: b"a".to_vec(),
                value: b"123".to_vec(),
                cf : "default".to_string(),
            })).map_err(|e| panic!("gRPC request failed; err={:?}", e))
        })
        .and_then(|response| {
            println!("RESPONSE = {:?}", response);
            Ok(())
        })
        .map_err(|e| {
            println!("ERR = {:?}", e);
        });

    tokio::run(say_hello);
}

上面我们强制操作了 Region 2,通过 pd-ctl 以及 tikv-ctl 这两个工具可以得到相关的 region 信息,然后执行,得到如下输出:

RESPONSE = Response { http: Response { status: 200, version: HTTP/2.0, headers: {"content-type": "application/grpc", "grpc-accept-encoding": "identity,deflate,gzip", "accept-encoding": "identity,gzip"}, body: RawPutResponse { region_error: None, error: "" } } }

证明操作成功了,我们通过 tikv-ctl 在 TiKV 上面查询相关的数据:

tikv-ctl --host 127.0.0.1:20161 print -k za
value: 123

发现 key a 的值为 123,写入成功。这里需要注意,在 TiKV 里面,所有 key 都会增加前缀 “z” 写入,所以这里我们是 “za”。

可以看到,使用 tower-grpc 是非常容易的,我们也在仔细考虑这个事情 https://github.com/tikv/tikv/issues/3951,如果你对这块感兴趣,欢迎联系我们。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 148,827评论 1 317
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 63,511评论 1 266
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 99,318评论 0 218
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,108评论 0 189
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,112评论 1 266
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,387评论 1 185
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 30,905评论 2 283
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,657评论 0 177
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,144评论 0 223
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,744评论 2 225
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,100评论 1 236
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,565评论 2 222
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,041评论 3 216
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,769评论 0 9
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,301评论 0 178
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,173评论 2 239
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,313评论 2 242

推荐阅读更多精彩内容

  • gRPC 是一个高性能、通用的开源RPC框架,其由 Google 主要面向移动应用开发并基于HTTP/2 协议标准...
    刘琨_10f5阅读 1,238评论 4 6
  • 这是PingCAP的首席架构师唐刘在 Rust 专场 Meetup 英文演讲稿的翻译篇。鉴于译者水平有限,错误之处...
    Yuan2021阅读 5,368评论 5 20
  • 经过很长一段时间的开发,TiDB 终于发了 RC3。RC3 版本对于 TiKV 来说最重要的功能就是支持了 gRP...
    siddontang阅读 41,610评论 7 80
  • 0. Rust的源文件 像c语言的源文件我们以".c"为后缀,c++以".cpp"为后缀,java以".java"...
    一发元气弹阅读 1,879评论 0 0
  • 今天是国庆假期的第二天,由于我妈家水网改造,连续三天都在不停的往那跑,今天第四天上午带小宝送哥哥去文化宫敲鼓,下午...
    蓝枫zdd阅读 127评论 0 0