手游服务端框架之GM金手指的设计

玩过单机游戏的朋友，应该对金山游侠这个软件很熟悉把。当初我经常嫌刷怪升级非常辛苦，很多时候都是直接用金山游侠来修改游戏的经验或者等级内存，直接把角色调得很牛逼。

游戏开发也非常需要这些可以修改玩家数据的金手指。在游戏里，它有个更加专业的名称，叫ＧＭ（GameMaster）命令。

有了ＧＭ命令，我们就看好很方便让角色快速升级或者直接获取极品道具。当然，只要是数据，都可以有对应的ＧＭ命令，只要项目有需要。

下面，我们就来看一下ＧＭ系统的一种实现方式。

假设我们需要有一种指令，比如输入playerLv加一个数字表示要达到的等级，只要服务端受到这条指令，就直接将当前角色升到目标等级。不同的ＧＭ命令，指令的前缀和参数都是不同的，也就是说，每个指令都有自己固定的格式。在Java里，我们可以用正则表达式来定义这样的格式。

１．首先来看一些我们的ｇｍ命令抽象类，该类有几个作用，例如，定制具体的ｇｍ命令参数的格式，解析参数的方法，以及执行逻辑的方法。

import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import com.kingston.game.database.user.player.Player;
import com.kingston.game.gm.message.ResGmResultMessage;

/**
 * 抽象gm命令
 * @author kingston
 */
public abstract class AbstractGmCommand {

	/**
	 * 正则表达式模式
	 * @return
	 */
	public abstract String getPattern();

	/**
	 * 帮助文档
	 * @return
	 */
	public abstract String help();

	/**
	 * 是否匹配
	 * @param pattern
	 * @param content
	 * @return
	 */
	public boolean isMatch(Pattern pattern, Matcher matcher, String content) {
		return matcher.matches();
	}

	/**
	 * 返回正则表达式解析的一系列参数
	 * @param matcher
	 * @param message
	 * @return
	 */
	public List<String> params(Matcher matcher, String message) {
		List<String> params = new ArrayList<>();
		for (int i=1; i<matcher.groupCount()+1; i++) {
			params.add(matcher.group(i));
		}
		return params;
	}

	/**
	 * 执行逻辑
	 * @param player
	 * @param params
	 * @return
	 */
	public abstract ResGmResultMessage execute(Player player, List<String> params);

}

２．定义一个ｇｍ命令的管理工具，负责缓存所有的ｇｍ命令。当收到玩家的ｇｍ指令后，如果判断当前玩家的ＩＰ地址或者角色有执行的权限，那么再通过枚举的方式，找到能够处理请求的具体ｇｍ命令。从而执行对应的逻辑。

public class GmManager {

	private static volatile GmManager instance;

	private GmManager() {}

	/** 缓存ｇｍ指令的模式与对应的逻辑处理者 */
	private Map<Pattern, AbstractGmCommand> commands = new HashMap<>();

	private final String SCAN_PATH = "com.kingston.game.gm.command";

	public static GmManager getInstance() {
		if (instance == null) {
			synchronized(GmManager.class) {
				if (instance == null) {
					instance = new GmManager();
					instance.init();
				}
			}
		}
		return instance;
	}

	private void init() {
		Set<Class<?>> clazzs = ClassScanner.getClasses(SCAN_PATH, new ClassFilter() {
			@Override
			public boolean accept(Class<?> clazz) {
				return AbstractGmCommand.class.isAssignableFrom(clazz)
						&& !Modifier.isAbstract(clazz.getModifiers());
			}
		});

		for (Class<?> clazz:clazzs) {
			try{
				AbstractGmCommand command = (AbstractGmCommand) clazz.newInstance();
				String regex = command.getPattern();
				commands.put(Pattern.compile(regex), command);
			}catch(Exception e) {
				e.printStackTrace();
			}
		}

	}

