원래 2012년 Facebook에서 저전력 모바일 장치를 위한 더 나은 데이터 수집 솔루션으로 개발된 GraphQL은 2015년에 오픈 소스로 공개되었습니다. 유연성을 위해 설계된 API 기술인 GraphQL은 API 개발자와 소비자는 물론 API 뒤에 있는 조직을 위한 강력한 지원 도구입니다. GraphQL 구현의 모든 세부정보와 기능은GraphQL 스키마
에 나열되어 있습니다. 유효한 GraphQL스키마
를 작성하려면GraphQL 유형 시스템.GraphQL Schema
中列出。为了编写一个有效的 GraphQLschema
,必须理解好GraphQL 类型系统。
在本文中,将学习 GraphQL 类型:五种内置标量(scalar
)类型、枚举(enums
)、列表(list
)和非空包装(non-null
)类型、对象(object
)类型以及与它们一起工作的抽象接口和联合类型(union
)。
GraphQL 模式中的所有数据最终都解析为各种标量类型,代表原始值。GraphQL 响应可以看作一棵树,标量类型是树末端的叶子。嵌套响应中可以有多个级别,但最后一个级别将始终解析为标量(或枚举)类型。 GraphQL 带有五种内置标量类型:Int
、Float
、String
、Boolean
和ID
。
Int
是带符号的32
位非小数值,它是不包括小数的带符号(正或负)整数。带符号的32
位整数的最大值为2,147,483,647
。这是用于数值数据的两个内置标量之一。
Float
是带符号的双精度小数值。它是一个带小数点的有符号(正或负)数,例如1.2
,这是用于数值数据的另一个内置标量。
String
是UTF-8
字符序列。String
类型用于任何文本数据,这也可以包括非常大的数字等数据。大多数自定义标量都是字符串数据类型。
Boolean
包含true
和false
。
ID
是唯一标识符,始终序列化为字符串,即使ID
是数字也是如此。ID
类型通常可以用通用唯一标识符 (UUID) 表示。
除了上述这些内置标量之外,还可以使用scalar
关键字来定义自定义标量。可以使用自定义标量来创建具有额外服务器级别验证的类型,例如Date
、Time
或Url
。下面是一个定义新Date
类型的示例:
scalar Date
服务器将知道如何使用GraphQLScalarType处理与这种新类型的交互。
Enum
类型,也称为Enumerator
类型,用于描述了一组可能的值。
例如可以为游戏角色的Job
和Species
创建一个枚举,其中包含系统将接受的所有值。
"角色的工作等级" enum Job { FIGHTER WIZARD } "性格的种类或血统" enum Species { HUMAN ELF DWARF }
通过定义枚举类型可以保证角色的Job
只能是FIGHTER
或WIZARD
,并且永远不会意外地成为其他一些随机字符串,如果使用String
类型而不是Enum
,那么就有可能是别的随机字符串。
枚举也可以用作参数中的可接受值。例如,可以制作一个Hand
枚举来表示武器是单手(如短剑)还是双手(如重斧),并使用它来确定是否可以装备一个或两个:
enum Hand { SINGLE DOUBLE}"战士使用的一种武器"type Weapon { name: String! attack: Int range: Int hand: Hand } type Query { weapons(hand: Hand = SINGLE): [Weapon] }
Hand
枚举已声明为SINGLE
和DOUBLE
作为值,weapons
字段上的参数具有默认值SINGLE
,这意味着如果未传递任何参数,它将回默认为SINGLE
scalar
) 유형, 열거형(
enums
), 목록(
list
) 및 null이 아닌 래퍼(null이 아닌
) 유형, 객체(
object
) 유형, 추상 인터페이스 및 공용체 유형(
union
) >).
Int
,
Float
,
String
,
Boolean
,
등 5가지 내장 스칼라 유형이 있습니다. 아이디< /코드>. Int
Int
는 부호 있는
32
자리 십진수가 아닌 값입니다. , 이는 소수를 제외한 부호 있는(양수 또는 음수) 정수입니다. 부호 있는
32
비트 정수의 최대값은
2,147,483,647
입니다. 이는 숫자 데이터에 대해 기본 제공되는 두 가지 스칼라 중 하나입니다.
Float
Float
은 부호 있는 배정밀도 십진수 값입니다. 이는 숫자 데이터에 사용되는 또 다른 내장 스칼라인
1.2
와 같이 소수점이 있는 부호 있는(양수 또는 음수) 숫자입니다.
문자열
문자열
은
UTF-8
문자의 시퀀스입니다.
String
유형은 모든 텍스트 데이터에 사용되며 매우 큰 숫자와 같은 데이터도 포함될 수 있습니다. 대부분의 사용자 정의 스칼라는 문자열 데이터 유형입니다.
부울
부울
에는
true
및
false가 포함됩니다. 코드>. ID
ID
는 고유 식별자이며
ID가 숫자인 경우에도 마찬가지입니다.
ID
유형은 일반적으로 UUID(Universally Unique Identifier)로 표시될 수 있습니다.
사용자 정의 스칼라
위에 내장된 스칼라 외에도
스칼라
를 사용할 수도 있습니다. 사용자 정의 스칼라를 정의하는 키워드입니다. 사용자 정의 스칼라를 사용하면
날짜
,
시간
또는
Url
과 같은 추가 서버 수준 유효성 검사가 포함된 유형을 만들 수 있습니다. 다음은 새로운
Date
유형을 정의하는 예입니다.
"具有直接战斗能力和力量的英雄" type Fighter { id: ID! name: String! level: Int active: Boolean! }
로그인 후 복사
로그인 후 복사
서버는
GraphQLScalarType은 이 새로운 유형과의 상호 작용을 처리합니다.
Enum 유형
Enum
유형은
Enumerator
유형이라고도 하며 가능한 값 세트를 설명하는 데 사용됩니다. 예를 들어 시스템에서 허용하는 모든 값을 포함하는 게임 캐릭터의
Job
및
Species
에 대한 열거형을 생성할 수 있습니다.
"战士使用的一种武器" type Weapon { name: String! attack: Int range: Int } "具有直接战斗能力和力量的英雄" type Fighter { id: ID! name: String! level: Int active: Boolean! weapon: Weapon }
로그인 후 복사
로그인 후 복사
열거 유형을 정의하면 역할의
Job
이
FIGHTER
또는
WIZARD
만 될 수 있고 실수로 다른 역할이 되는 일이 없도록 할 수 있습니다. 임의 문자열,
Enum
대신
String
유형을 사용하는 경우 다른 임의 문자열일 수 있습니다. 열거형은 매개변수에서 허용되는 값으로 사용될 수도 있습니다. 예를 들어,
Hand
열거형을 만들어 무기가 한손(단검 등)인지 양손(큰 도끼 등)인지 여부를 나타내고, 이를 사용하여 무기가 한손인지 또는 한손인지를 결정할 수 있습니다. 둘 다 장착 가능:
schema { query: Query mutation: Mutation subscription: Subscription }
로그인 후 복사
로그인 후 복사
Hand
열거형은
SINGLE
및
DOUBLE
값으로 선언되었으며
의 매개변수는 무기
필드에는 기본값
SINGLE
이 있습니다. 즉, 매개변수가 전달되지 않으면 기본값이
SINGLE
로 돌아갑니다.
非空类型
可能会注意到内置标量列表中缺少null
或undefined
(一种被许多语言视为原始类型的常见类型)。Null
在 GraphQL 中确实存在,表示缺少一个值。默认情况下,GraphQL 中的所有类型都可以为null
,因此null
是对任何类型的有效响应。为了使值成为必需值,必须将其转换为带有尾随感叹号的 GraphQL 非空类型。Non-Null
被定义为类型修饰符,这些类型用于修饰它所引用的类型。例如,String
是一个可选的(或可为空的)字符串,而String!
是必需的(或非空的)字符串。
列表类型
GraphQL 中的List
类型是另一种类型修饰符。任何用方括号 ([]
) 括起来的类型都会成为List
类型,这是一个定义列表中每个项目类型的集合,像 JavaScript 中的数组。
例如,定义为[Int]
的类型意味着这个集合所有元素的类型为Int
类型,[String]
将是String
类型的集合。Non-Null
和List
可以一起使用,使一个类型既需要又定义为List
,例如[String]!
。
对象类型
如果 GraphQL 标量类型描述分层 GraphQL 响应末尾的“叶子”,那么对象类型描述中间的分支
,并且 GraphQL 模式中的几乎所有内容都是一种对象类型。
对象由命名字段(键)列表和每个字段将解析为的值类型组成。对象是用type
关键字定义的。至少要定义一个或多个字段,字段不能以两个下划线(__
)开头,以免与GraphQL自省系统冲突。
例如创建一个Fighter
对象来表示游戏中的一种角色:
"具有直接战斗能力和力量的英雄" type Fighter { id: ID! name: String! level: Int active: Boolean! }
로그인 후 복사
로그인 후 복사
在此示例中,声明了Fighter
对象类型,定义了 4 个字段:
id
:非空ID
类型。
name
:非空字符串类型。
level
:Int
类型。
active
:非空布尔类型。
在声明上方,可以使用双引号添加注释,如本例:具有直接战斗能力和力量的英雄
,这将显示为类型的描述。
在此示例中,每个字段都解析为标量类型,但对象字段也可以解析为其他对象类型。例如,可以创建一个Weapon
类型,并且可以设置 GraphQL 模式,其中Fighter
上的weapon
字段将解析为一个Weapon
对象:
"战士使用的一种武器" type Weapon { name: String! attack: Int range: Int } "具有直接战斗能力和力量的英雄" type Fighter { id: ID! name: String! level: Int active: Boolean! weapon: Weapon }
로그인 후 복사
로그인 후 복사
对象也可以嵌套到其他对象的字段中。
根操作类型
有三种特殊对象作为 GraphQLschema
的入口点:Query
、Mutation
和Subcription
。这些被称为根操作类型,并遵循与任何其他对象类型相同的规则。
schema
关键字表示 GraphQL 模式的入口点。根Query
、Mutation
和Subcription
类型将位于根模式对象上:
schema { query: Query mutation: Mutation subscription: Subscription }
로그인 후 복사
로그인 후 복사
Query 类型在任何 GraphQL 模式上都是必需的,代表一个读取请求,类似于REST API GET
。以下是返回Fighter
类型列表的根查询对象的示例:
type Query { fighters: [Fighter] }
로그인 후 복사
Mutations
代表写入请求,类似于REST API
中的POST
、PUT
或DELETE
。在以下示例中,Mutation
有一个带有命名参数(输入)的addFighter
字段:
type Mutation { addFighter(input: FighterInput): Fighter }
로그인 후 복사
最后,一个Subscription
对应于一个事件流,它将与 Web 应用程序中的 Websocket 结合使用。如下所示:
type Subscription { randomBattle(enemy: Enemy): BattleResult }
로그인 후 복사
请注意,schema
入口点通常在某些 GraphQL 实现中被抽象掉。
字段参数
GraphQL 对象的字段本质上是返回值的函数,并且它们可以像任何函数一样接受参数。字段参数由参数名称后跟类型定义,参数可以是任何非对象类型。在此示例中,可以通过id
字段(解析为非空ID
类型)过滤Fighter
对象:
type Query { fighter(id: ID!): Fighter }
로그인 후 복사
这个特定示例对于从数据存储中获取单个项目很有用,但参数也可用于过滤、分页和其他更具体的查询。
接口类型
与Object
类型一样,抽象接口类型由一系列命名字段及其关联的值类型组成。接口看起来像并遵循与对象相同的所有规则,但用于定义对象实现的子集。
到目前为止,在schema
中有一个Fighter
对象,但可能还想创建一个Wizard
、一个Healer
和其他对象,它们将共享大部分相同的字段但还是存在一些差异。在这种情况下,可以使用接口来定义它们共有的字段,并创建作为接口实现的对象。
在下面的示例中,使用interface
关键字创建BaseCharacter
接口,其中包含每种类型的字符将拥有的所有字段:
"A hero on a quest."interface BaseCharacter { id: ID! name: String! level: Int! species: Species job: Job }
로그인 후 복사
每个角色类型都有字段id
、name
、level
、species
和job
。
现在,假设有一个具有这些共享字段的Fighter
类型和一个Wizard
类型,但是Fighters
使用Weapon
而Wizards
使用Spells
。可以使用implements
关键字将每个描述为BaseCharacter
实现,这意味着它们必须具有创建的接口中的所有字段:
type Fighter implements BaseCharacter { id: ID! name: String! level: Int! species: Species job: Job! weapon: Weapon } type Wizard implements BaseCharacter { id: ID! name: String! level: Int! species: Species job: Job! spells: [Spell] }
로그인 후 복사
Fighter
和Wizard
都是BaseCharacter
接口的有效实现,因为它们具有所需的字段子集。
Union 类型
可以与对象一起使用的另一种抽象类型是union
类型。使用union
关键字,可以定义一个类型,其中包含所有有效响应的对象列表。
使用上面创建的接口,可以创建一个 Character union,将character
定义为Wizard
或Fighter
:
union Character = Wizard | Fighter
로그인 후 복사
等号=
设置定义,管道符|
用作OR
语句。请注意,union
必须由对象或接口组成,标量类型在union
上无效。
现在,如果查询characters
列表,它可以使用Character
union
并返回所有Wizard
和Fighter
类型。
总结
上面学习了定义 GraphQL 类型系统的类型,包括最基本的类型是标量类型由Int
、Float
、String
、Boolean
、ID
和 GraphQL 实现创建的任何自定义标量类型组成。枚举是有效常量值的列表,当需要对查询响应进行更多控制时,可以使用枚举,而不是简单地将其声明为字符串。列表类型和非空类型被称为类型修饰符type modifier
或包装类型wrapping type
,它们分别可以将其他类型定义为集合类型或必需类型。GraphQLschema
中的几乎所有内容都是对象类型,包括query
、mutation
和subscription
入口点。接口和联合类型是抽象类型,在定义对象时很有用。
위 내용은 GraphQL 유형 시스템에 대한 심층 분석의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!