sofa環境配置查看
sofa調用流程
GlobalPlugin -> BodyParamPlugin[org.dromara.soul.plugin.sofa.param] -> AbstractSoulPlugin -> SofaPlugin -> SofaResponsePlugin -> 結束
代碼解析
GlobalPlugin 全局插件，調用所有插件之前使用該插件封裝soulContext
@Override
// 全局插件，構造SoulContext
public Mono<Void> execute(final ServerWebExchange exchange, final SoulPluginChain chain) {
// 獲取請求信息
final ServerHttpRequest request = exchange.getRequest();
// 獲取頭信息
final HttpHeaders headers = request.getHeaders();
// 升級？
final String upgrade = headers.getFirst("Upgrade");
SoulContext soulContext;
// 升級不為空，或者websocket不等于升級
if (StringUtils.isBlank(upgrade) || !"websocket".equals(upgrade)) {
// 封裝元數據信息
soulContext = builder.build(exchange);
} else {
// 獲取請求參數
final MultiValueMap<String, String> queryParams = request.getQueryParams();
// 封裝參數進soulContext
soulContext = transformMap(queryParams);
}
exchange.getAttributes().put(Constants.CONTEXT, soulContext);
return chain.execute(exchange);
}
BodyParamPlugin，sofa插件參數解析
@Override
// sofa參數解析
public Mono<Void> execute(final ServerWebExchange exchange, final SoulPluginChain chain) {
// 獲取請求
final ServerHttpRequest request = exchange.getRequest();
// 獲取soulContext
final SoulContext soulContext = exchange.getAttribute(Constants.CONTEXT);
// soulContext不為空且是sofa代理的
if (Objects.nonNull(soulContext) && RpcTypeEnum.SOFA.getName().equals(soulContext.getRpcType())) {
// 獲取請求類型
MediaType mediaType = request.getHeaders().getContentType();
// 轉換請求
ServerRequest serverRequest = ServerRequest.create(exchange, messageReaders);
if (MediaType.APPLICATION_JSON.isCompatibleWith(mediaType)) {
// json請求方式參數封裝
return body(exchange, serverRequest, chain);
}
if (MediaType.APPLICATION_FORM_URLENCODED.isCompatibleWith(mediaType)) {
// 表單請求方式參數封裝
return formData(exchange, serverRequest, chain);
}
// get方式的直接解析封裝
return query(exchange, serverRequest, chain);
}
return chain.execute(exchange);
}
SofaPlugin，調用sofa主要插件
@Override
// sofa請求執行
protected Mono<Void> doExecute(final ServerWebExchange exchange, final SoulPluginChain chain, final SelectorData selector, final RuleData rule) {
// 獲取sofa處理好的參數
String body = exchange.getAttribute(Constants.SOFA_PARAMS);
// 獲取soulContext
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);
}
// 代理sofa執行
final Mono<Object> result = sofaProxyService.genericInvoker(body, metaData, exchange);
return result.then(chain.execute(exchange));
}
SofaProxyService，sofa服務調用執行主要服務
// sofa泛化調用
public Mono<Object> genericInvoker(final String body, final MetaData metaData, final ServerWebExchange exchange) throws SoulException {
// 根據元數據中的path獲取引用對象
ConsumerConfig<GenericService> reference = ApplicationConfigCache.getInstance().get(metaData.getPath());
// 如果引用對象沒有初始化的話則進行初始化
if (Objects.isNull(reference) || StringUtils.isEmpty(reference.getInterfaceId())) {
ApplicationConfigCache.getInstance().invalidate(metaData.getServiceName());
reference = ApplicationConfigCache.getInstance().initRef(metaData);
}
// 泛化服務調用對象
GenericService genericService = reference.refer();
// 參數
Pair<String[], Object[]> pair;
if (null == body || "".equals(body) || "{}".equals(body) || "null".equals(body)) {
// 參數為空處理
pair = new ImmutablePair<>(new String[]{}, new Object[]{});
} else {
// 根據body和參數類型構造請求參數
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.complete(o);
}
@Override
public void onAppException(final Throwable throwable, final String s, final RequestBase requestBase) {
future.completeExceptionally(throwable);
}
@Override
public void onSofaException(final SofaRpcException e, final String s, final RequestBase requestBase) {
future.completeExceptionally(e);
}
});
// 執行sofa請求
genericService.$genericInvoke(metaData.getMethodName(), pair.getLeft(), pair.getRight());
return Mono.fromFuture(future.thenApply(ret -> {
if (Objects.isNull(ret)) {
ret = Constants.SOFA_RPC_RESULT_EMPTY;
}
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
@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);
}));
}
