galife: ASP.NET

ラベル ASP.NET の投稿を表示しています。すべての投稿を表示

machineKey の生成ツール

ASP.NET MVC + Web API でフォーム認証の実装

ASP.NET MVC でフォーム認証の実装方法

認証（Authentication）と承認（Authorization）の違い

ASP.NET Web API のルーティング

ASP.NET Web API におけるクエリパラメーターとメッセージボディーのバインド

ASP.NET Web API で DataContract の利用

ASP.NET Web API でレスポンスヘッダーの設定

Web API を利用していると、簡単にレスポンスヘッダーを調整することができます。ほとんどは HttpResponseMessage クラス の設定で処理を行います。以下に、ケース別の具体例を掲載します。

Content-Type の書き換え
ステータスコードの書き換え
カスタムレスポンスヘッダー

Content-Type の書き換え

何も設定しない場合、application/json になるので、ここでは text/plain に設定する例を掲載します。

namespace WebService
{
    using System.Text;
    using System.Web;
    using System.Web.Http;

    public class SampleController : ApiController
    {
        public string Get()
        {
            var response = this.Request.CreateResponse(HttpStatusCode.OK);

            response.Content = new StringContent("Hello World.", Encoding.UTF8, "text/plain");

            return response;
        }
    }
}

ステータスコードの書き換え

namespace WebService
{
    using System.Web;
    using System.Web.Http;

        public HttpResponseMessage Post()
        {
            try
            {
                // 何か処理

                return this.Request.CreateResponse(HttpStatusCode.OK);
            }
            catch
            {
                return this.Request.CreateErrorResponse(HttpStatusCode.InternalServerError, "エラーメッセージ");
            }
        }
}

カスタムレスポンスヘッダー

namespace WebService
{
    using System.Web;
    using System.Web.Http;

    public class SampleController : ApiController
    {
        public HttpResponseMessage Options()
        {
            var response = this.Request.CreateResponse(HttpStatusCode.OK);

            response.Headers.Add("Access-Control-Allow-Origin", "*");
            response.Headers.Add("Access-Control-Allow-Methods", "GET, POST, OPTIONS");
            response.Headers.Add("Access-Control-Max-Age", "1728000");

            return response;
        }
    }
}

今回、以下のサイトを参考にしました。

ASP.NET Web API で独自フィルターの実装方法

ASP.NET Web API チュートリアル

クロスドメイン制約を XmlHttpRequest level 2 で回避（プリフライト）

WCF Web サービスにおけるレスポンスヘッダーの設定方法

WCF を利用した RESTful Web サービスの作成

クロスドメイン制約を JSONP で回避（ASP.NET MVC + jQuery）

C# で .mdf (SQL Server データベースファイル) を開く

Visual Studio のプロジェクトに追加された SQL Server データベースファイル (mdf ファイル) を SqlConnection を用いて開いて利用する方法を見ていきます。テーブルはサーバーエクスプローラーで開いて GUI を使ってあらかじめ登録してあるものとします。（サンプルコードでは Person テーブルが作られている前提の処理となっています。）

サンプルコードのダウンロード

（※ SQL Server データベースの中身を見る or 操作するだけなら黒猫 SQL Studio が個人的には好みです。）

サンプルコード（抜粋）

namespace DataBaseService.Controllers
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Web;
    using System.Web.Mvc;
    using System.Data.SqlClient;
    using System.Data;

    public class HomeController : Controller
    {
        //
        // GET: /Home/

        public ActionResult Index()
        {
            var connectionString = string.Empty;
            connectionString += @"Data Source=.\SQLEXPRESS;";
            connectionString += @"AttachDbFilename=";
            connectionString += this.Server.MapPath("./App_Data/Database.mdf");
            connectionString += @";";
            connectionString += @"Integrated Security=true;";
            connectionString += @"User Instance=true;";

            DataTable dataTable = new DataTable();

            using (SqlConnection connection = new SqlConnection())
            {
                var query = "SELECT * from Person";
                using (SqlCommand cmd = new SqlCommand(query, connection))
                {
                    connection.ConnectionString = connectionString;
                    connection.Open();
                    
                    SqlDataAdapter da = new SqlDataAdapter(cmd);
                    da.Fill(dataTable);

                    connection.Close();
                }
            }

            return View();
        }

    }
}

