やる気駆動型エンジニアの備忘録

WPF(XAML+C#)の話題を中心に.NET/Android/CI やたまに趣味に関するブログです

(WPF)App Centerでクラッシュ レポートを送る

前回、App Center + WPF を使ってユーザー利用状況を収集する機能を試してみました。 今回はクラッシュ レポートで遊んでみます。

参考資料

docs.microsoft.com

今回はこの資料をベースに進めていきます。

意図的にクラッシュさせる

App Center の API をテスト的に使用したい場合は、以下のコードを呼び出してクラッシュさせてね、とのこと。

Microsoft.AppCenter.Crashes.Crashes.GenerateTestCrash();

多分、私がやっているような検証のためのコードだと思うんですが、あってるのかな?

前回クラッシュした情報を取得する

前回アプリがクラッシュしたかどうか、クラッシュした時の情報を取得する方法です。 用途としてはユーザーにより詳細な操作内容を入力してもらうためのクラッシュ レポートを送る、などでしょうか。

前回クラッシュしたかどうかを取得するには、以下のようなコードで実現できます。

bool didAppCrash = await Microsoft.AppCenter.Crashes.Crashes.HasCrashedInLastSessionAsync();

クラッシュ時の情報を取得する方法はこう。

Microsoft.AppCenter.Crashes.ErrorReport crashReport = await Microsoft.AppCenter.Crashes.Crashes.GetLastSessionCrashReportAsync();

Microsoft.AppCenter.Crashes.ErrorReport型では以下のような情報が取得できます。 この辺の情報は見つけられなかったので、クラス定義を翻訳しただけです。間違ってたらごめんなさい。

  • Id : クラッシュ レポートの UUID。クラッシュ情報を一位に識別するためのもの。
  • AppStartTime : 前回クラッシュしたときのアプリが起動した日時。
  • AppErrorTime : 前回クラッシュしたときの日時。
  • Device : クラッシュしたデバイスの情報。Microsoft.AppCenter.Device型。OS の情報とか取れるっぽい。
  • Exception : 前回クラッシュした際にスローされた例外インスタンス。App Center に通知される内容と同じもの。
  • AndroidDetails : Android 特有のエラー情報。多分、Javathrowableとの互換性のためのもの。
  • iOSDetails : iOS 特有のエラー情報。こちらも iOS との五感のためのものっぽい。

さて、試しに前回クラッシュした情報をエラーメッセージで表示するようなサンプルを作りました。 こんな感じです。

namespace AppCenter.Wpf
{
    using System;
    using System.Collections.Generic;
    using System.Windows;
    using Microsoft.AppCenter.Analytics;
    using Microsoft.AppCenter.Crashes;

    /// <summary>
    /// MainWindow.xaml の相互作用ロジック
    /// </summary>
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void MainWindow_OnLoaded(object sender, RoutedEventArgs e)
        {
            bool didAppCrash = await Crashes.HasCrashedInLastSessionAsync();
            if (didAppCrash)
            {
                ErrorReport crashReport = await Crashes.GetLastSessionCrashReportAsync();

                MessageBox.Show($"前回セッションでクラッシュしました。{Environment.NewLine}"
                                + $"- 発生日時 : {crashReport.AppErrorTime}{Environment.NewLine}"
                                + $"- エラー内容 : {crashReport.Exception.Message}"
                              , "Report"
                              , MessageBoxButton.OK
                              , MessageBoxImage.Information);
            }
        }
    }
}

例外を適当にスローすると App Center にクラッシュレポートが通知されます。初回、レポートが通知されるまで2,3分かかったのでちょっと待ったほうがいいかもしれません。 レポートされると以下のような結果が表示されます。

f:id:iyemon018:20190817190138p:plain

f:id:iyemon018:20190817190211p:plain

レポートを送信するかどうか判断する

何らかの条件によってクラッシュ レポートを送信したくない場合は次のようにコールバックを呼び出します。 例えば、アプリ固有の例外がスローされた場合、あるレベル以下の例外がスローされても通知しない、といった使い方でしょうか。 このコールバックはAppCenter.Start()よりも前に呼び出す必要があります。

