CacheStorage

🌏 English

🚩 목차

개요
설치
스펙
API
Release notes

개요

CacheStorage는 Unity에서 웹 통신을 할 때 Cache를 지원합니다.
Cache를 이용하여 통신을 할 때 받은 데이터를 재사용하여 성능을 개선할 수 있습니다.

성능 향상

네트워크 통신을 할 때 HTTP 기반으로 콘텐츠를 저장하고 재사용합니다. 이때 콘텐츠가 수정되지 않은 경우에는 응답에 콘텐츠를 포함하지 않기 때문에 전송 속도가 크게 향상됩니다

CacheStorage 샘플 기반 성능 테스트
- UnityWebRequest: 28ms
- WebCache: 14ms
- Local: 1ms

웹 캐시를 사용했을 때 일반적인 통신보다 2배 정도 빨라진 것을 확인할 수 있습니다.

간편한 사용

관리 포인트가 URL 하나로 일원화되어 간편합니다.

콘텐츠를 재사용 하는 경우 속도가 매우 빠릅니다. 동시에 최신 콘텐츠의 데이터 관리도 필요합니다. 웹 캐시를 사용하게 되면 동일한 url로 최신 콘텐츠인지 검증하며 재사용할 수 있어 간편해집니다.

용량 관리

캐시를 관리하여 용량을 제어할 수 있습니다.

실시간 관리

오랫동안 사용되지 않는 콘텐츠를 실시간으로 제거해 줍니다.
UnusedPeriodTime와 RemoveCycle를 둘 다 설정해야 동작합니다.
- UnusedPeriodTime
  - 설정한 시간(초) 동안 사용하지 않은 캐시를 지워줍니다.
- RemoveCycle
  - 제거되는 캐시들을 성능에 영향이 가지 않도록 설정한 시간(초)마다 하나씩 제거합니다.

조건 관리

새로운 콘텐츠를 받을 때 설정한 용량, 개수가 넘지 않도록 제거해 줍니다.
우선순위가 낮은 캐시부터 제거해 줍니다.
- MaxCount
  - 관리되는 캐시가 설정한 개수가 넘으면 우선순위가 낮은 것부터 지워줍니다.
- MaxSize
  - 관리되는 캐시가 설정한 용량이 넘으면 우선순위가 낮은 것부터 지워줍니다.

설치

Game Package Manger 설치
실행 : Unity Menu > Tools > GPM > Manager
서비스 설치 : CacheStorage

스펙

Unity 지원 버전

2019.4.0 이상

사용 방법

using Gpm.CacheStorage를 선언합니다.
대부분의 기능은 GpmCacheStorage에 정의되어 있습니다.
GpmCacheStorage.Initialize를 사용하여 초기화합니다.
GpmCacheStorage.Request를 사용하여 Cache를 요청합니다.

NameSpace

using Gpm.CacheStorage;

Initialize

CacheStorage를 사용하기 위해서는 반드시 초기화를 해야 합니다.

GpmCacheStorage.Initialize를 호출합니다.

CacheStorage에 사용될 매개변수를 설정합니다.

maxCount
- 설정한 최대 개수가 넘으면 우선순위가 낮은 캐시부터 지워줍니다.
- 0으로 설정 시 무제한입니다.
maxSize
- 설정한 최대 용량이 넘으면 우선순위가 낮은 캐시부터 지워줍니다.
- 0으로 설정 시 무제한입니다.
reRequestTime
- 요청할 때 설정한 시간(초)이 지난 캐시는 재검증합니다.
- 0으로 설정 시 요청 시간 기반으로 재검증하지 않습니다.
defaultRequestType
- 요청할 때 설정한 타입 기반으로 재검증합니다.
  - ALWAYS
    - 요청할 때마다 재검증합니다.
  - FIRSTPLAY
    - 앱이 재실행될 때마다 재검증합니다, 유효 기간이 끝났을때도 재검증합니다.
  - Once
    - 재사용 하고 유효 기간이 끝났을때 재검증합니다.
  - LOCAL
    - 저장된 캐시를 사용합니다.
unusedPeriodTime
- 설정한 시간(초) 동안 사용하지 않은 캐시를 지워줍니다.
- unusedPeriodTime 또는 removeCycle가 0으로 설정 시 실시간 제거를 하지 않습니다.
removeCycle
- 제거되는 캐시들을 성능에 영향이 가지 않도록 설정한 시간(초)마다 하나씩 제거합니다.
- unusedPeriodTime 또는 removeCycle가 0으로 설정 시 실시간 제거를 하지 않습니다.

using Gpm.CacheStorage;

public void Something()
{
    int maxCount = 10000;
    int maxSize = 5 * 1024 * 1024; // 5 MB
    double reRequestTime = 30 * 24 * 60 * 60; // 30 Days
    CacheRequestType defaultRequestType = CacheRequestType.FIRSTPLAY;
    double unusedPeriodTime = 365 * 24 * 60 * 60; // 1 Years
    double removeCycle = 1; // 1 Seconds
             
    GpmCacheStorage.Initialize(maxCount, maxSize, reRequestTime, defaultRequestType, unusedPeriodTime, removeCycle);
}

Request

Request를 통해 url의 데이터를 요청합니다.

