<h1 id="h8d027c8ed3">はじめに</h1>過去に私が参画したプロジェクトでSSOを使用したログインの実装をすることがありましたが、 OpenIDConnectを使ったSSOについてのイメージやフローについてなんとなくの理解で実装に入ってしまい、 思わぬ不具合や手戻りが発生することがありました。 OpenIDConnectを使ったSSOクライアントを実装する上で、今後同じ過ちが起きないようにするための備忘録を残しておこうと思います。 <h1 id="ha05a6a746e">SSO（Single Sign-On）とは</h1>そもそもSSOとは何かについて軽く触れておきます。 SSO（Single Sign-On）は、ユーザーが複数の関連するシステムやサービスに対して、1度の認証操作でアクセスできる仕組みです。 1つの認証情報（ユーザー名とパスワード、または他の認証手段）を使用して、複数のシステムにログインできるようになります。 SSOを導入することで、ユーザーは複数のアカウントを持つ必要がなくなり、ログインの手間が省けます。また、管理者側もユーザーの認証情報を1箇所で管理することができ、セキュリティを向上させることができます。 InstagramにGoogleでログインできたりするのをイメージしてもらうとわかりやすいです。 SSO認証を利用する側のアプリケーションを「サービスプロバイダ」「SSOクライアント」といい、 ユーザー認証を提供するサーバー側を「IDp（IDプロバイダー）」と言ったりします。 <h1 id="hf9616a5f67">OpenIDConnectとは</h1><blockquote>OpenID Connect は OAuth 2.0 認可プロセスを拡張し, 認証目的で利用できるようにする. 本拡張を利用する場合, Client は&nbsp;openid &nbsp;scope を指定して Authorization Request を送信する. 認証結果は ID Token (<a style="color:#0f83fd" href="http://openid-foundation-japan.github.io/openid-connect-core-1_0.ja.html#IDToken" target="_blank" rel="noopener noreferrer">Section&nbsp;2</a> &nbsp;参照) と呼ばれる&nbsp;<a style="color:#0f83fd" href="http://openid-foundation-japan.github.io/openid-connect-core-1_0.ja.html#JWT" target="_blank" rel="noopener noreferrer">JSON Web Token (JWT)</a> &nbsp;[JWT] として返される. OpenID Connect をサポートする OAuth 2.0 Authentication Server は, OpenID Provider (OP) とも呼ばれる. OpenID Connect を利用する OAuth 2.0 Client は Relying Party (RP) とも呼ばれる. (OpenID Connect Core 1.0 incorporating errata set 1より引用）</blockquote>OpenID Connect（OpenIDConnect、OIDC）は、先ほど説明したSSOログインの認証プロトコルの一種です。 <a href="https://qiita.com/TakahikoKawasaki/items/e37caf50776e00e733be" target="_blank" rel="noopener noreferrer">OAuth 2.0</a>プロトコルをベースにしていますが、認証に特化しており、認証と認可の両方をサポートしています。 具体的には、OpenID Connectでは以下のような流れで認証が行われます。<ol><li>クライアントアプリケーションがユーザーを認証サーバーにリダイレクト</li><li>認証サーバーは、ユーザーにログインを要求</li><li>ユーザーがログインすると、認証サーバーはクライアントアプリケーションに認証コードをレスポンス</li><li>クライアントアプリケーションは、認証コードを使用してアクセストークン、IDトークンを取得</li><li>クライアントアプリケーションはIDトークンを検証</li><li>アクセストークンを使用して、クライアントアプリケーションはユーザー情報を取得</li><li>ログイン後画面を返却</li></ol> <h1 id="h28d8ab4132">SSO/OpenIDConnectについて勘違いしがちなこと</h1>SSO全般の部分とOpenIDConnectについて勘違いしがちなことをまとめます。 <h2 id="hb71763dd4d">1. SSOはセキュリティ上のリスクを増やすものではない</h2>SSOを導入すると、1つの認証情報で複数のサービスにアクセスできるため、セキュリティ上の懸念があると考える人もいます。 しかし、適切に実装されたSSOはむしろセキュリティを強化することができます。 例えば、たいていのSSO認証プロバイダーは多要素認証に対応しており、WAFのチューニングも適切に行われています。 その認証方式を丸々利用できると考えると、通常のパスワードIDのログインよりセキュリティリスクの軽減が見込まれます。 SSOはセキュリティのリスクが、、という不安で敬遠する方は、逆にSSOを使わなかった場合の認証方式のセキュリティリスクについても考えてみたほうが良いと思います。 ※かといってSSOのデメリットの一つとして、認証情報が洩れるだけですべてのアプリケーションにアクセス可能になる等といった問題もあります。ここではメリデリを考えて導入を決定するべきということを主張しています。 <h2 id="he0ec2e49ea">2. OpenIDConnectでのSSOログイン成功以降の認証時はIDpへリクエストを行わない</h2>意外と勘違いしていた人が多い印象だったのが、ログイン後のサービスプロバイダの認証方法。 下図はOAuth+OpenIDConnectを使用したSSOのフローです。 この図自体はググってもよく出てくるありきたりなフロー図ですが、皆さん勘違いしているのはログインしたその後。 アクセストークンを利用したリソースの取得以外で、サービスプロバイダはIDpのAPIを叩きません。 OpenIDConnectは認証のプロトコルであり、認証後のセッション管理やアクセス制御とは無関係です。 当然、IDトークン取得後の認証はサービスプロバイダーにゆだねられており、 IDトークンをクライアントで保存してJWT認証するか、はたまたログインセッションを発行するかは実装者次第です。 <img src="https://images.microcms-assets.io/assets/836ad3163d294bd8906c4bb5dc834b92/e27be978a95d493484921baccea2e06f/SSO%E3%83%95%E3%83%AD%E3%83%BC.jpg" alt=""><h2 id="hbfb665d547">3.ログアウトを忘れないで</h2>ログアウト処理、ログアウト後のフローって結構後々になって考え出すこと多いですよね。 SSOログインを導入する場合は、ログアウトのフローについても必ず考慮する必要があります。 SSOを導入したアプリケーション開発では、ここら辺で多分揉めます（実体験）。 特に以下の点については要件定義時に必ず調査して方針を定めておくべきです。<ul><li>IDプロバイダーはシングルログアウトに対応しているのか。</li><li>サービスプロバイダー側の画面で、ログアウトボタンを押した際、シングルログアウトをするのか、それともシンプルにサービスプロバイダー側だけログアウトするのか。</li><li>認証元のサービスからログアウトした際、サービスプロバイダー側のアプリケーションもログアウトするのか。</li></ul> <h2 id="h74be1c737a">4.OAuthとの違い、なぜOpenIDConnectなのかを理解しよう</h2>勘違いというよりか、よく理解しないまま実装する人が多い印象です。 OAuthとOpenIDConnectの違いとしてよく「OAuthが認可のプロトコルであるのに対して、OpenIDは認証のプロトコルである」と説明されています。 OpenIDConnectは認証プロトコルであり、ユーザーが本人であることを証明するためのフローです。具体的には、OpenIDConnectを利用することによって得られるIDトークンにユーザーに関する基本的な情報が含まれており、その内容と署名によって改ざんを検知することにより認証を担保しています。 一方OAuthは認可プロトコルであり、ユーザーが本人であるかという確認（認証）ではなく、ユーザーが自分のリソースに対してアプリケーションのアクセスを許可するためのフローです。Oauthではリソースにアクセスするためのアクセストークンを取得できますが、アクセストークンはOpenIDConnectのIDトークンのように、取得したトークンの改ざんを検証することはできないので、そのアクセストークンがユーザー本人のものかという認証部分は担保できません。 アクセストークンは発行元が制御するサービスによって発行されるため、第三者がアクセストークンを入手した場合には、リソースに不正アクセスできる可能性があります。また、アクセストークンは有効期限があるため、認証情報として使用すると期限切れのアクセストークンが悪用される可能性もあります。 <h1 id="hcbec2bf0d9">終わりに</h1>今回はOpenIDConnectを使ったSSOで勘違いしがちなことを実体験を元にまとめました。 認証認可、暗号化プロトコルは学べは学ぶほど面白くて夜も眠れなくなりますよね、今後もこういった知識系の記事もまとめていこうと思います！

OpenIDConnectを使ったSSOについて

<h1 id="h8d027c8ed3">はじめに</h1>いままで私が実装してきたWebアプリでは、アップロードされた画像に対して、拡張子とファイルサイズの二点のみの検証しか行っていませんでした。 しかし、昨今のAI関連のOSSの発達で、バイナリ単位でのより高度な画像検証が簡単に実装可能になっており、画像に何が映っているのか等の高度な検証を、業務システム畑出身のど素人でも実装することができます。 今回、試しにアップロード画像に顔が映っているかどうかの検証をASP.netのカスタムバリデーションで実装していきます。 今回使用するライブラリは「<a href="https://github.com/shimat/opencvsharp" target="_blank" rel="noopener noreferrer">OpenCvSharp</a>」です。 <h1 id="hbdc914e536">OpenCvSharpとは</h1>インテルが開発・公開した画像処理の有名なOSSライブラリに「<a href="https://github.com/opencv/opencv/tree/master" target="_blank" rel="noopener noreferrer">OpenCv</a>」というものがあります。 20年ほど前から開発、バージョンアップが続いており、画像解析だけでなく、画像編集、生成も可能な万能ライブラリです。 「OpenCV」は主にPythonで動かすライブラリですが、「OpenCvSharp」はそれをC#で利用するためのラッパーです。 もちろんNugetからインストール可能です。 <h1 id="hed900658dc">環境</h1>今回の環境は以下となります。(古いですがCore3.1を使っています。確信は無いですが.Net6,7でも動くと思います。)<ul><li>ASP.net Core3.1</li><li>OpenCVSharp4(4.8.0.20230708)</li></ul> <h1 id="h3d37611809">OpenCvSharpを使用する準備</h1><h2 id="h43b7545a9a">ライブラリインストール</h2>NugetでOpenCVの必要パッケージをインストールします。 ・OpenCvSharp4 ・OpenCvSharp4.runtime.win <img src="https://images.microcms-assets.io/assets/836ad3163d294bd8906c4bb5dc834b92/5384eaa1b12049c0ace8e0ab36f5b02f/OpenCv_Nuget.png" alt=""> <h2 id="hc297c771ab">カスケード分類器？のダウンロード</h2>お恥ずかしながら私はAIについては全くの素人です。 画像から物体を検出するアルゴリズムについての知識は「ゼロ」です。 なので、「カスケード分類器」などと言われてもちっともぴんと来ないのですが、説明文だけ載せておきます。(間違ってたらすみません。)<blockquote>特定の条件をプログラムが判別できるようにまとめたものを「カスケード分類器」といいます。</blockquote>要するに、リンゴは「赤くて、丸くて、房が付いてて…」 みたいな情報をOpenCvが理解できるようにまとめたファイルみたいなものなのでしょう。 カスケード分類器は個人で自作も可能ですが、「人の顔」や「人の体」等の代表的なカスケード分類器はOpenCvのリポジトリからダウンロード可能です。ちなみにOpenCvのカスケード分類器はxml形式です。 下記リンクからダウンロードできます。 ・<a href="https://github.com/opencv/opencv/tree/master/data/haarcascades" target="_blank" rel="noopener noreferrer">openCv/haarcascades</a> 今回は、人の顔を識別するので、「haarcascadefrontalfacedefault.xml」を使用します。 <a href="https://github.com/opencv/opencv/blob/master/data/haarcascades/haarcascade_frontalface_default.xml" target="_blank" rel="noopener noreferrer">https://github.com/opencv/opencv/blob/master/data/haarcascades/haarcascade_frontalface_default.xml</a> ↑からファイルをダウンロードして、任意のフォルダに保存しておきます。 コピペして同名のファイルをローカルに作成すると、エラーになる可能性が高いです。なるべくダウンロードして使いましょう。 ※私はプロジェクトフォルダの「Data/OpenCvSharp/」に保存しました。 <h1 id="h4b4db67da6">カスタムバリデーションを実装</h1>カスタムバリデーションについて知識が無い方は<a href="https://qiita.com/gushwell/items/d659027304645b30b805" target="_blank" rel="noopener noreferrer">こちら</a>をご覧ください。 アノテーション一つで任意のフィールドにバリデーションルールを追加できます。 今回はローカルファイルではなくオンメモリでの画像読み込みなので、<code>Mat.FromStream()</code>を使用してMemoryStreamを読み込んでいますが、その際の第二引数で、オプションを指定できます。<pre><code> var mat = Mat.FromStream(ms,ImreadModes.Color);</code></pre> オプションの説明については<a href="https://shimat.github.io/opencvsharp_docs/html/f2c6a40e-a45a-d2da-e1fc-bbe6e4a2fd31.htm" target="_blank" rel="noopener noreferrer">こちら</a>で詳しい説明がされていますが、基本的には「UnChanged」で問題ないかと思います。 また、これはOpenCvSharpとは関係ないですが、ASP.netMVCでプロジェクトファイルのルートを取得する場合、IWebHostEnviromentをDIから取得する必要があります。 カスタムバリデーションからDIを取得するには、ValidationContext(DI)を引数で取得し、IWebHostEnviroment実装インスタンスを取得します。<pre><code> protected override ValidationResult IsValid(object value,ValidationContext context)</code></pre> 以下がカスタムバリデーションのソースコードです。 <code>PhotoFaceValidationAttribute.cs</code><pre><code>&nbsp; &nbsp; public class PhotoFaceValidationAttribute : ValidationAttribute
&nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; const String ERROR_MSG = "画像から顔を検出することができませんでした。";
&nbsp; &nbsp; &nbsp; &nbsp; protected override ValidationResult IsValid(object value,ValidationContext context)
&nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //ファイルがnullの場合は検証をスルー
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if(value==null) return ValidationResult.Success;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //FormFile形式での取得
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; var postedFile = value as IFormFile;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //カスケード分類器のパスを指定します。
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; var faceCascadeXml = System.IO.Path.Join(((IWebHostEnvironment)context.GetService(typeof(IWebHostEnvironment))).ContentRootPath, "Data","OpenCvSharp","haarcascade_frontalface_default.xml");
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; using (MemoryStream ms = new MemoryStream())
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; postedFile.CopyTo(ms);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //ストリーム現在位置を戻す
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ms.Seek(0, SeekOrigin.Begin);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; var mat = Mat.FromStream(ms,ImreadModes.Color);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //カスケード分類器の読み込み
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; using (CascadeClassifier cascade = new CascadeClassifier(faceCascadeXml))
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //一人以上の顔が見つかったらOK
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if (cascade.DetectMultiScale(mat).Length &gt; 0)
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; return&nbsp; ValidationResult.Success;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; return new ValidationResult(ERROR_MSG);
&nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; }</code></pre> <code>モデル</code><pre><code>&nbsp;public class PhotoEntryViewModel
&nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; [PhotoFaceValidation()]
&nbsp; &nbsp; &nbsp; &nbsp; public IFormFile File { get; set; }
&nbsp; &nbsp; }</code></pre> 実行してみると、人の顔が映っていない画像の時のみ検証に失敗すると思います。 <h1 id="ha214098e44">まとめ</h1>はじめてAIを用いた処理を実装しましたが、専門知識無しでも簡単に実装できることに感動しました。 OpenCvSharpは今後の汎用性も高いと思ったので、次は、カスケード分類器を自作して、好きな画像だけ検出するような処理も作っていけたらなと思います。<h1 id="hcf83e1357e"> </h1>