protected override void OnStartup(StartupEventArgs e)
{
    base.OnStartup(e);

    // アプリ固有の CustomException がスローされた場合、ShouldReportProcessed = true (= 処理済み) であればレポートを出力しない。
    // ShouldReportProcessed = false (= 未処理) もしくは CustomException 以外の例外はレポートに通知する。
    Crashes.ShouldProcessErrorReport = (ErrorReport report)
                                            => !(report.Exception is CustomException customException)
                                                || !customException.ShouldReportProcessed;
    AppCenter.Start("xxxxxxxxxxxxxxxxxxxxxxxx", typeof(Analytics), typeof(Crashes));
}

クラッシュ レポートを送信するかどうかユーザーに確認する

クラッシュ レポートに個人情報などが含まれる場合、予めユーザーに確認しておくことでトラブルを防ぐことができます。 あるいは、プロダクトのポリシーによっては個人情報の収集はユーザーの意思がなくてはならない場合もあるでしょう。 Microsoft でもユーザーへの確認を推奨しています。

App Center でもこの仕組みを使うことができます。 Microsoft.AppCenter.Crashes.Crashes.ShouldAwaitUserConfirmationコールバックを呼び出すことで、レポート送信するかどうかを決定することができます。 このコールバックを使うことで、ユーザーが操作するまでクラッシュ レポートが送られなくなります。 ただし、このコールバックは UI を提供するものではないため、ダイアログは自前で呼び出す必要があります。

また、アプリとしてクラッシュ レポートを送信するかどうかは以下の API によって決定します。

Microsoft.AppCenter.Crashes.Crashes.NotifyUserConfirmation(Microsoft.AppCenter.Crashes.UserConfirmation.Send);

引数の Microsoft.AppCenter.Crashes.UserConfirmationによって、"送信する", "送信しない", "常に送信する" から選択することができます。

試しに書いてみたサンプルはこちら。

protected override void OnStartup(StartupEventArgs e)
{
    base.OnStartup(e);

    Crashes.ShouldAwaitUserConfirmation = () =>
                                            {
                                                MessageBoxResult result = MessageBox.Show("クラッシュレポートを送信します。よろしいでしょうか?"
                                                                                        , "Question"
                                                                                        , MessageBoxButton.YesNo
                                                                                        , MessageBoxImage.Question);

                                                if (result == MessageBoxResult.Yes)
                                                {
                                                    Crashes.NotifyUserConfirmation(UserConfirmation.Send);
                                                    return true;
                                                }
                                                else
                                                {
                                                    Crashes.NotifyUserConfirmation(UserConfirmation.DontSend);
                                                    return false;
                                                }
                                            };
    AppCenter.Start("xxxxxxxxxxxxxxxxxxxxxxxx", typeof(Analytics), typeof(Crashes));
}

クラシュ レポートのログ送信状態を取得する

Microsoft.AppCenter.Crashes.Crashes.ShouldAwaitUserConfirmationコールバックでクラッシュ レポートを送信する前と送信成功・失敗それぞれの場合ごとにコールバックが用意されています。 用途としてはレポートの送信ダイアログを表示したりとかでしょうか。 API は次のとおりです。

  • クラッシュ レポートを送信する前に呼ばれるコールバック
Microsoft.AppCenter.Crashes.Crashes.SendingErrorReport
  • クラッシュ レポートの送信成功後に呼ばれるコールバック
Microsoft.AppCenter.Crashes.Crashes.SentErrorReport
  • クラッシュ レポートの送信失敗後に呼ばれるコールバック
Microsoft.AppCenter.Crashes.Crashes.FailedToSendErrorReport

クラッシュ レポートに添付ファイルを追加する

レポートに画像ファイルやテキストファイル(添付ファイル)を追加する仕組みがあります。 例えばクラッシュした時点のキャプチャなどを送ったりする場合に使用するのでしょうか。 添付ファイルを送信するコールバックは次のとおりです。

Microsoft.AppCenter.Crashes.Crashes.GetErrorAttachments

注意点として、送信可能な添付ファイルのサイズは 7MB となっています。 この容量を超える場合、送信エラーとなります。 検証してませんが、多分Crashes.FailedToSendErrorReportが呼ばれるんじゃないでしょうか。

なお、呼びだされるコールバックの順序は次のようになります。

  1. Crashes.ShouldAwaitUserConfirmation
  2. Crashes.GetErrorAttachments
  3. Crashes.SendingErrorReport
  4. Crashes.SentErrorReport / Crashes.FailedToSendErrorReport

これらのコールバックを実行するサンプルを書いてみました。