데이터는 cache로 저장되며 같은 url을 호출할 때 재사용합니다.
CacheRequestType을 통해 언제 서버에 검증할 것인지 정의할 수 있습니다.
서버에 검증할 때 동일한 데이터일 경우 다시 받지 않고 캐시를 재사용합니다.

using Gpm.CacheStorage;

public void Something()
{
    string url;
    GpmCacheStorage.Request(url, (GpmCacheResult result) =>
    {
        if (result.IsSuccess() == true)
        {
            bytes[] data = result.Data;
        }
    });
}

CacheRequestConfiguration

요청할 때 세밀하게 캐시 요청을 제어할 수 있는 설정입니다.

requestType : 캐시된 데이터를 언제 서버에 다시 검증할지를 결정하는 타입
- ALWAYS : 요청할 때마다 재검증합니다.
- FIRSTPLAY : 앱이 재실행될 때마다 재검증합니다, 유효 기간이 끝났을 때도 재검증합니다.
- ONCE : 유효 기간이 끝났을 때 재검증합니다.
- LOCAL : 캐시된 데이터를 사용합니다.
reRequestTime : 로컬에서 지정된 재검증 주기( 초)
- requestType이 FIRSTPLAY, ONCE 인 경우 동작합니다.
  - 캐시 검증 후 reRequestTime이 지나면 재검증합니다.
  - 만약 서버에 설정된 유효 기간이 더 짧다면 해당 시간으로 재검증합니다.
- 0일 경우 reRequestTime은 무시됩니다.
validCacheTime : 로컬 캐시 유효 기간 (초)
- min : 캐시 재사용의 최소 시간 (초)
  - 설정한 시간이 지나기 전에는 재검증 없이 재사용합니다.
  - 0일 경우 min은 무시됩니다.
- max : 캐시 재사용의 최대 시간 (초)
  - 설정한 시간이 지나면 새로운 캐시를 받습니다.
  - 0일 경우 max는 무시됩니다.
header
- 서버에 요청할 때 추가할 헤더를 설정합니다.

using Gpm.CacheStorage;

public void Something()
{
    string url;
    
    CacheRequestType requestType = CacheRequestType.ONCE;
    
    double reRequestTime = 60 * 60 * 2;
    
    double cacheValidTimeMin = 60 * 5;
    double cacheValidTimeMax = 60 * 60 * 24 * 30;
    CacheValidTime validCacheTime = new CacheValidTime(cacheValidTimeMin, cacheValidTimeMax)); 

    Dictionary<string, string> header = new Dictionary<string, string>();
    header.Add("Content-Type", "application/json");
    
    CacheRequestConfiguration config = new CacheRequestConfiguration(requestType, reRequestTime, validCacheTime, header); 
    GpmCacheStorage.Request(url, config, (GpmCacheResult result) =>
    {
        if (result.IsSuccess() == true)
        {
            bytes[] data = result.Data;
        }
    });
}

GpmCacheResult

캐시된 데이터의 결괏값입니다. 캐시 정보와 데이터를 반환합니다.

IsSuccess 통해 성공 여부를 받아올 수 있습니다.
기본적으로 데이터는 Data로 저장됩니다.
Text나 Json은 인코딩을 통해 변환할 수 있으며 기본값은 utf8입니다.

bool IsSuccess() // 결과 성공 여부를 반환합니다.
CacheInfo Info; // 캐시 정보를 반환합니다.
byte[] Data;  // 캐시 데이터를 반환합니다.
string Text;  // utf8로 인코딩된 데이터를 반환합니다.

string GetTextData() // utf8로 인코딩된 데이터를 반환합니다.
string GetTextData(Encoding encoding) // 인코딩된 데이터를 반환합니다.

T GetJsonData<T>() // utf8로 인코딩된 json 데이터를 반환합니다.
T GetJsonData<T>(Encoding encoding) // utf8로 인코딩된 json 데이터를 반환합니다.

public void Something()
{
    string url;
    GpmCacheStorage.Request(url, (GpmCacheResult result) =>
    {
        // success
        if (result.IsSuccess() == true)
        {
            // date
            bytes[] data = result.Data;

            // text - Encoding.UTF8
            string text = result.Text;

            // text - Encoding.UTF8
            text = result.GetTextData();

            // text - Encoding.Default
            text = result.GetTextData(Encoding.Default);    

            // json - Encoding.UTF8
            JsonClass json = result.GetJsonData<JsonClass>();

            // json - Encoding.Default
            json = result.GetJsonData<JsonClass>(Encoding.Default);           
        }
    });
}

CacheRequestOperation

캐시를 요청할 때 반환 값입니다. 캐시 요청 상태를 알 수 있습니다.

bool keepWaiting() // 코루틴에서 대기 할 것인지를 반환합니다.
void Cancel() // 요청을 취소합니다. 취소한 요청은 콜백이 전달되지 않습니다.

코루틴 대기하기

CacheRequestOperation를 이용하여 코루틴에서 대기할 수 있습니다.

using Gpm.CacheStorage;

public IEnumerator Something()
{
    bytes[] data;
    string url;
    yield return GpmCacheStorage.Request(url, (GpmCacheResult result) =>
    {
        if (result.IsSuccess() == true)
        {
            data = result.Data;
        }
    });
}

요청 취소하기

