アーキテクチャ
アーキテクチャSOLID

SOLID

Gato GraphQLはソフトウェアアーキテクチャにSOLIDアプローチを採用しており、異なる責務に対応するための異なるエンティティを提供することで、コードを保守可能・拡張可能・理解しやすいものにしています。

これは、プラグインがすでに提供しているユーザーエンティティの例です。Userタイプはこのコードを通じて提供されています:

class UserTypeResolver extends AbstractTypeResolver
{
  public function getTypeName(): string
  {
    return 'User';
  }
 
  public function getSchemaTypeDescription(): ?string
  {
    return $this->translationAPI->__('Representation of a user', "users");
  }
 
  public function getID(object $user)
  {
    return $this->usersAPI->getUserId($user);
  }
 
  public function getTypeDataLoaderClass(): string
  {
    return UserTypeDataLoader::class;
  }
}

タイプリゾルバーはデータベースからオブジェクトを直接ロードするのではなく、この作業をTypeDataLoaderオブジェクトに委譲します(上記の例では、クラスUserTypeDataLoaderから)。

Userタイプへのusernameemailurlフィールドの追加は、このコードを持つFieldResolverオブジェクトを通じて行われます:

class UserFieldResolver extends AbstractDBDataFieldResolver
{
  public static function getClassesToAttachTo(): array
  {
    return [
      UserTypeResolver::class,
    ];
  }
 
  public static function getFieldNamesToResolve(): array
  {
    return [
      'username',
      'email',
      'url',
    ];
  }
 
  public function getSchemaFieldDescription(
    TypeResolverInterface $typeResolver,
    string $fieldName
  ): ?string {
    $descriptions = [
      'username' => $this->translationAPI->__("User's username handle", "users"),
      'email' => $this->translationAPI->__("User's email", "users"),
      'url' => $this->translationAPI->__("URL of the user's profile in the website", "users"),
    ];
    return $descriptions[$fieldName];
  }
 
  public function getSchemaFieldType(
    TypeResolverInterface $typeResolver,
    string $fieldName
  ): ?string {
    $types = [
      'username' => SchemaDefinition::TYPE_STRING,
      'email' => SchemaDefinition::TYPE_EMAIL,
      'url' => SchemaDefinition::TYPE_URL,
    ];
    return $types[$fieldName];
  }
 
  public function resolveValue(
    TypeResolverInterface $typeResolver,
    object $user,
    string $fieldName,
    array $fieldArgs = []
  ) {
    switch ($fieldName) {
      case 'username':
        return $this->usersAPI->getUserLogin($user);
 
      case 'email':
        return $this->usersAPI->getUserEmail($user);
 
      case 'url':
        return $this->usersAPI->getUserURL($user);
    }
 
    return null;
  }
}

ご覧のとおり、GraphQLスキーマのフィールド定義とその解決は、複数の関数に分割されています:

  • getSchemaFieldDescription
  • getSchemaFieldType
  • resolveValue

その他の関数には以下が含まれます:

このコードは、すべての機能を単一の関数や設定配列で実現する場合よりも読みやすく、リゾルバーの実装と保守が容易になっています。