🐦

ASP.NET Razor Pages を最初から(1)

2023/02/12に公開

はじめに

ここ10年ほどセキュリティSEとして働いているので、Webアプリケーション開発からは遠ざかっていたが、来年度は脆弱性診断を担当する事になりそうなので久々にWebアプリケーションを学びなおすためにASP.NETを触ってみることにした。
ただ触るだけだとすぐに忘れてしまうので、いつでもおさらいできるように記事として残しておこうと考えた。

なぜASP.NET Razorか？

担当企業は99％JavaなThe JTCな訳だが、どうにもJavaは好きになれない。
.NETはやっておけばとりあえず無駄になることは無いし、あれこれとフレームワーク入れず.NETだけ入れれば使えるし、オフィシャルドキュメントも充実している(読みやすいとは言えないが)ので始めやすい。
VisualStudio Communityが無償で使えるのも大きい。

プロジェクト作成

Project

色々作れるがRazor Pagesで始めるためには、ASP.NET Core Webアプリを選択する。
プロジェクト名はZennSampleにして次へ進む。

追加情報
せっかくなので、最新の.NET7.0を選択する。
最初なので、認証はなし、HTTPS用の構成もOFFにしておく。
最上位レベルのステートメントはデフォルトで使用するようになっているようなのでとりあえずそのままにしておく。

初期画面
プロジェクトが作成された。

初期ファイル
作成されたファイル群。
C#のファイルは、プロジェクト直下のProgram.csと後はPagesフォルダに配置されている。

Program.csを確認する

Program.cs

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
}
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();

app.Run();

まずは実行。
初期状態実行
問題なくコンパイルされ、ブラウザが立ち上がり画面が表示される。
特に設定はしていないがEdgeが立ち上がった。
停止するとブラウザも閉じる、よくできてる。

Pagesフォルダーを確認する

Pagesフォルダの下には.cshtmlファイルと、同名ファイルに.csを付けたファイルが配置されている。

Index.cshtml
Index.cshtml.cs
この2ファイルでトップページ(Indexページ)が作成されている。

Index.cshtml

@page
@model IndexModel
@{
    ViewData["Title"] = "Home page";
}

<div class="text-center">
    <h1 class="display-4">Welcome</h1>
    <p>Learn about <a href="https://docs.microsoft.com/aspnet/core">building Web apps with ASP.NET Core</a>.</p>
</div>

Index.cshtml.cs

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;

namespace ZennSample.Pages
{
    public class IndexModel : PageModel
    {
        private readonly ILogger<IndexModel> _logger;

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

        public void OnGet()
        {

        }
    }
}

Index.cshtmlの中身にはコンテンツ部分しかない。
HTMLで共通して利用される部分は、Sharedフォルダ内に_Layout.cshtmlとして作成されている。

_Layout.cshtml

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>@ViewData["Title"] - ZennSample</title>
    <link rel="stylesheet" href="~/lib/bootstrap/dist/css/bootstrap.min.css" />
    <link rel="stylesheet" href="~/css/site.css" asp-append-version="true" />
    <link rel="stylesheet" href="~/ZennSample.styles.css" asp-append-version="true" />
</head>
<body>
    <header>
        <nav class="navbar navbar-expand-sm navbar-toggleable-sm navbar-light bg-white border-bottom box-shadow mb-3">
            <div class="container">
                <a class="navbar-brand" asp-area="" asp-page="/Index">ZennSample</a>
                <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target=".navbar-collapse" aria-controls="navbarSupportedContent"
                        aria-expanded="false" aria-label="Toggle navigation">
                    <span class="navbar-toggler-icon"></span>
                </button>
                <div class="navbar-collapse collapse d-sm-inline-flex justify-content-between">
                    <ul class="navbar-nav flex-grow-1">
                        <li class="nav-item">
                            <a class="nav-link text-dark" asp-area="" asp-page="/Index">Home</a>
                        </li>
                        <li class="nav-item">
                            <a class="nav-link text-dark" asp-area="" asp-page="/Privacy">Privacy</a>
                        </li>
                    </ul>
                </div>
            </div>
        </nav>
    </header>
    <div class="container">
        <main role="main" class="pb-3">
            @RenderBody()
        </main>
    </div>

    <footer class="border-top footer text-muted">
        <div class="container">
            &copy; 2023 - ZennSample - <a asp-area="" asp-page="/Privacy">Privacy</a>
        </div>
    </footer>

    <script src="~/lib/jquery/dist/jquery.min.js"></script>
    <script src="~/lib/bootstrap/dist/js/bootstrap.bundle.min.js"></script>
    <script src="~/js/site.js" asp-append-version="true"></script>

    @await RenderSectionAsync("Scripts", required: false)
</body>
</html>

<title>@ViewData["Title"] - ZennSample</title>
@RenderBody()
@await RenderSectionAsync("Scripts", required: false)

@を使用して内容を埋め込むようになっており。
@RenderBody()部分に、先ほどのIndex.cshtmlの内容が埋め込まれる。

他、いたるところにasp-*という名前のタグが存在している。
これは、へルパータグといい、HTMLヘルパーの進化版だと思われる（多分）。
@HTML.Labelよりも<label asp-for=""></label>のほうが個人的にも好み。

_Layout.cshtml.css
cshtmlファイルと同名のファイルに.cssを付けると、そのファイルだけに適用できるcssが作成できるようになっている。
wwwroot/cssフォルダに配置するよりもすっきりしてわかりやすいと思う。

今回はここまで。
次回は、Pages/Index.cshtmlと、Pages/Index.cshtml.csを詳しく見ていこうと思う。