HoloLens2でホロモンアプリを作る その９１（ホロモンの状態をファイル保存する）

本日はアプリ作成枠です。
HoloLens2でホロモンアプリを作る進捗を書き留めていきます。

今回はホロモンの状態をファイル保存するメモです。

オブジェクトのXMLドキュメントへのシリアル化と書き出し

オブジェクトのXMLドキュメントへのシリアル化と書き出しを使ってホロモンの状態を保存します。
docs.microsoft.com

XMLドキュメントへのシリアル化の詳細は以下の記事を参照ください。
bluebirdofoz.hatenablog.com

ホロモンのコンディション情報をシリアル化を使ってファイルへの書き出しと読み込みを行います。

実装コード

以下のようなデータクラスと、ファイル書き出しと読み込みを行うクラスを実装しました。

クリックで展開

・HoloMonSaveData.cs

using System;
using System.Xml;
using System.Xml.Serialization;

using HoloMonApp.ConditionSpace;

namespace HoloMonApp.SaveDataSpace
{
    /// <summary>
    /// データファイル構造クラス
    /// </summary>
    [Serializable]
    public class HoloMonSaveData
    {
        /// <summary>
        /// 保存時刻
        /// </summary>
        public SaveDateTime SavedDataTime;

        /// <summary>
        /// 保存バージョン
        /// </summary>
        public SavePackageVersion SavedPackageVersion;

        /// <summary>
        /// ホロモンアプリの名前
        /// </summary>
        public string AppName;

        /// <summary>
        /// 身体状態
        /// </summary>
        public HoloMonBodyStatus BodyStatus;

        /// <summary>
        /// 生活状態
        /// </summary>
        public HoloMonLifeStatus LifeStatus;
    }
}

クリックで展開

・HoloMonDataXmlSerializer.cs

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

namespace HoloMonApp.SaveDataSpace
{
    // クラス名を別名でまとめて管理する
    using CUSTOMTYPE = HoloMonSaveData;

    public class HoloMonDataXmlSerializer
    {
        /// <summary>
        /// データファイル名(XML)のベース
        /// </summary>
        [SerializeField, Tooltip("データファイル名")]
        private string p_DataFileName = "HoloMonData.xml";

        /// <summary>
        /// データ読み込み
        /// </summary>
        public CUSTOMTYPE ReadData()
        {
            return XMLRead();
        }

        /// <summary>
        /// データ書き込み
        /// </summary>
        /// <param name="a_Data"></param>
        public void WriteData(CUSTOMTYPE a_Data)
        {
            XMLWrite(a_Data);
        }

        #region "シリアライズ処理"

        /// <summary>
        /// データファイル読み込み(XML)
        /// </summary>
        private CUSTOMTYPE XMLRead()
        {
            // 返却用データ
            CUSTOMTYPE data = null;

            // オブジェクトの型を指定して Serializer オブジェクトを作成する
            System.Xml.Serialization.XmlSerializer serializer;
            serializer = new System.Xml.Serialization.XmlSerializer(typeof(CUSTOMTYPE));

            // ファイルの存在確認
            if (System.IO.File.Exists(XMLFilePath()) == true)
            {
                // 読み込みファイルを開く
                System.IO.StreamReader streamreader;
#if WINDOWS_UWP
                // 読み込みファイルを開く(UWPアプリではStreamReader(filepath)メソッドは使用不可)
                streamreader = new System.IO.StreamReader((System.IO.Stream)System.IO.File.OpenRead(XMLFilePath()));
#else
                // 読み込みファイルを開く
                streamreader = new System.IO.StreamReader(XMLFilePath(), new System.Text.UTF8Encoding(false));
#endif
                // XMLファイルから逆シリアル化する
                data = (CUSTOMTYPE)serializer.Deserialize(streamreader);

#if WINDOWS_UWP
                // ファイルを閉じる(UWPアプリではClose()メソッドは使用不可)
                streamreader.Dispose();
#else
                // ファイルを閉じる
                streamreader.Close();
#endif
            }

            return data;
        }

        /// <summary>
        /// データファイル書き込み(XML)
        /// </summary>
        private void XMLWrite(CUSTOMTYPE a_Data)
        {
            // オブジェクトの型を指定して Serializer オブジェクトを作成する
            System.Xml.Serialization.XmlSerializer serializer;
            serializer = new System.Xml.Serialization.XmlSerializer(typeof(CUSTOMTYPE));

            // ディレクトリの存在確認
            if (System.IO.Directory.Exists(SettingFileDirectoryPath()) == true)
            {
                // UWPの場合は書き込み前に既存のファイルを削除する
#if WINDOWS_UWP
                // ファイルの存在確認
                if (System.IO.File.Exists(XMLFilePath()) == true)
                {
                    System.IO.File.Delete(XMLFilePath());
                }
#endif

                // 書き込みファイルを開く
                System.IO.StreamWriter streamwriter;
#if WINDOWS_UWP
                // 書き込みファイルを開く(UWPアプリではStreamWriter(filepath)メソッドは使用不可)
                streamwriter = new System.IO.StreamWriter((System.IO.Stream)System.IO.File.OpenWrite(XMLFilePath()));
#else
                // 書き込みファイルを開く
                streamwriter = new System.IO.StreamWriter(XMLFilePath(), false, new System.Text.UTF8Encoding(false));
#endif

                // シリアル化してXMLファイルに保存する
                serializer.Serialize(streamwriter, a_Data);

#if WINDOWS_UWP
                // ファイルを閉じる(UWPアプリではClose()メソッドは使用不可)
                streamwriter.Dispose();
#else
                // ファイルを閉じる
                streamwriter.Close();
#endif
            }
        }
        #endregion

