ASP.NET MVC/フィルター - 版の履歴

imported>Fallout New Tokyo: /* 使い道の例 */

2014-03-06T06:00:42Z

使い道の例

← 古い版		2014年3月6日 (木) 06:00時点における版
4行目:		4行目:
	[[アクション]]ごとにユーザー認証処理が「されている」「されていない」などの処理を書いていたのでは面倒、かつ本流ではない[[ソースコード]]が入りまくり見通しが悪くなるのでフィルター化しておくと便利だという。		[[アクション]]ごとにユーザー認証処理が「されている」「されていない」などの処理を書いていたのでは面倒、かつ本流ではない[[ソースコード]]が入りまくり見通しが悪くなるのでフィルター化しておくと便利だという。

	たとえばEditアクションはログインしているユーザーのみとする場合は、以下のようにEditアクションにAuthorizeフィルター（アトリビュート）を付ける。		たとえばEditアクションはログインしているユーザーのみ使えるとする場合は、以下のようにEditアクションにAuthorizeフィルター（アトリビュート）を付ける。
	<source lang="csharp">		<source lang="csharp">
	[Authorize]		[Authorize]

2014年3月6日 (木) 05:59にimported>Fallout New Tokyoによる

2014-03-06T05:59:58Z

← 古い版		2014年3月6日 (木) 05:59時点における版
1行目:		1行目:
	[[ASP.NET MVC]]の'''フィルター'''とは、コントローラークラスやアクションメソッド（コントローラークラスのメソッド）に、[[属性]]（Attribute）もちいて処理を挿入する機能のことである。		[[ASP.NET MVC]]の'''フィルター'''とは、コントローラークラスやアクションメソッド（コントローラークラスのメソッド）に、[[属性]]（Attribute）もちいて処理を挿入する機能のことである。

	~~たとえばユーザー認証処理がされている、されていない、などの処理を~~[[アクション]]~~ごとに書いていたのでは面倒、かつ本流ではないソースコードが入りまくり見通しが悪くなるのでフィルター化しておくと便利だという。~~		== 使い道の例 ==
			[[アクション]]ごとにユーザー認証処理が「されている」「されていない」などの処理を書いていたのでは面倒、かつ本流ではない[[ソースコード]]が入りまくり見通しが悪くなるのでフィルター化しておくと便利だという。

	~~== 使い道の例 ==~~		たとえばEditアクションはログインしているユーザーのみとする場合は、以下のようにEditアクションにAuthorizeフィルター（アトリビュート）を付ける。
	~~たとえばEditアクションはログインしているユーザーのみとする場合は以下のようになる。~~
	<source lang="csharp">		<source lang="csharp">
	[Authorize]		[Authorize]
17行目:		17行目:

	== フィルターの種類 ==		== フィルターの種類 ==
	[[ASP.NET MVC]]~~のフィルターは大きく、承認フィルター、アクションフィルター、結果フィルター、例外フィルターの4つに分けられる。~~		[[ASP.NET MVC]]のフィルターは大きく分けて、承認フィルター、アクションフィルター、結果フィルター、例外フィルターの4つに分けられる。

	=== 承認フィルター ===		=== 承認フィルター ===
