書籍「プログラミング ASP.NET Core」の感想

Dino Esposite が書いた「Programming ASP.NET Core」の日本語翻訳版が出版されると知って、早速「プログラミング ASP.NET Core」を読んでみました。

プログラミングASP.NET Core (マイクロソフト関連書)

目次

第1部　新しい ASP.NET の概要
　第1章　新しい ASP.NET の存在意義
　第2章　初めての ASP.NET Core プロジェクト
第2部　ASP.NET MVC のアプリケーションモデル
　第3章　ASP.NET MVC の起動
　第4章　ASP.NET MVC のコントローラー
　第5章　ASP.NET MVC のビュー
　第6章　Razor の構文
第3部　横断的関心事
　第7章　設計について考える
　第8章　アプリケーションのセキュリティ
　第9章　アプリケーションデータへのアクセス
第4部　フロントエンド
　第10章　Web API の設計
　第11章　クライアント側からのデータ送信
　第12章　クライアント側のデータバインディング
　第13章　デバイスフレンドリなビューの構築
第5部　ASP.NET Core のエコシステム
　第14章　ASP.NET Core のランタイム環境
　第15章　ASP.NET Core アプリケーションのデプロイメント
　第16章　移行戦略と導入戦略

書籍で解説されているサンプルコードは、GitHub でも公開されています。
github.com

どんな書籍なのか

この書籍は、Web 開発の最低限の知識を持っていれば、ASP.NET の初心者にも理解できる内容ですが、やはり従来の ASP.NET 開発者に読んでほしい書籍です。

第１部では、これまでの .NET の歴史を振り返りながら、ASP.NET Core が登場した背景を明らかにし、Hello World な ASP.NET Core アプリケーションを動かすまでのイントロダクションとなっています。

第２部では、ASP.NET Core の MVC アプリケーションモデルについて、順を追ってアーキテクチャを解説しており、従来の ASP.NET との違いを押さえつつ、構造や仕組みを理解することができます。

第３部では、ASP.NET Core では欠かすことができない DI の役割を紹介し、従来の３層アーキテクチャではなく、プレゼンテーション、アプリケーション、ドメイン、インフラストラクチャの４層の Layered Architecture パターンをベースに横断的関心事を解説しています。セキュリティとして ASP.NET Identity による認証認可、データアクセスとして Entity Framework Core を解説していますが、モノリシックなアプリケーションを例に挙げたコマンドとクエリの分割にも触れ、Layered Architecture パターンと CQRS パターンの組み合わせまで解説している部分がよかったです。

第４部では、従来の ASP.NET では MVC とは別実装となっていた Web API について、ASP.NET Core での Web API をしっかりと解説しています。合わせて、クライアント側からのデータ送信やデータバインディングも解説しています。

第５部では、ASP.NET Core のランタイム環境やデプロイメント、最後に移行戦略を述べています。従来の ASP.NET アプリケーションの移行は、それなりのコストがかかるので、単純に最新版へのマイグレーションという目的だけでは不十分であり、クロスプラットフォーム、マイクロサービス、コンテナーといったクラウドネイティブなアプリケーションへの移行にビジネス上の価値があると見極めることが重要とする意見に同意です。

まとめ

先日の Microsoft Build 2019 では、.NET Core 3.0 の次バージョンが .NET 5 となるロードマップが発表されました。.NET 5 のネーミングはアレですが、ひとつの .NET として統一されることになります。
従来の ASP.NET 開発者に読んでもらい、クラウドネイティブなアプリケーションという未来に向かってチャレンジしてほしいと感じました。
devblogs.microsoft.com

Managed Service Identity を使って Azure Key Vault から接続文字列を取得する

Azure Key Vault は、アプリケーションが利用するシークレットを安全に保管してくれるサービスです。シークレットには、DBの接続文字列、API のアクセスキー、証明書などの情報があります。
アプリケーションで Azure Key Vault から接続文字列を取得するには、Azure Active Directory のサービスプリンシパルが必要となり、ソースコードに決め打ちしない構成やサービスプリンシパルの有効期間の管理など、少し手間がかかります。
Managed Service Identity（MSI）を使うことで、このあたりの煩わしさを解消できるようになっていたので、まとめておきます。

