ASP.NET Core 3.0 Razor Pages 事始め(1) - はじめてのRazor Pagesアプリケーション #C#

記事目次

はじめに

ASP.NET Coreから利用できるようになったRazor PagesによるWebアプリ開発についての学習の記録をここに残していこうと思います。

ASP.NET MVC (Coreではない)はこれまでに使っているので、ASP.NET MVCと比較してどうなのか、という視点で説明するような個所も出てくるかと思います。

まずは、公式ページの

チュートリアル: ASP.NET Core で Razor ページ Web アプリを作成する

の記事に沿って、チュートリアルをやっていこうと思います。このチュートリアルのページは日本語化されてるし、翻訳も良い出来なので、僕がここで書く意味はあるのか？という疑問は残りますが、あくまでも学習の記録ということでご容赦を。

チュートリアルには書かれていない内容とかも（もし、あれば）書ければと思っています。

準備

使うのは、Visual Studio Code です。
C# for Visual Studio Code (最新バージョン) をインストールします。

それと、.NET Core 3.0 SDKが必要です。これもインストールする必要があります。

僕は、Visual Studio 2019 v16.3 更新したら、.NET Core 3.0 SDKが入ったので、手動でのインストールはしていません。Visual Studio 2019 for Mac の場合は、v8.3以降に.NET Core 3.0 が含まれています。

ASP.NET Core Razor Page は、ASP.NET Coreで導入されたWebアプリケーションのフレームワークです。

チュートリアルやってみただけの感想ですが、ASP.NET MVCと似ている部分も多いので、ASP.NET MVCでの開発経験があれば、それなりにスムーズに学習できるかなと思います。まあ個人的な感想ですが。

Razor Pages の特徴

Razor Pages の特徴は、ControllerとViewsフォルダがプロジェクトにありません。
この２つが、Pagesフォルダに統合されています。

Pagesフォルダの中に、ページファイル（.cshtml)と、それに対応する<ページ名>.cshtml.cs という名前の分離コードファイルがあります。例えば、index.cshtml の場合は、index.cshtml.cs ファイルがあります。

<ページ名>.cshtml.csには、MVCで言うところのViewModel+Actionメソッドを定義します。

この前提を知っていると、チュートリアルもスムーズに理解できるかなと思います。

Razor Pagesのプロジェクトを作成する

では、さっそく作成してみます。

VS Codeからターミナルウインドウを表示します。
cdコマンドで、プロジェクトを作成したい親ディレクトリに移動します。

例えば、以下のようなコマンドを実行します。
```
cd source/repos
```
以下のコマンドを投入します。
```
dotnet new webapp -o RazorPagesMovie
```
これで、RazorPagesMovie フォルダーに新しい Razor Pages プロジェクトが作成されます。
次に、下のコマンドを投入し、VS Code で、このフォルダを開きます。
```
code -r RazorPagesMovie
```
VS Codeは、現在のインスタンスのまま、RazorPagesMovie フォルダを開きます。

プロジェクト構成

プロジェクトには、Pages フォルダとwwwroot フォルダーがあります。初期状態はいたってシンプルな構造です。

Pagesフォルダには、.cshtml ファイルと .cshtml.cs ファイルがあります。View とそれに対応するサーバー側のコードを書くファイルです。
ここがMVCとRazorPagesとの大きな違いのようです。

ASP.NET MVC と同様に、 Sharedフォルダの下には、_Layout.cshtml もあります。

wwwrootは、JavaScript ファイル、CSS ファイルなどの静的ファイルが格納されます。このフォルダ構造は、Content と Scriptsに分かれていたASP.NET MVC よりもいいですね。

そのほか、プロジェクトフォルダ直下には、appSettings.json Program.cs Startup.cs などがあります。

Controllerフォルダはありません。

実行してみる

Ctrl+F5キーで実行します。

環境を聞いてきた場合は、.NET Core を選択します。Launch.jsonが作成されます。再度、Ctrl+F5キーを押します。

すると、ブラウザが起動し初期ページが表示されます。

画面上の privacy リンクをクリックすると、Privacyページに移動します。

cshtml.cs ファイルをのぞいてみる

試しに、Privacyページに対応する Privacy.cshtml.csの中を覗いてみます。

using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.Extensions.Logging;

