Tweet

.NET TIPS ［ASP.NET MVC］有効期限のあるルーティング規則を定義するには？［3.5、4以降、C#、VB］ 山田 祥寛 2010/08/19

　「TIPS：［ASP.NET MVC］特定のHTTPメソッドにマッチするルートを定義するには？」では、標準の制約条件クラスであるHttpMethodConstraintクラス（System.Web.Routing名前空間）を利用して、ルートの制約を定義する方法について紹介した。

　しかし、.NET Framework 4の時点で標準提供される制約条件クラス（IRouteConstraintインターフェイス（System.Web.Routing名前空間）の実装クラス）は、HttpMethodConstraintクラスだけである。そのほか、制約条件を課したい場合には、自分でIRouteConstraint実装クラスを用意しなければならない。

　本稿では、自作の制約条件を定義する例として、特定の日時までの間だけ有効なルートを定義してみよう（指定日時を経過すると、ルートは無効化される）。このような制約条件は、特定の期間のみ展開するキャンペーン・ページを構築する場合に利用できるだろう。

　それではさっそく、具体的な実装の手順を見ていく。

1. 制約条件クラスを実装する

　まずは、制約条件を表すIRouteConstraint実装クラスの定義からだ。

using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.Routing; namespace MvcAppCs.Extensions {   public class DateTimeConstraint : IRouteConstraint {     // ルートの有効期限を表すプライベート変数_Limit     private DateTime _Limit = DateTime.MaxValue;     // コンストラクタ（ルートの有効期限をセット）     public DateTimeConstraint(DateTime limit) {       this._Limit = limit;     }     // ルートが有効であるかを判定するMatchメソッド     public bool Match(HttpContextBase httpContext, Route route, string parameterName, RouteValueDictionary values, RouteDirection routeDirection) {       var current = DateTime.Now;       // 現在の日時が_Limitよりも未来であれば、ルートは無効       if (current > this._Limit) { return false; }   ……       return true;     }   } } Public Class DateTimeConstraint   Implements IRouteConstraint   ' ルートの有効期限を表すプライベート変数_Limit   Private _Limit As DateTime = DateTime.MaxValue   ' コンストラクタ（ルートの有効期限をセット）   Public Sub New(ByVal limit As DateTime)     Me._Limit = limit   End Sub   ' ルートが有効であるかを判定するMatchメソッド   Public Function Match(ByVal httpContext As HttpContextBase, ByVal route As Route, ByVal parameterName As String, ByVal values As RouteValueDictionary, ByVal routeDirection As RouteDirection) As Boolean Implements IRouteConstraint.Match     Dim current = DateTime.Now     ' 現在の日時が_Limitよりも未来であれば、ルートは無効     If current > Me._Limit Then Return False   ……     Return True   End Function End Class

現在の日時が指定された有効期限より前であるかを判定する制約条件（上：DateTimeConstraint.cs、下：DateTimeConstraint.vb）

　制約条件クラス（IRouteConstraint実装クラス）で実装しなければならないメソッドは、Matchメソッドだけである。これはルートを決定する際に呼び出されるメソッドで、そのルートが有効であるかどうかをtrue／falseで返す必要がある（ルートを無効にする場合はfalse）。

　また、Matchメソッドが受け取る引数は、先頭から順に以下の表のとおりである。

データ型	概要
HttpContextBase	HTTP通信に関する情報を管理
Route	ルート定義に関する情報を管理
string	制約のキー名（MapRouteメソッドで定義された文字列）
RouteValueDictionary	ルート・パラメータのセット
RouteDirection	リクエストURLの処理方法
Matchメソッドが受け取る引数

　DateTimeConstraintクラスでは、コンストラクタで有効期限を示す変数「_Limit」をセットしておき、これをMatchメソッドで現在の日時と比較しているわけだ（）。現在の日時が_Limitよりも未来である場合、Matchメソッドはfalse（ルートは無効）を返す。

2. 制約条件付きのルートを定義する

　制約条件クラスが定義できたら、実際にDateTimeConstraint制約を利用したCampaignルートを設定してみよう。ルート定義そのものに関する詳細は、「TIPS：［ASP.NET MVC］ルート定義を追加するには？」を参照していただきたい。

　制約条件は、MapRouteメソッドの第4引数に「キー名 = IRouteConstraint実装クラスのインスタンス」の匿名型として指定するのだった。手順1で見たように、DateTimeConstraintクラスのコンストラクタには、有効期限を表すDateTimeオブジェクトを渡す必要がある。つまり、ここでは2010年5月10日12時までを有効期限としたルートを定義していることになる。

　以上を理解できたら、さっそく「http://localhost:8080/Campaign/108」のようなURLでアクセスしてみよう。有効期限（2010年5月10日12時）以前の場合には正しくRoute/Indexアクションの内容が、有効期限以降の場合には、404 Not Foundエラーが返され、ルートが無効化されていることが確認できるはずだ。

有効期限のあるルーティング規則を定義したサンプルの実行結果

　制約条件の挙動を確認する際には、コンピュータの日付設定を変更するか、Campaignルートの有効期限を変更すればよい。

この記事と関連性の高い別の.NET TIPS ［ASP.NET MVC］ルート・パラメータに妥当な日付が渡されているかを判定するには？ ［ASP.NET MVC］特定のHTTPメソッドにマッチするルートを定義するには？ ［ASP.NET MVC］特定のルートを無効化するには？ ［ASP.NET MVC］ルート・パラメータに制約条件を追加するには？ ［ASP.NET MVC］ルート定義を追加するには？ このリストは、（株）デジタルアドバンテージが開発した 自動関連記事探索システム Jigsaw（ジグソー） により自動抽出したものです。 generated by

「.NET TIPS」

＠ITメールマガジン　新着情報やスタッフのコラムがメールで届きます（無料）