요청을 취소하여 콜백을 받지 않을 수 있습니다.

using Gpm.CacheStorage;

public IEnumerator Something()
{
    bytes[] data;
    string url;
    CacheRequestOperation op = GpmCacheStorage.Request(url, (GpmCacheResult result) =>
    {
        if (result.IsSuccess() == true)
        {
            data = result.Data;
        }
    });

    // Cancel
    op.Cancel();

    yield return op;
}

텍스처 캐싱 요청

RequestTexture를 통해 캐시된 텍스처를 요청할 수 있습니다.

앱 실행 후 로드한 텍스처라면 재사용합니다.
캐시된 데이터와 웹 데이터가 동일한 데이터인 경우 캐시된 텍스처를 로드하여 사용합니다.
preload : 캐시된 텍스처를 로컬에서 즉시 로드합니다.
- 캐시된 데이터와 웹 데이터가 다를 경우 콜백이 한번 더 호출됩니다.

요청

public void Something()
{
    string url;
    bool preload = true;

    GpmCacheStorage.RequestTexture(url, preload, (CachedTexture cachedTexture) =>
    {
        if (cachedTexture != null)
        {
            Texture texture = cachedTexture.texture;
        }
    });
}

설정값 추가

public void Something()
{
    string url;
    
    Dictionary<string, string> header = new Dictionary<string, string>();
    header.Add("Authorization ", "value");
    CacheRequestConfiguration config = new CacheRequestConfiguration(header);
    
    bool preload = true;

    GpmCacheStorage.RequestTexture(url, config, preload, (CachedTexture cachedTexture) =>
    {
        if (cachedTexture != null)
        {
            Texture texture = cachedTexture.texture;
        }
    });
}

코루틴 사용

public IEnumerator Something()
{
    string url;
    bool preload = true;
    
    CachedTexture cachedTexture;
    yield return GpmCacheStorage.RequestTexture(url, preload, (CachedTexture recvCachedTexture) =>
    {
        cachedTexture = recvCachedTexture;
    });

    if (cachedTexture != null)
    {
        Texture texture = cachedTexture.texture;
    }
}

CachedTexture

캐시된 텍스쳐의 결괏값입니다. 캐시 정보를 반환합니다.

캐시된 텍스쳐를 받아올 수 있습니다.
updateData를 통해 텍스쳐 변경 여부를 알 수 있습니다.

CacheInfo info // 캐시 정보를 반환합니다.
Texture2D texture; // 결과 텍스쳐를 반환합니다.
bool requested;  // true일 때 웹에서 새로 받은 요청입니다.
bool updateData;  // true일 때 새롭게 업데이트된 텍스쳐입니다.

void DestroyTexture() // 텍스쳐를 파괴하고 관리되는 텍스쳐에서도 제외합니다.
void ReleaseCache() // 관리되는 텍스쳐에서 제외합니다. 텍스쳐를 파괴하지는 않습니다.

public void Something()
{
    string url;
    GpmCacheStorage.RequestTexture(url, (CachedTexture cachedTexture) =>
    {
        if (cachedTexture != null)
        {
            // texture
            Texture texture = cachedTexture.texture;

            // requested
            bool requested = cachedTexture.requested;

            // updateData
            bool updateData = cachedTexture.updateData;

            // DestroyTexture
            cachedTexture.DestroyTexture();

            // ReleaseCache
            cachedTexture.ReleaseCache();
        }
    });
}

더 효과적인 웹 캐시 사용

웹 캐시를 사용하면 동일할 경우 콘텐츠를 다운로드 하지 않기 때문에 일반적인 웹 요청보다 속도가 2배 정도 빠릅니다.

로컬 캐시에서 직접 불러오는 것은 웹 요청을 않아 더욱 빠르지만 최신 상태 여부를 확인할 수 없습니다.

이러한 특성을 활용하여 필요할 때만 검증하면 웹 캐시를 더욱 효과적으로 사용할 수 있습니다.

웹 캐시 검증 전략

CacheStorage에서는 아래와 같이 4가지 검증 요청 타입을 지원하고 있습니다.

ALWAYS
- 콘텐츠를 요청할 때마다 재검증을 수행합니다.
FIRSTPLAY
- 앱 실행 후 처음 콘텐츠를 요청할 때 재검증을 수행합니다.
- 재 실행 시 다시 콘텐츠를 요청할 때 재검증을 수행 합니다.
- 이 후 콘텐츠를 요청할 때 유효 기간이 지나면 재검증을 수행 합니다.
ONCE
- 콘텐츠를 요청할 때 유효 기간이 지나면 재검증을 수행합니다.
LOCAL
- 로컬에 캐시된 콘텐츠를 사용합니다.

ALWAYS는 매번 웹 캐시 요청 후 동일하다면 콘텐츠를 다운로드 받지 않습니다.

FIRSTPLAY와 ONCE는 콘텐츠에 지정한 유효기간 까지 로컬에 캐시된 콘텐츠를 사용하여 더욱 빠릅니다.

캐시 검증 및 성능

재검증이 빈번할수록 콘텐츠의 무결성을 보장할 수 있으며, 재사용이 많을수록 성능이 향상됩니다.

보안이 중요하거나 지속적인 갱신이 필요할 경우는 일반적인 네트워크 통신을 통해 무결성을 보장합니다.

