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
}

指定模式位置

使用schemaFiles 属性指定

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

ⓘ 注意

如果schemaFiles未设置，Apollo Kotlin会将src/main/graphql/（Android/JVM项目）或src/commonMain/graphql/（多平台项目）中的所有*.[graphqls|json|sdl]文件组合在一起。

合并多个模式文件

Apollo Kotlin支持一组客户端指令，包括@nonnull、@optional和@typePolicy。这些指令允许您通过客户端特定的类型和字段扩展服务器的基本模式。

如果您在一个单独的文件（通常命名为extra.graphqls）中扩展了模式，您可以告诉Apollo Kotlin从多个文件组合中构建其模式，如下所示：

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

连接生成的源

默认情况下，Apollo Kotlin会将生成的源

添加到JVM项目的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

或者如果每个flavor都有一个特定的后端，则可能如下所示

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

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
}

下载模式

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

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

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

5
    // This creates a downloadStarwarsApolloSchemaFromRegistry task
6
    registry {
7
      key.set(System.getenv("APOLLO_KEY"))
8
      graph.set(System.geten("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
}

生成方法

“equalsHashCode”生成用于比较生成类属性的

以下是一些可能的配置

1
apollo {
2
  service("service") {
3
    // Generates equals and hashCode
4
    generateMethods.set(listOf("equalsHashCode"))
5
    // Generates toString, equals, and hashcode (the default for Java)
6
    generateMethods.set(listOf("equalsHashCode", "toString"))
7
    // Only generates copy
8
    generateMethods.set(listOf("copy"))
9
    // Generates data classes (the default for Kotlin)
10
    generateMethods.set(listOf("dataClass"))
11
  }
12
}

Gradle 插件配置

多模块