アクションを作成する (C#)

[アーティクル]
05/01/2024

ASP.NET MVC コントローラーに新しいアクションを追加する方法について説明します。メソッドをアクションにするための要件について説明します。

このチュートリアルの目的は、新しいコントローラーアクションを作成する方法を説明することです。アクションメソッドの要件について説明します。また、メソッドがアクションとして公開されないようにする方法についても説明します。

コントローラーへのアクションの追加

コントローラーに新しいメソッドを追加することで、コントローラーに新しいアクションを追加します。たとえば、リスト 1 のコントローラーには、Index() という名前のアクションと SayHello() という名前のアクションが含まれています。どちらのメソッドもアクションとして公開されます。

リスト 1 - Controllers\HomeController.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;

namespace MvcApplication1.Controllers
{
    [HandleError]
    public class HomeController : Controller
    {
        public ActionResult Index()
        {
            return View();
        }

        public string SayHello()
        {
            return "Hello!";
        }
    }
}

アクションとしてグローバルに公開するには、メソッドは特定の要件を満たす必要があります。

メソッドはパブリックでなければなりません。
メソッドを静的メソッドにすることはできません。
メソッドを拡張メソッドにすることはできません。
メソッドを、コンストラクター、ゲッター、またはセッターにすることはできません。
メソッドは、オープンジェネリック型を持つことはできません。
メソッドは、コントローラーの基底クラスのメソッドではない。
メソッドに ref パラメーターおよび out パラメーターを含めることはできません。

コントローラーアクションの戻り値の型に制限がないことに注意してください。コントローラーアクションは、文字列、DateTime、Random クラスのインスタンス、または void を返すことができます。 ASP.NET MVC フレームワークにより、アクションの結果ではない戻り値の型は文字列に変換され、その文字列がブラウザーにレンダリングされます。

これらの要件に違反しないメソッドをコントローラーに追加すると、そのメソッドはコントローラーアクションとして公開されます。ここで注意が必要です。コントローラーアクションは、インターネットに接続されているすべてのユーザーが呼び出すことができます。たとえば、DeleteMyWebsite() コントローラーアクションを作成しないでください。

パブリックメソッドが呼び出されないようにする

コントローラークラスでパブリックメソッドを作成する必要があり、そのメソッドをコントローラーアクションとして公開したくない場合は、[NonAction] 属性を使用してメソッドが呼び出されないようにすることができます。たとえば、リスト 2 のコントローラーには、[NonAction] 属性で修飾された CompanySecrets() という名前のパブリックメソッドが含まれています。

リスト 2 - Controllers\WorkController.cs

using System.Web.Mvc;

namespace MvcApplication1.Controllers
{
    public class WorkController : Controller
    {
        [NonAction]
        public string CompanySecrets()
        {
            return "This information is secret.";
        }
    }
}

ブラウザーのアドレスバーに「/Work/CompanySecrets」と入力して CompanySecrets() コントローラーアクションを呼び出そうとすると、図 1 のエラーメッセージが表示されます。