protected override void OnStartup(StartupEventArgs e)
{
    base.OnStartup(e);

    Crashes.SendingErrorReport += (object sender, SendingErrorReportEventArgs sere) =>
                                    {
                                        // Your code, e.g. to present a custom UI.
                                        MessageBox.Show("クラッシュ レポートを送っています。"
                                                    , "Sending Crash Report"
                                                    , MessageBoxButton.OK
                                                    , MessageBoxImage.Information);
                                    };

    Crashes.SentErrorReport += (object sender, SentErrorReportEventArgs sere) =>
                                {
                                    // Your code, e.g. to hide a custom UI.
                                    MessageBox.Show("クラッシュ レポートの送信を完了しました。"
                                                    , "Send Crash Report Completed"
                                                    , MessageBoxButton.OK
                                                    , MessageBoxImage.Information);
                                };

    Crashes.FailedToSendErrorReport += (object sender, FailedToSendErrorReportEventArgs ftsere) =>
                                        {
                                            // Your code goes here.
                                            MessageBox.Show("クラッシュ レポートの送信に失敗しました。"
                                                            , "Send Crash Report Failed"
                                                            , MessageBoxButton.OK
                                                            , MessageBoxImage.Information);
                                        };

    Crashes.GetErrorAttachments = (ErrorReport report) =>
                                    {
                                        ErrorAttachmentLog textLog =
                                            ErrorAttachmentLog.AttachmentWithText("This is a text attachment.", "text.txt");

                                        byte[] imageBuffer;
                                        using (var bitmap = new Bitmap("test-image.png"))
                                            using (var ms = new MemoryStream())
                                        {
                                            bitmap.Save(ms, ImageFormat.Png);
                                            imageBuffer = ms.GetBuffer();
                                        }

                                        ErrorAttachmentLog binaryLog =
                                            ErrorAttachmentLog.AttachmentWithBinary(imageBuffer, "test-image.png", "image/jpeg");

                                        MessageBox.Show("Get Error Attachments");

                                        return new List<ErrorAttachmentLog> {textLog, binaryLog};
                                    };

    AppCenter.Start("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", typeof(Analytics), typeof(Crashes));
}

なお、送信された添付ファイルは Dignostics から該当のレポートを選択して ATTACHEMENTS タブから参照することができます。

f:id:iyemon018:20190818180121p:plain

クラッシュ レポートの送信有無を設定する

総合テストや受け入れテストなど、後工程のテストでクラッシュ レポートを送信したくないようなケースで以下の API を使用することで、レポートを送信するかどうかを決定することができます。

Microsoft.AppCenter.Crashes.Crashes.SetEnabledAsync

引数に true を設定することでレポートを送信し、false を設定することでレポート送信を無効化します。 この設定はデバイスのストレージ上(どこかは不明)に保存されるため、一度呼び出すと永続的に適応されるようです。

また、この送信有無を設定したかどうかは以下の API で判定することができます。

bool isEnabled = await Crashes.IsEnabledAsync();

エラー レポートを送信する

App Center ではクラッシュ レポートの他に、何らかの例外がスローされた場合にその内容を App Center に送信する機能があります。 そして、エラー レポートにはキーと値を持つプロパティを登録することができます。 エラー レポートはクラッシュ レポートと同じく Dignostics から参照することができます。

private void ExceptionButton_OnClick(object sender, RoutedEventArgs e)
{
    try
    {
        throw new ApplicationException($"これは手動で発生さました。- Exception ({DateTime.Now:yyyy-MM-dd HH:mm:ss})");
    }
    catch (ApplicationException exception)
    {
        var properties = new Dictionary<string, string>
                            {
                                { "Category", "Test" },
                            };
        Microsoft.AppCenter.Crashes.Crashes.TrackError(exception, properties);
    }
}

最後に

クラッシュ レポートに関してもいろいろな API が用意されていて検証した感じだとプレビュー版でも特に問題なく使えています。 機能的にも十分なのであとはどう使うかに重点をおいてプロダクトを開発していけば良さげです。

(WPF)App CenterにWPFが対応したので使ってみた

devblogs.microsoft.com

上記ページでApp Centerに WPF/WinForms が対応したとのことなので早速使ってみました。 私自身これまで App Center を使ったことがなかったため、このエントリでは導入から Analytics までをチュートリアル形式で記載しています。

開発環境

開発環境はこんな感じ。