azure.microsoft.com

Azure Key Vault を作成する

Azure Portal を開いて、Azure Key Vault を作成します。特に説明は必要ないと思います。

続いて、シークレットを作成します。今回は、SQL の接続文字列を想定したシークレット（SqlConnection）を追加しました。

Azure Key Vault 側の準備は、これで完了です。

ローカル開発環境で接続文字列を取得する

Managed Service Identity（MSI）を利用すると、認証資格情報をアプリケーションに含めずに、Azure の各サービスへ認証を行うことができます。
今回は、ASP.NET Core で作成した Web アプリケーションで試してみます。Visual Studio のテンプレートから作成したシンプルな MVC アプリケーションです。
MSI を使って Azure Key Vault に接続するための２つの NuGet ライブラリをインストールします。

Install-Package Microsoft.Azure.KeyVault -Version 3.0.3
Install-Package Microsoft.Azure.Services.AppAuthentication -Version 1.0.3

HomeController クラスで、MSI を使って Azure Key Vault から接続文字列を取得するコードを書きます。
vaultBaseUrl は、先ほど作成した Azure Key Vault のURL です。AzureServiceTokenProvider を使って KeyVaultClient をインスタンス化している部分がポイントです。

public class HomeController : Controller
{
    public async Task<IActionResult> About()
    {
        var vaultBaseUrl = "https://xxx.vault.azure.net/";
        var provider = new AzureServiceTokenProvider();
        using (var client = new KeyVaultClient(new KeyVaultClient.AuthenticationCallback(provider.KeyVaultTokenCallback)))
        {
            var secret = await client.GetSecretAsync(vaultBaseUrl, "SqlConnection");
            ViewData["Message"] = secret.Value;
        }

        return View();
    }
}

ローカル開発環境で Visual Studio からデバッグ実行してみます。Azure Key Vault に作成したシークレット（SqlConnection）の値が取得できたことがわかります。

ここで疑問に思うのが、ローカル開発環境からシークレットを取得できた理由です。
最近の Visual Studio では、Azure サービス認証に登録されたアカウントのトークンを使って AzureServiceTokenProvider が生成されるようになっているので、Visual Studio から Azure Web Apps にデプロイなどの機能を使っていれば、特に意識せずに Azure Key Vault に作成したシークレットを取得することができます。

環境によってこの方法が利用できない場合には、環境変数「AzureServicesAuthConnectionString」を使いましょう。設定する値については、こちらを参照してください。

Azure Web Apps で接続文字列を取得する

先ほど作成した ASP.NET Core の Web アプリケーションを Azure Web Apps にデプロイしてみます。
Azure Web Apps の MSI を有効にしておきます。このタイミングで、サービスプリンシパルが追加されます。

続いて、Azure Key Vault の Access policies で、Azure Web Apps のサービスプリンシパルを許可します。必要最低限のパーミッションとして、シークレットの Get だけを許可しました。忘れずに Save ボタンで保存ましょう。

ASP.NET Core の Web アプリケーションを Azure Web Apps にデプロイし、結果を確認します。

Azure Key Vault に作成したシークレット（SqlConnection）の値が取得できたことがわかります。

まとめ

アプリケーションを開発する際には、DBの接続文字列、API のアクセスキー、証明書などのシークレットは手間をかけずに安全に管理したいところです。MSI と Azure Key Vault を組み合わせて使うことで、このあたりの煩わしさを解消できます。パブリックなリポジトリでシークレットを公開してしまう事故を防ぐためにも、しっかりとアーキテクチャで考慮しておきたい事項です。

Visual Studio 2019 for MAC を試してみた

先日 GA したばかりの Visual Studio 2019 for MAC を試してみました。
初めて MAC 向けの Visual Studio（Preview）が発表された際と同様に、ASP.NET Core で作った Web API を Xamarin Forms のアプリから呼び出してみます。

