タイムゾーンの保存と復元

[アーティクル]
04/07/2023

TimeZoneInfo クラスは、定義済みのタイムゾーンデータを取得するためにレジストリに依存しています。ただし、レジストリは動的な構造です。また、レジストリに含まれているタイムゾーン情報は、主に現在の年の時間調整と変換を処理するためにオペレーティングシステムによって使用されます。これにより、正確なタイムゾーンデータに依存するアプリケーションには、次の 2 つの大きな影響があります。

アプリケーションで必要とされているタイムゾーンがレジストリに定義されていなかったり、名前変更されたり、レジストリから削除されたりしている可能性があります。
レジストリに定義されているタイムゾーンには、過去のタイムゾーン変換に必要な特定の調整規則に関する情報が含まれていない場合があります。

TimeZoneInfo クラスでは、タイムゾーンデータのシリアル化 (保存) と逆シリアル化 (復元) をサポートすることで、これらの制限に対処します。

タイムゾーンのシリアル化と逆シリアル化

タイムゾーンデータをシリアル化および逆シリアル化してタイムゾーンを保存および復元することに関係するのは、次の 2 つのメソッド呼び出しだけです。

ToSerializedString オブジェクトのシリアル化は、オブジェクトの TimeZoneInfo メソッドを呼び出すことによって行えます。このメソッドは、パラメーターを受け取らず、タイムゾーン情報を含む文字列を返します。
シリアル化された文字列から TimeZoneInfo オブジェクトを逆シリアル化することは、static (Visual Basic では Shared) TimeZoneInfo.FromSerializedString メソッドにその文字列を渡すことによって行えます。

シリアル化と逆シリアル化のシナリオ

TimeZoneInfo オブジェクトを文字列に保存 (またはシリアル化) し、後で使用できるように復元 (または逆シリアル化) する機能により、TimeZoneInfo クラスの利便性と柔軟性が向上します。このセクションでは、シリアル化と逆シリアル化が最も役立ついくつかの状況を調べます。

アプリケーション内のタイムゾーンデータのシリアル化と逆シリアル化

必要なときに、文字列から、シリアル化されたタイムゾーンを復元できます。アプリケーションでは、レジストリから取得したタイムゾーンで特定の日付範囲内の日付と時刻を正しく変換できない場合に、このような処理が実行される可能性があります。たとえば、Windows XP レジストリのタイムゾーンデータでは 1 つの調整規則がサポートされていますが、Windows Vista レジストリで定義されているタイムゾーンでは通常、2 つの調整規則に関する情報が提供されます。これは、過去の時刻変換が不正確になるおそれがあることを意味します。タイムゾーンデータのシリアル化と逆シリアル化では、この制限に対処できます。

次の例では、カスタムの TimeZoneInfo クラスには、米国東部標準タイムゾーンを 1883 年から 1917 年の期間 (米国に夏時間が導入される前) について表現するための調整規則が定義されていません。カスタムタイムゾーンは、グローバルスコープを持つ変数にシリアル化されます。タイムゾーンの変換メソッド ConvertUtcTime には、変換する協定世界時 (UTC) の時刻が渡されます。日付と時刻が 1917 年以前である場合は、シリアル化された文字列からカスタム東部標準タイムゾーンが復元され、レジストリから取得したタイムゾーンは置き換えられます。

using System;

public class TimeZoneSerialization
{
   static string serializedEst;

   public static void Main()
   {
      // Retrieve Eastern Standard Time zone from registry
      try
      {
         TimeZoneSerialization tzs = new TimeZoneSerialization();
         TimeZoneInfo est = TimeZoneInfo.FindSystemTimeZoneById("Eastern Standard Time");
         // Create custom Eastern Time Zone for historical (pre-1918) conversions
         CreateTimeZone();
         // Call conversion function with one current and one pre-1918 date and time
         Console.WriteLine(ConvertUtcTime(DateTime.UtcNow, est));
         Console.WriteLine(ConvertUtcTime(new DateTime(1900, 11, 15, 9, 32, 00, DateTimeKind.Utc), est));
      }
      catch (TimeZoneNotFoundException)
      {
         Console.WriteLine("The Eastern Standard Time zone is not in the registry.");
      }
      catch (InvalidTimeZoneException)
      {
         Console.WriteLine("Data on the Eastern Standard Time Zone in the registry is corrupted.");
      }
   }

