[Soul 源码之旅] 1.8 Soul插件初体验 （Sofa ）

SOFARPC 是蚂蚁金服开源的一款基于 Java 实现的 RPC 服务框架，为应用之间提供远程服务调用能力，具有高可伸缩性，高容错性，目前蚂蚁金服所有的业务的相互间的 RPC 调用都是采用 SOFARPC。SOFARPC 为用户提供了负载均衡，流量转发，链路追踪，链路数据透传，故障剔除等功能。

1.8.3.1SOFARPC 配置流程

首先我们在Client 端需要加入 sofaRpc 和 soul-sofa 的依赖。

       
           com.alipay.sofa
           rpc-sofa-boot-starter
           ${rpc-sofa-boot-starter.version}
       
       
           org.dromara
           soul-spring-boot-starter-client-sofa
           ${soul.version}
       

我们使用 zk 作为 sofaRpc 的注册中心，所以需要做如下配置。

com:
 alipay:
   sofa:
     rpc:
       registry-address: zookeeper://127.0.0.1:2181
       bolt-port: 8888

sofaRpc 需要定义一个 xml 文件类似于 dubbo.xml 配置暴露的服务。

最后我们在各个 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 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 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 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