GraphQL.NET 授权工具集启动与配置教程

1. 项目的目录结构及介绍

graphql-dotnet/authorization 项目是一个为 GraphQL.NET 提供授权功能的工具集。项目的主要目录结构如下：

• src：存放项目的源代码。
  • GraphQL.Authorization：包含授权核心功能的类库。
• .github：包含GitHub特有的配置文件。
• .vscode：包含Visual Studio Code的配置文件。
• assets：可能包含一些项目相关的资源文件。
• codeql：包含用于代码质量分析和安全性检查的配置文件。
• LICENSE.md：项目的MIT许可证文件。
• README.md：项目的说明文件。
• 其他文件夹和文件可能包括项目构建、测试或文档相关的配置和脚本。

每个目录和文件的具体功能在项目中有详细的说明和配置。

2. 项目的启动文件介绍

项目的启动通常是通过NuGet包管理器来引入 GraphQL.Authorization 包到你的GraphQL.NET项目中。以下是一个基本的启动示例：

在你的依赖注入容器中注册授权类：

services.AddAuthorization();
services.AddGraphQL(...) // 添加GraphQL服务
    .AddAuthorization(); // 在GraphQL服务中注册授权

然后，在执行GraphQL查询时，需要通过 ExecutionOptions.User 提供一个 ClaimsPrincipal：

var result = await executor.ExecuteAsync(options => {
    options.User = user; // user 是一个ClaimsPrincipal实例
});

3. 项目的配置文件介绍

项目的配置主要通过代码来完成，而不是配置文件。以下是一些配置的示例：

• 注册授权策略：你需要在 AuthorizationSettings 中添加策略。

services.Configure<AuthorizationSettings>(settings =>
{
    settings.Policies.Add("AdminPolicy", ...); // 添加一个名为"AdminPolicy"的策略
});

• 应用授权策略：可以使用 AuthorizeWithPolicy 扩展方法或 AuthorizeAttribute 属性。

public class MyType : ObjectGraphType
{
    public MyType()
    {
        this.AuthorizeWithPolicy("AdminPolicy");
        Field<StringGraphType>("name")
            .AuthorizeWithPolicy("SomePolicy");
    }
}

或者使用 AuthorizeAttribute：

[Authorize("MyPolicy")]
public class MutationType
{
    [Authorize("AnotherPolicy")]
    public async Task<string> CreateSomething(MyInput input)
    {
        return await SomeMethodAsync(input);
    }

    [Authorize("SuperPolicy")]
    public string SomeProperty => Guid.NewGuid().ToString();
}

请注意，上述代码只是示例，具体配置需要根据你的项目需求来设置。项目的详细配置和用法可以在项目的 README.md 文件中找到。