   private static void CreateTimeZone()
   {
      // Create a simple Eastern Standard time zone
      // without adjustment rules for 1883-1918
      TimeZoneInfo earlyEstZone = TimeZoneInfo.CreateCustomTimeZone("Eastern Standard Time",
                                      new TimeSpan(-5, 0, 0),
                                      " (GMT-05:00) Eastern Time (United States)",
                                      "Eastern Standard Time");
      serializedEst = earlyEstZone.ToSerializedString();
   }

   private static DateTime ConvertUtcTime(DateTime utcDate, TimeZoneInfo tz)
   {
      // Use time zone object from registry
      if (utcDate.Year > 1917)
      {
         return TimeZoneInfo.ConvertTimeFromUtc(utcDate, tz);
      }
      // Handle dates before introduction of DST
      else
      {
         // Restore serialized time zone object
         tz = TimeZoneInfo.FromSerializedString(serializedEst);
         return TimeZoneInfo.ConvertTimeFromUtc(utcDate, tz);
      }
   }
}

Module TimeZoneSerialization
    Dim serializedEst As String

    Public Sub Main()
        ' Retrieve Eastern Standard Time zone from registry
        Try
            Dim est As TimeZoneInfo = TimeZoneInfo.FindSystemTimeZoneById("Eastern Standard Time")
            ' Create custom Eastern Time Zone for historical (pre-1918) conversions
            CreateTimeZone()
            ' Call conversion function with one current and one pre-1918 date and time
            Console.WriteLine(ConvertUtcTime(Date.UtcNow, est))
            Console.WriteLine(ConvertUtcTime(New Date(1900, 11, 15, 9, 32, 00, DateTimeKind.Utc), est))
        Catch e As TimeZoneNotFoundException
            Console.WriteLine("The Eastern Standard Time zone is not in the registry.")
        Catch e As InvalidTimeZoneException
            Console.WriteLine("Data on the Eastern Standard Time Zone in the registry is corrupted.")
        End Try
    End Sub

    Private Sub CreateTimeZone()
        ' Create a simple Eastern Standard time zone 
        ' without adjustment rules for 1883-1918
        Dim earlyEstZone As TimeZoneInfo = TimeZoneInfo.CreateCustomTimeZone("Eastern Standard Time", _
                                        New TimeSpan(-5, 0, 0), _
                                        " (GMT-05:00) Eastern Time (United States)", _
                                        "Eastern Standard Time")
        serializedEst = earlyEstZone.ToSerializedString()
    End Sub

    Private Function ConvertUtcTime(utcDate As Date, tz As TimeZoneInfo) As Date
        ' Use time zone object from registry 
        If Year(utcDate) > 1917 Then
            Return TimeZoneInfo.ConvertTimeFromUtc(utcDate, tz)
            ' Handle dates before introduction of DST
        Else
            ' Restore serialized time zone object
            tz = TimeZoneInfo.FromSerializedString(serializedEst)
            Return TimeZoneInfo.ConvertTimeFromUtc(utcDate, tz)
        End If
    End Function
End Module

タイムゾーンの例外を処理する

レジストリは動的な構造であるため、その内容は誤ってまたは意図的に変更される可能性があります。これは、レジストリに定義されていなければならない、アプリケーションの正常実行に必要なタイムゾーンが欠落している場合もあるということです。タイムゾーンのシリアル化と逆シリアル化をサポートしていない場合は、結果として発生する TimeZoneNotFoundException を、アプリケーションを終了することで処理するしかありません。しかし、タイムゾーンのシリアル化と逆シリアル化を使用すれば、シリアル化された文字列から必要なタイムゾーンを復元して予期しない TimeZoneNotFoundException を処理でき、アプリケーションは継続して実行されます。