웹 캐시 유효 기간

웹 캐시 검증은 콘텐츠 별로 서버에서 설정된 유효 기간 시간으로 동작합니다. CDN에서 콘텐츠의 유효기간을 설정한다면 재검증 주기를 설정할 수 있습니다.

웹 캐시 유효기간
- 웹 캐시의 유효기간이 0이라면 항상 ALWAYS같이 재검증을 수행합니다.
- 유효기간이 3시간으로 지정 되었다면 3시간이 지난 후 FIRSTPLAY와 ONCE 요청 시 재검증을 수행합니다.

웹 캐시 시간 제어

서버에서 제어가 힘든 콘텐츠가 많을 수 있습니다.

CacheStorage에서는 클라이언트에서 제어할수 있도록 지원합니다.

reRequestTime
- 재검증을 요청 할 시간을 설정할 수 있습니다.
- 캐시 검증 후 reRequestTime이 지나면 재검증합니다.
  - reRequestTime를 1일로 설정한다면 1일 후 재요청 합니다.
- 만약 서버에 설정된 유효 기간이 더 짧다면 해당 시간으로 재검증합니다.
  - 콘텐츠의 유효기간이 1일이고 reRequestTime를 3일로 설정한다면 1일 후 재요청 합니다.
- reRequestTime를 0으로 설정한 경우 유효기만만 체크 합니다.
validCacheTime
- 로컬 캐시의 최소/최대 유효 기간을 설정할 수 있습니다.
  - min : 캐시 재사용의 최소 시간
    - 설정한 시간이 지나기 전에는 재검증 없이 재사용합니다.
    - 0일 경우 min은 무시됩니다.
  - max : 캐시 재사용의 최대 시간
    - 설정한 시간이 지나면 새로운 캐시를 받습니다.
    - 0일 경우 max는 무시됩니다.

웹 캐시의 활용

웹 캐시의 검증 전략과 캐시 시간 제어를 같이 사용하여 웹 캐시를 더 효과적으로 사용할 수 있습니다.

검증 전략이 ALWAYS이고 validCacheTime의 min 5분인 경우 max 30일인 경우
- ALWAYS는 무결성이 좋지만 validCacheTime의 min을 활용하여 성능을 향상 시킬 수 있습니다.
  - 5분 동안 로컬 캐시를 사용하고 5분 이후 재검증 하게 할 수 있습니다.
- validCacheTime의 max을 활용하여 무결성을 더욱 향상 시킬 수 있습니다.
  - 30일 이후 요청을 하면 바뀌지 않았어도 새롭게 콘텐츠를 다운 받습니다.
검증 전략이 FIRSTPLAY이고 validCacheTime의 min 5분이고 reRequestTime이 10분인 경우
- validCacheTime의 min을 활용하여 성능을 향상 시킬 수 있습니다.
  - FIRSTPLAY는 앱을 실행 시키고 처음 요청 했을 때 검증하지만 5분이 지나기 전에는 로컬 캐시를 사용합니다.
- reRequestTime을 활용해 최대 유효 시간을 제어할 수 있습니다.
  - 5분이 지난 후 처음 요청 할 때 재검증 하지만 유효기간이 10분보다 긴 경우 10분 후 재검증 합니다.
  - 유효기간이 reRequestTime보다 작다면 유효기간 이후 재검증 합니다.
    - 다만 validCacheTime의 min에 설정된 5분 이후 재검증 합니다.

CacheRequestConfiguration

요청 할 때 세밀하게 캐시 요청을 제어할 수 있는 설정입니다. 인자를 사용하지 않으면 Initialize에서 설정한 기본값을 사용합니다.

requestType : 캐시된 데이터를 언제 서버에 다시 검증할지를 결정하는 타입
- ALWAYS : 요청할 때마다 재검증합니다.
- FIRSTPLAY : 앱이 재실행될 때마다 재검증합니다, 유효 기간이 끝났을 때도 재검증합니다.
- ONCE : 유효 기간이 끝났을 때 재검증합니다.
- LOCAL : 캐시된 데이터를 사용합니다.
reRequestTime : 로컬에서 지정된 재검증 주기(초)
- requestType이 FIRSTPLAY, ONCE 인 경우 동작합니다.
  - 캐시 검증 후 reRequestTime이 지나면 재검증합니다.
  - 만약 서버에 설정된 유효 기간이 더 짧다면 해당 시간으로 재검증합니다.
- 0일 경우 reRequestTime은 무시됩니다.
validCacheTime : 로컬 캐시 유효 기간 (초)
- min : 캐시 재사용의 최소 시간 (초)
  - 설정한 시간이 지나기 전에는 재검증 없이 재사용합니다.
  - 0일 경우 min은 무시됩니다.
- max : 캐시 재사용의 최대 시간 (초)
  - 설정한 시간이 지나면 새로운 캐시를 받습니다.
  - 0일 경우 max는 무시됩니다.
header
- 서버에 요청할 때 추가할 헤더를 설정합니다.

using Gpm.CacheStorage;

