ファイルにログ出力する機能を作成する | Xamarin.Forms

2016/11/10
14:02

今回はファイルにログを出力する機能を作成するためのコードをご紹介いたします。

ただ単にログを出力する機能は.Net Framework で提供されていますが、それでは配布したアプリのログを取得することはできません。
System.Diagnostics.Debug.WriteLine
System.Diagnostics.Trace.WriteLine
System.Console.WriteLine

尚、ファイルにログを出力するには最低限以下の機能が必要になります。
（１）保存ディレクトリの取得機能
（２）ファイル書き込み機能
いずれもPCL単体では実現不可能ですので、DependencyServiceにて記述していきます。

前提条件
・Windows10
・Visual Studio 2015 Community Update3
・Xamarin 4.2.0.719 (NuGet Xamarin.Forms 2.3.2.127)
・macOS Sierra 10.12.1 / Xcode8.1 / Xamarin.iOS 10.2.0.4

１．PCLでの実装方法

文章を成形してファイルに出力する関数を作成します。

//LogUtility.cs
public static class LogUtility
{
    /// <summary>
    /// 保存パス
    /// </summary>
    private static string _savePath = null;

    /// <summary>
    /// ログを出力する
    /// </summary>
    /// <param name="err">エラー内容</param>
    public static void OutPutError(string err)
    {
        //保存パスを形成する
        //保存パス＝ドキュメントパス＆アプリ名_yyyyMMdd.log
        if (String.IsNullOrEmpty(_savePath))
        {
            _savePath = Common.GetDocumentPath();
            if (!_savePath.EndsWith("/"))
            {
                _savePath += "/";
            }
            _savePath += Common.FileService.GetPackageName() + "_";
        }
        //ログ内容の成形
        string msg = "---------------------------------------------------------------------------------------------" + System.Environment.NewLine +
                     DateTime.Now.ToString("yyyy/MM/dd HH:mm:ss") + " Error " + System.Environment.NewLine +
                     err;

        //Visual Studio 上でのログを出力する
        System.Diagnostics.Debug.WriteLine(msg);

        //ファイルログを出力する
        DependencyService.Get<IFileService>().OutPutLog(_savePath + DateTime.Now.ToString("yyyyMMdd") + ".log", msg);
    }    
}

//Common.cs
public static class Common
{
    /// <summary>
    /// ドキュメントディレクトリを取得する
    /// </summary>
    /// <returns></returns>
    public static string GetDocumentPath()
    {
        string path = DependencyService.Get<IFileService>().GetDocumentPath();
        if (String.IsNullOrEmpty(path))
        {
            path = DependencyService.Get<IFileService>().GetDownloadPath();
        }
        return path;
    }
}

//IFileService.cs
//DependencyServiceから利用する
public interface IFileService
{
    string GetPackageName();
    string GetDocumentPath();
    string GetDownloadPath();
    void OutPutLog(string path, string err);
}

２．Androidの実装方法

Androidプロジェクト内に以下のクラスを配置します。

//Android  FileService.cs
using Android.Content;
using System;
using System.IO;
using Xamarin.Forms;
[assembly: Dependency(typeof(FileService))]
public class FileService : IFileService
{
    public string GetPackageName()
    {
        Context context = Forms.Context;
        var name = context.PackageManager.GetPackageInfo(context.PackageName, 0).PackageName;
        return name;
    }
    public string GetDocumentPath()
    {
        try
        {
            var dir = Android.OS.Environment.GetExternalStoragePublicDirectory(Android.OS.Environment.DirectoryDocuments);
            return dir.AbsolutePath;
        }
        catch
        {
            return String.Empty;
        }
    }
    public string GetDownloadPath()
    {
        try
        {
            var dir = Android.OS.Environment.GetExternalStoragePublicDirectory(Android.OS.Environment.DirectoryDownloads);
            return dir.AbsolutePath;
        }
        catch
        {
            return String.Empty;
        }
    }
    public void OutPutLog(string path, string err)
    {
        //System.IOを利用する場合
        //System.IO.FileStream fs = new FileStream(path, FileMode.Append);
        //StreamWriter sw = new StreamWriter(fs);
        //sw.WriteLine(err);
        //sw.Close();
        //fs.Close();
        //sw = null;
        //fs = null;

        //こちらの方がNativeです。Java.IO
        Java.IO.FileWriter fw = new Java.IO.FileWriter(path, true);
        Java.IO.BufferedWriter bw = new Java.IO.BufferedWriter(fw);
        bw.Write(err);
        bw.NewLine();
        bw.Close();
        fw.Close();
        bw = null;
        fw= null;
    }
}

※外部ストレージにアクセスするためにはパーミッションの設定が必要です。
次の記事「Android6以降のパーミッションの設定方法」をご参考ください。
※ターゲットフレームワークが Android 7.0 以降の場合は、次の記事「FileProvider の設定方法」も設定が必要です。

３．iOSの実装方法

iOSプロジェクト内に以下のクラスを配置します。

//iOS FileService.cs
using System;
using System.IO;
using Foundation;
using Xamarin.Forms;
[assembly: Dependency(typeof(FileService))]
public class FileService : IFileService
{
    public string GetPackageName()
    {
        string name = NSBundle.MainBundle.InfoDictionary["CFBundleDisplayName"].ToString();
        return name.ToString();
    }
    public string GetDocumentPath()
    {
        return Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);
    }
    public string GetDownloadPath()
    {
        return Environment.GetFolderPath(Environment.SpecialFolder.InternetCache);
    }
    public void OutPutLog(string path, string err)
    {
        System.IO.FileStream fs = new FileStream(path, FileMode.Append);
        StreamWriter sw = new StreamWriter(fs);
        sw.WriteLine(err);
        sw.Close();
        fs.Close();
        sw = null;
        fs = null;
    }
}

４．使用例

PCLプロジェクトの中の任意のページに記述します。
Exception等が発生した場合にログに出力すると良いでしょう。

using AppName.Services;
using Xamarin.Forms;
public partial class TestPage : ContentPage
{
    void Test()
    {
        try
        {
            //省略
        }
        catch (Exception ex)
        {
            LogUtility.OutPutError(ex.Message + System.Environment.NewLine + ex.StackTrace);
        }
    }
}