FSharp.Data.GraphQL.Server.Relay 2.2.1

FSharp.Data.GraphQL

F# 实现 Facebook GraphQL 查询语言规范。

安装项目模板

输入以下命令以安装创建 web 应用程序的模板

从 GitHub： dotnet new -i "FSharp.Data.GraphQL::2.0.0-ci-*" --nuget-source "https://nuget.pkg.github.com/fsprojects/index.json"

从 NuGet： dotnet new -i "FSharp.Data.GraphQL::2.0.0"

快速入门

open FSharp.Data.GraphQL
open FSharp.Data.GraphQL.Types

type Person =
    { FirstName: string
      LastName: string }

// Define GraphQL type 
let PersonType = Define.Object(
    name = "Person",
    fields = [
        // Property resolver will be auto-generated
        Define.AutoField("firstName", StringType)
        // Asynchronous explicit member resolver
        Define.AsyncField("lastName", StringType, resolve = fun context person -> async { return person.LastName })
    ])

// Include person as a root query of a schema
let schema = Schema(query = PersonType)
// Create an Exector for the schema
let executor = Executor(schema)

// Retrieve person data
let johnSnow = { FirstName = "John"; LastName = "Snow" }
let reply = executor.AsyncExecute(Parser.parse "{ firstName, lastName }", johnSnow) |> Async.RunSynchronously
// #> { data: { "firstName", "John", "lastName", "Snow" } } 

它是类型安全的。无效字段或无效返回类型等重要问题将在编译时进行检查。

ASP.NET / Giraffe / WebSocket (用于 GraphQL 订阅) 使用

见 AspNetCore/README.md

演示

GraphiQL 客户端

转到 GraphiQL 样例目录。要运行它，以调试设置构建和运行 Star Wars API 样例项目。这将创建一个与 GraphQL 规范兼容的 Giraffe 服务器，在端口 8086 上运行。然后，您需要运行 node.js 的 graphiql 前端。要做到这一点，运行 npm i 以获取所有依赖项，然后运行 npm run serve | npm run dev - 这将在 http://localhost:8090/ 上启动一个 webpack 服务器。访问此链接，应该会出现 GraphiQL 编辑器。您可以尝试以下查询进行测试：

{
  hero(id:"1000") {
    id,
    name,
    appearsIn,
    homePlanet,
    friends {
      ... on Human {
        name
      }
      ... on Droid {
        name
      }
    }
  }
}

Relay.js 快速入门包

第二个示例是一个基于F#的流行Relay Starter Kit版本 - 这是一个使用React.js + Relay和Relay兼容服务端API的示例应用。[了解更多](https://github.com/bazingatechnologies/FSharp.Data.GraphQL/tree/dev/samples/relay-starter-kit)

要运行它，使用调试设置构建FSharp.Data.GraphQL和FSharp.Data.GraphQL.Relay项目。然后通过在你的FSI中运行server.fsx脚本启动服务器，这将在一个8083端口的Relay兼容F#服务器上启动。随后，通过获取所有依赖（npm i）并运行它（npm run serve | npm run dev）来构建node.js前端 - 这将启动使用Relay管理应用状态的React应用的webpack服务器。您可以在[http://localhost:8083/](http://localhost:8083/)中访问它。