public void Something()
{
    string url;
    
    CacheRequestType requestType = CacheRequestType.ONCE;
    
    double reRequestTime = 60 * 60 * 2;
    
    double cacheValidTimeMin = 60 * 5;
    double cacheValidTimeMax = 60 * 60 * 24 * 30;
    CacheValidTime validCacheTime = new CacheValidTime(cacheValidTimeMin, cacheValidTimeMax)); 

    Dictionary<string, string> header = new Dictionary<string, string>();
    header.Add("Content-Type", "application/json");
    
    CacheRequestConfiguration config = new CacheRequestConfiguration(requestType, reRequestTime, validCacheTime, header); 
    GpmCacheStorage.Request(url, config, (GpmCacheResult result) =>
    {
        if (result.IsSuccess() == true)
        {
            bytes[] data = result.Data;
        }
    });
}

위 셈플 코드를 분석하면 아래와 같습니다.

값
- requestType : ONCE
- reRequestTime : 2시간 (60 * 60 * 2)
- cacheValidTimeMin : 5분 (60 * 5)
- cacheValidTimeMax : 30일 (60 * 60 * 24 * 30)
해석
- requestType: ONCE
  - 유효 기간이 끝났을 때만 재검증이 수행됩니다.
- cacheValidTimeMin: 5분
  - 5분이 지나기 전에는 재검증이 수행되지 않습니다.
- reRequestTime: 2시간
  - 2시간이 지난 요청에는 재검증이 수행됩니다.
  - 유효 기간이 2시간보다 짧은 경우, 해당 시간이 지나면 재검증이 수행됩니다.
- cacheValidTimeMax: 30일
  - 30일 동안 재검증이 없었으면 새로운 캐시를 받습니다.
- 이전에 재검증을 수행한 경우, 그 시점부터 시간을 카운트합니다.
성능
- cacheValidTimeMin, reRequestTime, 유효 기간이 지나기 전
  - 캐시를 로컬에서 읽어오므로 성능이 빠릅니다.
- reRequestTime, 유효 기간이 지나 재검증
  - 서버에 요청하더라도 콘텐츠가 변경되지 않았을 경우, 새로운 다운로드가 발생하지 않아 성능이 향상됩니다.
- cacheValidTimeMax가 지났을 경우
  - 새로운 캐시를 받아야 하므로 다운로드가 발생하며, 이는 일반적인 서버 통신과 동일합니다.

Viewer

CacheStorage의 캐시 정보를 확인해 볼 수 있습니다.

사용 방법
- 메뉴의 GPM/CacheStorage/Viewer 를 통해 오픈 가능합니다.

1. Management

관리되는 캐시 메뉴입니다.

Size : 현재 캐시 용량 / 최대 용량 (byte 단위)
- 현재 Cache 용량과 설정된 최대 용량입니다.
- 최대 용량이 넘지 않게 유지해줍니다.
Count : 현재 캐시 개수 / 최대 개수
- 현재 Cache 개수와 설정된 최대 개수입니다.
- 최대 개수가 넘지 않게 유지해줍니다.

2. Request Info

캐시를 요청할 때 사용되는 정보입니다.

Default RequestType
- 요청할 때 설정한 타입 기반으로 재검증합니다.
  - ALWAYS
    - 요청할 때마다 재검증합니다.
  - FIRSTPLAY
    - 앱이 재실행될 때마다 재검증합니다, 유효 기간이 끝났을 때도 재검증합니다.
  - Once
    - 유효 기간이 끝났을 때 재검증합니다.
  - LOCAL
    - 저장된 캐시를 사용합니다.
ReRequest
- 요청할 때 설정한 시간(초)이 지난 캐시는 재검증합니다.
- 0으로 설정 시 요청 시간 기반으로 재검증하지 않습니다.

3. Auto Remove

오랫동안 사용되지 않는 콘텐츠를 실시간으로 제거해 줍니다. UnusedPeriodTime와 RemoveCycle를 둘 다 설정해야 동작합니다.

UnusedPeriodTime
- 설정한 시간(초) 동안 사용하지 않은 캐시를 지워줍니다.
- unusedPeriodTime 또는 removeCycle가 0일 때 실시간 제거를 하지 않습니다.
RemoveCycle
- 제거되는 캐시들을 성능에 영향이 가지 않도록 설정한 시간(초)마다 하나씩 제거합니다.
- unusedPeriodTime 또는 removeCycle가 0일 때 실시간 제거를 하지 않습니다.

4. 캐시 데이터 리스트

관리하고 있는 캐시 데이터 리스트입니다.

Name : 캐시 이름
Url : 캐시 경로
Size : 캐시 크기 (byte 단위)
Exfires : 유효 기간까지 남은 시간
Remain : 캐시 검증까지 남은 시간
- 남은 시간이 지나면 재검증합니다.
- 유효 기간까지 남은 시간과 ReRequest(초 단위) 시간 중 짧은 시간
Remove : 제거될 때까지 남은 시간
- 남은 시간 동안 사용하지 않으면 제거됩니다.
- 사용한 시간 / UnusedPeriodTime로 설정된 시간 (초 단위)
- unusedPeriodTime 또는 removeCycle가 0일 때 실시간 제거를 하지 않습니다.

5. 캐시 상세 정보

리스트에서 선택된 캐시 데이터 상세 정보입니다.

API

Initialize

CacheStorage를 사용하기 위해서는 반드시 초기화를 해야 합니다.

