【HTTP】304 Not Modifiedの意味と効果的なキャッシュ利用：更新不要レスポンスの仕組みと実装

using Microsoft.AspNetCore.Mvc;
using Microsoft.Net.Http.Headers;
using System;
namespace ExampleApp.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class ResourceController : ControllerBase
    {
        [HttpGet]
        public IActionResult Get()
        {
            var lastModified = new DateTime(2023, 10, 1);
            var etag = "12345";
            // クライアントからのIf-Modified-Sinceヘッダーを取得
            if (Request.Headers.ContainsKey(HeaderNames.IfModifiedSince))
            {
                var ifModifiedSince = DateTime.Parse(Request.Headers[HeaderNames.IfModifiedSince]);
                if (lastModified <= ifModifiedSince)
                {
                    // リソースが変更されていない場合、304を返す
                    return StatusCode(304);
                }
            }
            // クライアントからのIf-None-Matchヘッダーを取得
            if (Request.Headers.ContainsKey(HeaderNames.IfNoneMatch))
            {
                var ifNoneMatch = Request.Headers[HeaderNames.IfNoneMatch].ToString();
                if (etag == ifNoneMatch)
                {
                    // ETagが一致する場合、304を返す
                    return StatusCode(304);
                }
            }
            // リソースが変更されている場合、通常のレスポンスを返す
            var data = new { Message = "リソースの内容" };
            Response.Headers[HeaderNames.ETag] = etag;
            Response.Headers[HeaderNames.LastModified] = lastModified.ToString("R");
            return Ok(data);
        }
    }
}

# 上記のコードは、特定の条件下で304ステータスコードを返します。

using Microsoft.AspNetCore.Mvc;
using Microsoft.Net.Http.Headers;
using System;
namespace ExampleApp.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class CacheController : ControllerBase
    {
        [HttpGet]
        public IActionResult Get()
        {
            // リソースの作成日時
            var lastModified = new DateTime(2023, 10, 1);
            var etag = "abcde12345";
            // Cache-Controlヘッダーを設定(キャッシュの有効期間を3600秒に設定)
            Response.Headers[HeaderNames.CacheControl] = "public,max-age=3600";
            // ETagとLast-Modifiedヘッダーを設定
            Response.Headers[HeaderNames.ETag] = etag;
            Response.Headers[HeaderNames.LastModified] = lastModified.ToString("R");
            var data = new { Message = "キャッシュ可能なリソースの内容" };
            return Ok(data);
        }
    }
}

# 上記のコードは、キャッシュ制御ヘッダーを設定し、リソースをキャッシュ可能にします。

using Microsoft.AspNetCore.Mvc;
using Microsoft.Net.Http.Headers;
using System;
namespace ExampleApp.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class DetailedResourceController : ControllerBase
    {
        [HttpGet]
        public IActionResult Get()
        {
            // リソースの最終更新日時とETagを設定
            var lastModified = new DateTime(2023, 10, 1);
            var etag = "unique-etag-67890";
            // If-Modified-Sinceヘッダーの処理
            if (Request.Headers.ContainsKey(HeaderNames.IfModifiedSince))
            {
                var ifModifiedSince = DateTime.Parse(Request.Headers[HeaderNames.IfModifiedSince]);
                if (lastModified <= ifModifiedSince)
                {
                    // リソースが変更されていない場合、304を返す
                    return StatusCode(304);
                }
            }
            // If-None-Matchヘッダーの処理
            if (Request.Headers.ContainsKey(HeaderNames.IfNoneMatch))
            {
                var ifNoneMatch = Request.Headers[HeaderNames.IfNoneMatch].ToString();
                if (etag == ifNoneMatch)
                {
                    // ETagが一致する場合、304を返す
                    return StatusCode(304);
                }
            }
            // リソースが変更されている場合、通常のレスポンスを返す
            var responseData = new { Message = "詳細なリソースの内容" };
            Response.Headers[HeaderNames.ETag] = etag;
            Response.Headers[HeaderNames.LastModified] = lastModified.ToString("R");
            return Ok(responseData);
        }
        public static void Main(string[] args)
        {
            // アプリケーションの起動処理
        }
    }
}

# 上記のコードは、If-Modified-SinceおよびIf-None-Matchヘッダーを使用して304レスポンスを返します。

// ETagを生成する例(リソースの内容ハッシュを使用)
string GenerateETag(string content)
{
    using (var sha256 = SHA256.Create())
    {
        var hash = sha256.ComputeHash(Encoding.UTF8.GetBytes(content));
        return Convert.ToBase64String(hash);
    }
}

// Last-Modifiedヘッダーを設定する例
Response.Headers[HeaderNames.LastModified] = lastModified.ToUniversalTime().ToString("R");

// Cache-Controlヘッダーの設定例
Response.Headers[HeaderNames.CacheControl] = "public, max-age=3600";

using Microsoft.AspNetCore.Mvc;
using Microsoft.Net.Http.Headers;
using System;
using System.Security.Cryptography;
using System.Text;
namespace ExampleApp.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class BestPracticeController : ControllerBase
    {
        [HttpGet]
        public IActionResult Get()
        {
            // リソースの内容と最終更新日時
            string content = "サンプルリソースの内容";
            DateTime lastModified = new DateTime(2023, 10, 1);
            string etag = GenerateETag(content);
            // If-None-Matchヘッダーの処理
            if (Request.Headers.ContainsKey(HeaderNames.IfNoneMatch))
            {
                var ifNoneMatch = Request.Headers[HeaderNames.IfNoneMatch].ToString();
                if (etag == ifNoneMatch)
                {
                    // ETagが一致する場合、304を返す
                    return StatusCode(304);
                }
            }
            // If-Modified-Sinceヘッダーの処理
            if (Request.Headers.ContainsKey(HeaderNames.IfModifiedSince))
            {
                var ifModifiedSince = DateTime.Parse(Request.Headers[HeaderNames.IfModifiedSince]);
                if (lastModified <= ifModifiedSince)
                {
                    // リソースが変更されていない場合、304を返す
                    return StatusCode(304);
                }
            }
            // キャッシュヘッダーの設定
            Response.Headers[HeaderNames.ETag] = etag;
            Response.Headers[HeaderNames.LastModified] = lastModified.ToUniversalTime().ToString("R");
            Response.Headers[HeaderNames.CacheControl] = "public, max-age=3600";
            // 通常のレスポンスを返す
            var responseData = new { Message = content };
            return Ok(responseData);
        }
        // ETagを生成するメソッド
        private string GenerateETag(string content)
        {
            using (var sha256 = SHA256.Create())
            {
                var hash = sha256.ComputeHash(Encoding.UTF8.GetBytes(content));
                return Convert.ToBase64String(hash);
            }
        }
        public static void Main(string[] args)
        {
            // アプリケーションの起動処理
        }
    }
}

# 上記のコードは、ETagとLast-Modifiedを使用して条件付きリクエストを処理し、必要に応じて304レスポンスを返します。

try
{
    // リソースの処理ロジック
}
catch (Exception ex)
{
    // エラーログの記録
    // クライアントに500エラーを返す
    return StatusCode(500, "サーバー内部エラーが発生しました。");
}

Response.Headers[HeaderNames.CacheControl] = "no-store";