        #region "ファイルパス生成処理"
        /// <summary>
        /// データファイルファイルパス(XML)
        /// 実行環境によって参照ディレクトリを変更する
        /// </summary>
        private string XMLFilePath()
        {
            string filepath = System.IO.Path.Combine(SettingFileDirectoryPath(), p_DataFileName);
            return filepath;
        }

        /// <summary>
        /// データファイルディレクトリパス
        /// 実行環境によって参照ディレクトリを変更する
        /// </summary>
        private string SettingFileDirectoryPath()
        {
            string directorypath = "";
#if WINDOWS_UWP
            // HoloLens上での動作の場合、LocalAppData/AppName/LocalStateフォルダを参照する
            directorypath = Windows.Storage.ApplicationData.Current.LocalFolder.Path;
#elif UNITY_IOS
            // iOS上での動作の場合、/var/mobile/Applications/アプリ番号/Documentsフォルダを参照する
            directorypath = UnityEngine.Application.persistentDataPath;
#else
            // Unity上での動作の場合、Assets/StreamingAssetsフォルダを参照する
            directorypath = UnityEngine.Application.streamingAssetsPath;
#endif
            return directorypath;
        }
#endregion
    }
}

データ保存を行うラッパークラスを作成してシーンに設定します。

動作確認

シーンを再生してファイル保存を実行してみました。
以下の通り、xml ファイルが出力されます。

内容を確認してみます。
以下の通り、HoloMonSaveData クラスで保持していた情報が XML ドキュメントに変換されて出力されています。

<?xml version="1.0" encoding="utf-8"?>
<HoloMonSaveData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SavedDataTime>
    <Value>2022-01-08T14:43:20.5614211+09:00</Value>
  </SavedDataTime>
  <SavedPackageVersion>
    <Major>0</Major>
    <Minor>0</Minor>
    <Build>0</Build>
    <Revision>0</Revision>
  </SavedPackageVersion>
  <AppName>TestApp</AppName>
  <BodyStatus>
    <Initialized>true</Initialized>
    <BirthTime>
      <LastUpdateDateTime>2022-01-08T14:41:25.1222331+09:00</LastUpdateDateTime>
      <Value>2022-01-08T14:41:25.1222331+09:00</Value>
    </BirthTime>
    <AgeOfDay>
      <LastUpdateDateTime>0001-01-01T00:00:00</LastUpdateDateTime>
      <Value>0</Value>
    </AgeOfDay>
    <BodyHeight>
      <LastUpdateDateTime>2022-01-08T14:41:54.4948806+09:00</LastUpdateDateTime>
      <Value>0.42</Value>
    </BodyHeight>
    <DefaultBodyHeight>
      <LastUpdateDateTime>2022-01-08T14:41:25.12323+09:00</LastUpdateDateTime>
      <Value>0.4</Value>
    </DefaultBodyHeight>
    <BodyPower>
      <LastUpdateDateTime>2022-01-08T14:41:55.116408+09:00</LastUpdateDateTime>
      <Value>0.02</Value>
    </BodyPower>
  </BodyStatus>
  <LifeStatus>
    <Initialized>true</Initialized>
    <HungryPercent>
      <LastUpdateDateTime>2022-01-08T14:41:55.116408+09:00</LastUpdateDateTime>
      <Value>70</Value>
    </HungryPercent>
    <HumorPercent>
      <LastUpdateDateTime>2022-01-08T14:41:25.1152605+09:00</LastUpdateDateTime>
      <Value>50</Value>
    </HumorPercent>
    <StaminaPercent>
      <LastUpdateDateTime>2022-01-08T14:41:25.1152605+09:00</LastUpdateDateTime>
      <Value>50</Value>
    </StaminaPercent>
    <PoopPercent>
      <LastUpdateDateTime>2022-01-08T14:41:25.1152605+09:00</LastUpdateDateTime>
      <Value>99</Value>
    </PoopPercent>
    <SleepinessLevel>
      <LastUpdateDateTime>0001-01-01T00:00:00</LastUpdateDateTime>
      <Value>Nothing</Value>
    </SleepinessLevel>
  </LifeStatus>
</HoloMonSaveData>