なお、2019年8月8日時点で App Center の WPF/WinForms はプレビュー版のみの提供となっています。 そのため、.NET Coreには対応していません。 .NET Framework 4.5以上が対象となっています。 今後は.NET Core 3.0にも対応予定とのことなので期待したいところです。App Center のロードマップについては以下を参照してください。

github.com

また、今回私は以下のページを参考にしています。

docs.microsoft.com

App Centerの設定

App Center を開き、[Add new] - [Add new app] を選択して以下の様に OS は Windows, Platform は WPF を選択します。あとは[Add new app] を選択します。

f:id:iyemon018:20190808221428p:plain

[Settings] を開いて右上のメニューから [Copy app secret] を選択します。 ここでコピーした Secret は後ほど使うのでエディタにでもコピペしておいてください。

f:id:iyemon018:20190808221948p:plain

さて、これで App Center の準備は整いました。

アプリに組み込む

次はアプリです。 適当に.NET Framework 4.5以上の WPF アプリを作成してください。

まずは、NuGet から App Center のパッケージを取得します。

Install-Package Microsoft.AppCenter.Analytics -Version 2.2.1-preview
Install-Package Microsoft.AppCenter.Crashes -Version 2.2.1-preview

これを実行すると大量のアセンブリが追加されるのでしばらく待ちます。

準備が整ったらApp.xaml.csを以下のようにします。 まずは、アプリ セッションを開始して App Center と接続できることを確認します。 using は忘れずに。

namespace AppCenter.Wpf
{
    using System.Windows;
    using Microsoft.AppCenter;
    using Microsoft.AppCenter.Analytics;
    using Microsoft.AppCenter.Crashes;

    public partial class App : Application
    {
        protected override void OnStartup(StartupEventArgs e)
        {
            base.OnStartup(e);

            AppCenter.Start("<ここに Secret を貼り付ける>", typeof(Analytics), typeof(Crashes));
        }
    }
}

以上! 簡単ですね。

このままアプリを起動すると App Center の[Analytics] - [Overview] は次のようになります。

f:id:iyemon018:20190808222745p:plain

まずはこれでアプリが App Center に接続できたことを確認できたので、もうちょっと触ってみます。

チュートリアルはいくつかあるのですが、わかりやすいのが Event だったのでこちらを実装します。 ちなみに以下のページを参考にしています。

docs.microsoft.com

Event には以下のようなコードを追加して予めどのようなイベントが有るのかを定義します。

// 第一引数は name, 第二引数は parameter
Analytics.TrackEvent("Video clicked", new Dictionary<string, string> {
    { "Category", "Music" },
    { "FileName", "favorite.avi"}
});

MS Docs ページとコードのコメントを読む限りだとname, parameterには以下のような制限があるようです。 元の文章が英語なので間違ってたらごめんなさい…

  • Event に定義できる数は最大で 200 個。これはnameに最大 200 種類のイベント名称を定義できるということ。
  • nameは最大 256 byte まで。
  • 1種類の Event につき、プロパティ パラメータは 5 つまで。これはparameterに 5 種類のプロパティ名を設定できるということ。
  • parameterのプロパティ名は最大 64 byte まで。

実質 Event 名称 : 200 x パラメータ 5 で 1000 種類のイベントを計測することができそうです。

これをApp.xaml.csに追加します。

namespace AppCenter.Wpf
{
    using System.Collections.Generic;
    using System.Windows;
    using Microsoft.AppCenter;
    using Microsoft.AppCenter.Analytics;
    using Microsoft.AppCenter.Crashes;

    public partial class App : Application
    {
        #region Methods

        protected override void OnStartup(StartupEventArgs e)
        {
            base.OnStartup(e);

            AppCenter.Start("<ここに Secret を貼り付ける>", typeof(Analytics), typeof(Crashes));

            Analytics.TrackEvent("Example", new Dictionary<string, string>
                                            {
                                                {"Category", "Music"}, {"FileName", "favorite.avi"}
                                            });
        }
    }
}

例えば上記のExampleイベントを App Center で取得するには以下のようにします。

Analytics.TrackEvent("Example");

あとはこれを画面からボタンクリックなどのイベントハンドラから呼び出してやればOKです。

namespace AppCenter.Wpf
{
    using System.Collections.Generic;
    using System.Windows;
    using Microsoft.AppCenter.Analytics;

    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private void TestButton_OnClick(object sender, RoutedEventArgs e)
        {
            Analytics.TrackEvent("Example");
        }

