-
Notifications
You must be signed in to change notification settings - Fork 218
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
71 changed files
with
1,840 additions
and
325 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
221 changes: 221 additions & 0 deletions
221
common/common-core/src/main/java/com/iohao/game/action/skeleton/kit/RangeBroadcast.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| /* | ||
| * ioGame | ||
| * Copyright (C) 2021 - present 渔民小镇 （[email protected]、[email protected]） . All Rights Reserved. | ||
| * # iohao.com . 渔民小镇 | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 of the | ||
| * License, or (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| */ | ||
| package com.iohao.game.action.skeleton.kit; | ||
|
|
||
| import com.iohao.game.action.skeleton.core.BarMessageKit; | ||
| import com.iohao.game.action.skeleton.core.CmdInfo; | ||
| import com.iohao.game.action.skeleton.core.commumication.CommunicationAggregationContext; | ||
| import com.iohao.game.action.skeleton.core.flow.FlowContext; | ||
| import com.iohao.game.action.skeleton.core.flow.attr.FlowAttr; | ||
| import com.iohao.game.action.skeleton.protocol.ResponseMessage; | ||
| import com.iohao.game.common.kit.CollKit; | ||
| import lombok.AccessLevel; | ||
| import lombok.experimental.Accessors; | ||
| import lombok.experimental.FieldDefaults; | ||
| import org.jctools.maps.NonBlockingHashSet; | ||
|
|
||
| import java.util.Collection; | ||
| import java.util.Objects; | ||
| import java.util.Set; | ||
|
|
||
| /** | ||
| * 范围内的广播，这个范围指的是，指定某些用户进行广播。 | ||
| * <pre> | ||
| * 在执行广播前，开发者可以自定义业务逻辑，如 | ||
| * - 添加一些需要广播的用户 | ||
| * - 删除一些不需要接收广播的用户 | ||
| * - 可通过重写 logic、trick 方法来做一些额外扩展 | ||
| * </pre> | ||
| * for example | ||
| * <pre>{@code | ||
| * // example - 1 | ||
| * new RangeBroadcast(flowContext) | ||
| * // 需要广播的数据 | ||
| * .setResponseMessage(responseMessage) | ||
| * // 添加需要接收广播的用户 | ||
| * .addUserId(1) | ||
| * .addUserId(2) | ||
| * .addUserId(List.of(3L, 4L, 5L)) | ||
| * // 排除一些用户，被排除的用户将不会接收到广播 | ||
| * .removeUserId(1) | ||
| * // 执行广播 | ||
| * .execute(); | ||
| * | ||
| * // example - 2 | ||
| * new RangeBroadcast(flowContext) | ||
| * // 需要广播的数据 | ||
| * .setResponseMessage(cmdInfo, playerReady) | ||
| * // // 添加需要接收广播的用户 | ||
| * .addUserId(1) | ||
| * // 执行广播 | ||
| * .execute(); | ||
| * } | ||
| * </pre> | ||
| * | ||
| * @author 渔民小镇 | ||
| * @date 2024-04-23 | ||
| */ | ||
| @Accessors(chain = true) | ||
| @FieldDefaults(level = AccessLevel.PRIVATE) | ||
| public class RangeBroadcast { | ||
| final CommunicationAggregationContext aggregationContext; | ||
| /** 需要推送的 userId 列表 */ | ||
| final Set<Long> userIds = new NonBlockingHashSet<>(); | ||
| /** 响应数据 */ | ||
| ResponseMessage responseMessage; | ||
| /** 是否执行发送领域事件操作: true 执行推送操作 */ | ||
| boolean doSend = true; | ||
|
|
||
| public RangeBroadcast(CommunicationAggregationContext aggregationContext) { | ||
| Objects.requireNonNull(aggregationContext); | ||
| this.aggregationContext = aggregationContext; | ||
| } | ||
|
|
||
| public RangeBroadcast(FlowContext flowContext) { | ||
| this(flowContext.option(FlowAttr.aggregationContext)); | ||
| } | ||
|
|
||
| /** | ||
| * 响应消息到远程, 此方法是同步推送 | ||
| * <pre> | ||
| * 模板方法模式： | ||
| * 在一个方法中定义一个算法的骨架，而将一些步骤延迟到子类中。 | ||
| * 模板方法使得子类可以在不改变算法结构的情况下，重新定义算法中的某些步骤。 | ||
| * | ||
| * 要点： | ||
| * - “模板方法”定义了算法的步骤，把这些步骤的实现延迟到子类。 | ||
| * - 模板方法模式为我们提供了一种代码复用的重要技巧。 | ||
| * - 模板方法的抽象类可以定义具体方法、抽象方法和钩子。 | ||
| * - 抽象方法由子类实现。 | ||
| * - 钩子是一种方法，它在抽象类中不做事，或者只做默认的事情，子类可以选择要不要去覆盖它。 | ||
| * - 为了防止子类改变模板方法中的算法，可以将模板方法声明为final。 | ||
| * - 好莱坞原则告诉我们，将决策权放在高层模块中，以便决定如何以及何时调用低层模块。 | ||
| * - 你将在真实世界代码中看到模板方法模式的许多变体，不要期待它们全都是一眼就可以被你一眼认出的。 | ||
| * - 策略模式和模板方法模式都封装算法，一个用组合，一个用继承。 | ||
| * - 工厂方法是模板方法的一种特殊版本。 | ||
| * </pre> | ||
| */ | ||
| public final void execute() { | ||
| // 子类可根据需要来构建响应内容 | ||
| this.logic(); | ||
|
|
||
| // 钩子方法，see disableSend() | ||
| if (!this.doSend) { | ||
| return; | ||
| } | ||
|
|
||
| // 在将数据推送前调用的钩子方法 | ||
| this.trick(); | ||
|
|
||
| Objects.requireNonNull(this.responseMessage); | ||
|
|
||
| if (CollKit.isEmpty(this.userIds)) { | ||
| throw new RuntimeException("没有添加消息推送人 " + this.getClass()); | ||
| } | ||
|
|
||
| // 推送响应 （广播消息）给指定的用户列表 | ||
| this.aggregationContext.broadcast(this.responseMessage, this.userIds); | ||
| } | ||
|
|
||
| /** | ||
| * 在将数据推送到调用方之前，触发的方法 | ||
| * <pre> | ||
| * 可以做一些逻辑，在逻辑中可以决定是否执行推送 | ||
| * {@code | ||
| * // 不执行推送数据的操作 | ||
| * this.disableSend() | ||
| * } | ||
| * </pre> | ||
| */ | ||
| protected void logic() { | ||
| } | ||
|
|
||
| /** | ||
| * 小把戏 (钩子方法). 子类可以做些其他的事情 | ||
| * <pre> | ||
| * 在将数据推送到调用方之前，触发的方法 | ||
| * </pre> | ||
| */ | ||
| protected void trick() { | ||
| } | ||
|
|
||
| public RangeBroadcast setResponseMessage(ResponseMessage responseMessage) { | ||
| this.responseMessage = responseMessage; | ||
| return this; | ||
| } | ||
|
|
||
| public RangeBroadcast setResponseMessage(CmdInfo cmdInfo, Object bizData) { | ||
| var responseMessage = BarMessageKit.createResponseMessage(cmdInfo, bizData); | ||
| return this.setResponseMessage(responseMessage); | ||
| } | ||
|
|
||
| /** | ||
| * 接收广播的用户 | ||
| * | ||
| * @param userIds userIds | ||
| * @return me | ||
| */ | ||
| public RangeBroadcast addUserId(Collection<Long> userIds) { | ||
| this.userIds.addAll(userIds); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * 接收广播的用户 | ||
| * | ||
| * @param userId userId | ||
| * @return me | ||
| */ | ||
| public RangeBroadcast addUserId(long userId) { | ||
| this.userIds.add(userId); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * 添加接收广播的用户，顺带排除一个不需要接收广播的用户 | ||
| * | ||
| * @param userIds 接收广播的 userIds | ||
| * @param excludeUserId 需要排除的 userId | ||
| * @return me | ||
| */ | ||
| public RangeBroadcast addUserId(Collection<Long> userIds, long excludeUserId) { | ||
| return this.addUserId(userIds).removeUserId(excludeUserId); | ||
| } | ||
|
|
||
| /** | ||
| * 排除 userId | ||
| * | ||
| * @param excludeUserId 需要排除的 userId | ||
| * @return me | ||
| */ | ||
| public RangeBroadcast removeUserId(long excludeUserId) { | ||
| if (excludeUserId > 0) { | ||
| this.userIds.remove(excludeUserId); | ||
| } | ||
|
|
||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * 不执行推送数据的操作 | ||
| */ | ||
| protected void disableSend() { | ||
| this.doSend = false; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
80 changes: 0 additions & 80 deletions
80
common/common-core/src/test/java/com/iohao/game/action/skeleton/list/TheListTest.java
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.