Gradle 插件配置

Apollo Kotlin的默认配置适用于大多数用例。如果您是初学者，请参阅入门指南以了解默认Gradle配置的概述。

本文介绍了使用Gradle时的高级用例的配置选项。

使用多个GraphQL API

Apollo Kotlin支持与具有不同模式的不同GraphQL端点进行通信。要这样做，创建多个服务如下：

1
apollo {
2
  service("starwars") {
3
    srcDir("src/main/graphql/starwars")
4
    packageName.set("com.starwars")
5
  }
6
  service("githunt") {
7
    srcDir("src/main/graphql/githunt")
8
    packageName.set("com.githunt")
9
  }
10
}

指定模式位置

使用schemaFile属性指定您的模式文件的位置：

1
apollo {
2
  service("service") {
3
    schemaFile.set(file("shared/graphql/schema.graphqls"))
4
  }
5
}

默认情况下，Apollo Kotlin会将项目中所有匹配模式schema.[graphqls|json|sdl]的文件合并。

合并多个模式文件

Apollo Kotlin支持一系列客户端指令，包括@nonnull、@optional和@typePolicy。这些指令使得您能够通过客户端特定的类型和字段扩展您的服务器基础模式。

如果您在一个单独的文件中扩展您的模式，您可以指示Apollo Kotlin从多个文件组合中构建其模式，如下所示：

1
apollo {
2
  service("service") {
3
    schemaFiles.setFrom("shared/graphql/schema.graphqls", "shared/graphql/extra.graphqls")
4
  }
5
}

默认情况下，Apollo Kotlin会将项目中所有匹配模式schema.[graphqls|json|sdl]的文件合并。

连接生成的源

默认情况下，Apollo Kotlin会将生成的源代码添加到

Java VM项目的main源集
多平台项目的commonMain中
所有非测试变体中，适用于Android项目

您可以使用outputDirConnection属性来自定义此行为。例如，要将服务连接到Kotlin JVM项目的测试源集：

1
apollo {
2
  service("service") {
3
    outputDirConnection {
4
      connectToKotlinSourceSet("test")
5
    }
6
  }
7
}

Android变体支持

有时，根据Android项目的变体，这可能很有用。

为此，您可以指示Gradle插件自动为每个变体配置一个服务，如下所示：

1
apollo {
2
  createAllAndroidVariantServices(sourceFolder = ".", nameSuffix = "") {
3
    // Configure the service here
4
    packageName.set("...")
5
  }
6
}

sourceFolder相对于"src/$sourceSetName/graphql"找到GraphQL的位置。传递"."查找"src/$sourceSetName/graphql"。
nameSuffix为服务名称使用的后缀。留空以使用未更改的变体名称。

类似于Android变体系统对源代码的处理方式，GraphQL文件被按添加方式处理，并且src/main/graphql中的文件包含在所有服务中。这意味着您的项目可能看起来像这样（例如，当某些操作只必须在调试构建中存在时）：

1
- main
2
    - graphql
3
        - schema.graphqls // Schema for all variants
4
        - operations.graphql // Operations shared by all variants
5
- debug
6
    - graphql
7
        - operations.graphql // Operations specific to the 'debug' build type

或者例如，像这样（特定后端根据口味）。

1
- main
2
- demo
3
    - graphql
4
        - schema.graphqls // Schema for the 'demo' flavor
5
        - operations.graphql // Operations specific to the 'demo' flavor
6
- full
7
    - graphql
8
        - schema.graphqls // Schema for the 'full' flavor
9
        - operations.graphql // Operations specific to the 'full' flavor

如果您有大量变体且不需要为每个变体配置 Apollo 服务，手动声明服务可能更简单，例如：

1
apollo {
2
  service("debug") {
3
    srcDir(file("src/debug/graphql/"))
4
    packageName.set("com.example")
5
    outputDirConnection {
6
      connectToAndroidSourceSet("debug")
7
    }
8
  }
9
  service("release") {
10
    srcDir(file("src/release/graphql/"))
11
    packageName.set("com.example")
12
    outputDirConnection {
13
      connectToAndroidSourceSet("release")
14
    }
15
  }
16
}

下载数据模式

默认情况下，Gradle 插件会注册一个downloadApolloSchema任务，您可以从命令行使用该任务：

1
# --schema is interpreted relative to the project's root directory (can also be an absolute path). This example
2
# assumes the root project directory and an Android app in `app`
3
./gradlew downloadApolloSchema \
4
  --endpoint="https://your.domain/graphql/endpoint" \
5
  --schema="app/src/main/graphql/com/example/schema.graphqls"

如果您经常这样做或想从 CI 自动化过程，您可以配置一个introspection {}块：

1
apollo {
2
  service("starwars") {
3
    packageName.set("com.starwars")
4

5
    // This will create a downloadStarwarsApolloSchemaFromIntrospection task
6
    introspection {
7
      endpointUrl.set("https://your.domain/graphql/endpoint")
8
      // The path is interpreted relative to the current project here, no need to prepend 'app'
9
      schemaFile.set(file("src/main/graphql/com/example/schema.graphqls"))
10
    }
11
  }
12
}

这将创建一个名为download<ServiceName>ApolloSchemaFromIntrospection的任务。

[!NOTE]
这与其他的downloadApolloSchema任务不同。请确保调用download<ServiceName>ApolloSchemaFromIntrospection

如果您使用Apollo Studio注册模式，请使用registry块替代：

1
apollo {
2
  service("starwars") {
3
    packageName.set("com.starwars")
4

5
    // This will create a downloadStarwarsApolloSchemaFromRegistry task
6
    registry {
7
      key.set(System.getenv("APOLLO_KEY"))
8
      graph.set(System.getenv("APOLLO_GRAPH"))
9
      // The path is interpreted relative to the current project here, no need to prepend 'app'
10
      schemaFile.set(file("src/main/graphql/com/example/schema.graphqls"))
11
    }
12
  }
13
}

这将创建一个名为download<ServiceName>ApolloSchemaFromRegistry的任务（默认为downloadServiceApolloSchemaFromRegistry）。

连接源集

查询