OpenCvSharpを使ってAIで人の顔が映った画像かどうかを検出し、その検証ロジックをASP.netのバリデーションに応用する方法を解説します。
C#を使っての、はじめてのAIを使った実装となりました。


【C#でAI入門】ASP.Netでアップロード画像に顔が映っているのか検証を行う

<h1 id="h8d027c8ed3">はじめに</h1>DockerコンテナにpostfixのSMTPサーバーを実装します。 めんどくさいことは端折った超簡単な設定です。 リレー周りで少し詰まったので共有させていただきます。 <h1 id="h1eb43247fe">フォルダ構成</h1>メール送信用のアプリケーションもcomposeで立てることを想定しています。 今回、検証用にnodejsでメールを送信するので、composeでコンテナを立てます。<pre><code>project/
　├ app/
 │ ├ node_modules
 │ ├ package.json
 │　└ index.js 
　├ mail/
 │ ├ config/
 │ ｜　└ main.cf
 │　└ log/
 │　　 └ mail.log
　├ docker/
　│　└ postfix/
　│　　　└ Dockerfile
　│　└ app/
　│　　　└ Dockerfile
 ├ .env
　└ docker-compose.yml</code></pre> <h1 id="hf564c124b1">dockerの設定</h1>今回メールサーバーで使用するイメージは「<a style="background-color:#ffffff" href="https://hub.docker.com/r/catatnight/postfix/" target="_blank" rel="noopener noreferrer">catatnight/postfix</a>」です。 nodejsアプリケーションからのメール送信はホスト経由での送信になるので、 「networks」でIPを固定してあげます。 今回の設定だとコンテナ目線のホストマシンのIPは「172.21.0.1」で統一されます。 また、commandでコンテナ起動時にメールを送信します。 docker-compose.yml<pre><code>version: '3.8'
services:
&nbsp; postfix:
&nbsp; &nbsp; build:
&nbsp; &nbsp; &nbsp; context: .
&nbsp; &nbsp; &nbsp; dockerfile: ./docker/postfix/Dockerfile
&nbsp; &nbsp; hostname: postfix
&nbsp; &nbsp; container_name: postfix
&nbsp; &nbsp; ports:
&nbsp; &nbsp; &nbsp; - "${SMTP_PORT}:25"
&nbsp; &nbsp; volumes:
&nbsp; &nbsp; &nbsp; - maildata:/var/mail
&nbsp; &nbsp; &nbsp; - mailstate:/var/mail-state
&nbsp; &nbsp; &nbsp; - ./mail/config/main.cf:/etc/postfix/main.cf
&nbsp; &nbsp; &nbsp; - ./mail/log/mail.log:/var/log/mail.log
&nbsp; &nbsp; environment:
&nbsp; &nbsp; &nbsp; - maildomain=mail.example.com
&nbsp; &nbsp; &nbsp; - smtp_user=${SMTP_USER}:${SMTP_PASS}
&nbsp; &nbsp; networks:
&nbsp; &nbsp; &nbsp; fixed_compose_network:
&nbsp; &nbsp; restart: always
&nbsp; node_app: 
&nbsp; &nbsp; build: 
&nbsp; &nbsp; &nbsp; context: .
&nbsp; &nbsp; &nbsp; dockerfile: ./docker/app/Dockerfile
&nbsp; &nbsp; hostname: app
&nbsp; &nbsp; depends_on:
&nbsp; &nbsp; &nbsp; - postfix
&nbsp; &nbsp; container_name: node_app
&nbsp; &nbsp; volumes:
&nbsp; &nbsp; &nbsp; - ./app:/usr/app
&nbsp; &nbsp; &nbsp; - node_modules:/usr/app/node_modules
&nbsp; &nbsp; networks:
&nbsp; &nbsp; &nbsp; fixed_compose_network:
&nbsp; &nbsp; environment:
&nbsp; &nbsp; &nbsp; - SMTP_USER=${SMTP_USER}
&nbsp; &nbsp; &nbsp; - SMTP_PASS=${SMTP_PASS}
&nbsp; &nbsp; &nbsp; - SMTP_HOST=${SMTP_HOST}
&nbsp; &nbsp; &nbsp; - SMTP_PORT=${SMTP_PORT}
&nbsp; &nbsp; command: sh -c 'npm install &amp;&amp; node /usr/app/index.js'
volumes:
&nbsp; node_modules:
&nbsp; maildata:
&nbsp; mailstate:
networks:
&nbsp; fixed_compose_network:
&nbsp; &nbsp; ipam:
&nbsp; &nbsp; &nbsp; driver: default
&nbsp; &nbsp; &nbsp; config:
&nbsp; &nbsp; &nbsp; &nbsp; - subnet: 172.21.0.0/24</code></pre>.env<pre><code>SMTP_USER=user
SMTP_PASS=password
SMTP_HOST=172.21.0.1
SMTP_PORT=1025</code></pre>app/Dockerfile<pre><code>FROM node:alpine
WORKDIR /usr/app</code></pre>postfix/Dockerfile<pre><code>FROM &nbsp;catatnight/postfix</code></pre> <h1 id="h60988a12e7">メールサーバーの設定</h1>main.cfを編集することでメールサーバーの設定が可能です。 基本的にはデフォルトの設定のままですが、 今回は「172.21.0.1」からのメールのリレーを許可する必要があります。 (私はこのリレーの設定でハマりました。) リレーを許可するには、mynetworksにIPを追記します。<pre><code>mynetworks =172.21.0.1</code></pre> 以下が僕の設定したmain.cfです(特にデフォルトから触っていません)。 main.cf<pre><code>
smtpd_banner = $myhostname ESMTP $mail_name (Ubuntu)
biff = no