maxCount
- 설정한 최대 개수가 넘으면 우선순위가 낮은 캐시부터 지워줍니다.
- 0으로 설정 시 무제한입니다.
maxSize
- 설정한 최대 용량이 넘으면 우선순위가 낮은 캐시부터 지워줍니다.
- 0으로 설정 시 무제한입니다.
reRequestTime
- 요청할 때 설정한 시간(초)이 지난 캐시는 재검증합니다.
- 0으로 설정 시 요청 시간 기반으로 재검증하지 않습니다.
defaultRequestType
- 요청할 때 설정한 타입 기반으로 재검증합니다.
  - ALWAYS
    - 요청할 때마다 재검증합니다.
  - FIRSTPLAY
    - 앱이 재실행될 때마다 재검증합니다, 유효 기간이 끝났을 때도 재검증합니다.
  - Once
    - 재사용 하고 유효 기간이 끝났을 때 재검증합니다.
  - LOCAL
    - 저장된 캐시를 사용합니다.
unusedPeriodTime
- 설정한 시간(초) 동안 사용하지 않은 캐시를 지워줍니다.
- unusedPeriodTime 또는 removeCycle가 0으로 설정 시 실시간 제거를 하지 않습니다.
removeCycle
- 제거되는 캐시들을 성능에 영향이 가지 않도록 설정한 시간(초)마다 하나씩 제거합니다.
- unusedPeriodTime 또는 removeCycle가 0으로 설정 시 실시간 제거를 하지 않습니다.

API

public static void Initialize(int maxCount, int maxSize, double reRequestTime, CacheRequestType defaultRequestType, double unusedPeriodTime, double removeCycle)

Example

public void Something()
{
    int maxCount = 10000;
    int maxSize = 5 * 1024 * 1024; // 5 MB
    double reRequestTime = 30 * 24 * 60 * 60; // 30 Days
    CacheRequestType defaultRequestType = CacheRequestType.FIRSTPLAY;
    double unusedPeriodTime = 365 * 24 * 60 * 60; // 1 Years
    double removeCycle = 1; // 1 Seconds
             
    GpmCacheStorage.Initialize(maxCount, maxSize, reRequestTime, defaultRequestType, unusedPeriodTime, removeCycle);
}

Request

url로 데이터를 요청합니다. 캐시된 데이터와 웹 데이터가 동일한 데이터인 경우 캐시된 데이터를 사용합니다.

url
- 요청할 캐시 경로입니다.
requestType
- 캐시된 데이터를 언제 서버에 다시 검증할지를 결정하는 타입입니다.
- 인자를 사용하지 않으면 Initialize에서 설정한 기본값을 사용합니다.
reRequestTime
- 함수 별로 재검증 요청 주기를 설정할 수 있습니다.
- 기준은 초입니다. 10으로 설정한 다면 10초가 지난 캐시는 재검증합니다.
- 인자가 0이거나 사용하지 않으면 Initialize에서 설정한 기본값을 사용합니다.

API

public static CacheRequestOperation Request(string url, Action<GpmCacheResult> onResult)

public static CacheRequestOperation Request(string url, CacheRequestType requestType, Action<GpmCacheResult> onResult)

public static CacheRequestOperation Request(string url, double reRequestTime, Action<GpmCacheResult> onResult)

public static CacheRequestOperation Request(string url, CacheRequestType requestType, double reRequestTime, Action<GpmCacheResult> onResult)

Example

public void Something()
{
    string url;
    GpmCacheStorage.Request(url, (GpmCacheResult result) =>
    {
        if (result.IsSuccess() == true)
        {
            bytes[] data = result.Data;
        }
    });
}

public IEnumerator Something()
{
    string url;
    bytes[] data;
    yield return GpmCacheStorage.Request(url, CacheRequestType.ONCE, (GpmCacheResult result) =>
    {
        if (result.IsSuccess() == true)
        {
            data = result.Data;
        }
    });
}

GpmCacheResult

캐시된 데이터의 결괏값입니다. 캐시 정보와 데이터를 반환합니다.

IsSuccess 통해 성공 여부를 받아올 수 있습니다.
기본적으로 데이터는 Data로 저장됩니다.
Text나 Json은 인코딩을 통해 변환할 수 있으며 기본값은 utf8입니다.

API

bool IsSuccess() // 결과 성공 여부를 반환합니다.
CacheInfo Info; // 캐시 정보를 반환합니다.
byte[] Data;  // 캐시 데이터를 반환합니다.
string Text;  // utf8로 인코딩된 데이터를 반환합니다.

string GetTextData() // utf8로 인코딩된 데이터를 반환합니다.
string GetTextData(Encoding encoding) // 인코딩된 데이터를 반환합니다.

T GetJsonData<T>() // utf8로 인코딩된 json 데이터를 반환합니다.
T GetJsonData<T>(Encoding encoding) // utf8로 인코딩된 json 데이터를 반환합니다.

Example

