SOFARPC 是蚂蚁金服开源的一款基于 Java 实现的 RPC 服务框架，为应用之间提供远程服务调用能力，具有高可伸缩性，高容错性，目前蚂蚁金服所有的业务的相互间的 RPC 调用都是采用 SOFARPC。SOFARPC 为用户提供了负载均衡，流量转发，链路追踪，链路数据透传，故障剔除等功能。
1.8.3.1SOFARPC 配置流程
首先我们在Client 端需要加入 sofaRpc 和 soul-sofa 的依赖。
<dependency>
<groupId>com.alipay.sofa</groupId>
<artifactId>rpc-sofa-boot-starter</artifactId>
<version>${rpc-sofa-boot-starter.version}</version>
</dependency>
<dependency>
<groupId>org.dromara</groupId>
<artifactId>soul-spring-boot-starter-client-sofa</artifactId>
<version>${soul.version}</version>
</dependency>
我们使用 zk 作为 sofaRpc 的注册中心，所以需要做如下配置。
com:
alipay:
sofa:
rpc:
registry-address: zookeeper://127.0.0.1:2181
bolt-port: 8888
sofaRpc 需要定义一个 xml 文件类似于 dubbo.xml 配置暴露的服务。
<sofa:service ref="sofaSingleParamService" interface="org.dromara.soul.examples.sofa.api.service.SofaSingleParamService">
<sofa:binding.bolt/>
</sofa:service>
<sofa:service ref="sofaMultiParamService" interface="org.dromara.soul.examples.sofa.api.service.SofaMultiParamService">
<sofa:binding.bolt/>
</sofa:service>
最后我们在各个 SofaRpc 服务中加入 @SoulSofaClient 注解即可，这里定义了服务的访问路径，当我们注册成功后就会在 zookeeper 中发现如下服务。并且 soul admin 也会有对应的路径。
zookeeper
admin
同时我们需要在 soul bootstrap 引入 sofa-plugin 依赖和 zookeeper 的依赖。
1.8.3.2 sofa 插件详解
还是按惯用流程我们先到 SofaPluginConfiguration ,它定义了 sofaRpc 在 Boostrap 中处理类。其中主要的信息有 BodyParamPlugin SofaPlugin & SofaResponsePlugin 。我们先看一下 BodyParamPlugin， BodyParamPlugin 的getOrder 方法如下，这就是类似于声明一个前置处理器，根据我们之前的经验，先看 execute 方法。
public int getOrder() {
return PluginEnum.SOFA.getCode() - 1;
}
excute 主要是根据请求类型，进行参数封装，分为 application/json 和 x-www-form-urlencoded。
@Override
public Mono<Void> execute(final ServerWebExchange exchange, final SoulPluginChain chain) {
final ServerHttpRequest request = exchange.getRequest();
// 获取上下文
final SoulContext soulContext = exchange.getAttribute(Constants.CONTEXT);
if (Objects.nonNull(soulContext) && RpcTypeEnum.SOFA.getName().equals(soulContext.getRpcType())) {
MediaType mediaType = request.getHeaders().getContentType();
ServerRequest serverRequest = ServerRequest.create(exchange, messageReaders);
// 判断请求参数类型-》application/json
if (MediaType.APPLICATION_JSON.isCompatibleWith(mediaType)) {
return body(exchange, serverRequest, chain);
}
// x-www-form-urlencoded 类型
if (MediaType.APPLICATION_FORM_URLENCODED.isCompatibleWith(mediaType)) {
return formData(exchange, serverRequest, chain);
}
return query(exchange, serverRequest, chain);
}
return chain.execute(exchange);
}
body 就是将 serverRequest 中的body 内容放到交换区 exchange 中，然后执行下一个 plugin 即 sofaplugin
private Mono<Void> body(final ServerWebExchange exchange, final ServerRequest serverRequest, final SoulPluginChain chain) {
return serverRequest.bodyToMono(String.class)
.switchIfEmpty(Mono.defer(() -> Mono.just(""))) // 为空则使用空字符串
.flatMap(body -> {
exchange.getAttributes().put(Constants.SOFA_PARAMS, body); // 将body 塞入 sofa_param
// 执行以下一个插件 即 sofaplugin
return chain.execute(exchange);
});
}
sofaplugin 的 excute 上节已经解析过，即先匹配条件是否符合 然后执行插件的 doexecute 方法。我们看看 doExecute 方法,我们可以看到最后它调用的是 sofaProxyService 的 genericInvoker ， 嗯有点 dubbo 泛化调用的意思了。
@Override
protected Mono<Void> doExecute(final ServerWebExchange exchange, final SoulPluginChain chain, final SelectorData selector, final RuleData rule) {
// 取出参数
String body = exchange.getAttribute(Constants.SOFA_PARAMS);
// 取出上下文对象
SoulContext soulContext = exchange.getAttribute(Constants.CONTEXT);
assert soulContext != null;
MetaData metaData = exchange.getAttribute(Constants.META_DATA);
// 校验元数据
if (!checkMetaData(metaData)) {
assert metaData != null;
log.error(" path is :{}, meta data have error.... {}", soulContext.getPath(), metaData.toString());
exchange.getResponse().setStatusCode(HttpStatus.INTERNAL_SERVER_ERROR);
Object error = SoulResultWrap.error(SoulResultEnum.META_DATA_ERROR.getCode(), SoulResultEnum.META_DATA_ERROR.getMsg(), null);
return WebFluxResultUtils.result(exchange, error);
}
// 检测是否为空
if (StringUtils.isNoneBlank(metaData.getParameterTypes()) && StringUtils.isBlank(body)) {
exchange.getResponse().setStatusCode(HttpStatus.INTERNAL_SERVER_ERROR);
Object error = SoulResultWrap.error(SoulResultEnum.SOFA_HAVE_BODY_PARAM.getCode(), SoulResultEnum.SOFA_HAVE_BODY_PARAM.getMsg(), null);
return WebFluxResultUtils.result(exchange, error);
}
// 调用 sofaProxyService 获取返回结果
final Mono<Object> result = sofaProxyService.genericInvoker(body, metaData, exchange);
return result.then(chain.execute(exchange));
}
其主要代码如下，sofa 的调用和 dubbo 调用类似，就是通过泛化调用的方式进行调用，然后将返回结果放到交换区。
public Mono<Object> genericInvoker(final String body, final MetaData metaData, final ServerWebExchange exchange) throws SoulException {
// 构造 genericService
GenericService genericService = reference.refer();
Pair<String[], Object[]> pair;
// 构造参数
pair = sofaParamResolveService.buildParameter(body, metaData.getParameterTypes());
CompletableFuture<Object> future = new CompletableFuture<>();
RpcInvokeContext.getContext().setResponseCallback(new SofaResponseCallback<Object>() {
@Override
public void onAppResponse(final Object o, final String s, final RequestBase requestBase) {
// 通知future获取结果
future.complete(o);
}
});
// 真正调用服务
genericService.$genericInvoke(metaData.getMethodName(), pair.getLeft(), pair.getRight());
return Mono.fromFuture(future.thenApply(ret -> {
// 获取到真正结果
GenericObject genericObject = (GenericObject) ret;
// 将结果写入交换区
exchange.getAttributes().put(Constants.SOFA_RPC_RESULT, genericObject.getFields());
// 设置状态
exchange.getAttributes().put(Constants.CLIENT_RESPONSE_RESULT_TYPE, ResultEnum.SUCCESS.getName());
return ret;
})).onErrorMap(SoulException::new);
}
我们最后看一下 SofaResponsePlugin 插件，其主要是doexecute 方法
@Override
public Mono<Void> execute(final ServerWebExchange exchange, final SoulPluginChain chain) {
return chain.execute(exchange).then(Mono.defer(() -> {
final Object result = exchange.getAttribute(Constants.SOFA_RPC_RESULT); // 获取返回结果
if (Objects.isNull(result)) { // 结果为空则改为错误
Object error = SoulResultWrap.error(SoulResultEnum.SERVICE_RESULT_ERROR.getCode(), SoulResultEnum.SERVICE_RESULT_ERROR.getMsg(), null);
return WebFluxResultUtils.result(exchange, error);
}
Object success = SoulResultWrap.success(SoulResultEnum.SUCCESS.getCode(), SoulResultEnum.SUCCESS.getMsg(), JsonUtils.removeClass(result)); // 构造成功结果
return WebFluxResultUtils.result(exchange, success);//返回结果
}));
}
至此，整个请求的流程就走完了。
1.8.3.3 总结
在这节里我们学习了 soul 集成 sofaRpc 的流程，sofaRpc 的整个流程和 Dubbo 的非常像，稍微有区别是参数的构造这方面。
网友评论