# appending .domain is the MUA's job.
append_dot_mydomain = no


# Uncomment the next line to generate "delayed mail" warnings
#delay_warning_time = 4h


readme_directory = no


# TLS parameters
smtpd_tls_cert_file=/etc/ssl/certs/ssl-cert-snakeoil.pem
smtpd_tls_key_file=/etc/ssl/private/ssl-cert-snakeoil.key
smtpd_use_tls=no
smtpd_tls_session_cache_database = btree:${data_directory}/smtpd_scache
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache


# See /usr/share/doc/postfix/TLS_README.gz in the postfix-doc package for
# information on enabling SSL in the smtp client.


smtpd_relay_restrictions = permit_mynetworks
myhostname = mail.example.com
alias_maps = hash:/etc/aliases
alias_database = hash:/etc/aliases
mydestination = dd40882ba0ea, localhost.localdomain, , localhost
relayhost =&nbsp;
#↓ここにIPを追記
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128, 172.21.0.0/24
mailbox_size_limit = 0
recipient_delimiter = +
inet_interfaces = all
smtpd_sasl_auth_enable = yes
broken_sasl_auth_clients = yes
smtpd_recipient_restrictions = permit_mynetworks,permit_sasl_authenticated,reject_unauth_destination</code></pre> <h1 id="hdf1955805a">メール送信用スクリプト</h1>nodejsでのメールの送信は「nodemailer」を使用します。 optionsを指定して送信します。<pre><code>const nodemailer = require('nodemailer');

// SMTP の設定
const options = {
&nbsp; host: &nbsp;process.env.SMTP_HOST, // メールサーバー
&nbsp; port: &nbsp;process.env.SMTP_PORT, // ポート番号 
};
// メールメッセージ
const mail = {
&nbsp; from: {from}, // 送信元メールアドレス
&nbsp; to: {to}, // 送信先メールアドレス
&nbsp; subject: 'Testメール',
&nbsp; text: `送信成功`,
};

// メールの送信
(async () =&gt; {
&nbsp; try {
&nbsp; &nbsp; const transport = nodemailer.createTransport(options);
&nbsp; &nbsp; const result = await transport.sendMail(mail);
&nbsp; &nbsp; console.log('+++ Sent +++');
&nbsp; &nbsp; console.log(result);
&nbsp; } catch (err) {
&nbsp; &nbsp; console.log('--- Error ---');
&nbsp; &nbsp; console.log(err);
&nbsp; }
})();</code></pre> <h1 id="h59b93dba3f">Dockerで実行</h1>コンテナを立ち上げるとメールが送信されます。 また、送信がうまくいかない場合は、mail/log/mail.logを確認してみてください。 <pre><code>docker-compose up -d</code></pre>

DockerでSMTPサーバーを立ち上げ、nodeJsでメールを送信するシンプルな構築をするチュートリアルです。


Dockerで簡単にメールサーバーを実装

<h1 id="h8d027c8ed3">はじめに</h1>ASP.netでページング機能を実装するチュートリアルの記事は多いですか、どこか助長で拡張性に欠ける実装が多かったので、普段私が使用しているクラスの構成を共有します。 <h1 id="hed900658dc">環境</h1><ul><li>ASP.net Core 3.1</li><li>Bootstrap4</li><li>X.PagedList.Mvc.Core 8.4</li><li>EntityFrameWork Core</li><li>BootstrapIcon4</li></ul> <h1 id="h82ff5f5177">ヘルパークラスの実装</h1><h2 id="h1334ac44ea">インターフェース</h2><pre><code>//ページング機能付き一覧ページ(ソート機能付き)
public interface IPaginationListViewModel&lt;T&gt; : IListViewRouteCondition
&nbsp; &nbsp; &nbsp; &nbsp; where T : class&nbsp;
{
 //一覧の表示結果
 &nbsp; &nbsp; public IPagedList&lt;T&gt; Results { get; set; }
　　 
}
//検索、ソート、ページングのパラメータ
public interface IListViewRouteCondition
{
　　//ソートするフィールド名
&nbsp; &nbsp; public string SortF { get; set; }

　　 //ソートの方向
&nbsp; &nbsp; public string Dir { get; set; }

　　//表示したいページ
&nbsp; &nbsp; &nbsp;public int? Page { get; set; }

　　 //一覧に検索項目がある場合はその値をDictionaryで取得できるメソッドを実装
&nbsp; &nbsp; &nbsp;public Dictionary&lt;string, string&gt; GetSearchKeyValues();
}</code></pre><h2 id="hcaf727aa1b">EFのOrderBy、OrderByDscendingをプロパティ名でソートできるように拡張メソッドを作成</h2>Expressionを使用しています。 SQLを発行する前に指定のプロパティ名からプロパティのオブジェクトを取得するコードをコンパイルするイメージです。<pre><code>/// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// プロパティ名で昇順ソート
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;typeparam name="T"&gt;&lt;/typeparam&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;param name="source"&gt;&lt;/param&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;param name="propertyName"&gt;&lt;/param&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;returns&gt;&lt;/returns&gt;
&nbsp; &nbsp; &nbsp; &nbsp; public static IOrderedQueryable&lt;T&gt; OrderBy&lt;T&gt;(this IQueryable&lt;T&gt; source, string propertyName)
&nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; return source.OrderBy(ToLambda&lt;T&gt;(propertyName));
&nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// プロパティ名で降順ソート
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;typeparam name="T"&gt;&lt;/typeparam&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;param name="source"&gt;&lt;/param&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;param name="propertyName"&gt;&lt;/param&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;returns&gt;&lt;/returns&gt;
&nbsp; &nbsp; &nbsp; &nbsp; public static IOrderedQueryable&lt;T&gt; OrderByDescending&lt;T&gt;(this IQueryable&lt;T&gt; source, string propertyName)
&nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; return source.OrderByDescending(ToLambda&lt;T&gt;(propertyName));
&nbsp; &nbsp; &nbsp; &nbsp; }


&nbsp; &nbsp; &nbsp; &nbsp; private static Expression&lt;Func&lt;T, object&gt;&gt; ToLambda&lt;T&gt;(string propertyName)
&nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; var parameter = Expression.Parameter(typeof(T));
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; var property = Expression.Property(parameter, propertyName);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; var propAsObject = Expression.Convert(property, typeof(object));


&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; return Expression.Lambda&lt;Func&lt;T, object&gt;&gt;(propAsObject, parameter);
&nbsp; &nbsp; &nbsp; &nbsp; }</code></pre><h2 id="h40dbf67e33"> 抽象一覧作成用基底クラス</h2>デフォルト一覧表示行数10、ソート順のパラメータは"asc"、"desc"としています。 特に変わったことはしていませんが、<pre><code>public abstract class PagedListProcessBase&lt;T, T_Row&gt; where T: IPaginationListViewModel&lt;T_Row&gt;&nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; where T_Row : class&nbsp;
&nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; protected const int DEFAULT_PAGE_SIZE = 10;
&nbsp; &nbsp; &nbsp; &nbsp; protected const int DEFAULT_PAGE = 1;
&nbsp; &nbsp; &nbsp; &nbsp; protected const string DESC = "desc";//ソートの際に使用されるパラメータ(降順)
&nbsp; &nbsp; &nbsp; &nbsp; protected const string ASC = "asc";//ソートの際に使用されるパラメータ(昇順)
&nbsp; &nbsp; &nbsp; &nbsp; protected readonly AppDbContext _context;//EFのDbContext
&nbsp; &nbsp; &nbsp; &nbsp; public PagedListProcessBase(AppDbContext context)
&nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; _context = context;
&nbsp; &nbsp; &nbsp; &nbsp; }


&nbsp; &nbsp; &nbsp; &nbsp; public abstract Task&lt;T&gt; GetDataAsync(T vm);
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// 基本クエリ
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;returns&gt;&lt;/returns&gt;
&nbsp; &nbsp; &nbsp; &nbsp; protected virtual IQueryable&lt;T_Row&gt; GetBaseQuery() =&gt; _context.Set&lt;T_Row&gt;();
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// ソート
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;param name="query"&gt;&lt;/param&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;param name="sortfield"&gt;&lt;/param&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;param name="descOrAsc"&gt;&lt;/param&gt;
&nbsp; &nbsp; &nbsp; &nbsp; protected virtual void SetFieldSortQuery(ref IQueryable&lt;T_Row&gt; query, string sortfield, string descOrAsc)
&nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if (String.IsNullOrEmpty(sortfield)) return;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if (descOrAsc == "desc")
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; query = query.OrderByDescending(sortfield);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; else
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; query = query.OrderBy(sortfield);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; 
&nbsp; &nbsp; }