	/**
	 * 处理gm入口
	 * @param playerId
	 * @param content
	 * @return
	 */
	public void receiveCommand(long playerId, String content) {
		Player player = PlayerManager.getInstance().get(playerId);
		//判断权限
		if (!hasExecPower(player)) {
			return;
		}
		for (Map.Entry<Pattern, AbstractGmCommand> entry:commands.entrySet()) {
			Pattern pattern = entry.getKey();
			AbstractGmCommand command = entry.getValue();

			Matcher matcher = pattern.matcher(content);
			if (command.isMatch(pattern, matcher, content)) {
				List<String> params = command.params(matcher, content);
				ResGmResultMessage result =  command.execute(player, params);
				MessagePusher.pushMessage(playerId, result);
				return;
			}
		}

		ResGmResultMessage failedMessage = ResGmResultMessage.buildFailResult("找不到对应的gm命令");
		MessagePusher.pushMessage(playerId, failedMessage);
	}

	/**
	 * 是否有执行权限
	 * @param player
	 * @return
	 */
	private boolean hasExecPower(Player player) {
		//这里根据具体业务进行拦截
		return true;
	}

	public static void main(String[] args) {
		Pattern pattern = Pattern.compile("^reloadConfig\\s+([a-zA-Z_]+)");
		String expr = "reloadConfig CofingPlayer_Level";
		Matcher matcher = pattern.matcher(expr);
		if (matcher.matches()) {
			List<String> params = new ArrayList<>();
			for (int i=1; i<matcher.groupCount()+1; i++) {
				params.add(matcher.group(i));
			}
			System.err.println(params);
		}

	}

}

３．举个例子，上面的修改玩家等级的ｇｍ命令。格式为：playerLv [level]，对应的正则表达式模式为

^playerLv\\s+(\\d+)

该命令的完整代码

/**
 * 修改玩家等级的gm
 * @author kingston
 */
public class GmPlayerLevelCommand extends AbstractGmCommand {

	@Override
	public String getPattern() {
		return "^playerLv\\s+(\\d+)";
	}

	@Override
	public String help() {
		return "修改玩家等级(playerLv [level])";
	}

	@Override
	public ResGmResultMessage execute(Player player, List<String> params) {
		int newLevel = Integer.parseInt(params.get(0));
		ConfigPlayerLevel configLevel = ConfigDatasPool.getInstance()
								.configPlayerLevelContainer.getConfigBy(newLevel);
		if (configLevel == null) {
			return ResGmResultMessage.buildFailResult("目标等级参数无效");
		}
		player.setLevel(newLevel);
		player.setUpdate();

		DbService.getInstance().add2Queue(player);
		return ResGmResultMessage.buildSuccResult("修改玩家等级成功");
	}

}

４．还有一个指令也很常见。比如游戏运行过程中，策划童鞋发现数值填错了（他们经常这么干）。我们不想重启服务但又希望内存里的策划配置能刷新。所以，我们需要有热更新配置的ｇｍ命令。回顾一下我们前一篇文章，关于配置数据库的设计。里面将策划的所有配置统一由ConfigDatasPool管理。如此，我们很容易通过反射的方式，动态实例化新的配置容器，读取新的配置并替换原有的container。

重载配置的ｇｍ指令格式为　

^reloadConfig [tableName]

对应的正则表达式为

^reloadConfig\\s+([a-zA-Z_]+)

完整代码如下：

/**
 * 修改配置表的gm
 * @author kingston
 */
public class GmReloadConfigCommand extends AbstractGmCommand {

	@Override
	public String getPattern() {
		return "^reloadConfig\\s+([a-zA-Z_]+)";
	}

	@Override
	public String help() {
		return "修改配置表(^reloadConfig [tableName])";
	}

	@Override
	public ResGmResultMessage execute(Player player, List<String> params) {
		String tableName = params.get(0);
		String containerName = tableName + "Container";
		try {
			Field field = ConfigDatasPool.class.getDeclaredField(containerName);
			Class<?> type = field.getType();
			Reloadable newContainer = (Reloadable) type.newInstance();
			newContainer.reload();
			field.set(ConfigDatasPool.getInstance(), newContainer);

			return ResGmResultMessage.buildSuccResult("重载["+tableName+"]表成功");
		} catch (Exception e) {
			e.printStackTrace();
		}
		return ResGmResultMessage.buildFailResult("找不到目标配置表");
	}

}

５．ＧＭ命令也属于玩家请求，那么也是需要对应的Controller，Message，RequestMapper。都是很简单的申明，这里就不贴代码了。

文章预告：下一篇主要介绍使用观察者模式实现事件驱动

该系列完整的代码请移步github ->>game_server