要更新客户端schema，访问[http://localhost:8083/](http://localhost:8083/)并将响应（即当前F#服务器的 introspection查询结果）复制粘贴到data/schema.json中。

流功能

stream指令现在具有额外的功能，比如通过间隔和/或批次大小进行批处理（缓冲）。要使其生效，必须在SchemaConfig.Directives列表中放置一个自定义的流指令，该指令包含两个可选参数interval和preferredBatchSize。

let customStreamDirective =
    let args = [|
        Define.Input(
            "interval",
            Nullable IntType,
            defaultValue = Some 2000,
            description = "An optional argument used to buffer stream results. ")
        Define.Input(
            "preferredBatchSize",
            Nullable IntType,
            defaultValue = None,
            description = "An optional argument used to buffer stream results. ") |]
    { StreamDirective with Args = args }
let schemaConfig =
    { SchemaConfig.Default with
        Directives = [
            IncludeDirective
            SkipDirective
            DeferDirective
            customStreamDirective
            LiveDirective ] }

此样板代码可以很容易地通过内置实现进行缩减。

let streamOptions =
    { Interval = Some 2000; PreferredBatchSize = None }
let schemaConfig =
    SchemaConfig.DefaultWithBufferedStream(streamOptions)

实时查询

live指令现在由服务器组件支持。要支持实时查询，需要将每个类型每个字段的配置为实时字段。这可以通过使用ILiveFieldSubscription和ILiveQuerySubscriptionProvider来完成，这些可以在SchemaConfig中进行配置。

type ILiveFieldSubscription =
    interface
        abstract member Identity : obj -> obj
        abstract member TypeName : string
        abstract member FieldName : string
    end

and ILiveFieldSubscription<'Object, 'Identity> =
    interface
        inherit ILiveFieldSubscription
        abstract member Identity : 'Object -> 'Identity
    end

and ILiveFieldSubscriptionProvider =
    interface
        abstract member HasSubscribers : string -> string -> bool
        abstract member IsRegistered : string -> string -> bool
        abstract member AsyncRegister : ILiveFieldSubscription -> Async<unit>
        abstract member TryFind : string -> string -> ILiveFieldSubscription option
        abstract member Add : obj -> string -> string -> IObservable<obj>
        abstract member AsyncPublish<'T> : string -> string -> 'T -> Async<unit>
    end

要将字段设置为实时字段，请调用Register扩展方法。每个订阅都必须知道对象标识符，因此必须在ILiveFieldSubscription的Identity函数上进行配置。同时，Type的名称和ObjectDef内的字段名称也需要传递。

let schemaConfig = SchemaConfig.Default
let schema = Schema(root, config = schemaConfig)
let subscription =
    { Identity = fun (x : Human) -> x.Id
      TypeName = "Hero"
      FieldName = "name" }

schemaConfig.LiveFieldSubscriptionProvider.Register subscription

有了这个，英雄字段的名称现在可以通过使用live指令实时更新，每当它被查询时都会通知客户端。要向订阅者推送更新，只需调用Publish方法，并传递类型名称、字段名称和更新后的对象。

let updatedHero = { hero with Name = "Han Solo - Test" }
schemaConfig.LiveFieldSubscriptionProvider.Publish "Hero" "name" updatedHero

客户端Provider

我们的客户端库现在有一个全新的类型提供者。要开始使用它，首先需要访问您试图连接的服务器的introspection schema。这可以通过以下两种方式之一完成：

1. 提供所需GraphQL服务器的URL（无需任何自定义HTTP头）。提供者将访问服务器，发送Introspection Query，并使用该schema提供用于发出查询的类型。

type MyProvider = GraphQLProvider<"http://some.graphqlserver.development.org">

2. 提供用于提供者的introspection json文件。不过要注意的是，introspection json应该包含提供者需要的所有字段。您可以通过在所需服务器上运行我们的标准introspection查询并将其保存到使用提供者的同一路径的文件中，以获取正确的字段。

type MyProvider = GraphQLProvider<"swapi_schema.json">

从现在开始，您可以开始运行查询和变异。

let operation = 
    MyProvider.Operation<"""query q {
      hero (id: "1001") {
        name
        appearsIn
        homePlanet
        friends {
          ... on Human {
            name
            homePlanet
          }
          ... on Droid {
            name
            primaryFunction
          }
        }
      }
    }""">()

// This is a instance of GraphQLProviderRuntimeContext.
// You can use it to provider a runtime URL to access your server,
// and optionally additional HTTP headers (auth headers, for example).
// If you use a local introspection file to parse the schema,
// The runtime context is mandatory.
let runtimeContext =
  { ServerUrl = "http://some.graphqlserver.production.org"
    CustomHttpHeaders = None }

let result = operation.Run(runtimeContext)

// Query result objects have pretty-printing and structural equality.
printfn "Data: %A\n" result.Data
printfn "Errors: %A\n" result.Errors
printfn "Custom data: %A\n" result.CustomData

// Response from the server:
// Data: Some
//   {Hero = Some
//   {Name = Some "Darth Vader";
// AppearsIn = [|NewHope; Empire; Jedi|];
// HomePlanet = Some "Tatooine";
// Friends = [|Some {Name = Some "Wilhuff Tarkin";
// HomePlanet = <null>;}|];};}

// Errors: <null>

// Custom data: map [("documentId", 1221427401)]

有关如何使用客户端提供者的更多信息，请参阅示例文件夹。

中间件

您可以在Executor<'Root>对象之上创建和使用中间件。

使用Executor进行查询执行过程涉及三个阶段：

• schema编译阶段：这个阶段发生在Executor<'Root>类实例化时。在这个阶段，使用类型Schema map构建字段执行map，该map包含所有字段定义及其字段解析函数。这个映射在后续的计划和执行阶段中用来检索查询的字段值。

• 操作规划阶段:该阶段发生在执行没有执行计划的查询之前。该阶段负责分析查询生成的AST文档，并构建执行计划。

• 操作执行阶段:该阶段是执行查询的阶段。它需要一个执行计划，因此通常在操作规划阶段之后发生。

所有阶段都将所需数据封装在一个上下文对象中，以执行阶段工作。它们通过函数在内部表示

let internal compileSchema (ctx : SchemaCompileContext) : unit =
  // ...

let internal planOperation (ctx: PlanningContext) : ExecutionPlan =
  // ...

let internal executeOperation (ctx : ExecutionContext) : AsyncVal<GQLResponse> =
  // ...

因此，在编译模式阶段，在SchemaCompileContext对象内部修改模式和生成执行映射。在操作规划阶段，使用PlanningContext对象的值生成执行计划，最后，将此计划与其他值一起传递给ExecutionContext对象，该对象最终将其用于执行查询并生成GQLResponse。

因此，可以使用中间件拦截每个阶段并根据需要自定义它们。每个中间件都必须作为具有特定签名的函数实现，并包裹在IExecutorMiddleware接口中

type SchemaCompileMiddleware =
    SchemaCompileContext -> (SchemaCompileContext -> unit) -> unit

type OperationPlanningMiddleware =
    PlanningContext -> (PlanningContext -> ExecutionPlan) -> ExecutionPlan

type OperationExecutionMiddleware =
    ExecutionContext -> (ExecutionContext -> AsyncVal<GQLResponse>) -> AsyncVal<GQLResponse>

type IExecutorMiddleware =
    abstract CompileSchema : SchemaCompileMiddleware option
    abstract PlanOperation : OperationPlanningMiddleware option
    abstract ExecuteOperationAsync : OperationExecutionMiddleware option

可选地，为了易于实现，可以用来派生的具体类，它仅接受在构造函数中的可选子中间件函数

type ExecutorMiddleware(?compile, ?plan, ?execute) =
    interface IExecutorMiddleware with
        member _.CompileSchema = compile
        member _.PlanOperation = plan
        member _.ExecuteOperationAsync = execute

每个中间件函数都像是一个拦截函数，有两个参数：阶段的上下文、下一个中间件的函数（或实际的阶段本身，他是最后一个运行的），以及返回值。这些函数可以作为参数传递给Executor<'Root>对象的构造函数

let middleware = [ ExecutorMiddleware(compileFn, planningFn, executionFn) ]
let executor = Executor(schema, middleware)

一个实际中间件的简单例子可以是测量规划查询所需时间的一个中间件。其结果作为规划上下文的Metadata部分返回。Metadata对象是Map<string, obj>实现，作为一个信息包传递给每个阶段，直到在GQLResponse对象中返回。您可以使用它通过中间件传递自定义信息

let planningMiddleware (ctx : PlanningContext) (next : PlanningContext -> ExecutionPlan) =
    let watch = Stopwatch()
    watch.Start()
    let result = next ctx
    watch.Stop()
    let metadata = result.Metadata.Add("planningTime", watch.ElapsedMilliseconds)
    { result with Metadata = metadata }

内置中间件

在FSharp.Data.GraphQL.Server.Middleware包中有一些内置的中间件

QueryWeightMiddleware

此中间件 可以用于对模式中的字段施加权重。现在这些加权字段可以用于保护服务器免受可能导致DDoS攻击的复杂查询的侵害。

定义字段时，我们使用扩展方法WithQueryWeight对该字段施加权重

let resolveFn (h : Human) =
  h.Friends |> List.map getCharacter |> List.toSeq

let field =
  Define.Field("friends", ListOf (Nullable CharacterType),
    resolve = resolveFn).WithQueryWeight(0.5)

然后我们定义Executor的阈值中间件。如果我们执行一个递归请求 "朋友的朋友" 的查询，Executor将仅接受嵌套4次，在此之前查询将超过2.0的权重阈值。

let middleware = [ Define.QueryWeightMiddleware(2.0) ]

ObjectListFilterMiddleware

此中间件可以用于自动生成对模式中的对象列表字段进行过滤。此过滤器可以作为查询中的参数传递，并在字段解析函数的ResolveFieldContext参数中恢复。

例如，我们可以创建一个用于过滤Human对象列表字段的中间件，这些字段类型为Character option

let middleware = [ Define.ObjectListFilterMiddleware<Human, Character option>() ]

过滤器参数是一个对象，通过字段上的filter参数中的JSON定义进行映射。一个简单的例子是过滤以A开头的英雄的朋友

query TestQuery {
    hero(id:"1000") {
        id
        name
        appearsIn
        homePlanet
        friends (filter : { name_starts_with: "A" }) {
            id
            name
        }
    }
}

此过滤器由中间件在ObjectListFilter定义中映射

type FieldFilter<'Val> =
    { FieldName : string
      Value : 'Val }

type ObjectListFilter =
    | And of ObjectListFilter * ObjectListFilter
    | Or of ObjectListFilter * ObjectListFilter
    | Not of ObjectListFilter
    | Equals of FieldFilter<System.IComparable>
    | GreaterThan of FieldFilter<System.IComparable>
    | LessThan of FieldFilter<System.IComparable>
    | StartsWith of FieldFilter<string>
    | EndsWith of FieldFilter<string>
    | Contains of FieldFilter<string>
    | FilterField of FieldFilter<ObjectListFilter>

查询中恢复的过滤器值可用于字段解析函数的ResolveFieldContext中。为了轻松访问它，您可以使用扩展方法Filter，它返回一个ObjectListFilter option（如果没有对象实现具有中间件通用定义的列表，或者用户没有提供过滤器输入，则它没有值）。

Define.Field("friends", ListOf (Nullable CharacterType),
    resolve = fun ctx (d : Droid) -> 
        ctx.Filter |> printfn "Droid friends filter: %A"
        d.Friends |> List.map getCharacter |> List.toSeq)

通过从字段解析上下文中检索此过滤器，可以使用客户端代码自定义针对数据库执行的查询，例如，并扩展您的GraphQL API功能。

LiveQueryMiddleware

此中间件可以用作快速允许您的架构字段通过live指令进行查询，假设所有这些字段都有一个可以由函数IdentityNameResolver发现的标识属性名。

/// A function that resolves an identity name for a schema object, based on a object definition of it.
type IdentityNameResolver = ObjectDef -> string

例如，如果我们的所有架构对象都有一个名为Id的标识字段，我们可以这样使用我们的中间件：

let schema = Schema(query = queryType)

let middleware = [ Define.LiveQueryMiddleware(fun _ -> "Id") ]

let executor = Executor(schema, middleware)

IdentityNameResolver是可选的。如果没有提供解析函数，则使用此默认实现。此外，通过Publish的ILiveFieldSubscriptionProvider进行订阅者通知，如上所述。

使用扩展构建自己的中间件

您可以使用FSharp.Data.GraphQL.Shared包提供的扩展方法来帮助构建自己的中间件。在创建中间件时，通常需要修改架构定义以向用户代码定义的架构添加功能。"ObjectListFilter"中间件是一个示例，其中所有实现列表的特定类型的字段都需要修改，通过接受名为filter的参数。

由于字段定义默认为不可变，因此有时生成具有改进功能的副本是一件很费力的工作。这正是扩展方法可以帮助的地方：例如，如果在架构编译阶段需要向已定义的字段添加一个参数，可以使用FieldDef< 'Val>接口的WithArgs方法。

let field : FieldDef<'Val> = // Search for field inside ISchema
let arg : Define.Input("id", StringType)
let fieldWithArg = field.WithArgs([ arg ])

要查看用于扩展定义的完整列表，您可以查看包含在FSharp.Data.GraphQL.Shared包中的TypeSystemExtensions模块。