</code></pre><h2 id="h4caa7f762a">ソートのリンク生成用タグヘルパー</h2>IListViewSearchConditionで実装している検索パラメータ群をViewから取得し、ソート用のリンクを生成するコードです。 AchorTagHelperを継承していればRouteValuesプロパティにパラメータを追加するだけで、レンダリング後のhrefの値を編集できます。 ソートの順番やアイコンのタグなどは適宜調整してください。<pre><code>public class SortTagHelper : AnchorTagHelper
&nbsp; &nbsp; {
　　　　//PagedListProcessBaseと同じ値を使用するので、どこかに静的な変数として保管しておくとBetter
&nbsp; &nbsp; &nbsp; &nbsp; const string DESC = "desc";
&nbsp; &nbsp; &nbsp; &nbsp; const string ASC = "asc";
&nbsp; &nbsp; &nbsp; &nbsp; public SortTagHelper(IHtmlGenerator generator ) : base(generator)
&nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; [HtmlAttributeName("asp-for")]
&nbsp; &nbsp; &nbsp; &nbsp; //現在のソート、ページング、検索条件
&nbsp; &nbsp; &nbsp; &nbsp; public IListViewRouteCondition SortAndSearch { get; set; }
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// リンクを作成する対象のフィールド(プロパティ名)
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; public string PropertyName { get; set; }
&nbsp; &nbsp; &nbsp; &nbsp;&nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; public async override Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
&nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //検索条件を設定
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; foreach (var searchVerb in SortAndSearch.GetSearchKeyValues())
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if(!String.IsNullOrEmpty(searchVerb.Value))RouteValues.Add($"Con.{searchVerb.Key}",searchVerb.Value);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //ページング設定を設定
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if (SortAndSearch.Page != null)
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {&nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; RouteValues.Add(nameof(SortAndSearch.Page), SortAndSearch.Page.ToString());
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if (SortAndSearch.PageSize != null)
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; RouteValues.Add(nameof(SortAndSearch.PageSize), SortAndSearch.PageSize.ToString());
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //ソート
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; var descOrAscClassName ="";
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; var sortmode = "";
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //現在ソート対象のフィールドである場合、ソート順を参照して次回ソート順のリンクを作成
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //ソートの順序：降順＝＞昇順＝＞ソート無し=&gt;降順...
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if (SortAndSearch.SortF == PropertyName)
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; descOrAscClassName = $"dir-{SortAndSearch.Dir}";//viewに反映されるクラス名
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if (SortAndSearch.Dir == DESC)
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; sortmode = DESC;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; RouteValues.Add(nameof(SortAndSearch.SortF), PropertyName);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; RouteValues.Add(nameof(SortAndSearch.Dir), ASC);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; else if (SortAndSearch.Dir == ASC)
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; sortmode = ASC;


&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //ソート対象でない場合降順ソートのリンクを作成
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; else
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; RouteValues.Add(nameof(SortAndSearch.SortF), PropertyName);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; RouteValues.Add(nameof(SortAndSearch.Dir), DESC);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; await base.ProcessAsync(context,output);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; output.TagName = "a";
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; output.Attributes.Add("class", $"table-header {descOrAscClassName} text-nowrap sort-link");
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //昇順、降順それぞれの場合に表示するアイコン
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if (sortmode == ASC)
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; output.PostContent.SetHtmlContent($"&lt;i class=\"bi bi-caret-down-fill\"&gt;&lt;/i&gt;");
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; else if(sortmode == DESC)
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {&nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; output.PostContent.SetHtmlContent($"&lt;i class=\"bi bi-caret-up-fill\"&gt;&lt;/i&gt;");
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; }</code></pre> <h1 id="hf2fbc75167">ヘルパークラスを利用して実装してみる</h1><h2 id="hd1f3776a36">検索条件クラス</h2><pre><code>&nbsp;/// &lt;summary&gt;
&nbsp; &nbsp; /// 顧客一覧検索条件
&nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; public class GuestListSearchCondition
&nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// 顧客名
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; public string Name { get; set; }
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// 会社名
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; public string CompanyName { get; set; }
&nbsp; &nbsp; }</code></pre> <h2 id="hf4711ba66b">一覧(ViewModel)クラス　</h2>IPaginationListViewModelを実装しておくだけでいいです。 ※Guestsで定義しているのはEFでバインドされる対象のモデルです。<pre><code>&nbsp;/// &lt;summary&gt;
&nbsp; &nbsp; /// 顧客一覧ViewModel（検索、ソート、ページングあり）
&nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; public class GuestListViewModel : IPaginationListViewModel&lt;Guests&gt;
&nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// 検索条件
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; public GuestListSearchCondition Con { get; set; } = new GuestListSearchCondition();
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// 一覧
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; public IPagedList&lt;Guests&gt; Results { get; set; }
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// ソートするカラム
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; public string SortF { get; set; }
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// ソートの方向
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; public string Dir { get; set; }
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// 現在のページ
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; public int? Page { get; set; }
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// ページサイズ
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; public int? PageSize { get; set; }

　　　　/// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// 検索条件をDictionaryで取得
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; public Dictionary&lt;string, string&gt; GetSearchKeyValues()
&nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; return new Dictionary&lt;string, string&gt;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; { nameof(Con.Name),Con.Name}
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; };
&nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; }</code></pre> <h2 id="hb31e834edc">一覧データ取得用クラスの実装</h2>PagedListProcessBaseを継承します。 検索、ソート、データ取得部分で特殊な動きを実現したい場合は検索、ソートメソッドをオーバーライドしてください。<pre><code>public class GuestListProcess: PagedListProcessBase&lt;GuestListViewModel, Guests&gt;
&nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; public GuestListProcess(AppDbContext context):base(context)
&nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; }
 /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// 表示データ取得
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;param name="vm"&gt;&lt;/param&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;returns&gt;&lt;/returns&gt;
&nbsp; &nbsp; &nbsp; &nbsp; public async override Task&lt;GuestListViewModel&gt; GetDataAsync(GuestListViewModel vm)
&nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //基本クエリ生成
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; var query = GetBaseQuery();
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //ソート
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; SetFieldSortQuery(ref query, vm.SortF, vm.Dir);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //検索
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; SetSearchQuery(ref query, vm.Con);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //データ取得
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; vm.Results = await query.ToPagedListAsync(vm.Page ?? DEFAULT_PAGE, vm.PageSize ?? DEFAULT_PAGE_SIZE);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; return vm;
&nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; 
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// 検索
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;/summary&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;param name="query"&gt;&lt;/param&gt;
&nbsp; &nbsp; &nbsp; &nbsp; /// &lt;param name="con"&gt;&lt;/param&gt;
&nbsp; &nbsp; &nbsp; &nbsp; private void SetSearchQuery(ref IQueryable&lt;T_Guest&gt; query, GuestListSearchCondition con)
&nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //従業員名
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; query = query.WhereEx(!String.IsNullOrEmpty(con.Name), x =&gt; x.Name.Contains(con.Name));
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //会社名
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; query = query.WhereEx(!String.IsNullOrEmpty(con.CompanyName), x =&gt; x.CompanyName.Contains(con.CompanyName));
&nbsp; &nbsp; &nbsp; &nbsp; }
}</code></pre><h2 id="h2d51efde38">Controller</h2><pre><code>/// &lt;summary&gt;
/// 従業員一覧
/// &lt;/summary&gt;
/// &lt;returns&gt;&lt;/returns&gt;
[HttpGet]
public async Task&lt;IActionResult&gt; List(GuestListViewModel vm)
&nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; var proc = new GuestListProcess(_context);
&nbsp; &nbsp; &nbsp; &nbsp; return View(await proc.GetDataAsync(vm));
&nbsp; &nbsp; }</code></pre><h2 id="habf12851ff">View（ソート用のリンク部分）</h2>自作のタグヘルパーを利用し、asp-forにIListViewRouteConditionを実装しているModelを指定し、PropertyNameにはソート対象のプロパティ名を指定します。<pre><code>&lt;th scope="col"&gt;
&nbsp; &nbsp; &nbsp;&lt;sort asp-for="@Model" property-name="@nameof(Guests.Name)"&gt;従業員名&lt;/sort&gt;
&lt;/th&gt;</code></pre> <h1 id="ha214098e44">まとめ</h1>今回は検索、ソート、ページング機能付きの一覧画面を実装しました。 この実装をしてから、一覧のViewとデータ取得処理部分の実装、保守工数が削減できました。 XpagedListを凌駕する便利なページングライブラリが出るまではこの方法で一覧画面を作っていく予定です。

ASP.NET Core MVCで検索、列ソート、ページング機能付きの一覧ページを作成します。
タグヘルパーを使用してViewのコーディング時間を大幅に短縮することに成功しました。

ASP.NET Core MVCで検索、列ソート、ページング機能付きの一覧を作成する。

<h1 id="h8d027c8ed3">はじめに</h1>LINQ、便利ですよね。 VB.net、C#でコレクション操作をするのにLINQ無しではやってられないほどです。 便利なLINQですが、 複雑な業務でシステムを作っていると、既存のLINQクエリメソッドだけでは賄いきれないケースもあります。 僕が業務の中で使用している自作のLINQカスタムメソッドをまとめてみました。 ※LINQの拡張については「<a style="background-color:#ffffff" href="https://github.com/morelinq/MoreLINQ" target="_blank" rel="noopener noreferrer">MoreLinq</a>」「<a style="background-color:#ffffff" href="https://github.com/mariusschulz/ExtraLINQ" target="_blank" rel="noopener noreferrer">ExtraLinq</a>」等が有名ですので、こちらも参考にしてみるとさらに面白いカスタムLINQが作れるかもですね。 <h1 id="hf031c5e696">実装方法</h1>LINQのメソッドはIEnumerable&lt;T&gt;で定義されているので、IEnumerableの静的メソッドを定義すれば、 簡単に自作のLINQクエリメソッドが実装できます。 例として、Whereを自作する場合の実装方法を紹介します。 コレクションをforeachで回して、該当レコードだった場合、 イテレータ(yield)を使ってそのレコードを返します。 イテレータを使うことで遅延評価で実行可能となります。 <code>例-自作Where</code><pre><code>public static class EnumerableEx
{
 public static IEnumerable&lt;T&gt; Where&lt;T&gt;(this IEnumerable&lt;T&gt; source, Func&lt;T, bool&gt; f)
 {
 foreach (var item in source)
 {
 if (f(item)) yield return item;
 }
 }
}</code></pre> <h1 id="h530d14e56f">NULL、Default値を除外する</h1>基本的ですがよく使います。<pre><code>public static IEnumerable&lt;T&gt; ExcludeNullOrDefault&lt;T&gt;(this IEnumerable&lt;T&gt; source)
{
&nbsp; &nbsp; foreach (var item in source)
&nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; if (item == null || item.Equals(default(T))) continue;
&nbsp; &nbsp; &nbsp; &nbsp; yield return item;
 &nbsp; &nbsp;}
}</code></pre> <h1 id="h806b2627b5">検索結果をインデックス付きで返すWhere</h1>順番に取り出してKeyValuePair等の辞書を作成します。<pre><code>public static IEnumerable&lt;KeyValuePair&lt;int,T&gt;&gt; WhereWithIndex&lt;T&gt;(this IEnumerable&lt;T&gt; source, Func&lt;T, bool&gt; f)
{
&nbsp; &nbsp; int index = -1;
&nbsp; &nbsp; foreach (var item in source)
&nbsp; &nbsp; {
 &nbsp; &nbsp; &nbsp; &nbsp;checked { index++; }//indexのオーバーフローを補足
&nbsp; &nbsp; &nbsp; &nbsp; if (f(item)) yield return new KeyValuePair&lt;int, T&gt;(index, item);
&nbsp; &nbsp; }
}</code></pre> <h1 id="he1c4dda99c">指定のフィールドの値が最も高い(低い)レコードを複数件取得</h1>一番高いレコードを探す時点ですべての要素にアクセスするので、ここでは遅延評価に対応する必要はありません。<pre><code>public static IEnumerable&lt;TSource&gt; MaxBy&lt;TKey,TSource&gt;(this IEnumerable&lt;TSource&gt; source, Func&lt;TSource, TKey&gt; keySelector)&nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; where TKey:IComparable&lt;TKey&gt;,IEquatable&lt;TKey&gt;
{
 //最大値を取得
&nbsp; &nbsp; var max = source.Max(keySelector);
 //最大値のレコードを全取得
&nbsp; &nbsp; return source.Where(x=&gt;keySelector(x).Equals(max));
}</code></pre> <h1 id="h545c618dfc">特定基準日から数えて一年ごとにGroupBy</h1>LINQの自作というより、GroupByの処理を共通化するためのメソッドです。 timestampを持っているクラスのコレクションを年度ごとでまとめることが可能です。 業務システムでは帳票データを年度ごとで集計するようなケースが多いので載せました。<pre><code>&nbsp;public static IEnumerable&lt;IGrouping&lt;int,T&gt;&gt; YearGroupBy&lt;T&gt;(this IEnumerable&lt;T&gt; source, Func&lt;T, DateTime&gt; keyselector,(int month,int day) reference)
&nbsp;{
&nbsp; &nbsp; &nbsp; return source.GroupBy(x =&gt;
&nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; var date = keyselector(x);
　　　　　//基準月日を超得ていない場合、年度はdate-1になる。
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if (date.Day &gt;= reference.day &amp;&amp; date.Month &gt;= reference.month)
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; return date.Year;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; else
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; return date.Year - 1;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; });
}</code></pre> <h1 id="ha166d92c51">同一プロパティ名の値をコピーした別クラスのコレクションを取得</h1>AutoMaapperのIEnumerable版。 例外処理はだいぶ省略してます。<pre><code>public static IEnumerable&lt;TTarget&gt; AutoMap&lt;TSource,TTarget&gt;(this IEnumerable&lt;TSource&gt; source)
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; where TTarget:new() where TSource:class
{
&nbsp; &nbsp; &nbsp; foreach (var item in source)
&nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; var targetObj = new TTarget();
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; foreach (var prop in typeof(TSource).GetProperties())
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; var targetProp =typeof(TTarget).GetProperty(prop.Name);
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //プロパティが存在しないor型が一致しない場合は処理をスキップ
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if (targetProp == null || targetProp.GetType()!=prop.GetType()) continue;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; targetProp.SetValue(targetObj, prop.GetValue(item));
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; yield return targetObj;
&nbsp; &nbsp; &nbsp; }
}</code></pre> <h1 id="ha214098e44">まとめ</h1>随時更新中。