次の例では、カスタムの中部標準時のタイムゾーンを作成してシリアル化します。その後、レジストリから中部標準時のタイムゾーンを取得しようとします。取得操作によって TimeZoneNotFoundException または InvalidTimeZoneException のいずれかがスローされた場合、例外ハンドラーによってタイムゾーンが逆シリアル化されます。

using System;
using System.Collections.Generic;

public class TimeZoneApplication
{
   // Define collection of custom time zones
   private Dictionary<string, string> customTimeZones = new Dictionary<string, string>();
   private TimeZoneInfo cst;

   public TimeZoneApplication()
   {
      // Create custom Central Standard Time
      //
      // Declare necessary TimeZoneInfo.AdjustmentRule objects for time zone
      TimeZoneInfo customTimeZone;
      TimeSpan delta = new TimeSpan(1, 0, 0);
      TimeZoneInfo.AdjustmentRule adjustment;
      List<TimeZoneInfo.AdjustmentRule> adjustmentList = new List<TimeZoneInfo.AdjustmentRule>();
      // Declare transition time variables to hold transition time information
      TimeZoneInfo.TransitionTime transitionRuleStart, transitionRuleEnd;

      // Define end rule (for 1976-2006)
      transitionRuleEnd = TimeZoneInfo.TransitionTime.CreateFloatingDateRule(new DateTime(1, 1, 1, 2, 0, 0), 10, 5, DayOfWeek.Sunday);
      // Define rule (1976-1986)
      transitionRuleStart = TimeZoneInfo.TransitionTime.CreateFloatingDateRule(new DateTime(1, 1, 1, 2, 0, 0), 04, 05, DayOfWeek.Sunday);
      adjustment = TimeZoneInfo.AdjustmentRule.CreateAdjustmentRule(new DateTime(1976, 1, 1), new DateTime(1986, 12, 31), delta, transitionRuleStart, transitionRuleEnd);
      adjustmentList.Add(adjustment);
      // Define rule (1987-2006)
      transitionRuleStart = TimeZoneInfo.TransitionTime.CreateFloatingDateRule(new DateTime(1, 1, 1, 2, 0, 0), 04, 01, DayOfWeek.Sunday);
      adjustment = TimeZoneInfo.AdjustmentRule.CreateAdjustmentRule(new DateTime(1987, 1, 1), new DateTime(2006, 12, 31), delta, transitionRuleStart, transitionRuleEnd);
      adjustmentList.Add(adjustment);
      // Define rule (2007- )
      transitionRuleStart = TimeZoneInfo.TransitionTime.CreateFloatingDateRule(new DateTime(1, 1, 1, 2, 0, 0), 03, 02, DayOfWeek.Sunday);
      transitionRuleEnd = TimeZoneInfo.TransitionTime.CreateFloatingDateRule(new DateTime(1, 1, 1, 2, 0, 0), 11, 01, DayOfWeek.Sunday);
      adjustment = TimeZoneInfo.AdjustmentRule.CreateAdjustmentRule(new DateTime(2007, 01, 01), DateTime.MaxValue.Date, delta, transitionRuleStart, transitionRuleEnd);
      adjustmentList.Add(adjustment);

      // Create custom U.S. Central Standard Time zone
      customTimeZone = TimeZoneInfo.CreateCustomTimeZone("Central Standard Time",
                      new TimeSpan(-6, 0, 0),
                      "(GMT-06:00) Central Time (US Only)", "Central Standard Time",
                      "Central Daylight Time", adjustmentList.ToArray());
      // Add time zone to collection
      customTimeZones.Add(customTimeZone.Id, customTimeZone.ToSerializedString());

      // Create any other required time zones
   }

   public static void Main()
   {
      TimeZoneApplication tza = new TimeZoneApplication();
      tza.AppEntryPoint();
   }

