More than 3 years have passed since last update.

UE5のBlueprintでGraphQLをリクエストする

Last updated at 2021-10-29Posted at 2021-10-28

UE5で簡単なGraphQLのやり取りを行いたい

マーケットプレイスで検索すると、GraphQLを扱えるようになるコンテンツが見つかります

ただ、そこそこいい値段がするので、サーバーとの簡単な（認証など不要な）やり取りができるコードを書いてみました

環境

ソフトウェア	バージョン
MacOS	10.15.7
UnrealEngine	5.0.0
Visual Studio Code	1.61.2
Xcode	12.4
.NET SDK	5.0.402

基本設計

UObjectを継承して、Blueprint上でクエリー文の入力と、イベントによる結果の受信を行います
プロジェクト名はGraphqlTestとして進めます

コード

Build.csファイルのPublicDependencyModuleNamesにHttp,Json,JsonUtilitiesを追加します

GraphqlTest.Build.cs

 PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "Http", "Json", "JsonUtilities" });

GraphqlObject.h

// Fill out your copyright notice in the Description page of Project Settings.

# pragma once

# include "Http.h" // Http関連が使用できるように追加
# include "CoreMinimal.h"
# include "UObject/NoExportTypes.h"
# include "GraphqlObject.generated.h"

/**
 * 
 */
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FBlueprintAssignableSignature);

UCLASS(Blueprintable, BlueprintType)
class GRAPHQLTEST_API UGraphqlObject : public UObject
{
	GENERATED_BODY()

public:
	UGraphqlObject();

	FHttpModule *Http;

private:

public:
	// GraphQLのサーバをBlueprintから指定できるようにプロパティを公開
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Graphql")
	FString url;

	// 受信結果をBlueprintから参照できるように読み込み専用のプロパティを追加
	UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Graphql")
	FString ContentAsString;

	// 自身のインスタンスを作成するメソッド
	UFUNCTION(BlueprintPure, Category = "Graphql", meta = (DisplayName = "Create Object", Keywords = "Create Graphql Object", ShortTooltip = "Creates an empty Graphql Object"))
	static UGraphqlObject *Create();

	// HTTP通信を行ってレスポンスが返ってきた際のイベント処理
	void OnResponseReceived(FHttpRequestPtr Request, FHttpResponsePtr Response, bool bWasSuccessful);

	// 受診後のイベントを発行するためのメソッド
	UPROPERTY(BlueprintAssignable, Category = "Dynamic Delegate Component")
	FBlueprintAssignableSignature OnResponseReceivedDispatcherCalled;

	// クエリーを発行するためのメソッド
	UFUNCTION(BlueprintCallable, Category = "Graphql")
	void Query(FString document);
};

GraphqlObject.cpp

// Fill out your copyright notice in the Description page of Project Settings.


# include "GraphqlObject.h"

UGraphqlObject::UGraphqlObject() 
	: Super()
{
    Http = &FHttpModule::Get();
}

UGraphqlObject* UGraphqlObject::Create() {
    return NewObject<UGraphqlObject>();
}

void UGraphqlObject::OnResponseReceived(FHttpRequestPtr Request, FHttpResponsePtr Response, bool bWasSuccessful)
{
    if (!Response.IsValid())
    {
        GEngine->AddOnScreenDebugMessage(-1, 2.0f, FColor::Green, "No Valid");
    }
    else if (EHttpResponseCodes::IsOk(Response->GetResponseCode()))
    {
        ContentAsString = Response->GetContentAsString();

        TSharedPtr<FJsonObject> JsonObject;
        TSharedRef<TJsonReader<> > Reader = TJsonReaderFactory<>::Create(ContentAsString);

        // Jsonオブジェクトをデシリアライズ
        if (FJsonSerializer::Deserialize(Reader, JsonObject))
        {
            GEngine->AddOnScreenDebugMessage(-1, 10.0f, FColor::Red, "Received JSON String");

            //ここに、JSON StringをパースしてJSON Objectとして保持する工程を追加する

            OnResponseReceivedDispatcherCalled.Broadcast();
        }
    }
}

void UGraphqlObject::Query(FString document)
{
    // Jsonデータの作成
    TSharedPtr<FJsonObject> JsonObject = MakeShareable(new FJsonObject);
    JsonObject->SetStringField("query", document);
    // JsonStringにJson書き出し
    FString JsonString;
    TSharedRef<TJsonWriter<TCHAR> > JsonWriter = TJsonWriterFactory<>::Create(&JsonString);
    FJsonSerializer::Serialize(JsonObject.ToSharedRef(), JsonWriter);

    // Httpリクエストの作成
    TSharedRef<IHttpRequest, ESPMode::ThreadSafe> Request = Http->CreateRequest();
    Request->OnProcessRequestComplete().BindUObject(this, &UGraphqlObject::OnResponseReceived);
    Request->SetURL(url);
    Request->SetVerb("POST");
    Request->SetHeader(TEXT("User-Agent"), TEXT("X-UnrealEngine-Agent"));
    Request->SetHeader(TEXT("Content-Type"), TEXT("application/json"));
    Request->SetHeader(TEXT("Accepts"), TEXT("application/json"));
    Request->SetContentAsString(JsonString);
    Request->ProcessRequest();
}