自作のLINQクエリメソッドをまとめた備忘録です。


自作のLINQカスタムメソッド集(随時更新)

<h1 id="h8d027c8ed3">はじめに</h1>reactのチュートリアルから誰もがお世話になるcreate-react-app。 reactのアプリケーションをコマンド一発で楽々に作ることができますよね。 便利だし、早いし、typescriptの環境構築も楽勝です。 めちゃくちゃ便利なだけあってreact初心者は、 自動でインストールされているwebpack等の関連ライブラリを意識できません。 create-react-appを使用して開発を始めると、「package.json？？なんやそれ、、怖いから触らないでおこう」的な軽いノリで、 モダンJSにおいて大事な部分を見て見ぬふりをしながら、reactを触り始めることができてしまいます。 今回は、create-react-appを使わずにreact環境構築をして、 いろいろすっ飛ばしてきた部分を理解しつつ、create-react-appと遜色ない環境を作っていきます。 <h1 id="h31d727ccda">準備</h1>npmで各種パッケージをインストールし、環境構築していきます。 ※Node.Js、npmをインストールできていない方は下記を参考にしてください。 <a href="https://qiita.com/mk185/items/7ad004bf202f400daea1" target="_blank" rel="noopener noreferrer">Node.js、npmのインストール方法|Qiita</a> <h2 id="h64340b7f1f">プロジェクトフォルダを作成</h2>プロジェクト名は「react-forum」とします。<pre><code>#「react-forum」フォルダの作成
$ mkdir react-forum 
#react-forumフォルダ直下に移動
$ cd react-forum</code></pre> <h2 id="h8325fac47a">package.jsonを生成</h2>package.jsonの中にはインストールしたパッケージがJson形式で記録されています。 実行すると、コマンドラインでいろいろ聞かれると思いますが全部エンターを押して飛ばしてもらって問題ないです。<pre><code>#package.jsonを作成
$ npm init</code></pre>ここまではお約束といった感じですね。 <h2 id="h693109469e">Webpackをインストールする</h2>webpackの主な役割を簡単に説明すると、 複数のJavascriptやcss等のモジュールを一つのjsファイルにまとめてくれるライブラリです。 Webpackについては、下記で詳しく説明しておりますので、もっと知りたい方は下記を参考にしてください。 Webpackのパッケージを二つインストールします。<ul><li>webpack …Webpackの本体</li><li>webpack-cli …インストールしたWebpackをコマンドラインから実行できるツール</li></ul> <pre><code> $ npm install webpack webpack-cli</code></pre>　ここで package.jsonの中身を確認してみましょう。 <code>package.json</code><pre><code>{
&nbsp; "name": "react-forum",
&nbsp; "version": "1.0.0",
&nbsp; "description": "",
&nbsp; "main": "index.js",
&nbsp; "scripts": {
&nbsp; &nbsp; "test": "echo \"Error: no test specified\" &amp;&amp; exit 1"
&nbsp; },
&nbsp; "author": "",
&nbsp; "license": "ISC",
 //この中にインストールしたパッケージ名とバージョンが追加されていきます。
&nbsp; "devDependencies": {
&nbsp; &nbsp; "webpack": "^5.74.0",
&nbsp; &nbsp; "webpack-cli": "^4.10.0"
&nbsp; }
}</code></pre> devDependenciesにwebpack、webpack-cliが追記されていることが確認できれば問題ないです。 ちなみに、先ほどののインストールは「--save-dev」というオプションを付けましたが、これを付けた場合、 開発環境でのみ使うことができるパッケージとしてインストールされます。 「--save-dev」を付けなかった場合本番環境、開発環境両方で使えるパッケージとなり、 package.jsonのdependenciesに追加されます。 webpackはローカルでビルドする際にしか使用しないので、「--save-dev」オプションをつけてインストールします。 <h2 id="h3365c8559c">webpack.config.jsを作成</h2>「webpack.config.js」はwebpackの設定ができるJsファイルです。 入出力ファイルの設定はもちろんのこと、ビルド時のカスタマイズなど様々な設定ができます。 ルートディレクトリにwebpack.config.jsを作成します。<pre><code>$ mkdir webpack.config.js</code></pre> 今回は出力ファイルを「dist/static/main.js」としています。 各設定項目の説明はコメントに記載。 <code>webpack.config.js</code><pre><code>const path = require('path')
module.exports = {
 // 'development'に設定すると、バンドルファイルに「元のコード」と「変換後のコード」との
 // 対応関係が記述されたコメントが記述されます
 // 'production'に設定すると、コメントは記述されず、最適化されたコードで変換されます
 mode: 'development',

 // 最初に実行する変換前のファイル
　// 今回はsrcフォルダのindex.tsを指定
 entry: './src/index.ts',
　//バンドルファイルの出力設定
 //__dirnameでプロジェクトのルートパスを取得できます。
 output: {
 path: path.join(__dirname, '/dist/static'), 
 filename: 'main.js' //出力ファイル名
 },
　//importの際に省略する拡張子をextension:配列で指定
 resolve: {
 extensions: ['.ts', '.tsx', '.js'] 
 },
};</code></pre> <h2 id="h16db2c4abf">Typescriptの導入</h2>reactに限らず、webpack+typescriptの開発環境を作る上で必要な手順は下記のようになります。<ol><li>typescriptをjavascriptに変換(トランスパイル)するモジュールのインストール(typescript)</li><li>1の変換モジュールをwebpackで使えるようにするライブラリのインストール(ts-loader)</li><li>トランスパイルをどのように行うのかの設定</li><li>webpackでバンドルする際に、トランスパイルを実行するように設定</li></ol> まずは１，２のモジュールをインストールします。<pre><code>$ npm install --save-dev typescript ts-loader</code></pre> 次にトランスパイルをどのように行うかの設定を行います。 トランスパイルの設定を行います。<pre><code>$ mkdir tsconfig.json</code></pre> <code>tsconfig.json</code><pre><code>{
&nbsp; &nbsp; "compilerOptions": {
&nbsp; &nbsp; &nbsp; "target": "es5",//出力するjavascriptのバージョン
&nbsp; &nbsp; &nbsp; "jsx": "react",//jsxをReact.createElementに変換する設定。jsxのままにするような場合は"preserve"で指定
&nbsp; &nbsp; &nbsp; "strict": true,//trueにするとtypescriptのコンパイル時の型チェックがより厳格になる。
&nbsp; &nbsp; &nbsp; "esModuleInterop": true,//CommonJSとESモジュール間との相互運用を可能にするためのフラグです。積極的にtrueで大丈夫です。
 "removeComments": true,//出力ファイルのコメントを削除するかどうか
&nbsp; &nbsp; &nbsp; "skipLibCheck": true,//.d.tsファイルの型チェックをスキップする。
&nbsp; &nbsp; &nbsp; "forceConsistentCasingInFileNames": true//importするファイル名の大文字小文字を区別するかどうか。
&nbsp; &nbsp; }
}</code></pre> 最後に、4の手順です。 webpack.config.jsにmodule.rulesを追加し、「.ts」「.tsx」ファイルに対してts-loaderを使ってトランスパイルする設定します。 <code>webpack.config.js</code><pre><code>const path = require('path')
module.exports = {
 mode: 'development',
 entry: './src/index.ts',
 output: {
 path: path.join(__dirname, '/dist/static'), 
 filename: 'main.js' //出力ファイル名
 },
 //追加
 module: {
 rules: [
 {
 // 「.ts 」または「.tsx 」ファイルを変換するよ～
 test: /\.(ts|tsx)$/,
 // ts-loaderを使って変換するよ～
 use: 'ts-loader',
 },
 ],
 }
 resolve: {
 extensions: ['.ts', '.tsx', '.js'] 
 },
};</code></pre> <h2 id="hb56aa222ec">Reactをインストール</h2>Reactを使うためにはreact本体と、react-domの二種類のパッケージをインストールする必要があります。 react本体には、おなじみのreact機能が入っていて、 react-domはreactとDOMを橋渡しするような役割があります。 <pre><code>$ npm install react react-dom</code></pre> <h2 id="he838d27aab">Reactのtypesをインストール</h2>せっかくtypescriptを使っているのにreactのtypesがないことには意味がありません。<pre><code>$ npm install @types/react @types/react-dom</code></pre>@types/reactの中身に興味がある方はnode_modules/@types/react内の「index.d.js」、「global.d.js」のソースを見てみることもお勧めします。 <h1 id="hae07df4dac">Reactで動作確認</h1>ここまでで typescriptでreact開発 ↓ webpackでバンドル までの一連の流れを行う設定はできています。 あとは、reactの中身を書いて、webpackの出力ファイル(デフォルトで/dist/main.js) をhtmlで読み込んで表示していきます。 <h2 id="hf72561ba15">index.ts、app.tsxの作成</h2>webpack実行時のエントリポイントとなる「src/index.ts」と、親コンポーネントとなるApp.tsxを作成をします。 srcディレクトリを作成します。<pre><code>$ mkdir src</code></pre> srcディレクトリの中にファイルを二つ作成します。 (どうやらreactのv18以降はrender()は使えないみたいなので、createRoot()を使ってます。) <code>index.ts</code><pre><code>import React from "react";
import { createRoot } from 'react-dom/client';
import App from "./app"

