graphql-php로 스키마 구축
webonyx/graphql-php로 타입과 스키마를 정의합니다.
graphql-php로 스키마 구축은(는) CoddyKit의 무료 PHP Academy 강의입니다. 이것은 4개 중 2번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 PHP Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. PHP Academy 강의에는 총 4개의 강의가 포함되어 있습니다.
graphql-php: 참조 구현
webonyx/graphql-php는 사실상 PHP용 GraphQL 참조 구현 포트입니다. 타입 시스템, 구문 분석기, 검증기, 실행기를 제공합니다. 스키마는 프로그래밍 방식으로(PHP 객체를 사용해) 정의하거나 SDL에서 정의할 수 있습니다(스키마 우선 방식). 이 레슨에서는 각 구성 요소의 역할을 정확히 이해할 수 있도록 스키마를 직접 작성합니다.
composer require webonyx/graphql-php스칼라와 타입 레지스트리
모든 GraphQL 값은 결국 스칼라로 귀결됩니다: Int, Float, String, Boolean, ID. graphql-php에서는 이러한 타입이 Type 파사드에 있습니다. 객체 타입은 서로(그리고 자기 자신도) 참조하므로, 각 타입을 한 번만 생성하도록 메모이즈하는 정적 TypeRegistry를 사용하는 것이 일반적인 패턴입니다.
<?php
use GraphQL\Type\Definition\Type;
// Built-in scalars, returned as singletons:
var_dump(Type::int()->name); // "Int"
var_dump(Type::string()->name); // "String"
var_dump(Type::id()->name); // "ID"
var_dump(Type::nonNull(Type::string())->toString()); // "String!"
ObjectType 정의하기
ObjectType에는 name과 fields 맵이 있습니다. 각 필드는 type을 선언하고 선택적으로 resolve 콜백을 지정합니다. resolve를 생략하면 graphql-php는 기본 해결기를 사용합니다. 기본 해결기는 부모 값에서 일치하는 배열 키나 속성/게터를 읽습니다.
<?php
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
$postType = new ObjectType([
'name' => 'Post',
'fields' => [
'id' => Type::nonNull(Type::id()),
'title' => Type::nonNull(Type::string()),
'body' => Type::string(),
],
]);
널이 아닌 타입과 목록 래핑
래핑 타입은 널 허용 여부와 개수 제약을 표현합니다:
Type::nonNull(T)→T!(값이 널이 아님).Type::listOf(T)→[T](널일 수도 있고, 널인 항목을 포함할 수도 있는 목록).[Post!]!= 널이 아닌 게시물로 이루어진 널이 아닌 목록 →nonNull(listOf(nonNull($postType))).
이 부분을 정확히 설정하십시오. 이는 클라이언트와 맺는 스키마의 널 계약입니다.
<?php
use GraphQL\Type\Definition\Type;
// [Post!]! -- a required list whose elements are never null
$wrapped = Type::nonNull(Type::listOf(Type::nonNull(Type::string())));
echo $wrapped->toString(), "\n"; // [String!]!
지연 필드로 순환 참조 해결하기
User에는 posts가 있고, Post에는 author(사용자)가 있습니다. 서로 참조하는 타입을 구축하려면 fields를 배열이 아니라 클로저로 전달하십시오. 두 타입이 모두 생성된 후 클로저가 지연 실행되므로 닭과 달걀 문제를 피할 수 있습니다.
<?php
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
class Types {
private static array $cache = [];
public static function user(): ObjectType {
return self::$cache['User'] ??= new ObjectType([
'name' => 'User',
'fields' => fn() => [ // lazy!
'id' => Type::nonNull(Type::id()),
'name' => Type::nonNull(Type::string()),
'posts' => Type::listOf(self::post()),
],
]);
}
public static function post(): ObjectType {
return self::$cache['Post'] ??= new ObjectType([
'name' => 'Post',
'fields' => fn() => [
'id' => Type::nonNull(Type::id()),
'title' => Type::nonNull(Type::string()),
'author' => self::user(), // back-reference
],
]);
}
}
필드 인수
필드는 인수를 받을 수 있습니다. args 키 아래에 선언하면 인수는 해결기의 두 번째 매개변수($args)로 전달됩니다. 인수 자체에도 타입을 지정할 수 있고, 널이 아니도록 할 수 있으며, defaultValue를 포함할 수 있습니다.
<?php
use GraphQL\Type\Definition\Type;
$userField = [
'type' => Type::string(),
'args' => [
'id' => Type::nonNull(Type::id()),
'locale' => ['type' => Type::string(), 'defaultValue' => 'en'],
],
'resolve' => fn($root, array $args) => "user {$args['id']} ({$args['locale']})",
];
루트 Query 타입
모든 스키마에는 루트 Query 타입이 필요합니다. 이는 클라이언트가 시작할 수 있는 진입점입니다. 여기서는 전체 흐름을 실행할 수 있도록 hello 필드 하나를 노출합니다. 루트 해결기의 첫 번째 인수는 스키마의 rootValue이며, 대개 null입니다.
<?php
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
$queryType = new ObjectType([
'name' => 'Query',
'fields' => [
'hello' => [
'type' => Type::string(),
'args' => ['name' => Type::nonNull(Type::string())],
'resolve' => fn($root, array $args) => 'Hello, ' . $args['name'],
],
],
]);
스키마 조립 및 실행
쿼리 타입을 Schema로 감싸고 쿼리 문자열을 GraphQL::executeQuery()를 통해 실행합니다. 결과 객체는 toArray()를 통해 표준 { data, errors } 배열로 변환됩니다.
<?php
require 'vendor/autoload.php';
use GraphQL\GraphQL;
use GraphQL\Type\Schema;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
$queryType = new ObjectType([
'name' => 'Query',
'fields' => [
'hello' => [
'type' => Type::string(),
'args' => ['name' => Type::nonNull(Type::string())],
'resolve' => fn($root, $args) => 'Hello, ' . $args['name'],
],
],
]);
$schema = new Schema(['query' => $queryType]);
$result = GraphQL::executeQuery($schema, '{ hello(name: "Ada") }');
echo json_encode($result->toArray());
// {"data":{"hello":"Hello, Ada"}}
BuildSchema를 사용한 스키마 우선 대안
SDL을 선호한다면 BuildSchema::build()가 스키마 문자열을 실행 가능한 스키마로 구문 분석합니다. 그런 다음 해결기를 별도로 연결합니다(예: 필드 해결기 콜백). 이렇게 하면 타입 정의는 선언적으로 유지하고 로직은 PHP에 둘 수 있습니다.
<?php
use GraphQL\Utils\BuildSchema;
$sdl = <<<'GQL'
type Query {
hello(name: String!): String
}
GQL;
$schema = BuildSchema::build($sdl);
// Provide resolvers via the executeQuery $fieldResolver argument
// or with a type config decorator.
배포 전 검증하기
graphql-php는 실행 전에 수신 쿼리를 스키마에 대해 자동으로 검증합니다. 또한 $schema->assertValid()를 사용해 빌드/CI 시점에 스키마 자체가 내부적으로 일관적인지 확인할 수도 있습니다 — 요청 시점이나 배포 후가 아니라 그 전에 오타와 잘못된 참조를 잡아냅니다.
<?php
use GraphQL\Type\Schema;
/** @var Schema $schema */
$schema->assertValid(); // throws InvariantViolation on a broken schema
echo "schema OK\n";
열거형과 사용자 정의 스칼라
객체 외에도 대부분의 스키마를 완성하는 두 가지 타입 종류가 있습니다. EnumType은 필드를 이름이 지정된 고정된 값 집합으로 제한합니다. CustomScalarType을 사용하면 고유한 serialize/parseValue/parseLiteral 로직으로 도메인 스칼라(DateTime, 이메일)를 정의할 수 있으므로 경계에서 값이 검증되고 정규화됩니다.
<?php
use GraphQL\Type\Definition\EnumType;
$statusEnum = new EnumType([
'name' => 'PostStatus',
'values' => [
'DRAFT' => ['value' => 0],
'PUBLISHED' => ['value' => 1],
'ARCHIVED' => ['value' => 2],
],
]);
// A field typed as $statusEnum only accepts DRAFT/PUBLISHED/ARCHIVED.
간단 확인
왜 fields를 클로저로 전달합니까?
복습
처음부터 스키마를 구축했습니다:
- 스칼라와 래핑 타입(
nonNull,listOf)은 널/개수 계약을 표현합니다. - 필드 맵(또는 지연 클로저)을 포함한
ObjectType이 데이터 형태를 정의합니다. - 메모이즈하는 타입 레지스트리가 순환 참조를 처리합니다.
- 필드는 타입이 지정된
args를 받고, 루트Query타입이 진입점이 됩니다. GraphQL::executeQuery()가 실행을 담당하고,assertValid()가 CI에서 스키마를 보호합니다.
다음: 해결기, 변경 작업, 구독입니다.
자주 묻는 질문
“graphql-php로 스키마 구축” 강의는 무료인가요?
네 — “graphql-php로 스키마 구축” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 PHP Academy 강의 전체를 잠금 해제할 수 있습니다. PHP Academy 강의에는 총 4개의 강의가 포함되어 있습니다.
“graphql-php로 스키마 구축”에서 뭘 배우나요?
webonyx/graphql-php로 타입과 스키마를 정의합니다. 브라우저에서 직접 실행하는 실습 코드로 PHP Academy을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.
PHP Academy을(를) 시작하는 데 경험이 필요한가요?
사전 경험은 필요하지 않습니다. CoddyKit의 PHP Academy은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 2번째 강의입니다.
“graphql-php로 스키마 구축” 강의는 얼마나 걸리나요?
대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.
이 PHP Academy 강의에서 코드를 작성하고 실행할 수 있나요?
네. 모든 PHP Academy 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.
이 강의의 모든 강의
- GraphQL과 REST 비교
- graphql-php로 스키마 구축
- 리졸버, 변이와 구독
- 성능: N+1과 DataLoader