   private void AppEntryPoint()
   {
      try
      {
         cst = TimeZoneInfo.FindSystemTimeZoneById("Central Standard Time");
      }
      catch (TimeZoneNotFoundException)
      {
         if (customTimeZones.ContainsKey("Central Standard Time"))
            HandleTimeZoneException("Central Standard Time");
      }
      catch (InvalidTimeZoneException)
      {
         if (customTimeZones.ContainsKey("Central Standard Time"))
            HandleTimeZoneException("Central Standard Time");
      }
      if (cst == null)
      {
         Console.WriteLine("Unable to load Central Standard Time zone.");
         return;
      }
      DateTime currentTime = DateTime.Now;
      Console.WriteLine("The current {0} time is {1}.",
                        TimeZoneInfo.Local.IsDaylightSavingTime(currentTime) ?
                            TimeZoneInfo.Local.StandardName :
                            TimeZoneInfo.Local.DaylightName,
                        currentTime.ToString("f"));
      Console.WriteLine("The current {0} time is {1}.",
                        cst.IsDaylightSavingTime(currentTime) ?
                            cst.StandardName :
                            cst.DaylightName,
                        TimeZoneInfo.ConvertTime(currentTime, TimeZoneInfo.Local, cst).ToString("f"));
   }

   private void HandleTimeZoneException(string timeZoneName)
   {
      string tzString = customTimeZones[timeZoneName];
      cst = TimeZoneInfo.FromSerializedString(tzString);
   }
}

Imports System.Collections.Generic