const ROOT_ID = "root"&nbsp;as const ;//次に作成するdist/index.htmlのルート要素のid

const rootElement = document.getElementById(ROOT_ID);

//rootElementは HTMLElement | null なので、nullの場合の処理を書かないと怒られます
if (!rootElement) throw new Error(`${ROOT_ID}の要素が見つかりません。`);

const root = createRoot(rootElement);
root.render(&lt;App/&gt;);</code></pre> <code>app.tsx</code><pre><code>import React from 'react'

function App() {
&nbsp; return (
&nbsp; &nbsp; &lt;h1&gt;Hello World!!&lt;/h1&gt;
&nbsp; )
}
export default App</code></pre> <h2 id="hfefa9e7a08">index.htmlを作成</h2>webpack実行時の出力ファイルはdist/static/main.jsなので、distフォルダを作成し、 dist直下にindex.htmlを作ってあげます。 reactをレンダリングする部分にはindex.jsでも指定した、id="root"を設定します。 バンドルファイル(static/main.js)はhtml読み込み後に実行しなければならないので、 defer属性を付与することを忘れないようにしてください。 <code>dist/index.html</code><pre><code>&lt;!DOCTYPE html&gt;
&lt;html&gt;
&nbsp; &nbsp; &lt;head&gt;
&nbsp; &nbsp; &nbsp; &nbsp; &lt;meta charset="UTF-8"&gt;
&nbsp; &nbsp; &nbsp; &nbsp; &lt;script defer src="static/main.js"&gt;&lt;/script&gt;
&nbsp; &nbsp; &nbsp; &nbsp; &lt;title&gt;掲示板&lt;/title&gt;
&nbsp; &nbsp; &lt;/head&gt;
&nbsp; &nbsp; &lt;body&gt;
&nbsp; &nbsp; &nbsp; &nbsp; &lt;div id="root"&gt;&lt;/div&gt;
&nbsp; &nbsp; &lt;/body&gt;
&lt;/html&gt;</code></pre> <h2 id="h752a5347cd">webpackを実行</h2>ここまで出来たらあとはwebpackを実行すれば、src配下のファイルがdist/static/main.jsにバンドルされます！ 実行する際はnpm の場合パスが通っていないので、npxを使用します。 （npxで実行した場合には、node_modules/.bin配下から実行するファイルを選んで実行してくれます。）<pre><code>$ npx webpack</code></pre> npmで実行したい場合は、package.jsonファイルのscriptにビルドコマンドを追加し、実行します。 <code>package.json</code><pre><code>"scripts": {
&nbsp; &nbsp; "test": "echo \"Error: no test specified\" &amp;&amp; exit 1",
&nbsp; &nbsp; "build":"webpack"
&nbsp; },</code></pre> <pre><code>$ npm run build</code></pre> dist/static/main.jsが作成されていれば成功です。 <h2 id="hd8b55bdbee">index.htmlをブラウザで確認</h2>エクスプローラからdist/index.htmlを実行してみましょう。 <img src="https://images.microcms-assets.io/assets/836ad3163d294bd8906c4bb5dc834b92/0316efc60a1f498c956b8f120b774c6a/reacttutorial1.jpg" alt=""> 成功！！！ でも毎度毎度コマンドをたたいてブラウザを確認するのは不便ですよね。 ここからはローカルサーバーを使ってよりサクサクテストできる環境を作っていきます。 <h2 id="h783d76bdef">webpack-dev-serverをインストール</h2>webpack-dev-serverを使えば、保存時に変更の差分のみバンドルファイルに即時反映され、効率よく開発を行うことができます。 webpack-dev-serverをインストールします。 ※「webpack-devserver」という似て非なるパッケージもあるので、インストールする際は気を付けてください。<pre><code>$ npm install --save-dev webpack-dev-server</code></pre> 続いて、webpack-dev-serverの設定を行っていきます。 webpack.config.jsでdevserverオプションを設定することで、webpack-dev-serverの起動時の挙動や、サーバーの設定が可能です。 <code>webpack.config.js</code><pre><code>&nbsp; &nbsp; //webpack-dev-serverの設定
&nbsp; &nbsp; devServer: {
&nbsp; &nbsp; &nbsp; &nbsp; static: path.join(__dirname, '/dist'), //webpackの出力先を指定してあげてください
&nbsp; &nbsp; &nbsp; &nbsp; open: true, //ブラウザを自動的に起動します
&nbsp; &nbsp; &nbsp; &nbsp; port: 3000 //ポート番号を3000番に指定
&nbsp; &nbsp; },</code></pre> それではwebpack-dev-serverを起動してみましょう。<pre><code>$npx webpack-dev-server</code></pre>ブラウザが自動で起動し、http://localhost:3000で先ほどの画面が見れれば成功です。 <h2 id="he7d561ed84">webpack-dev-serverでホットリロードが効かない</h2>webpack-dev-serverを起動した状態で、src配下のファイルに何かしらの変更を加えて保存してみましょう。 変更がブラウザに反映されていないと思います。 僕はこれに引っ掛かって何時間もハマっていました。 何時間もの格闘の末、 「webpack-dev-serverはオンメモリでバンドル結果を保持していて、 そのバンドル結果はデフォルトで表示する静的ファイル直下のmain.jsからアクセスできるようになっている」 という事実が判明し、解決に至りました。 つまり、webpack-dev-serverのバンドル結果にアクセスするためのパスを変更してあげる必要があるということです。 この変更はwebpack.config.jsのoutput.publicPathから行います。 <code>webpack.config.js</code><pre><code>&nbsp;output: {
&nbsp; &nbsp; &nbsp; &nbsp; path: path.join(__dirname, '/dist/static'), 
&nbsp; &nbsp; &nbsp; &nbsp; publicPath: '/static/', //staticディレクトリ直下のmain.jsからバンドル結果にアクセスできるように変更
&nbsp; &nbsp; &nbsp; &nbsp; filename: 'main.js'
&nbsp; &nbsp; },</code></pre> これで、ホットリロードが正常に機能するはずです。 <h1 id="ha214098e44">まとめ</h1>今回は、create-react-appを使わずにtypescript+react開発の環境構築方法について解説いたしました。 webpack、typescript周りについて、まだまだ理解できていないことが多いなと反省するいいきっかけになりました。

create-react-appを使わずに、reactで掲示板を作る準備編。
webpackの解説多めでreact+typescriptの環境構築をするチュートリアルです。
より深くreactを理解したい方に向けたreact初心者向けの記事となっています。


create-react-appなしでReact+typescriptの環境を構築しwebpackを理解する

