Skip to content

Latest commit

 

History

History
69 lines (58 loc) · 2.04 KB

combine_service_cn.md

File metadata and controls

69 lines (58 loc) · 2.04 KB

Combine Service 的使用

使用场景

有些服务提供了几十个方法,而对于调用方可能只请求其中1、2个方法,为了避免这种巨大的service带来的庞大的生成代码,Combine Service 可以让用户将原来一个 Service 的几十个方法拆分成多个 Service。比如原来的Service是:

service ExampleService {
    ExampleResponse Method0(3: ExampleRequest req)
    ExampleResponse Method1(3: ExampleRequest req)
    ExampleResponse Method2(3: ExampleRequest req)
}

用户IDL定义可以拆分为三个Service:

service ExampleService0 {
    ExampleResponse Method0(3: ExampleRequest req)
}

service ExampleService1 {
    ExampleResponse Method1(3: ExampleRequest req)
}

service ExampleService2 {
    ExampleResponse Method2(3: ExampleRequest req)
}

调用方可以只保留其中一个Service生成代码,方法名和参数保持一致不影响rpc调用。

具体描述

当 root thrift 文件中存在形如下述定义时:

service ExampleService0 {
    ExampleResponse Method0(3: ExampleRequest req)
}

service ExampleService1 {
    ExampleResponse Method1(3: ExampleRequest req)
}

service ExampleService2 {
    ExampleResponse Method2(3: ExampleRequest req)
}

带上--combine-service参数后,会生成一个名为 CombineService 的新 service 及其对应的 client/server 代码。 其定义为:

service CombineService {
    ExampleResponse Method0(3: ExampleRequest req)
    ExampleResponse Method1(3: ExampleRequest req)
    ExampleResponse Method2(3: ExampleRequest req)
}

当同时使用了-service参数时,会使用 CombineService 作为 main package 中 server 对应的 service 。 注意: CombineService 只是 method 的聚合,因此当 method 名冲突时将无法生成 CombineService 。

Tips: 配合extends关键字,可以实现跨文件的CombineService 如:

service ExampleService0 extends thriftA.Service0 {
}

service ExampleService1 extends thriftB.Service1 {
}

service ExampleService2 extends thriftC.Service2 {
}