        private void MusicEventButton_OnClick(object sender, RoutedEventArgs e)
        {
            Analytics.TrackEvent("Example", new Dictionary<string, string> {{"Category", "Music"}});
        }
    }
}

Analytics.TrackEventメソッドの第二引数にプロパティ名を指定することでより詳細なイベントの振り分けができそうです。

さて、これでアプリを起動して何回かボタンを押すと、 App Center の[Analytics] - [Events] は以下のようになります。

f:id:iyemon018:20190808224726p:plain

Exampleというイベントが追加されました。 イベントをクリックするとさらに詳細な情報を取得できます。

f:id:iyemon018:20190808224917p:plain f:id:iyemon018:20190808224934p:plain

Event はうまく使えばユーザーの利用状況とかかなり具体的かつ正確に収集できそうです。

最後に

さて、他にもクラッシュログとかプッシュ通知、アプリの自動配布なんかもあるそうです。 クラッシュログは Android の Crashlytics みたいなイメージでしょうか? アプリの自動配布もこれまでは Click once しかなかったので、代替案になるかも検証していきたいと思っています。

ちなみに今回のサンプルは App Center 初利用の私でも 1時間程度で組み込むことができました。

まだまだ App Center は触り始めたばかりで勉強不足な部分が多々あるので、もう少し色々触ってみようと思います。

Surface Bookがモニターアーム+ノートPCスタンドで快適に使えるようになった

私は自宅の開発環境はSurface Bookを使っています。 SurfaceなのでもちろんSurface Dockも使っています。

自宅の環境で悩んだ末にモニターアーム+ノートPCスタンドの環境が自分にピッタリだったので紹介したいと思います。

これまでの問題点

私は開発するときはできるだけ作業スペースを確保したいのですが、ノートPCってキーボードが邪魔じゃないですか? Surface Bookのいいところは、キーボードとディスプレイが分離型であることとディスプレイを前後入れ替えても問題なく使用できるところにあると思っています。 なので、ディスプレイを通常とは逆向きに接続して作業スペースを確保するように使用していました。

f:id:iyemon018:20190714191928j:plain

ただ、これでもテーブルとの接地面積は結構広く、ちょくちょくSurface Bookの位置を調整することがありました。 これが面倒だったのでどうにかできないかなーといろいろ調べてみました。

モニターアーム+ノートPCスタンドを使ってみた

で、調べた結果、すでに使ってたモニターアームに取り付けられるノートPCスタンドを見つけました。

設置するとこんな感じになります。

f:id:iyemon018:20190714192001j:plain

ディスプレイを反転して使ってるのはモニタの高さと合わせるためです。 Surface Book以外のコンバーチブルでないノートPCだとそのまま乗せるしかないのですがこういうところが地味に便利ですね。

さて、モニターアームに取り付けるということはある程度の高さがります。 なので地震なんかで揺れたりすると落ちたりするのかと思いましたが、ガッチリ固定することができるため問題ありません。 手で位置を調整しても気にならないレベルです。

f:id:iyemon018:20190714192031j:plain

モニターアームに乗せることでテーブル上の作業面積が広がりました。

これで快適ですね!!

さいごに

これ、会社にも導入したいなーと思ってたんですが、会社のデスクはモニターアームが設置できない構造になっているため、あえなく断念しています。 利用しているテーブルの構造やノートPCによっては使用できないパターンはあるかもしれませんので、現在の環境で利用できるかどうかきちんと確認する必要があります。

特に、モニターアームはクランプ式とグロメット式があるため、どちらの設置方法で使うかによって利用不可能なシーンも有ることでしょう。 参考程度に私が使用しているモニターアームはこちらです。

みなさんも試行錯誤してベストな作業環境を作ってみてください。

Azure Pipelines で.NET Core 3.0 Preview をビルドする

前回.NET FrameworkWPF プロジェクトを.NET Core 3.0 Preview へ移行したのですが、そのときAzure Pipelines ではビルドできないと思っていました。

iyemon018.hatenablog.com

しかし、@kkamegawa さんからのアドバイスを頂き、自動ビルドができることがわかりました。

今回はその手順をまとめます。

実行手順

まずはgrobal.jsonファイルを作成します。 このファイルは実行環境に複数の.NET Core SDK が存在する場合にgrobal.jsonに定義したバージョンのSDKを使用する事ができます。