gooner.hateblo.jp

インストール

Visual Studio 2019 for MAC は、Community Edition であれば、こちらから無料でダウンロードすることができます。

visualstudio.microsoft.com

Xcode が必須なので最初にインストールしましたが、それ以外はウィザード通りに進めれば、問題なくインストールできました。

ASP.NET Core で Web API を作る

Visual Studio を起動して、新しいプロジェクトを作成します。テンプレートは、ASP.NET Core MVC のアプリケーションを選択します。

まず、モデルとして、Person クラスを追加します。

public class Person
{
    public int Id { get; set; }
    public string Name { get; set; }
}

API コントローラーとして、PersonController クラスを追加します。サンプルデータは前回と同じにしました。「君の名は。」が流行っていた頃だったようです。

[Route("api/[controller]")]
[ApiController]
public class PersonController : ControllerBase
{
    [HttpGet]
    public IActionResult Get()
    {
        var result = new List<Person> {
            new Person{ Id = 1, Name = "立花 瀧"},
            new Person{ Id = 2, Name = "宮水 三葉"},
        };
        return Ok(result);
    }
}

iOS と Android のエミュレータからは、localhost に HTTPS で接続できないので、Azure Web Apps にデプロイしておきます。Windows 版と同様に、Visual Studio からダイレクトに Azure Web Apps へアプリケーションを発行できるようになりました。

Xamarin Forms から Web API を呼び出す

前回はターミナルからコマンドで起動する必要がありましたが、Dock から複数の Visual Studio を起動できるようになりました。

Xamarin Forms 用にもう１つの Visual Studio が起動したら、新しいプロジェクトを作成します。テンプレートは、Xamarin.Forms の空白フォームのアプリを選択します。

Web API から返された JSON をデシリアライズするための JSON.NET の NuGet ライブラリをインストールします。

Xamarin Forms プロジェクトにボタンとリストビューを追加して、コードビハインドから Web API を呼び出すコードを追加します。

<?xml version="1.0" encoding="utf-8"?>
<ContentPage xmlns="http://xamarin.com/schemas/2014/forms" xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml" xmlns:local="clr-namespace:xamarinapp2" x:Class="xamarinapp2.MainPage">
    <StackLayout>
        <ListView x:Name="personList" >
          <ListView.ItemTemplate>
            <DataTemplate>
              <TextCell Text="{Binding Name}" />
            </DataTemplate>
          </ListView.ItemTemplate>
        </ListView>
        <Button Text="your name" Clicked="getPerson" />
    </StackLayout>
</ContentPage>

[DesignTimeVisible(true)]
public partial class MainPage : ContentPage
{
    public MainPage()
    {
        InitializeComponent();
    }

    public async void getPerson(object sender, System.EventArgs e)
    {
        using (var client = new HttpClient())
        {
            var response = await client.GetAsync("https://xxx.azurewebsites.net/api/person");
            if (response.IsSuccessStatusCode)
            {
                var json = await response.Content.ReadAsStringAsync();
                this.personList.ItemsSource = JsonConvert.DeserializeObject<List<Person>>(json);
            }
        }
    }
}

public class Person
{
    public int Id { get; set; }
    public string Name { get; set; }
}

結果確認（iOS）

Xamarin Forms プロジェクトで iOS のプロジェクトをスタートアップに設定してデバッグ実行すると、エミュレータが起動して Web API を呼び出して結果を表示することができます。

結果確認（Android）

同様に Android のプロジェクトをスタートアップに設定してデバッグ実行すると、エミュレータが起動して Web API を呼び出して結果を表示することができます。

まとめ

Visual Studio for MAC が最初にリリースされてから2年半が経ち、実用に耐え得るようになってきたかなという印象です。
Visual Studio Code もありますし、開発者が好きなデバイスでモバイルやクラウドのアプリケーションを作れるのはいいことだと思います。