<h1 id="h8d027c8ed3">はじめに</h1>私がなぜNext.Jsでブログを作ったかというと、SPAでかつSSGできて、基本的なSEO対策も簡単にできるという点に惹かれたからです。 僕と同じようにNextJSでサイトを構築された方なら少なからず同じような考えで、NextJsを選定されているのではないかと思います。 特にSSGしている分、初期表示速度については必要以上に気になってしまう方が多いのではないかと思います。 私も同様で、表示速度について気になって気になって、自己流で何度も試行錯誤をしてきました。 しかし、ある程度基本的な速度対策をした後に、「この対策がどれぐらい意味を成しているのか」という疑問が生まれてきます。 そこで使ってみようと思ったのが、Google提供の「PageSpeed Insights」です。 <h1 id="h124e852a10">PageSpeed Insightsとは</h1><blockquote>PageSpeed Insights API（PSI）は、モバイル端末向けとパソコン向けの両方のページにおけるパフォーマンスに関するレポートと、そのページを改善する最適化案を提供します。参照：<a style="color:#202124" href="https://developers.google.com/speed/docs/insights/v5/about" target="_blank" rel="noopener noreferrer">PageSpeed Insights API について</a></blockquote> 要は、ページの表示速度、サイトパフォーマンスを点数化してくれるGoogle公式のAPIです。 Google公式なだけあって、この点数がSEOにも影響してるとかしてないとか。 <h1 id="hdcc132a15c">まずは自分のブログをPSIで診断してみた</h1>結果は以下の通りです。 <code>デスクトップ</code> <img src="https://images.microcms-assets.io/assets/836ad3163d294bd8906c4bb5dc834b92/87612fd87b3a4216a9d8d8a892de36ac/PageSpeedInsights-before..jpg" alt=""> <code>モバイル</code> <img src="https://images.microcms-assets.io/assets/836ad3163d294bd8906c4bb5dc834b92/7d6c507729f64e87812629bed1bbabf9/PSI-mobile-before..jpg" alt=""> デスクトップは89、モバイルは65。 モバイルの数値が気になる、、 実はこれでも、まあまあ対策したほうです。 この数値が出る前に私がやったことは、<ul><li>@next/<a href="https://www.npmjs.com/package/webpack-bundle-analyzer" target="_blank" rel="noopener noreferrer">bundle-analyzer</a>を使用して、クライアント側にバンドルされている不要なJavascriptを削除(hljs等)</li><li>静的画像をできるだけ圧縮</li><li>next/linkを使用したタグで、プレレンダリングが必要ない部分のprefetch属性をfalseに変更</li></ul> ここまでは調べてできる範囲の対策ですね。 特に、bundleanalyzerを使って不要なバンドルファイルを除外するのはかなり効果があったと思います。 しかしこの数値、、、 「いったいこれ以上何をすればええんや！！」 案ずるなかれ、さすがは天下のGoogle様。 ご丁寧にその数値が出た原因も記述されていました。 <img src="https://images.microcms-assets.io/assets/836ad3163d294bd8906c4bb5dc834b92/66ef7fe7aa1d405abab594e6053da6f4/PSI-detail-2..jpg" alt=""> 要するにwebpackの不要なチャンクを削除しろよと。 <h1 id="h35bf254f20">PSI数値、上げてみた</h1><h2 id="h2220f0ef7d">やったこと</h2><ul><li>cheerioをクライアント側で使っている部分があったので、サーバー側ですべてパースできるように最適化</li><li>MUIをpaginationのみ使用していたため、React-paginationに移行、MUIを削除</li><li>開発環境でデバックしたところ、Linkコンポーネント周りで警告があったので修正</li></ul>	<h2 id="hb6509f48bf">結果</h2><code>デスクトップ</code> <img src="https://images.microcms-assets.io/assets/836ad3163d294bd8906c4bb5dc834b92/215d2a00ccb24b1185ff05590cfd782b/psi_afrter1.jpg" alt=""> <code>モバイル</code> <img src="https://images.microcms-assets.io/assets/836ad3163d294bd8906c4bb5dc834b92/3ecf22506eea4c4b984cb4eda5773703/psi_afrter2.jpg" alt=""> デスクトップ 89→94 モバイル 65→72 誤差程度には上がりました。 理想としてはモバイルは85以上には上げたいのですが、、 <h2 id="he6e3e00f90">効果があったと考えられる対策</h2>webpackのチャンクが大きいという警告は修正後も治っていなかったので、 多分そこまで効果が無かったのでしょう。 では何がPSIの点数を上げる要因になったのかというと、 デバック時に警告があったLink周りを修正したからだと考えられます。 開発環境でプロジェクトを立ち上げると、コンソールに 「Warning: Prop href did not match. Server: "category/tutorial/page/1" Client: "/category/tutorial/page/1」が表示されていました。 NectJsでSSGされたレンダリング結果と、クライアント側でのレンダリング結果に差異があった場合、このような警告が出るみたいです。 Next.Jsでは、サーバー側で生成されたhtmlと、クライアント側でのレンダリング結果の差分を検知するようになっています。 差異が無かった場合、クライアントサイドでのレンダリングコストはかかりませんが、 差異があった場合はクライアントサイドで再度レンダリングが行われてしまいます。 当然、この差異があった場合はレンダリング時のパフォーマンスも悪くなってしまい、PSIの数値にも悪影響を与えます。 ちなみに、僕の場合<pre><code>&lt;NextLink href={`category/${categoryArticle.categoryId}/page/1`}&gt;</code></pre>となっていたところを<pre><code>&lt;NextLink href={`/category/${categoryArticle.categoryId}/page/1`}&gt;</code></pre> に変えただけで、パフォーマンスが上がったわけです。 <h1 id="ha214098e44">まとめ</h1>Next.Jsで作られた当ブログのPageSpeedInsightsの数値を少しだけ改善してみました。 今回はデバック時の警告を直すだけでスコアが改善されました。 ここまでやっておいてなんなんですが、ぶっちゃけ数値が悪かろうがユーザーの体感値的に遅くなければ問題なくね？ とかも思ったりします。 あまりPSIの数値にセンシティブになっているより、 他のSEO対策やUI/UXの改善に時間を割く方が効率的なのかもしれませんね。

Next.js(Static Site Generation)で作られたサイトのPageSpeedInsightsの数値を改善する方法についての記事です。
特にモバイルの数値が上がらない方に参考になればと思います。
JAMStack構成のブログを作成されている方、React(SPI)を使ったサイトでのPSI数値を上げる方法について考察します。


Next.JsでPageSpeed Insightsのスコアを上げたい！

<h1 id="h8d027c8ed3">はじめに</h1>NextJs+Typescript+MicroCMS構成のブログ作成チュートリアルは様々なQAサイト、ブログに記事があります。 それら記事を拝見しながら作った本ブログですが、 技術的に一歩踏み込んだところで、「どう実装するんだ？」となってしまった部分がいくつかありました。 その中でも今回は、「ページング付きの、カテゴリ別記事一覧」の実装方法についてまとめてみようという試みです。 <h1 id="h8a175a9b0e">前提</h1>今回の記事は、以下の知識があることを前提とした説明になっています。<ul><li>GetStaticProps、GetStaticPathsの大まかな挙動を理解している。</li><li>TypeScriptの基礎(型や宣言)について理解している。</li></ul> また、本記事はNextJsでSSGをする方法、MicroCMSのAPI連携部分の実装等、いろいろとすっ飛ばして説明しています。 基本的なブログの作成方法に関する、記事は下記リンクを参考にしてください。 <a style="background-color:#ffffff" href="https://blog.microcms.io/microcms-next-jamstack-blog/" target="_blank" rel="noopener noreferrer">microCMS + Next.jsでJamstackブログを作ってみよう｜MicroCMS公式Blogより</a> 環境構築～デプロイの手順がとってもわかりやすくまとまっています。 (MicroCMS公式ブログはわかりやすくて、ためになる優良記事ばかりで、控えめに言って、最高です。 Next.Jsについての記事もたくさんありますので、他記事を拝読することもお勧めします。) <h1 id="h922edff87b">実装</h1><h2 id="hc6a9bd6981">ファイル作成</h2>pagesディレクトリに、category/[categoryId]/page/[page].tsxを追加します。 ディレクトリ構成<pre><code>pages
|-category
 |-[categoryId]
 |-page
 |- [page].tsx &lt;=追加
|-_app.tsx
|-index.tsx</code></pre> <code>pages.tsx</code><pre><code>import { GetStaticPaths, GetStaticProps, NextPage } from 'next';
//1ページに表示する最大記事数
const MAX_PAGE =10 as const;

type Props={
&nbsp; data:IMicroCMSBlogRes,
&nbsp; page:number,
&nbsp; categoryName:string,
&nbsp; categoryId:string
}

const CategoryPage:NextPage&lt;Props&gt; =({categoryName,data,page,categoryId})=&gt;{
&nbsp; return(
&nbsp; &nbsp; &lt;&gt;&lt;/&gt;
 &nbsp; )
}

export const getStaticPaths:GetStaticPaths =async () =&gt;{
&nbsp; return //GetStaticPathsの結果オブジェクト
}

export const getStaticProps:GetStaticProps=async({params}:GetStaticPropsContext)=&gt;{
&nbsp; &nbsp;return //Props
}
export default CategoryPage;</code></pre>GetStaticPaths、GetStaticProps、NextPageの中身はとりあえず空にしています。 個人的な好みで、コンポーネントごとに固有のpropsは　 <code>type Props={}</code> で統一していますが、命名は好みで変えてください。 今回使用するtypescriptの型は以下のようになっています。 <code>interfaces/microCMS.ts</code><pre><code>//MicroCMSAPIからの取得記事
export interface IArticle {
&nbsp; &nbsp; id: string
&nbsp; &nbsp; createdAt: string
&nbsp; &nbsp; updatedAt: string
&nbsp; &nbsp; publishedAt: string
&nbsp; &nbsp; revisedAt: string
&nbsp; &nbsp; title: string
&nbsp; &nbsp; content: string
&nbsp; &nbsp; description:string
&nbsp; &nbsp; eyecatch:{
&nbsp; &nbsp; &nbsp; &nbsp; url: string
&nbsp; &nbsp; height: number
&nbsp; &nbsp; width: number
&nbsp; &nbsp; }
&nbsp; &nbsp; category:ICategory
}

export interface ICategory{
&nbsp; &nbsp; id:string
&nbsp; &nbsp; name:string
}

//MicroCMAPIからのレスポンス固定のパラメータ
export interface IMicroCMSRes{
&nbsp; totalCount: number,
&nbsp; &nbsp; offset: number,
&nbsp; &nbsp; limit: number
}