docs.microsoft.com

grobal.jsonを作るにはプロジェクト フォルダ上でコマンドプロンプトを起動して以下のコマンドを実行します。

dotnet new globaljson --sdk-version <.NET Core のバージョン>

例えば.NET Core Preview4 の場合は以下のようになります。

dotnet new globaljson --sdk-version 3.0.100-preview4-011223

次にAzure Pipelines に.NET Core SDK Installer タスクを追加します。 タスクの設定はこんな感じ。

f:id:iyemon018:20190422221050p:plain

YAML だとこんな感じ。

steps:
- task: DotNetCoreInstaller@0
  displayName: 'Use .NET Core runtime 3.0.0-preview4-27615-11'
  inputs:
    version: '3.0.100-preview4-011223'

この.NET Core のバージョンは以下のページを参照してください。 注意すべき点としてSDK とRuntime でバージョン番号の表記が若干異なります。 タスクのPackage to installの種別を確認しておきましょう。

github.com

なお、.NET Core 3.0 なのでVS 2019 にしないとビルドできませんのでご注意を。

あとはビルドをキューに登録して実行すればOKです。

(WPF).NET Framework で作ったアプリを.NET Core 3.0 Preview へ移行した

.NET Framework で作成していたWPF アプリを.NET Core 3.0 Preview へ移行してみました。 というのもxUnit.NET でテストコードを書いていたんですが、.NET Framework だとテストを実行するにはxunit.console.runner を実行するしかなく、Azure Pipelines でバージョンアップ時に書き換えるのがめんどいしカバレッジも自力で集計・レポート作成設定しないといけないのでなかなかに辛いのです。 で、せっかくVS 2019 Community もリリースされたので使ってみようと思いました。

なお、このエントリで試したことは2019年4月21日時点のものです。

.NET Framework版のプロジェクト構成

移行前のソリューション構成です。

f:id:iyemon018:20190421152109p:plain

それぞれのプロジェクト構成はこんな感じ。

プロジェクト名 フレームワーク 用途
Cartica.App .NET Framework 4.7.1 アプリのエントリポイント。起動時のexe。
Cartica.Controls .NET Framework 4.7.1 UI 関連の機能。
Cartica.Core .NET Standard 2.1 ビジネスロジックとか。
Cartica.Domain .NET Framework 4.7.1 ドメイン関連の機能とか値オブジェクトとか。
Cartica.Domain.Net .NET Framework 4.7.1 ドメイン関連のうちWEB API 使うものとか。
Cartica.Encryptions .NET Framework 4.7.1 暗号化、復号化関連。
Cartica.Core.Tests .NET Core 2.1 .NET Standard 用のテストプロジェクト。
Cartica.Tests .NET Framework 4.7.1 .NET Framework 用のテストプロジェクト。
Tests.Core .NET Standard 2.0 テストコードの汎用機能。

なお、今回移行対象に考えているのは"Cartica.App"プロジェクトです。

.NET Coreへの移行手順

まず、今回移行に伴い参考にした資料はこちらです。

docs.microsoft.com

下準備

  1. プロジェクトが.NET Core へ移行可能か検証する。 検証には.NET Portability Analyzer を使用します。 docs.microsoft.com
  2. .NET Core 3.0 Preview をインストールする。 .NET Core 3.0 Preview のインストールは以下から。 dotnet.microsoft.com
  3. Visual Studio 2019 をインストールする。 初期設定ではVS 2019 で.NET Core 3.0 Preview を使えないので、以下のページの「RC 版で .NET Core 3.0」にある通りに設定しましょう。 ufcpp.net

移行手順

  1. dotnet new wpfコマンドを使って.NET Core のWPF プロジェクトを作成する。
  2. 作成した.csproj ファイルの内容を.NET Framework の.csproj にコピペする。
  3. NuGet パッケージを参照しているのであれば、.csproj に記載する。packages.config ファイルとタグが若干違うので目Grep で書き換える。(ここめんどい)
  4. Properties/AssemblyInfo.csが未変更なら不要なので削除する。私の場合はInternalsVisibleTo使ってたので、そのコードだけ残して削除しました。
  5. NU1701の警告がめっちゃ出てくるので、.NET Framework 互換モード で警告を非表示にする。(ここはOSS の対応待ち or .NET Core 向けあるならそっち使う)