88行目:		88行目:
	public override void OnActionExecuting(ActionExecutingContext filterContext)		public override void OnActionExecuting(ActionExecutingContext filterContext)
	{		{
	filterContext.HttpContext.Trace.Write("(Logging Filter)Action Executing: " +		filterContext.HttpContext.Trace.Write(
	filterContext.ActionDescriptor.ActionName);		"(Logging Filter)Action Executing: "
			+ filterContext.ActionDescriptor.ActionName);

	base.OnActionExecuting(filterContext);		base.OnActionExecuting(filterContext);
98行目:		99行目:
	{		{
	if (filterContext.Exception != null)		if (filterContext.Exception != null)
			{
	filterContext.HttpContext.Trace.Write("(Logging Filter)Exception thrown");		filterContext.HttpContext.Trace.Write("(Logging Filter)Exception thrown");
			}

	base.OnActionExecuted(filterContext);		base.OnActionExecuted(filterContext);
110行目:		113行目:

	== 参考文献 ==		== 参考文献 ==
	~~<references/>~~		{{reflist}}
	~~== 外部リンク ==~~

	{{stub}}		{{stub}}

imported>Administrator: /* 関連項目 */

2012-03-22T07:45:13Z

imported>Administrator: /* 独自フィルター */

2012-03-22T05:07:28Z

独自フィルター

← 古い版		2012年3月22日 (木) 05:07時点における版
74行目:		74行目:
	[AttributeUsageAttribute(AttributeTargets.Class\|AttributeTargets.Method, Inherited = true, AllowMultiple = true)]		[AttributeUsageAttribute(AttributeTargets.Class\|AttributeTargets.Method, Inherited = true, AllowMultiple = true)]
	public class AuthorizeAttribute		public class AuthorizeAttribute
	: FilterAttribute,		: FilterAttribute, // FilterAttributeを継承して
	IAuthorizationFilter		IAuthorizationFilter // IAuthorizationFilterを実装する
	{		{
	//...		//...

imported>Administrator: /* 独自フィルター */

2012-03-22T05:06:21Z

独自フィルター

@@ 78行目: / 78行目: @@
+{
      //...
+}
 </source>

imported>Administrator: ページの作成：「ASP.NET MVCの'''フィルター'''とは、コントローラークラスやアクションメソッド（コントローラークラスのメソッド）に、[[...」

2012-03-22T05:00:47Z

ページの作成：「ASP.NET MVCの'''フィルター'''とは、コントローラークラスやアクションメソッド（コントローラークラスのメソッド）に、[[...」

新規ページ

[[ASP.NET MVC]]の'''フィルター'''とは、コントローラークラスやアクションメソッド（コントローラークラスのメソッド）に、[[属性]]（Attribute）もちいて処理を挿入する機能のことである。

たとえばユーザー認証処理がされている、されていない、などの処理を[[アクション]]ごとに書いていたのでは面倒、かつ本流ではないソースコードが入りまくり見通しが悪くなるのでフィルター化しておくと便利だという。

== 使い道の例 ==
たとえばEditアクションはログインしているユーザーのみとする場合は以下のようになる。
<source lang="csharp">
[Authorize]
public ActionResult Edit(int id)
{
//...
return View();
}
</source>

ASP.NET MVCでは上記のAuthorize属性をはじめ、OutputCache属性やChildActionOnly属性、HandleError属性など、さまざまなフィルターがあらかじめ用意されている。またフィルターは自作することも可能である。

== フィルターの種類 ==
[[ASP.NET MVC]]のフィルターは大きく、承認フィルター、アクションフィルター、結果フィルター、例外フィルターの4つに分けられる。

=== 承認フィルター ===
IAuthorizationFilterインターフェイスを実装し、認証に関わる処理を記述する。

=== アクションフィルター ===
IActionFilterインターフェイスを実装し、アクションメソッドの実行前後で行われるべき処理を記述する。

=== 結果フィルター ===
IResultFilterインターフェイスを実装し、[[ActionResult]]の実行前後（ビューエンジンの実行前後）に行われるべき処理を記述する。

=== 例外フィルター ===
IExceptionFilterインターフェイスを実装し、例外発生時に行われるべき処理を記述する。

== フィルターの実行順序 ==
<pre>
承認フィルター
　↓
アクションフィルター前処理
　↓
アクションメソッド
　↓
アクションフィルター後処理
　↓
結果フィルター前処理
　↓
ビューエンジン
　↓
結果フィルター後処理

その他：例外フィルター
</pre>

== 標準フィルター ==
[[ASP.NET MVC]]にはあらかじめいくつかフィルターが用意されている。なお、MSDNのドキュメントでは「実装例」と繰り返し書かれてる。

* AuthorizeAttribute - 承認フィルター
* OutputCacheAttribute - 結果フィルター
* HandleErrorAttribute - 例外フィルター



== 独自フィルター ==
自前の独自フィルターを作成するには、基本的にFilterAttributeクラスを継承し、前述のフィルターの種類に応じたインターフェイスを実装する。

たとえば標準フィルターのAuthorizeAttributeであれば以下のようになっている。
<source lang="csharp">
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = true, AllowMultiple = true)]
public class AuthorizeAttribute
: FilterAttribute,
IAuthorizationFilter
{
//...
}
</source>

== 関連項目 ==
* [[ASP.NET MVC]]

== 参考文献 ==
<references/>
== 外部リンク ==

{{stub}}

← 古い版		2012年3月22日 (木) 07:45時点における版
107行目:		107行目:
	== 関連項目 ==		== 関連項目 ==
	* [[ASP.NET MVC]]		* [[ASP.NET MVC]]
			** [[ASP.NET MVC/セレクター]]

	== 参考文献 ==		== 参考文献 ==