命令和命令过滤器

关键字: 命令, 命令过滤器

命令 (Command)

SuperSocket 中的命令设计出来是为了处理来自客户端的请求的, 它在业务逻辑处理之中起到了很重要的作用。

命令类必须实现下面的基本命令接口, 根据你的需要选择实现同步命令或异步命令:

// 同步命令
public interface ICommand<TAppSession, TPackageInfo>
    where TAppSession : IAppSession
{
    void Execute(TAppSession session, TPackageInfo package);
}

// 异步命令
public interface IAsyncCommand<TAppSession, TPackageInfo> : ICommand
    where TAppSession : IAppSession
{
    ValueTask ExecuteAsync(TAppSession session, TPackageInfo package), CancellationToken cancellationToken;
}

请求包的处理代码应被放置于方法 "Execute" 或 "ExecuteAsync"之内。每个命令都有自己的包含Name和Key的元数据。

Name: 人们可以直接理解的名字; Key: 用于匹配接收到的包的Key的对象;

我们可以通过给Command增加Attribute来定义它的元数据 (Name='ShowVoltage', Key=0x03):

[Command(Key = 0x03)]
public class ShowVoltage : IAsyncCommand<StringPackageInfo>
{
    public async ValueTask ExecuteAsync(IAppSession session, StringPackageInfo package, CancellationToken cancellationToken)
    {
        ...
    }
}

请求处理代码必须被放置于方法 "Execute" or "ExecuteAsync" 之中，并且属性 "Keys" 的值用于匹配接收到请求实例(packageInfo)的Key。当一个请求实例(packageInfo) 被收到时，SuperSocket 将会通过匹配请求实例(package)的Key和命令的Keys的方法来查找用于处理该请求的命令。

如果命令没有定义元数据的Attribute，它的Name 和 Key 将会默认为这个命令类的类名。

元数据中的Key的值是用于匹配接收到的包请求的。当一个包被接收到，SuperSocket会去通过包的Key去寻找拥有相同Key的命令，找到的命令将会用于处理这个包。

但是，有个前提条件是包的类型必须实现接口 IKeyedPackageInfo (TKey 可以是任意元数据类型如 int，string，short 或 byte)，例如 StringPackageInfo：

public class StringPackageInfo : IKeyedPackageInfo<string>

举个例子, 如果你收到如下请求(package):

Key: "ADD"
Body: "1 2"

于是 SuperSocket 将会寻找Key属性为"ADD"的命令。如果有个命令定义如下:

public class ADD : IAsyncCommand<StringPackageInfo>
{
    public async ValueTask ExecuteAsync(IAppSession session, StringPackageInfo package, CancellationToken cancellationToken)
    {
        var result = package.Parameters
            .Select(p => int.Parse(p))
            .Sum();

        await session.SendAsync(Encoding.UTF8.GetBytes(result.ToString() + "\r\n"));
    }
}

如果你注册了此命令，SuperSocket就会找到该命令。

注册命令

hostBuilder.UseCommand((commandOptions) =>
{
    // 一个一个的注册命令
    commandOptions.AddCommand<ADD>();
    //commandOptions.AddCommand<MULT>();
    //commandOptions.AddCommand<SUB>();

    // 注册程序集重的所有命令
    //commandOptions.AddCommandAssembly(typeof(SUB).GetTypeInfo().Assembly);
}

命令过滤器

SuperSocket中的命令过滤器的作用类似于ASP.NET MVC中的Action Filter。你可以用它来拦截命令的执行。命令过滤器被在命令运行的前后被调用。

同步命令过滤器:

public class HelloCommandFilterAttribute : CommandFilterAttribute
{
    public override void OnCommandExecuted(CommandExecutingContext commandContext)
    {
        Console.WriteLine("Hello");
    }

    public override bool OnCommandExecuting(CommandExecutingContext commandContext)
    {
        Console.WriteLine("Bye bye");
        return true;
    }
}

异步命令过滤器:

public class AsyncHelloCommandFilterAttribute  : AsyncCommandFilterAttribute
{
    public override async ValueTask OnCommandExecutedAsync(CommandExecutingContext commandContext)
    {
        Console.WriteLine("Hello");
        await Task.Delay(0);
    }

    public override async ValueTask<bool> OnCommandExecutingAsync(CommandExecutingContext commandContext)
    {
        Console.WriteLine("Bye bye");
        await Task.Delay(0);
        return true;
    }
}

在命令上应用命令过滤器:

[AsyncHelloCommandFilter]
[HelloCommandFilter]
class COUNTDOWN : IAsyncCommand<StringPackageInfo>
{
    //...
}

全局命令过滤器

全局命令过滤器就是被应用在所有命令之上的命令过滤器。

注册全局命令过滤器:

hostBuilder.UseCommand((commandOptions) =>
{
    commandOptions.AddCommand<COUNT>();
    commandOptions.AddCommand<COUNTDOWN>();

    // register global command filter
    commandOptions.AddGlobalCommandFilter<HitCountCommandFilterAttribute>();
}

通过配置文件注册命令

你可以吧命令程序集添加到配置文件的节点 "commands/assemblies" 下。与此同时，请确保此命令程序集被复制到的程序的运行目录。

这是配置文件示例:

{
    "serverOptions": {
        "name": "GameMsgServer",
        "listeners": [
            {
                "ip": "Any",
                "port": "2020"
            },
            {
                "ip": "192.168.3.1",
                "port": "2020"
            }
        ],
        "commands": {
            "assemblies": [
                {
                    "name": "CommandAssemblyName"
                }
            ]
        }
    }
}

除此之外，你可能还需要干另外一件事情。因为 .NET Core 应用程序反射时默认只在此程序的依赖树（*.deps.json）里寻找程序集。所以你的命令程序集如果没有被加为你的主程序的依赖，它可能不会被找到。解决这个问题，你需要在你的主程序根目录添加一个运行时配置文件 "runtimeconfig.json"。

runtimeconfig.json

{
    "runtimeOptions": {
        "Microsoft.NETCore.DotNetHostPolicy.SetAppPaths" : true            
    }
}