説明

上記サンプルコードの 21行目はデータベースファイルへのパスなので、環境により変化します。

connectionString がなかなかうまくいかず、いろいろと試して上記コードでなんとかうまく動きました。

ASP.NET MVC （C#）でアプリケーションを作成していて、スタブとして .mdf ファイルのデータベースが利用できると作業効率もあがるのではないか… そんな考えで、SQL Server データベースファイルの利用方法をまとめてみました。

ASP.NET MVC でページ遷移を記録するフィルター

ブラウザでどのようにページ遷移が行われたかを簡単に記録するためのフィルターを作成します。

このフィルターを利用することで「不適切なページ遷移を拒否できる」とか「ブラウザの戻る機能の無効化」ができるようになることを目指します。

ソースコード
説明
使用例

ソースコード

閲覧履歴をセッションに残すフィルターを作成します。ここでは Filters フォルダ & 名前空間を１つ掘って実装しています。

BrowsingHistoryAttribute.cs

namespace SampleMvcApplication.Filters
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Web;
    using System.Web.Mvc;

    /// <summary>
    /// 閲覧履歴をセッションに記録するフィルター属性を表します。
    /// </summary>
    public class BrowsingHistoryAttribute : FilterAttribute, IActionFilter
    {
        /// <summary>
        /// 直前に閲覧したURLをセッションに保存するキー文字列
        /// </summary>
        public static string PREVIOUS_URL = "PREVIOUS_URL";

        /// <summary>
        /// 現在要求されたURLをセッションに保存するキー文字列
        /// </summary>
        public static string CURRENT_URL = "CURRENT_URL";

        /// <summary>
        /// アクション結果の実行後に ASP.NET MVC フレームワークによって呼び出されます。
        /// </summary>
        /// <param name="filterContext">フィルター コンテキスト</param>
        public void OnActionExecuted(ActionExecutedContext filterContext)
        {
        }

        /// <summary>
        /// アクション結果の実行前に ASP.NET MVC フレームワークによって呼び出されます。
        /// </summary>
        /// <param name="filterContext">フィルター コンテキスト</param>
        public void OnActionExecuting(ActionExecutingContext filterContext)
        {
            // 必要な変数を取得
            var httpContext = filterContext.HttpContext;
            var session = httpContext.Session;
            var request = httpContext.Request;

            // POST と Ajax リクエスト は記録しない
            if (request.HttpMethod == "POST" || request.IsAjaxRequest())
            {
                return;
            }

            // リクエストURL を正規化
            var url = this.GetNormalizedRequestUrl(httpContext);

            // 閲覧履歴を更新
            session[PREVIOUS_URL] = session[CURRENT_URL];
            session[CURRENT_URL] = url;
        }

        /// <summary>
        /// リクエストURLを正規化します
        /// </summary>
        /// <param name="httpContext">HTTP コンテキスト</param>
        /// <returns>正規化された リクエストURL</returns>
        private string GetNormalizedRequestUrl(HttpContextBase httpContext)
        {
            var routeData = System.Web.Routing.RouteTable.Routes.GetRouteData(httpContext);
            var controllerName = routeData.Values["controller"].ToString().ToLower();
            var actionName = routeData.Values["action"].ToString().ToLower();
            var queryString = httpContext.Request.QueryString.ToString();

            if (string.IsNullOrEmpty(queryString))
            {
                return string.Format("{0}/{1}", controllerName, actionName);
            }
            else
            {
                return string.Format("{0}/{1}?{2}", controllerName, actionName, queryString);
            }
        }
    }
}

説明

フィルターなので FilterAttributeクラスの継承を行います。今回のフィルターはできるだけ早いタイミングで実施したいので、IActionFilterインターフェースの実装を行っています。

.OnActionExecuting でセッションに対して閲覧履歴を更新しにかかります。 POST と Ajax リクエストは保存しないように処理されています。

.OnActionExecuted は特に必要な処理がないので何も記述しない空のメソッドになります。

