mirror of
https://github.com/tiennm99/zfoo.git
synced 2026-08-05 16:25:54 +00:00
perf[module]: 以TcpServerTest为例子，从头梳理asyncAask的执行流程并添加注释
This commit is contained in:
jianan
@@ -24,6 +24,7 @@ public class ConsumerModule {
|
||||
|
||||
private ProtocolModule protocolModule;
|
||||
|
||||
// 负载均衡方式
|
||||
private String loadBalancer;
|
||||
|
||||
// 消费哪个provider
|
||||
|
||||
@@ -17,13 +17,20 @@ import com.zfoo.protocol.registration.ProtocolModule;
|
||||
import java.util.Objects;
|
||||
|
||||
/**
|
||||
*
|
||||
* @author jaysunxiao
|
||||
* @version 3.0
|
||||
*/
|
||||
public class ProviderModule {
|
||||
|
||||
/**
|
||||
* 模块id和模块名
|
||||
*/
|
||||
private ProtocolModule protocolModule;
|
||||
|
||||
/**
|
||||
* 提供者名字
|
||||
*/
|
||||
private String provider;
|
||||
|
||||
public ProviderModule(ProtocolModule protocolModule, String provider) {
|
||||
|
||||
@@ -42,9 +42,11 @@ public class RegisterVO {
|
||||
private static final String uuid = IdUtils.getUUID();
|
||||
|
||||
private String id;
|
||||
private ProviderConfig providerConfig;
|
||||
private ConsumerConfig consumerConfig;
|
||||
|
||||
// 服务提供者配置
|
||||
private ProviderConfig providerConfig;
|
||||
// 服务消费者配置
|
||||
private ConsumerConfig consumerConfig;
|
||||
|
||||
public static boolean providerHasConsumer(RegisterVO providerVO, RegisterVO consumerVO) {
|
||||
if (Objects.isNull(providerVO) || Objects.isNull(providerVO.providerConfig) || CollectionUtils.isEmpty(providerVO.providerConfig.getProviders())
|
||||
@@ -137,30 +139,39 @@ public class RegisterVO {
|
||||
@Override
|
||||
public String toString() {
|
||||
var builder = new StringBuilder();
|
||||
|
||||
// 模块模块名
|
||||
builder.append(id);
|
||||
|
||||
// 服务提供者相关配置信息
|
||||
if (Objects.nonNull(providerConfig)) {
|
||||
var providerAddress = providerConfig.getAddress();
|
||||
if (StringUtils.isBlank(providerAddress)) {
|
||||
throw new RuntimeException(StringUtils.format("providerConfig的address不能为空"));
|
||||
}
|
||||
builder.append(StringUtils.SPACE).append(StringUtils.VERTICAL_BAR).append(StringUtils.SPACE);
|
||||
// 服务提供者地址
|
||||
builder.append(providerAddress);
|
||||
|
||||
builder.append(StringUtils.SPACE).append(StringUtils.VERTICAL_BAR).append(StringUtils.SPACE);
|
||||
var providerModules = providerConfig.getProviders().stream()
|
||||
.map(it -> StringUtils.joinWith(StringUtils.HYPHEN, it.getProtocolModule().getId(), it.getProtocolModule().getName(), it.getProvider()))
|
||||
.collect(Collectors.toList());
|
||||
|
||||
// 服务提供者模块信息列表
|
||||
builder.append(StringUtils.format("provider:[{}]"
|
||||
, StringUtils.joinWith(StringUtils.COMMA + StringUtils.SPACE, providerModules.toArray())));
|
||||
}
|
||||
|
||||
// 服务消费者相关信息
|
||||
if (Objects.nonNull(consumerConfig)) {
|
||||
builder.append(StringUtils.SPACE).append(StringUtils.VERTICAL_BAR).append(StringUtils.SPACE);
|
||||
|
||||
var consumerModules = consumerConfig.getConsumers().stream()
|
||||
.map(it -> StringUtils.joinWith(StringUtils.HYPHEN, it.getProtocolModule().getId(), it.getProtocolModule().getName(), it.getLoadBalancer(), it.getConsumer()))
|
||||
.collect(Collectors.toList());
|
||||
|
||||
// 服务消费者模块信息列表
|
||||
builder.append(StringUtils.format("consumer:[{}]"
|
||||
, StringUtils.joinWith(StringUtils.COMMA + StringUtils.SPACE, consumerModules.toArray())));
|
||||
}
|
||||
|
||||
@@ -69,6 +69,13 @@ public class Router implements IRouter {
|
||||
private final FastThreadLocal<SignalAttachment> serverReceiveSignalAttachmentThreadLocal = new FastThreadLocal<>();
|
||||
|
||||
|
||||
/**
|
||||
* 在服务端收到数据后，会调用这个方法. 这个方法在BaseRouteHandler.java的channelRead中被调用
|
||||
*
|
||||
* @param session
|
||||
* @param packet
|
||||
* @param attachment
|
||||
*/
|
||||
@Override
|
||||
public void receive(Session session, IPacket packet, @Nullable IAttachment attachment) {
|
||||
if (packet.protocolId() == Heartbeat.PROTOCOL_ID) {
|
||||
@@ -90,11 +97,14 @@ public class Router implements IRouter {
|
||||
// 客户端收到服务器应答，客户端发送的时候isClient为true，服务器收到的时候将其设置为false
|
||||
var removedAttachment = (SignalAttachment) SignalBridge.removeSignalAttachment(signalAttachment);
|
||||
if (removedAttachment != null) {
|
||||
// 这里会让之前的CompletableFuture得到结果，从而像asyncAsk之类的回调到结果
|
||||
removedAttachment.getResponseFuture().complete(packet);
|
||||
} else {
|
||||
logger.error("client receives packet:[{}] and attachment:[{}] from server, but clientAttachmentMap has no attachment, perhaps timeout exception."
|
||||
, JsonUtils.object2String(packet), JsonUtils.object2String(attachment));
|
||||
}
|
||||
|
||||
// 注意：这个return，这样子，asyncAsk的结果就返回了。
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -137,7 +147,8 @@ public class Router implements IRouter {
|
||||
}
|
||||
}
|
||||
|
||||
// 正常发送消息的接收
|
||||
// 正常发送消息的接收,把客户端的业务请求包装下到路由策略指定的线程进行业务处理
|
||||
// 注意：像客户端以asyncAsk发送请求，在服务器处理完后返回结果，也是进入这个receive方法，但是attachment不为空，会提前return掉不会走到这
|
||||
TaskBus.submit(new PacketReceiverTask(session, packet, attachment));
|
||||
}
|
||||
|
||||
@@ -207,10 +218,23 @@ public class Router implements IRouter {
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* 注意：这个里面其实还是调用send发送的消息
|
||||
*
|
||||
* @param session
|
||||
* @param packet
|
||||
* @param answerClass
|
||||
* @param argument
|
||||
* @param <T>
|
||||
* @return
|
||||
*/
|
||||
@Override
|
||||
public <T extends IPacket> AsyncAnswer<T> asyncAsk(Session session, IPacket packet, @Nullable Class<T> answerClass, @Nullable Object argument) {
|
||||
var clientSignalAttachment = new SignalAttachment();
|
||||
// 因此第3个参数传null，会得到一个随机的值，在得到结果回调时，是随机的线程
|
||||
// 这个值用于返回时，在CompletableFuture中选择哪个线程执行，也就是回到哪个线程
|
||||
var executorConsistentHash = (argument == null) ? RandomUtils.randomInt() : HashUtils.fnvHash(argument);
|
||||
|
||||
clientSignalAttachment.setExecutorConsistentHash(executorConsistentHash);
|
||||
|
||||
// 服务器在同步或异步的消息处理中，又调用了同步或异步的方法，这时候threadReceiverAttachment不为空
|
||||
@@ -221,6 +245,7 @@ public class Router implements IRouter {
|
||||
asyncAnswer.setSignalAttachment(clientSignalAttachment);
|
||||
|
||||
clientSignalAttachment.getResponseFuture()
|
||||
// 因此超时的情况，返回的是null
|
||||
.completeOnTimeout(null, DEFAULT_TIMEOUT, TimeUnit.MILLISECONDS)
|
||||
.thenApply(answer -> {
|
||||
if (answer == null) {
|
||||
@@ -237,6 +262,7 @@ public class Router implements IRouter {
|
||||
return answer;
|
||||
})
|
||||
.whenCompleteAsync((answer, throwable) -> {
|
||||
// 注意：进入这个方法的时机是：在上面的receive方法中，由于是asyncAsk的消息，attachment不为空，会调用CompletableFuture的complete方法
|
||||
try {
|
||||
SignalBridge.removeSignalAttachment(clientSignalAttachment);
|
||||
|
||||
@@ -302,7 +328,7 @@ public class Router implements IRouter {
|
||||
}
|
||||
}
|
||||
|
||||
// 调用PacketReceiver
|
||||
// 调用PacketReceiver,进行真正的业务处理
|
||||
PacketBus.submit(session, packet, attachment);
|
||||
} catch (Exception e) {
|
||||
logger.error(StringUtils.format("e[uid:{}][sid:{}]未知exception异常", session.getAttribute(AttributeType.UID), session.getSid(), e.getMessage()), e);
|
||||
|
||||
@@ -46,6 +46,8 @@ public class AsyncAnswer<T extends IPacket> implements IAsyncAnswer<T> {
|
||||
@Override
|
||||
public void whenComplete(Consumer<T> consumer) {
|
||||
thenAccept(consumer);
|
||||
|
||||
// 这里其实会触发发送消息
|
||||
askCallback.run();
|
||||
}
|
||||
|
||||
|
||||
@@ -55,6 +55,7 @@ public class NetDefinitionParser implements BeanDefinitionParser {
|
||||
// 注册ConfigManager
|
||||
clazz = ConfigManager.class;
|
||||
builder = BeanDefinitionBuilder.rootBeanDefinition(clazz);
|
||||
// 把Spring容器中的NetConfig引用赋值给ConfigManager中的localConfig属性
|
||||
builder.addPropertyReference("localConfig", NetConfig.class.getCanonicalName());
|
||||
parserContext.getRegistry().registerBeanDefinition(clazz.getCanonicalName(), builder.getBeanDefinition());
|
||||
|
||||
@@ -74,6 +75,7 @@ public class NetDefinitionParser implements BeanDefinitionParser {
|
||||
parserContext.getRegistry().registerBeanDefinition(clazz.getCanonicalName(), builder.getBeanDefinition());
|
||||
|
||||
// 注册SessionManager
|
||||
// 里面的serverSessionMap 和 clientSessionMap 是根据自己是客户端还是服务器保存连接自己 和 自己连接 的网络节点信息
|
||||
clazz = SessionManager.class;
|
||||
builder = BeanDefinitionBuilder.rootBeanDefinition(clazz);
|
||||
parserContext.getRegistry().registerBeanDefinition(clazz.getCanonicalName(), builder.getBeanDefinition());
|
||||
|
||||
@@ -80,6 +80,7 @@ public final class TaskBus {
|
||||
* SignalAttachment：executorConsistentHash通过IRouter和IConsumer的argument参数指定
|
||||
*/
|
||||
public static void submit(PacketReceiverTask task) {
|
||||
// 里面会看到是：其中一致性hash是根据附加包记录的hashId进行选择哪个线程进行业务处理
|
||||
taskDispatch.getExecutor(task).execute(task);
|
||||
}
|
||||
|
||||
|
||||
@@ -38,6 +38,7 @@ public class ConsistentHashTaskDispatch extends AbstractTaskDispatch {
|
||||
return SessionIdTaskDispatch.getInstance().getExecutor(packetReceiverTask);
|
||||
}
|
||||
|
||||
// 可见最终是根据附加包的信息选择服务端由哪个线程执行这个业务
|
||||
return TaskBus.executor(attachment.executorConsistentHash());
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user