さて、ここまではよくブログなどに載せられている手順ですが、私のプロジェクト上では更に以下の手順を実施しました。 プロダクトによっては以下の手順は不要だと思います。

追加した移行手順

  1. ユニットテスト プロジェクトの参照を.NET Framework 用プロジェクトから.NET Core 側に移行した。
  2. System.Windows.Interactivity.dllを参照していたので、XamlBehaviors for WPF のNuGet パッケージを追加した。
    XAML に使用している場合、namespace はxmlns:interactions="http://schemas.microsoft.com/xaml/behaviors"に変更しておきます。xmlns:ei="http://schemas.microsoft.com/expression/2010/interactions"こっちはいらないので削除しておきましょう。
  3. 複数プロジェクトあったので、下位のプロジェクトから順にクリーン + リビルドを実施する。

これでビルドが成功し、実行すると動くようになりました。

移行後の.csproj

.NET Core 3.0 への移行で若干迷ったのが.csproj ファイルの編集なんですが、その理由がMS 公式リファレンスや個人ブログでは.csproj の中身が見えないのでどこに追記すればいいかわかんないんですよね。 なので、今回私が作成した.csproj ファイルはここに載せておきます。

タグの意味とかは移行手順の参考資料に記載しているのでそちらを御覧ください。

<Project Sdk="Microsoft.NET.Sdk.WindowsDesktop">

  <PropertyGroup>
    <OutputType>WinExe</OutputType>
    <TargetFramework>netcoreapp3.0</TargetFramework>
    <UseWPF>true</UseWPF>
    <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
    <AssemblyName>Cartica.App</AssemblyName>
    <RootNamespace>Cartica.App</RootNamespace>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="CommonServiceLocator" Version="2.0.4" />
    <PackageReference Include="LiveCharts" Version="0.9.7" NoWarn="NU1701" />
    <PackageReference Include="LiveCharts.Wpf" Version="0.9.7" NoWarn="NU1701" />
    <PackageReference Include="MaterialDesignColors" Version="1.1.1" NoWarn="NU1701" />
    <PackageReference Include="MaterialDesignThemes" Version="2.5.0.1205" NoWarn="NU1701" />
    <PackageReference Include="Microsoft.Xaml.Behaviors.Wpf" Version="1.0.1" NoWarn="NU1701" />
    <PackageReference Include="Prism.Core" Version="7.1.0.431" />
    <PackageReference Include="Prism.Unity" Version="7.1.0.431" NoWarn="NU1701" />
    <PackageReference Include="Prism.Wpf" Version="7.1.0.431" NoWarn="NU1701" />
    <PackageReference Include="Unity.Abstractions" Version="3.3.1" />
    <PackageReference Include="Unity.Container" Version="5.8.11" />
  </ItemGroup>

  <ItemGroup>
    <ProjectReference Include="..\Cartica.Controls\Cartica.Controls.csproj" />
    <ProjectReference Include="..\Cartica.Core\Cartica.Core.csproj" />
    <ProjectReference Include="..\Cartica.Domain.Net\Cartica.Domain.Net.csproj" />
    <ProjectReference Include="..\Cartica.Domain\Cartica.Domain.csproj" />
    <ProjectReference Include="..\Cartica.Encryptions\Cartica.Encryptions.csproj" />
  </ItemGroup>

</Project>

できないこと

まだプレビュー版だからなのか、以下は対応できませんでした。

  1. .NET FrameworkWPF コントロールライブラリの.NET Core 3.0 対応

2. Azure Pipelines でVS 2019 Hosted で自動ビルド

2019年4月22日 追記

Azure Pipelines で.NET Core 3.0 Preview の自動ビルドは可能でした。 その手順を以下にまとめましたのでご確認ください。

iyemon018.hatenablog.com

ここまで追記

この辺は正式版がリリースされてからの話だと思うので楽しみに待ってましょう。

移行の感想

ぶっちゃけブログなどでは移行が簡単そうに書いていますが、それはWPF プロジェクトが1プロジェクトしかないときと考えたほうがいいでしょう。 WPF コントロールライブラリは.NET Core への移行が現時点では不可能なので使用している場合は無理に.NET Core へ移行する必要もないでしょう。

あと、Azure Pipelines もビルドできないので使用している方はご注意ください。

結論、 .NET Core 3.0 リリース早く来てくれ!!