リクエストURLはショートカットされる場合（MapPathに登録されていたり、IndexのようにIISに登録されていたりする場合）があるので、 .GetNormalizedRequestUrl 関数を利用してキチンとしたURLへ再マッピングしなおしています。この関数にかんする詳細はこちらの記事をご参照ください。

使用例

上記ソースコードで記述した属性を利用してみます。以下のサンプルコードでハイライトされた部分が利用例となります。 Controller クラスに対して属性をつけることで、そのクラスのメソッドすべてに対して履歴を取るようにしています。

サンプルコード

namespace SampleMvcApplication.Controllers
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Web;
    using System.Web.Mvc;
    using SampleMvcApplication.Filters;

    [BrowsingHistory]
    public class HomeController : Controller
    {
        public ActionResult Index()
        {
            return this.View();
        }

        public ActionResult Login()
        {
            return this.View();
        }

        public ActionResult Index2()
        {
            return this.View();
        }
    }
}

ASP.NET MVC でアプリケーションルート URL の取得

アプリケーションルートURL（ベースURL？基本URL？…どういう呼び方が正しいかよく分かりません。。）は IIS へホストされた状況によって変化します。そのような状況でも確実にルートURL を取得する方法です。

サンプルコード

var scheme = httpContext.Request.Url.Scheme;
var authority = httpContext.Request.Url.Authority;
var path = HttpRuntime.AppDomainAppVirtualPath;

// ルートURL の生成
var baseUrl = string.Format("{0}://{1}{2}", scheme, authority, path);

説明

Request.Url.Scheme では、http または https を取得します。
Request.Url.Authority では、ホスト名または IPアドレスとポート番号の組み合わせを取得します。
HttpRuntime.AppDomainAppVirtualPath では、現在のアプリケーションドメインでホストされる、アプリケーションを格納するディレクトリの仮想パスを取得します。 AppDomainAppVirtualPath は static プロパティなので、HttpRuntimeクラスから直接取得します。

※上記サンプルコード中の httpContext に対して何もありませんが、現在実行中の HttpContextBase を指定します。

今回、参考にしたサイトは以下の通りです。

ASP.NET MVC でコントローラー名、アクション名の取得

RouteData を利用して、リクエストされたコントローラー名およびアクション名を取得する方法です。

コントローラー名、アクション名を取得する方法の基本
コントローラー内で取得するサンプルコード
ヘルパークラス内で取得するサンプルコード
カスタムフィルター内で取得するサンプルコード

コントローラー名、アクション名を取得する方法の基本

サンプルコード

var routeData = System.Web.Routing.RouteTable.Routes.GetRouteData(httpContext);
var controllerName = routeData.Values["controller"].ToString();
var actionName = routeData.Values["action"].ToString();

説明

RouteDataインスタンスの Values プロパティはハッシュ配列になっています。このハッシュ配列において、"controller" キーの値がコントローラー名、"action" キーの値がアクション名となっています。（"controller" および "action" の文字列は固定文字列のようです。）

リクエストされたコントローラー名、アクション名の取得は、RouteDataクラスのインスタンスをいかに取得するかがポイントになります。以下のサンプルコードでは、状況に応じて RouteData インスタンスの取得方法が変わっています。

※上記サンプルコードでは "httpContext" に対して何も記述がありませんが、現在実行中の "HttpContextBase" を指定します。

コントローラーのアクションメソッド内で取得するサンプルコード

サンプルコード

public class HomeController : Controller
{
    //
    // GET: /Home/Index
    public ActionResult Index()
    {
        // コントローラー名、アクション名の取得
        var controllerName = this.RouteData.Values["controller"].ToString();
        var actionName = this.RouteData.Values["action"].ToString();

        return View();
    }
}

説明

Controller クラスを継承したクラス内で利用する場合、RouteDataインスタンスがプロパティに既に存在しているので、そのまま利用します。

ヘルパークラスの拡張メソッド内で取得するサンプルコード

サンプルコード

