Xamarin.Essentials 體驗 1 : File System Helpers 檔案系統存取

根據 Xamarin.Essentials 官方文件中指出：Xamarin.Essentials 跨平台應用程式開發介面的開發人員提供他們的行動應用程式。透過 Xamarin.Essentials 的套件幫忙，可以將這些功能整合到您的應用程式：加速計 應用程式資訊 電池 剪貼簿 指南針 資料傳輸 裝置顯示資訊 裝置資訊 電子郵件 檔案系統的協助程式 手電筒 地理編碼 地理位置 迴轉儀 磁力計 開啟瀏覽器 電話撥號員 喜好設定 螢幕鎖定 安全儲存體 SMS 文字轉換語音 追蹤版本 震動。

我們首先來體驗關於 File System Helpers 檔案系統的協助程式 這項功能，因此，可以參考底下的專案範例，該專案範例位於 https://github.com/vulcanlee/xamarin-forms-sample2018/tree/master/XFESFileSystem

建立測試專案

• 首先，我們先使用 Prism Template Pack 擴充功能所提供的專案樣板，建立起一個 Xamarin.Forms 專案，在這裡我們僅選擇 Android / iOS / UWP 類型的專案；接著，我們需要把 PropertyChanged.Fody NuGet 套件安裝到 .NET Standard 專案類別庫內，並且安裝 FodyWeavers.xml 檔案。
• 緊接著，我們要開始安裝 Xamarin.Essentials NuGet 套件到所有的專案內，在這裡，請使用滑鼠右擊方案節點，選擇 管理方案的 NuGet 套件 選項
• 請在 NuGet - 解決方案 的視窗中，輸入要搜尋的套件名稱 : Xamarin.Essentials
  並且，請勾選 包括搶鮮版 的文字檢查盒，並且安裝這個套件；我寫這篇文章的時候，Xamarin.Essentials 的最新版本為 0.7.0.17 版本，因此，我們安裝這個版本。
  
  
• 當 Xamarin.Essentials 套件安裝完成之後，您將會發現到在 Visual Studio 2017 的錯誤視窗中，出現了底下錯誤訊息

偵測到 Xamarin.Android.Support.Compat 的版本衝突。請直接從專案參考套件，以解決此問題。 
 XFESFileSystem.Android -> Xamarin.Essentials 0.7.0.17-preview -> Xamarin.Android.Support.CustomTabs 27.0.2 -> Xamarin.Android.Support.Compat (= 27.0.2) 
 XFESFileSystem.Android -> Xamarin.Android.Support.Design 25.4.0.2 -> Xamarin.Android.Support.Compat (= 25.4.0.2).

• 現在讓我們來修正這個錯誤，在這裡，我使用了 Visual Studio Code 開啟了 Android 專案下的 .csproj 檔案，請搜尋這個關鍵字 PackageReference Include="Xamarin.Essentials"
  此時，您將會看到底下的內容

  <ItemGroup>
    <PackageReference Include="Xamarin.Essentials">
      <Version>0.7.0.17-preview</Version>
    </PackageReference>
    <PackageReference Include="Xamarin.Forms" Version="2.5.0.122203" />
    <PackageReference Include="Xamarin.Android.Support.Design" Version="25.4.0.2" />
    <PackageReference Include="Xamarin.Android.Support.v7.AppCompat" Version="25.4.0.2" />
    <PackageReference Include="Xamarin.Android.Support.v4" Version="25.4.0.2" />
    <PackageReference Include="Xamarin.Android.Support.v7.CardView" Version="25.4.0.2" />
    <PackageReference Include="Xamarin.Android.Support.v7.MediaRouter" Version="25.4.0.2" />
    <PackageReference Include="Prism.Unity.Forms" Version="7.0.0.396" />
  </ItemGroup>

• 我們需要將 Xamarin.Android.Support.xxx 的套件，全部都變更成從 "25.4.0.2" 到 "27.0.2.1"
  修改完成結果如下所示，請進行存檔該 .csproj 檔案，並且回到 Visual Studio 2017 下，此時，將會重新載入這個 Android 專案

  <ItemGroup>
    <PackageReference Include="Xamarin.Essentials">
      <Version>0.7.0.17-preview</Version>
    </PackageReference>
    <PackageReference Include="Xamarin.Forms" Version="2.5.0.122203" />
    <PackageReference Include="Xamarin.Android.Support.Design" Version="27.0.2.1" />
    <PackageReference Include="Xamarin.Android.Support.v7.AppCompat" Version="27.0.2.1" />
    <PackageReference Include="Xamarin.Android.Support.v4" Version="27.0.2.1" />
    <PackageReference Include="Xamarin.Android.Support.v7.CardView" Version="27.0.2.1" />
    <PackageReference Include="Xamarin.Android.Support.v7.MediaRouter" Version="27.0.2.1" />
    <PackageReference Include="Prism.Unity.Forms" Version="7.0.0.396" />
  </ItemGroup>