public void Something()
{
    string url;
    GpmCacheStorage.Request(url, (GpmCacheResult result) =>
    {
        // success
        if (result.IsSuccess() == true)
        {
            // date
            bytes[] data = result.Data;

            // text - Encoding.UTF8
            string text = result.Text;

            // text - Encoding.UTF8
            text = result.GetTextData();

            // text - Encoding.Default
            text = result.GetTextData(Encoding.Default);    

            // json - Encoding.UTF8
            JsonClass json = result.GetJsonData<JsonClass>();

            // json - Encoding.Default
            json = result.GetJsonData<JsonClass>(Encoding.Default);           
        }
    });
}

CacheRequestOperation

캐시를 요청할 때 반환 값입니다. 캐시 요청 상태를 알 수 있습니다.

코루틴에서 대기할 수 있습니다.
캐시 요청을 취소할 수도 있습니다.

API

bool keepWaiting() // 코루틴에서 대기 할 것인지를 반환합니다.
void Cancel() // 요청을 취소합니다. 취소한 요청은 콜백이 전달되지 않습니다.

Example

using Gpm.CacheStorage;

public IEnumerator Something()
{
    bytes[] data;
    string url;
    CacheRequestOperation op = GpmCacheStorage.Request(url, (GpmCacheResult result) =>
    {
        if (result.IsSuccess() == true)
        {
            data = result.Data;
        }
    });

    while(op.keepWaiting() == true)
    {
        yield return null;
    }
}

public IEnumerator Something()
{
    bytes[] data;
    string url;
    CacheRequestOperation op = GpmCacheStorage.Request(url, (GpmCacheResult result) =>
    {
        if (result.IsSuccess() == true)
        {
            data = result.Data;
        }
    });

    // Cancel
    op.Cancel();

    yield return op;
}

RequestHttpCache

url로 데이터를 요청합니다. 캐시된 데이터와 웹 데이터가 동일한 데이터인 경우 캐시된 데이터를 사용합니다.

API

public static CacheRequestOperation RequestHttpCache(string url, Action<GpmCacheResult> onResult)

Example

public void Something()
{
    string url;
    GpmCacheStorage.RequestHttpCache(url, (GpmCacheResult result) =>
    {
        if (result.IsSuccess() == true)
        {
            bytes[] data = result.Data;
        }
    });
}

public IEnumerator Something()
{
    string url;
    bytes[] data;
    yield return GpmCacheStorage.RequestHttpCache(url, (GpmCacheResult result) =>
    {
        if (result.IsSuccess() == true)
        {
            data = result.Data;
        }
    });
}

RequestLocalCache

url로 이미 캐시된 데이터를 요청합니다. 캐시 되어있지 않은 경우 실패합니다.

API

public static CacheRequestOperation RequestLocalCache(string url, Action<GpmCacheResult> onResult)

Example

public void Something()
{
    string url;
    GpmCacheStorage.RequestLocalCache(url, (GpmCacheResult result) =>
    {
        if (result.IsSuccess() == true)
        {
            bytes[] data = result.Data;
        }
    });
}

GetCachedTexture

url로 이미 캐시된 텍스처를 요청합니다. 앱 실행 후 로드한 텍스처라면 재사용합니다.

API

public static CacheRequestOperation GetCachedTexture(string url, Action<CachedTexture> onResult)

Example

public void Something()
{
    string url;
    GpmCacheStorage.GetCachedTexture(url, (CachedTexture cachedTexture) =>
    {
        if (cachedTexture != null)
        {
            Texture texture = cachedTexture.texture;
        }
    });
}

RequestTexture

url로 캐시된 데이터를 요청합니다. 앱 실행 후 로드한 텍스처라면 재사용합니다. 캐시된 데이터와 웹 데이터가 동일한 데이터인 경우 캐시된 텍스처를 로드하여 사용합니다.

url
- 요청할 캐시 경로입니다.
requestType
- 캐시된 데이터를 언제 서버에 다시 검증할지를 결정하는 타입입니다.
- 인자를 사용하지 않으면 Initialize에서 설정한 기본값을 사용합니다.
reRequestTime
- 함수 별로 재검증 요청 주기를 설정할 수 있습니다.
- 마지막 검증한 이후 설정한 시간(초 단위)가 지나면 재검증합니다.
- 인자가 0이거나 사용하지 않으면 Initialize에서 설정한 기본값을 사용합니다.
preLoad
- 웹에 검증하기 전에 미리 저장된 캐시를 읽어옵니다.
- 검증 이후 콘텐츠가 바뀌었을 경우 콜백이 다시 호출됩니다.

API

public static CacheRequestOperation RequestTexture(string url, Action<CachedTexture> onResult)

public static CacheRequestOperation RequestTexture(string url, bool preLoad, Action<CachedTexture> onResult)

public static CacheRequestOperation RequestTexture(string url, CacheRequestType requestType, Action<CachedTexture> onResult)

public static CacheRequestOperation RequestTexture(string url, CacheRequestType requestType, bool preLoad, Action<CachedTexture> onResult)

public static CacheRequestOperation RequestTexture(string url, double reRequestTime, Action<CachedTexture> onResult)

public static CacheRequestOperation RequestTexture(string url, double reRequestTime,  bool preLoad, Action<CachedTexture> onResult)

public static CacheRequestOperation RequestTexture(string url, CacheRequestType requestType, double reRequestTime, bool preLoad, Action<CachedTexture> onResult)

Example

public void Something()
{
    string url;
    GpmCacheStorage.RequestTexture(url, (CachedTexture cachedTexture) =>
    {
        if (cachedTexture != null)
        {
            Texture texture = cachedTexture.texture;
        }
    });
}