public static class SampleExtensions
{
    public static string GetNormalizedRequestUrl(this HtmlHelper helper)
    {
        // HttpContextBase インスタンス の取得
        var httpContext = helper.ViewContext.HttpContext;

        // RouteData および コントローラー名、アクション名、クエリ文字列 の取得
        var routeData = helper.RouteCollection.GetRouteData(httpContext);
        var controllerName = routeData.Values["controller"].ToString();
        var actionName = routeData.Values["action"].ToString();
        var queryString = httpContext.Request.QueryString.ToString();

        // クエリ有無によってURL生成方法を変更
        if (string.IsNullOrEmpty(queryString))
        {
            return string.Format("{0}/{1}", controllerName, actionName);
        }
        else
        {
            return string.Format("{0}/{1}?{2}", controllerName, actionName, queryString);
        }
    }
}

説明

ヘルパークラスでは RouteDataインスタンスが直接利用できないため、取得してくる必要があります。 HttpContextBaseインスタンスを利用して RouteCollection.GetRouteData( HttpContextBase httpContext ) を利用して RouteDataインスタンス取得します。

カスタムフィルターのメソッド内で取得するサンプルコード

サンプルコード

public class SampleAttribute: FilterAttribute, IActionFilter
{
    public void OnActionExecuted(ActionExecutedContext filterContext)
    {
        // RouteData および コントローラー名、アクション名 の 取得
        ////var routeData = System.Web.Routing.RouteTable.Routes.GetRouteData(filterContext.HttpContext);
        var routeData = filterContext.RouteData;
        var controllerName = routeData.Values["controller"].ToString();
        var actionName = routeData.Values["action"].ToString();
    }

    public void OnActionExecuting(ActionExecutingContext filterContext)
    {
    }
}

説明

カスタムフィルターでは RouteDataインスタンスが直接利用できないため、取得してくる必要があります。まず、RouteTableクラスの Routes static プロパティから RouteCollection を取得します。次に、RouteCollection.GetRouteData( HttpContextBase httpContext ) を利用して RouteDataインスタンス取得します。
ActionExecutedContext のプロパティに RouteData が存在しているのでそちらをそのまま利用します。(2013/06/25 修正)

今回、参考にしたサイトは以下の通りです。

ASP.NET MVC でカスタムフィルターの実装方法

独自フィルター（カスタムフィルター）を作成、実装することで、各アクションに対して画一的な処理を "簡単に" 施すことができるようになります。例えば「特定の条件を満たさない場合、実行できなくする」「ユーザーのページ遷移を記録する」「キャッシュを無効化する」といったことができるようになります。

この独自フィルターの実装方法ですが、通常は FilterAttribute クラスを継承して作成します。簡易的に組込フィルタークラスを継承することでも独自フィルターを作成できます。
※フィルターの実行順序はこちらをご参照ください。

以下では「キャッシュを無効化する独自フィルター」を実装する手順を見ていきます。

実装手順

独自フィルターを作成するプロジェクトを選択し、[プロジェクト]-[新しい項目の追加] を選択
任意の名前で「クラス」を「追加」
（ここでは NoCacheAttribute としています。）

FilterAttribute を継承

    public class NoCacheAttribute: FilterAttribute

IResultFilter を実装
（どのインターフェースを実装すべきかの判断はこちらをご参照ください。）
```
    public class NoCacheAttribute: FilterAttribute, IResultFilter
```

.OnResultExecuted を実装

        public void OnResultExecuted(ResultExecutedContext filterContext)
        {
            var response = filterContext.HttpContext.Response;
            response.Cache.SetCacheability(HttpCacheability.NoCache);
        }

.OnResultExecuting の内容を削除

        public void OnResultExecuting(ResultExecutingContext filterContext)
        {
            // 処理を行わないので、明示的に処理を削除します。
            ////throw new NotImplementedException();
        }

最終的なソースコード

namespace SampleMvcApplication.Controllers
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Web;
    using System.Web.Mvc;

    /// <summary>
    /// キャッシュを無効化するフィルター属性を表します。
    /// </summary>
    public class NoCacheAttribute: FilterAttribute, IResultFilter
    {
        /// <summary>
        /// アクション結果の実行後に ASP.NET MVC フレームワークによって呼び出されます。
        /// </summary>
        /// <param name="filterContext">フィルター コンテキスト</param>
        public void OnResultExecuted(ResultExecutedContext filterContext)
        {
            var response = filterContext.HttpContext.Response;
            response.Cache.SetCacheability(HttpCacheability.NoCache);
        }

        /// <summary>
        /// アクション結果の実行前に ASP.NET MVC フレームワークによって呼び出されます。
        /// </summary>
        /// <param name="filterContext">フィルター コンテキスト</param>
        public void OnResultExecuting(ResultExecutingContext filterContext)
        {
        }
    }
}