• 現在，我們需要安裝 Xamarin.Android.Support.CustomTabs 這個套件到 Android 專案下，在這個時間點，我們將會安裝最新版本的 "27.0.2.1"
  
• 如此，最初產生的錯誤訊息便會消失了。
• 我們將開始要進行 View ViewModel Model 的設計了，首先，我們開啟 MainPage.xaml 這個檔案，底下是我們測試的頁面 XAML 語法
  這個頁面相當的精簡，有兩個文字輸入盒，用來讓使用者輸入帳號或者密碼，接著，有三個按鈕，可以清空剛剛輸入的內容、將輸入的帳號與密碼儲存到檔案內或者從檔案內讀取出來。在這裡，我們將會要把檔案寫到應用程式的 sandbox 沙箱資料夾內。

<?xml version="1.0" encoding="utf-8" ?>
<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             x:Class="XFESFileSystem.Views.MainPage"
             Title="Xamarin.Essentials： 檔案系統的協助程式">

    <StackLayout HorizontalOptions="CenterAndExpand" VerticalOptions="CenterAndExpand">
        <Label Text="Welcome to Xamarin Forms and Prism!" />
        <Entry Text="{Binding Account}"
               Placeholder="請輸入帳號"/>
        <Entry Text="{Binding Password}" IsPassword="True"
               Placeholder="請輸入密碼"/>
        <StackLayout
            Orientation="Horizontal">
            <Button Text="清空" Command="{Binding CleanCommand}"/>
            <Button Text="儲存" Command="{Binding SaveCommand}"/>
            <Button Text="讀取" Command="{Binding ReadCommand}"/>
        </StackLayout>
    </StackLayout>

</ContentPage>

• 請打開 MainPageViewModel.cs 這個檔案
  在這個檔案中，我們定義一個類別 MyUser，其目的是要把讀取或者寫入到檔案的資料，先填入到這個類別的物件內，緊接著透過 Json.NET 套件，將這個物件進行 JSON 的序列化或者反序列化；也就是說，當要寫入到檔案前，我們先取得該物件的 JSON 序列化文字，緊接著把這些字串寫入到檔案內；若要讀取出來的話，則反向操作，先從檔案讀出文字，接著將 JSON 文字反序列化成為 .NET 物件。
  當要讀寫檔案的時候，我們需要指定該應用程式沙箱的目錄位置，我們可以透過 Xamarin.Essentials.FileSystem.AppDataDirectory 屬性來取得各個原生平台的應用程式 sandbox 目錄名稱，接著，使用 System.IO.Path.Combine 建立起該檔案的完整路徑名稱，最後，透過 .NET Standard 中的 System.IO.File 功能，進行檔案的存取。

using Prism.Commands;
using Prism.Mvvm;
using Prism.Navigation;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace XFESFileSystem.ViewModels
{
    using System.ComponentModel;
    using Prism.Events;
    using Prism.Navigation;
    using Prism.Services;
    public class MainPageViewModel : INotifyPropertyChanged, INavigationAware
    {
        public event PropertyChangedEventHandler PropertyChanged;
        public string Account { get; set; }
        public string Password { get; set; }
        public DelegateCommand CleanCommand { get; set; }
        public DelegateCommand SaveCommand { get; set; }
        public DelegateCommand ReadCommand { get; set; }
        private readonly INavigationService _navigationService;

        public MainPageViewModel(INavigationService navigationService)
        {
            _navigationService = navigationService;
            CleanCommand = new DelegateCommand(() =>
            {
                Account = "";
                Password = "";
            });
            SaveCommand = new DelegateCommand(() =>
            {
                var foo = new MyUser()
                {
                    Account = Account,
                    Password = Password,
                };
                var fooSerial = Newtonsoft.Json.JsonConvert.SerializeObject(foo);
                var mainDir = Xamarin.Essentials.FileSystem.AppDataDirectory;
                var fileName = System.IO.Path.Combine(mainDir, "MyData.txt");
                System.IO.File.WriteAllText(fileName, fooSerial);
            });
            ReadCommand = new DelegateCommand(() =>
            {
                var mainDir = Xamarin.Essentials.FileSystem.AppDataDirectory;
                var fileName = System.IO.Path.Combine(mainDir, "MyData.txt");
                var fooSerial= System.IO.File.ReadAllText(fileName);
                var foo = Newtonsoft.Json.JsonConvert.DeserializeObject<MyUser>(fooSerial);
                if(foo!=null)
                {
                    Account = foo.Account;
                    Password = foo.Password;
                }
            });
        }

        public void OnNavigatedFrom(NavigationParameters parameters)
        {

        }

        public void OnNavigatingTo(NavigationParameters parameters)
        {

        }

        public void OnNavigatedTo(NavigationParameters parameters)
        {

        }

    }

    public class MyUser
    {
        public string Account { get; set; }
        public string Password { get; set; }
    }
}

• Android 平台執行結果
  
• UWP 平台執行結果