//BlogエンドポイントのAPIレスポンス
export interface IMicroCMSBlogRes extends IMicroCMSRes{
&nbsp; contents:IArticle[]
}
//CategoryエンドポイントのAPIレスポンス
export interface IMicroCMSCategoriesRes extends IMicroCMSRes{
&nbsp; contents:ICategory[]
}</code></pre> <h2 id="h3ae2ec230b">GetStaticPaths内の処理</h2>GetStaticPathsの処理です。<pre><code>export const getStaticPaths:GetStaticPaths =async () =&gt;{
　//全カテゴリ取得
&nbsp; const categories =await GetAllCategories();
　
&nbsp; const pathsNotFlat = await Promise.all(
&nbsp; &nbsp; categories.map((category:ICategory) =&gt; {
　　　//カテゴリごとに記事数を取得し、何ページ必要かを計算
&nbsp; &nbsp; &nbsp; return GetPostsCountInCategories(category.id)
&nbsp; &nbsp; &nbsp; &nbsp; .then((totalCount) =&gt; {
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; const range = (start: number, end: number) =&gt;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; [...Array(end - start + 1)].map((_, i) =&gt; start + i);
 //ページの最大値を計算(記事数0でも表示)
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; const pagesEnd =Math.max(1,Math.ceil(totalCount / MAX_PAGE));
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; return range(1, pagesEnd ).map(
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; page =&gt; `/category/${category.id}/page/${page}`
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; )
&nbsp; &nbsp; &nbsp; });
&nbsp; &nbsp; })
&nbsp; )
&nbsp; const paths=pathsNotFlat.flat();

&nbsp; return { paths, fallback: false }
}</code></pre> 解説していきます。 まず、await GetAllCategories() で、MicroCMSに登録されているブログのカテゴリを全て取得します。 GetAllCategories()内の処理については、MicroCMSに登録されている全カテゴリを取得し、 IMicroCMSCategoriesResの型で返しているだけなので割愛します。 次に、Promise.All()内で、取得したカテゴリごとに、紐づいている記事の数を取得しています。 MicroCMSのデータ取得APIには、SQLで言うJoinにあたるクエリが無い(無いかもしれない)ので、 カテゴリ全取得 → 各カテゴリごとに記事数取得 という、とってもめんどくさいプロセスを踏んでいます。 (今思えば全記事を取得してreduce()でカテゴリごとの記事数をまとめたほうが良かったのかも、、) GetPostsInCategories()では、該当するIDのカテゴリの記事件数を取得してきます。 関数の中身はこのようになっています。 <code>lib/posts.ts</code><pre><code>export async function getPostsCountInCategories(id:string):Promise&lt;number&gt;{
&nbsp; const data:IMicroCMSCategoriesRes =await client.get({
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; endpoint: 'blogs',
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; queries: {filters: `category[equals]${id}`,fields: "totalcount"}
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; });
&nbsp; return data.totalCount;
}</code></pre>APIでカテゴリに紐づいているブログ数を取得しています。 この関数をPromiseで返し、PromiseAll()で全カテゴリの件数取得を待ちます。 続いて、GetPostsCountInCategories()のメソッドチェーンになっている.then()の中身についてです。 range()で、表示するすべてのページ番号を配列で取得します。<pre><code>const range = (start: number, end: number) =&gt;[...Array(end - start + 1)].map((_, i) =&gt; start + i);</code></pre>start～endの数値の連番を配列を返します。 range(1,5)は[1,2,3,4,5]を返すといった具合です。 ちなみに、<pre><code>Array(end-start+1).map((_, i) =&gt; start + i);//×Array()がemptyの配列を返すため、map()が機能しない。</code></pre>としてしまうと、一見動きそうですが動かないので注意です。<a href="https://qiita.com/dojyorin/items/eb4f6c1562791f613d14" target="_blank" rel="noopener noreferrer">参考：【JavaScript】Array.prototype.map()とemptyな配列</a> 動的に連番を取得する上記の関数は地味によく使うので、テンプレとして覚えておくことをお勧めします。 カテゴリごとの記事の最大ページ数を計算します。<pre><code>const pagesEnd = Math.max(1,Math.ceil(totalCount / MAX_PAGE));</code></pre>「総記事数÷1ページに表示したい記事数」を切り上げることで、ページ数が取得できます。 この時の注意点としては、記事数0、すなわちページ数0でもページを表示できるようにすることです。 今回はMath.max()を使用して、ページ数の最小値を1にしています。 SSGするページのルーティングを文字列で返します。 当然ですが生成するパスは、category/[categoryId]/page/[page].tsxのディレクトリ名と一致させてください。<pre><code>return range(1, pagesEnd ).map(
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; page =&gt; `/category/${item.id}/page/${page}`
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; )</code></pre> pathsオブジェクトで返したい場合は、paramsを持ったオブジェクトを返してください。<pre><code>//これでもいけます。
return range(1, pagesEnd ).map(
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; page =&gt; {
 params:{
 category:item.id
 page:page
 }
 }
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; )</code></pre> await PromiseAll()によって得られる値は、配列にしたルーティングを、カテゴリでごとにさらに配列したものになります。 string[][]となってしまっているので、string[]に直してあげます。<pre><code>&nbsp;const paths=pathsNotFlat.flat();//string[][]=&gt;string[]</code></pre> <h2 id="he813800427">GetStaticProps内の処理</h2>getStaticPropsの処理です。<pre><code>export const getStaticProps:GetStaticProps=async({params})=&gt;{
&nbsp; &nbsp;const categoryId = String(params?.categoryId);//カテゴリIDを取得
&nbsp; &nbsp;const categoryPage = Number(params?.page);//ページ
&nbsp; &nbsp;const data = await getPostsInCategories(MAX_PAGE,categoryPage-1,categoryId);//記事を取得
&nbsp; &nbsp;const categoryName = await GetCategoryName(categoryId);//カテゴリ名を取得
&nbsp; &nbsp;return {
&nbsp; &nbsp; props:{
&nbsp; &nbsp; &nbsp; data,
&nbsp; &nbsp; &nbsp; categoryPage,
&nbsp; &nbsp; &nbsp; categoryName,
&nbsp; &nbsp; &nbsp; categoryId
&nbsp; &nbsp; }
&nbsp; &nbsp;}
}</code></pre> paramsのメンバにはgetStaticPathsで定義したcategoryId,pageが含まれていますが、 今回の例では、getStaticPathsの戻り値を厳密に型指定していないので、補完が効かないことに注意してください。 getStaticPaths、getStaticPropsの引数を厳密に型指定したい方はこちらが参考になります。 <a href="https://zenn.dev/eitches/articles/2021-0424-getstaticprops-type" target="_blank" rel="noopener noreferrer">[Next] getStaticPropsの型の付け方、型定義について｜zenn</a> 一覧にする記事情報をawait getPostsInCategories()で取得します。 ブログ取得のクエリにoffsetとlimitを指定して、 「先頭から何件目」を、「何件取得するのか」を指定することで、ページごとの記事一覧を取得できます。<pre><code> 

export async function getPostsInCategories(count:number,offset:number,id:string):Promise&lt;IMicroCMSBlogRes&gt;{
&nbsp; const data:IMicroCMSBlogRes =await client.get({ endpoint: 'blogs',
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; queries: {filters: `category[equals]${id}`, 
　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　limit: count, 
　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　offset: offset}});
&nbsp; return data;
}</code></pre>カテゴリ名はわざわざAPIで取得せずとも、記事一覧から取得可能ですが、今回はわかりやすくするために、APIで取得するようにしています。 <code>await GetCategoryName()</code>で、カテゴリＩＤに対応するカテゴリ名を取得しています。 <h2 id="hf667e4873b">ページネーションの実装</h2>最後に、getStaticPropsによって取得した記事の一覧データを使って、NextPage関数内でページネーションを実装します。 ページネーションは、MUIを使うと簡単に実装できます。 MUIをインストールします。<pre><code>// npm
npm install @mui/material @emotion/react

// yarn
yarn add @mui/material @emotion/react</code></pre> @mui/materialからPaginationコンポーネントをインポートし、各propsを割り当てます。 詳しくは、<a href="https://mui.com/material-ui/react-pagination/" target="_blank" rel="noopener noreferrer">MUI/Pagination｜MUI公式</a>を参考にしてください。<pre><code>import { GetStaticPaths, GetStaticProps, NextPage } from 'next';
import { Pagination } from '@mui/material';//追加
//1ページに表示する最大記事数
const MAX_PAGE =10 as const;

//～～～～～～～～～～～～～～～

const CategoryPage:NextPage&lt;Props&gt; =({categoryName,data,page,categoryId})=&gt;{
　const totalPagesCount = Math.ceil(data.totalCount/MAX_PAGE);//記事数からページ数を計算
&nbsp; return(
&nbsp; &nbsp; &lt;&gt;
 &lt;Pagination 
 count={totalPagesCount} 
 page={page} 
 siblingCount={3} /&gt;
 &lt;/&gt;
 &nbsp; )
}</code></pre> ページネーションをnext/linkで遷移できるようにします。 next/routerからuseRouterモジュールをインポートし、 PaginationコンポーネントのonChangeイベントで、routerのpushイベントを発火させると、 任意のページに遷移できます。<pre><code>const CategoryPage:NextPage&lt;Props&gt; =({categoryName,data,page,categoryId})=&gt;{
　const totalPagesCount = Math.ceil(data.totalCount/MAX_PAGE);
　const router = useRouter();
&nbsp; &nbsp;const handlePageChange = (event: React.ChangeEvent&lt;unknown&gt;, page: number) =&gt; {
&nbsp; &nbsp; &nbsp; let {pathname} = router;//現在のドメイン以降のパスを取得(パラメータは取得できない)
&nbsp; &nbsp; &nbsp; router.query.page=page:
&nbsp; &nbsp; &nbsp; router.push({
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; pathname:pathname,
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; query:router.query
&nbsp; &nbsp; &nbsp; })
&nbsp; }
&nbsp; return(
&nbsp; &nbsp; &lt;&gt;
 &lt;Pagination 
　　　　onChange={handlePageChange}//追加
 count={totalPagesCount} 
 page={page} 
 siblingCount={3} /&gt;
 &lt;/&gt;
 &nbsp; )
}</code></pre>useRouter()から取得できるpathNameは、ドメイン以降のパスを取得できますが、パラメータは取得できません。 たとえば、category/blog/page/1のページで取得できるpathNameは”category/[categoryId]/page/[page]”となります。 よって、ページ遷移をしたいのであれば、router.queryを書き換えるのがよさそうです。 最後に、無理やり一覧画面を作るとすればこんな感じです。 <pre><code>const CategoryPage:NextPage&lt;Props&gt; =({categoryName,data,page,categoryId})=&gt;{
　const totalPagesCount = Math.ceil(data.totalCount/MAX_PAGE);
 const articles = datas.contents;
　const router = useRouter();
&nbsp; &nbsp;const handlePageChange = (event: React.ChangeEvent&lt;unknown&gt;, page: number) =&gt; {
&nbsp; &nbsp; &nbsp; let {pathname} = router;//現在のドメイン以降のパスを取得(パラメータは取得できない)
&nbsp; &nbsp; &nbsp; router.query.page=page:
&nbsp; &nbsp; &nbsp; router.push({
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; pathname:pathname,
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; query:router.query
&nbsp; &nbsp; &nbsp; })
&nbsp; }
&nbsp; return(
&nbsp; &nbsp; &lt;&gt;
 　　　&lt;h1&gt;{categoryName}&lt;/h1&gt;
 &lt;ul&gt;
 {articles.map(article=&gt;
 &lt;li&gt;{article.title}&lt;/li&gt;
 )}
 &lt;/ul&gt;
 &lt;Pagination 
 　　　　onChange={handlePageChange}
 count={totalPagesCount} 
 page={page} 
 siblingCount={3} /&gt;
 &lt;/&gt;
 &nbsp; )
 }</code></pre> 後は見た目のみですね！スタイルは適当に当てましょう。(本ブログはChakraUIを使ってスタイリングしています) <h1 id="ha214098e44">まとめ</h1>今回はNextJs+MicroCMSのブログでの、カテゴリ別記事一覧の実装方法について説明しました。 ただのカテゴリ別一覧なのに、意外と骨が折れる工程でしたね、、 まだまだ改善の余地があると思うので、ご自身で実装する際は自分なりに工夫してみてください！

Next.Js+MicroCMS+Typescriptで、カテゴリ別の記事一覧を実装する方法です。
Pages内で、2階層以上のDynamicRoutingを実装する方法についてチュートリアル形式で説明します。
javascript /typescript/ ブログの作り方/テックブログ

やかんのブログ

最新記事一覧

カテゴリ別おすすめ記事

Yakan

Yakan