public IEnumerator Something()
{
    string url;
    Texture texture;
    yield return GpmCacheStorage.RequestTexture(url, true, (CachedTexture cachedTexture) =>
    {
        if (cachedTexture != null)
        {
            texture = cachedTexture.texture;
        }
    });
}

CachedTexture

캐시된 텍스쳐의 결괏값입니다. 캐시 정보를 반환합니다.

캐시된 텍스쳐를 받아올 수 있습니다.
updateData를 통해 텍스쳐 변경 여부를 알 수 있습니다.

API

CacheInfo info // 캐시 정보를 반환합니다.
Texture2D texture; // 결과 텍스쳐를 반환합니다.
bool requested;  // true일 때 웹에서 새로 받은 요청입니다.
bool updateData;  // true일 때 새롭게 업데이트된 텍스쳐입니다.

void DestroyTexture() // 텍스쳐를 파괴하고 관리되는 텍스쳐에서도 제외합니다.
void ReleaseCache() // 관리되는 텍스쳐에서 제외합니다. 텍스쳐를 파괴하지는 않습니다.

Example

public void Something()
{
    string url;
    GpmCacheStorage.RequestTexture(url, (CachedTexture cachedTexture) =>
    {
        if (cachedTexture != null)
        {
            // texture
            Texture texture = cachedTexture.texture;

            // requested
            bool requested = cachedTexture.requested;

            // updateData
            bool updateData = cachedTexture.updateData;

            // DestroyTexture
            cachedTexture.DestroyTexture();

            // ReleaseCache
            cachedTexture.ReleaseCache();
        }
    });
}

GetCacheSize

관리 중인 캐시 용량을 알 수 있습니다.

API

public static long GetCacheSize()

Example

public long GetCacheSize()
{
    return GpmCacheStorage.GetCacheSize();
}

GetMaxSize

관리할 최대 캐시 용량을 알 수 있습니다.

API

public static long GetMaxSize()

Example

public long GetMaxSize()
{
    return GpmCacheStorage.GetMaxSize();
}

GetCacheCount

관리 중인 캐시 수를 알 수 있습니다.

API

public static int GetCacheCount()

Example

public int GetCacheCount()
{
    return GpmCacheStorage.GetCacheCount();
}

GetMaxCount

관리할 최대 캐시 개수를 알 수 있습니다.

API

public static int GetMaxCount()

Example

public int GetMaxCount()
{
    return GpmCacheStorage.GetMaxCount();
}

GetReRequestTime

웹캐시 재요청 시간을 알 수 있습니다.

API

public static double GetReRequestTime()

Example

public double GetReRequestTime()
{
    return GpmCacheStorage.GetReRequestTime();
}

GetCacheRequestType

GpmCacheStorage.Request를 요청할 때 적용되는 CacheRequestType를 알 수 있습니다.

API

public static CacheRequestType GetCacheRequestType()

Example

public CacheRequestType GetCacheRequestType()
{
    return GpmCacheStorage.GetCacheRequestType();
}

GetUnusedPeriodTime

불필요한 에셋의 삭제 기간을 알 수 있습니다.

API

public static double GetUnusedPeriodTime()

Example

public double GetUnusedPeriodTime()
{
    return GpmCacheStorage.GetUnusedPeriodTime();
}

GetRemoveCycle

지연 삭제 주기를 알 수 있습니다.

API

public static double GetRemoveCycle()

Example

public double GetRemoveCycle()
{
    return GpmCacheStorage.GetRemoveCycle();
}

ClearCache

관리 중인 모든 캐시를 제거합니다.

API

public static void ClearCache()

Example

public void ClearCache()
{
    GpmCacheStorage.ClearCache();
}

RemoveCache

관리 중인 캐시를 제거합니다.

API

public static void RemoveCache()

Example

public bool RemoveCache()
{
    string url;
    if( GpmCacheStorage.RemoveCache(url) == true)
    {
        // removed
    }
}

Files

README.md

Latest commit

History

README.md

File metadata and controls

CacheStorage

🚩 목차

개요

성능 향상

간편한 사용

용량 관리

설치

스펙

Unity 지원 버전

사용 방법

NameSpace

Initialize

Request

CacheRequestConfiguration

GpmCacheResult

CacheRequestOperation

코루틴 대기하기

요청 취소하기

텍스처 캐싱 요청

요청

설정값 추가

코루틴 사용

CachedTexture

더 효과적인 웹 캐시 사용

웹 캐시 검증 전략

캐시 검증 및 성능

웹 캐시 유효 기간

웹 캐시 시간 제어

웹 캐시의 활용

CacheRequestConfiguration

Viewer

1. Management

2. Request Info

3. Auto Remove

4. 캐시 데이터 리스트

5. 캐시 상세 정보

API

Initialize

Request

GpmCacheResult

CacheRequestOperation

RequestHttpCache

RequestLocalCache

GetCachedTexture

RequestTexture

CachedTexture

GetCacheSize

GetMaxSize

GetCacheCount

GetMaxCount

GetReRequestTime

GetCacheRequestType

GetUnusedPeriodTime

GetRemoveCycle

ClearCache

RemoveCache