Public Class TimeZoneApplication
    ' Define collection of custom time zones
    Private customTimeZones As New Dictionary(Of String, String)
    Private cst As TimeZoneInfo

    Public Sub New()
        ' Define custom Central Standard Time
        '
        ' Declare necessary TimeZoneInfo.AdjustmentRule objects for time zone
        Dim customTimeZone As TimeZoneInfo
        Dim delta As New TimeSpan(1, 0, 0)
        Dim adjustment As TimeZoneInfo.AdjustmentRule
        Dim adjustmentList As New List(Of TimeZoneInfo.AdjustmentRule)
        ' Declare transition time variables to hold transition time information
        Dim transitionRuleStart, transitionRuleEnd As TimeZoneInfo.TransitionTime

        ' Define end rule (for 1976-2006)
        transitionRuleEnd = TimeZoneInfo.TransitionTime.CreateFloatingDateRule(#02:00:00AM#, 10, 5, DayOfWeek.Sunday)
        ' Define rule (1976-1986)
        transitionRuleStart = TimeZoneInfo.TransitionTime.CreateFloatingDateRule(#2:00:00AM#, 04, 05, DayOfWeek.Sunday)
        adjustment = TimeZoneInfo.AdjustmentRule.CreateAdjustmentRule(#01/01/1976#, #12/31/1986#, delta, transitionRuleStart, transitionRuleEnd)
        adjustmentList.Add(adjustment)
        ' Define rule (1987-2006)  
        transitionRuleStart = TimeZoneInfo.TransitionTime.CreateFloatingDateRule(#2:00:00AM#, 04, 01, DayOfWeek.Sunday)
        adjustment = TimeZoneInfo.AdjustmentRule.CreateAdjustmentRule(#01/01/1987#, #12/31/2006#, delta, transitionRuleStart, transitionRuleEnd)
        adjustmentList.Add(adjustment)
        ' Define rule (2007- )  
        transitionRuleStart = TimeZoneInfo.TransitionTime.CreateFloatingDateRule(#2:00:00AM#, 03, 02, DayOfWeek.Sunday)
        transitionRuleEnd = TimeZoneInfo.TransitionTime.CreateFloatingDateRule(#2:00:00AM#, 11, 01, DayOfWeek.Sunday)
        adjustment = TimeZoneInfo.AdjustmentRule.CreateAdjustmentRule(#01/01/2007#, Date.MaxValue.Date, delta, transitionRuleStart, transitionRuleEnd)
        adjustmentList.Add(adjustment)
        ' Create custom time zone
        customTimeZone = TimeZoneInfo.CreateCustomTimeZone("Central Standard Time", _
                        New TimeSpan(-6, 0, 0), _
                        "(GMT-06:00) Central Time (US Only)", "Central Standard Time", _
                        "Central Daylight Time", adjustmentList.ToArray())
        ' Add time zone to collection
        customTimeZones.Add(customTimeZone.Id, customTimeZone.ToSerializedString())

        ' Create any other required time zones     
    End Sub

    Public Shared Sub Main()
        Dim tza As New TimeZoneApplication()
        tza.AppEntryPoint()
    End Sub

    Private Sub AppEntryPoint()
        Try
            cst = TimeZoneInfo.FindSystemTimeZoneById("Central Standard Time")
        Catch e As TimeZoneNotFoundException
            If customTimeZones.ContainsKey("Central Standard Time")
                HandleTimeZoneException("Central Standard Time")
            End If
        Catch e As InvalidTimeZoneException
            If customTimeZones.ContainsKey("Central Standard Time")
                HandleTimeZoneException("Central Standard Time")
            End If
        End Try
        If cst Is Nothing Then
            Console.WriteLine("Unable to load Central Standard Time zone.")
            Return
        End If
        Dim currentTime As Date = Date.Now
        Console.WriteLine("The current {0} time is {1}.", _
                          IIf(TimeZoneInfo.Local.IsDaylightSavingTime(currentTime), _
                              TimeZoneInfo.Local.StandardName, _
                              TimeZoneInfo.Local.DaylightName), _
                          currentTime.ToString("f"))
        Console.WriteLine("The current {0} time is {1}.", _
                          IIf(cst.IsDaylightSavingTime(currentTime), _
                              cst.StandardName, _
                              cst.DaylightName), _
                          TimeZoneInfo.ConvertTime(currentTime, TimeZoneInfo.Local, cst).ToString("f"))
    End Sub

    Private Sub HandleTimeZoneException(timeZoneName As String)
        Dim tzString As String = customTimeZones.Item(timeZoneName)
        cst = TimeZoneInfo.FromSerializedString(tzString)
    End Sub
End Class

シリアル化された文字列を格納し、必要に応じて復元する

前の例では、タイムゾーン情報を文字列変数に格納し、必要に応じて復元しました。ただし、シリアル化されたタイムゾーン情報を含む文字列そのものを、外部ファイル、アプリケーションに埋め込まれているリソースファイル、レジストリなど、一部のストレージメディアに格納することができます (カスタムタイムゾーンに関する情報は、レジストリ内のシステムのタイムゾーンキーとは別に保存する必要があることにご注意ください)。

この方法でシリアル化されたタイムゾーン文字列を格納すると、タイムゾーン作成ルーチンもアプリケーション自体から分離されます。たとえば、タイムゾーン作成ルーチンを実行して、アプリケーションが使用できる過去のタイムゾーン情報が入ったデータファイルを作成できます。その後、データファイルをアプリケーションと共にインストールすることができます。アプリケーションで必要になったときにこれを開いて、1 つまたは複数のタイムゾーンを逆シリアル化できます。

埋め込みリソースを使用してシリアル化されたタイムゾーンデータを格納する例については、「方法: 埋め込みリソースにタイムゾーンを保存する」および「方法: 埋め込みリソースからタイムゾーンを復元する」をご覧ください。

次の方法で共有

タイムゾーンの保存と復元

タイムゾーンのシリアル化と逆シリアル化

シリアル化と逆シリアル化のシナリオ

アプリケーション内のタイムゾーンデータのシリアル化と逆シリアル化

タイムゾーンの例外を処理する

シリアル化された文字列を格納し、必要に応じて復元する

関連項目

その他のリソース

次の方法で共有

タイム ゾーンの保存と復元

タイム ゾーンのシリアル化と逆シリアル化

シリアル化と逆シリアル化のシナリオ

アプリケーション内のタイム ゾーン データのシリアル化と逆シリアル化

タイム ゾーンの例外を処理する

シリアル化された文字列を格納し、必要に応じて復元する

関連項目

その他のリソース

タイムゾーンの保存と復元

タイムゾーンのシリアル化と逆シリアル化

アプリケーション内のタイムゾーンデータのシリアル化と逆シリアル化

タイムゾーンの例外を処理する