今回、参考にしたサイトは以下の通りです。

ASP.NET MVC のフィルター実行順序

組込アクションフィルターは、 FilterAttribute を継承しています。また、どのクラス、インターフェースも System.Web.Mvc 名前空間に属しています。

※ 独自フィルターの実装方法はこちら。

以下に主なアクションフィルターの実行順をまとめます。

実行順	説明	組込クラス	インターフェース	イベント
1	承認	AuthorizeAttribute	IAuthorizationFilter	OnAuthorize
2	アクションメソッドの実行前	ActionFilterAttribute	IActionFilter	OnActionExecuting
3	アクションメソッドの実行（Controller の処理を実行）
4	アクションメソッドの実行後	ActionFilterAttribute	IActionFilter	OnActionExecuted
5	ビューエンジンの実行前	ActionFilterAttribute	IResultFilter	OnResultExecuting
6	ビューエンジンの実行（cshtml の生成処理）
7	ビューエンジンの実行後	ActionFilterAttribute	IResultFilter	OnResultExecuted
その他	例外発生時	HandleErrorAttribute	IExceptionFilter	OnException

上記フィルターに関する MSDN を以下でまとめています。

フィルターを独自実装する際の基本クラス

FilterAttribute クラス

フィルターインターフェースの組込実装クラス

フィルターインターフェース

今回、参考にしたサイトは以下の通りです。

ASP.NET MVC/フィルター

galife

machineKey の生成ツール

ASP.NET MVC + Web API でフォーム認証の実装

ASP.NET MVC でフォーム認証の実装方法

認証（Authentication）と承認（Authorization）の違い

認証 ( Authentication )

承認 ( Authorization )

ASP.NET Web API のルーティング

ASP.NET Web API におけるクエリパラメーターとメッセージボディーのバインド

ASP.NET Web API で DataContract の利用

ASP.NET Web API でレスポンスヘッダーの設定

Content-Type の書き換え

ステータスコードの書き換え

カスタムレスポンスヘッダー

ASP.NET Web API で独自フィルターの実装方法

ASP.NET Web API チュートリアル

クロスドメイン制約を XmlHttpRequest level 2 で回避（プリフライト）

WCF Web サービスにおけるレスポンスヘッダーの設定方法

WCF を利用した RESTful Web サービスの作成

クロスドメイン制約を JSONP で回避（ASP.NET MVC + jQuery）

C# で .mdf (SQL Server データベースファイル) を開く

ASP.NET MVC でページ遷移を記録するフィルター

ソースコード

説明

使用例

ASP.NET MVC でアプリケーションルート URL の取得

ASP.NET MVC でコントローラー名、アクション名の取得

コントローラー名、アクション名を取得する方法の基本

コントローラーのアクションメソッド内で取得するサンプルコード

ヘルパークラスの拡張メソッド内で取得するサンプルコード

カスタムフィルターのメソッド内で取得するサンプルコード

ASP.NET MVC でカスタムフィルターの実装方法

実装手順

最終的なソースコード

ASP.NET MVC のフィルター実行順序

Labels

Archives

Pages

Contact

認証 ( Authentication )

承認 ( Authorization )

Content-Type の書き換え

ステータスコード の書き換え

カスタムレスポンスヘッダー

ソースコード

説明

使用例

コントローラー名、アクション名 を 取得する方法の基本

コントローラー の アクションメソッド内 で 取得 する サンプルコード

ヘルパークラス の 拡張メソッド内 で 取得 する サンプルコード

カスタムフィルター の メソッド内 で 取得 する サンプルコード

実装手順

最終的なソースコード

ステータスコードの書き換え

コントローラー名、アクション名を取得する方法の基本

コントローラーのアクションメソッド内で取得するサンプルコード

ヘルパークラスの拡張メソッド内で取得するサンプルコード

カスタムフィルターのメソッド内で取得するサンプルコード