namespace RazorPagesMovie.Pages
{
    public class PrivacyModel : PageModel
    {
        private readonly ILogger<PrivacyModel> _logger;

        public PrivacyModel(ILogger<PrivacyModel> logger)
        {
            _logger = logger;
        }

        public void OnGet()
        {
        }
    }
}

とてもシンプルです。

Razor ページハンドラー

PrivacyModelクラスには OnGetというメソッドはあるのが分かります。これが、Actionメソッドに対応するメソッドのようです。
名前のとおり、Http Get に対応するメソッドですね。

この OnGet メソッドには、Actionメソッドと違い、戻り値がありません。
ページを返す場合は良いけど、ファイルを返したり、JSON返したりするのって、どうやるんだろう？という疑問は残りますが、通常のページ表示にかぎれば、コードはとてもシンプルです。

OnPostというメソッドを定義すれば、Http Post に対応するメソッドを定義できるようです。
MVCでは、属性を指定することで、Http Get、Http Post に対応していたのですが、Razor Pagesでは、メソッド名に代わっているようです。

これらのメソッドを Razor ページハンドラーと言うようです。

PageModelクラス

上記のコードを見ると、PrivacyModel クラスは、PageModel クラスを継承していることが分かります。
PageModelから継承しているので、このクラスをページモデルと呼ぶようです。

PageModelクラスの定義をすこし覗いてみます。VS CodeもF12キーを押せば、該当のコードに飛べるので便利ですね。


namespace Microsoft.AspNetCore.Mvc.RazorPages
{
    [PageModel]
    public abstract class PageModel : IAsyncPageFilter, IFilterMetadata, IPageFilter
    {
        protected PageModel();

        public IUrlHelper Url { get; set; }
        public ITempDataDictionary TempData { get; set; }
        public RouteData RouteData { get; }
        public HttpResponse Response { get; }
        public HttpRequest Request { get; }
        [PageContext]
        public PageContext PageContext { get; set; }
        public ModelStateDictionary ModelState { get; }
        public IModelMetadataProvider MetadataProvider { get; set; }
        public HttpContext HttpContext { get; }
        public ClaimsPrincipal User { get; }
        public ViewDataDictionary ViewData { get; }


        ...

HttpContext、Request、Response、ModelStateなどのプロパティがあるのがわかります。
MVCのコントローラークラスと似ていますね。

なお、このPageModelクラスは、Razor構文を使って、cshtmlの中に記述することもできるようです。
小さなアプリケーションならば、それも良いでしょうが、普通は、分離コードファイル(.cshtml.cs)内に記述したほうが良いと思います。

cshtml ファイルをのぞいてみる

Privacy.cshtmlの中も覗いてみます。

@page
@model PrivacyModel
@{
    ViewData["Title"] = "Privacy Policy";
}
<h1>@ViewData["Title"]</h1>

<p>Use this page to detail your site's privacy policy.</p>

先頭に@pageディレクティブがあります。これが、Razor Pagesアプリ用の .cshtmlファイルであることを示しています。
@pageディレクティブがあると、Controllerを経由せずに前述のページモデルが要求を処理しますよ、と印をつけていることになるようです。

次の行の@model ディレクティブで、この.cshtmlファイルが扱うモデルの型を指定します。
当然のことながら、ページモデルであるPrivacyModelクラスがモデルになります。

3行目からの行では、ViewDataディクショナリに、値をセットしています。

@{
     ViewData["Title"] = "Privacy Policy";
}

このViewDataは、継承元のPageModelクラスに定義されているプロパティですね。

このViewData["Title"]の値は、直後の

<h1>@ViewData["Title"]</h1>

で参照しています。

あとは、通常のhtmlと同じですね。

ちなみに、Pages/Shared/_Layout.cshtml がHTMLのページ全体を示すテンプレートファイルで、MVCと同じようです。

_Layout.cshtmlの中に、@RenderBody() という行があり、これが、該当ページの.cshtml の内容に置き換わることになります。

ちょっと、Razor Pages のイメージが掴めたような気がします。チュートリアルの内容から脇にそれましたが、今日はこのへんで終わりにします。

次回は、モデルの追加をやります。

ASP.NET Core 3.0 Razor Pages 事始め(1) - はじめてのRazor Pagesアプリケーション