C# で現在のページの URL を取得するコード例の詳細解説

2024-08-22

C# の ASP.NET アプリケーションで、現在アクセスされているページの URL を取得したい場合、以下の方法が利用できます。

HttpContext.Current.Request.Url を利用する

最も一般的な方法です。HttpContext.Current は現在の HTTP コンテキストを表し、Request プロパティは現在のリクエストオブジェクトを取得します。Url プロパティは、そのリクエストの URL を保持しています。

string url = HttpContext.Current.Request.Url.ToString();

このコードは、現在のページの絶対 URL (プロトコル、ドメイン名、ポート、パスなどすべてを含む) を取得します。

Request.Url を直接利用する (ASP.NET MVC で推奨)

ASP.NET MVC では、HttpContext.Current にアクセスする代わりに、直接 Request オブジェクトを利用するのが一般的です。

string url = Request.Url.ToString();

URL の特定部分を取得する

場合によっては、URL の一部 (ドメイン名、パスなど) だけが必要な場合もあります。Url プロパティには、以下のメソッドが用意されています。

GetLeftPart(UriPartial partial): 指定された部分までの URL を取得します。(例: GetLeftPart(UriPartial.Authority) でドメイン名とポートを取得)
LocalPath: ローカルパス (仮想ディレクトリ以降の部分) を取得します。

C# で現在のページの URL を取得するコード例の詳細解説

string url = HttpContext.Current.Request.Url.ToString();

HttpContext.Current: 現在の HTTP コンテキストを表します。これは、現在のWebリクエストに関する情報を保持するオブジェクトです。
Request: 現在の HTTP リクエストを表します。このプロパティから、リクエストに関する様々な情報（URL、HTTPメソッド、ヘッダーなど）を取得できます。
Url: 現在のリクエストの URL を表す Uri オブジェクトです。ToString() メソッドで文字列に変換することで、URLを文字列として取得できます。

このコードで得られるのは、

プロトコル: http:// または https://
ドメイン名: 例えば、example.com
ポート番号: ポート番号が指定されている場合
パス: リクエストされたページのパス (例: /about/contact)
クエリ文字列: URLに含まれる ? 以降のパラメータ部分

例:

string url = Request.Url.ToString();

ASP.NET MVC では、コントローラーのアクションメソッド内で Request オブジェクトに直接アクセスできます。これは、HttpContext.Current を使用するよりも簡潔な書き方です。

動作は例1と同様です。

string domain = Request.Url.GetLeftPart(UriPartial.Authority);
string localPath = Request.Url.LocalPath;

GetLeftPart(UriPartial partial): 指定された部分までの URL を取得します。
UriPartial.Authority: ドメイン名とポート番号の部分を指定します。

上記の例では、

localPath には "/products" が格納されます。

これらのコードを利用することで、C# の ASP.NET アプリケーション内で、現在アクセスされているページの URL を簡単に取得することができます。取得した URL は、ログ出力、リダイレクト、または他の処理に利用できます。

ポイント

HttpContext.Current は、ASP.NET Web Forms でよく使用されます。
Request オブジェクトは、ASP.NET MVC でよく使用されます。
Uri クラスは、URLを操作するための様々なメソッドを提供します。

注意:

上記のコードは、サーバーサイドのコードです。クライアントサイド (ブラウザ) で URL を取得したい場合は、JavaScript の window.location.href を使用します。
ASP.NET Core では、HttpContext の使い方が若干異なります。

URLエンコーディング: URLに特殊文字が含まれる場合、URLエンコーディングが必要になることがあります。
相対URL: 相対URLを取得したい場合は、Request.Url.AbsolutePath などを使用します。

URLのパラメータを取得する: Request.QueryString を使用します。
URLからクエリパラメータを解析する: System.Web.HttpUtility.ParseQueryString を使用します。

ルーティング情報からの取得 (ASP.NET MVC)

ASP.NET MVC では、ルーティング情報から現在の URL を構成することも可能です。これは、URL 構造が複雑な場合や、カスタムルーティングを使用している場合に便利です。

string controllerName = this.ControllerContext.RouteData.Values["controller"].ToString();
string actionName = this.ControllerContext.RouteData.Values["action"].   ToString();
string id = this.RouteData.Values["id"]?.ToString();

// URLを組み立てます
string url = Url.Action(actionName, controllerName, new { id = id });

ControllerContext.RouteData.Values: 現在のルーティング情報にアクセスできます。
Url.Action: 指定されたアクションへの URL を生成します。

IUrlHelper インターフェース

ASP.NET MVC Core では、IUrlHelper インターフェースを使用して、より柔軟に URL を生成できます。

public class MyController : Controller
{
    private readonly IUrlHelper _urlHelper;

    public MyController(IUrlHelper urlHelper)
    {
        _urlHelper = urlHelper;
    }

    public IActionResult    Index()
    {
        var url = _urlHelper.Action("Details", "Home", new { id = 1 });
        // ...
    }
}

IUrlHelper: URL生成のためのヘルパーインターフェースです。

タグヘルパー

ASP.NET Core MVC では、タグヘルパーを使用して、ビュー内で直接 URL を生成できます。

<a asp-action="Details" asp-controller="Home" asp-route-id="1">詳細</a>

JavaScript を利用する

クライアントサイドで取得: JavaScript の window.location.href プロパティで、現在のページの完全な URL を取得できます。
サーバーサイドで JavaScript を生成: C# で JavaScript コードを生成し、クライアントに送信することで、クライアントサイドで URL を操作することも可能です。