Uri クラス

定義

public ref class Uri

public ref class Uri : IEquatable<Uri ^>, ISpanFormattable, System::Runtime::Serialization::ISerializable

public ref class Uri : System::Runtime::Serialization::ISerializable

public ref class Uri : ISpanFormattable, System::Runtime::Serialization::ISerializable

public ref class Uri : MarshalByRefObject, System::Runtime::Serialization::ISerializable

public class Uri

public class Uri : IEquatable<Uri>, ISpanFormattable, System.Runtime.Serialization.ISerializable

public class Uri : System.Runtime.Serialization.ISerializable

public class Uri : ISpanFormattable, System.Runtime.Serialization.ISerializable

[System.Serializable]
public class Uri : MarshalByRefObject, System.Runtime.Serialization.ISerializable

[System.Serializable]
[System.ComponentModel.TypeConverter(typeof(System.UriTypeConverter))]
public class Uri : System.Runtime.Serialization.ISerializable

type Uri = class

type Uri = class
    interface IEquatable<Uri>
    interface IFormattable
    interface ISpanFormattable
    interface ISerializable

type Uri = class
    interface ISerializable

type Uri = class
    interface ISpanFormattable
    interface IFormattable
    interface ISerializable

type Uri = class
    interface IFormattable
    interface ISpanFormattable
    interface IEquatable<Uri>
    interface ISerializable

[<System.Serializable>]
type Uri = class
    inherit MarshalByRefObject
    interface ISerializable

[<System.Serializable>]
[<System.ComponentModel.TypeConverter(typeof(System.UriTypeConverter))>]
type Uri = class
    interface ISerializable

Public Class Uri

Public Class Uri
Implements IEquatable(Of Uri), ISerializable, ISpanFormattable

Public Class Uri
Implements ISerializable

Public Class Uri
Implements ISerializable, ISpanFormattable

Public Class Uri
Inherits MarshalByRefObject
Implements ISerializable

継承

Object

Uri

継承

Object

MarshalByRefObject

Uri

属性

SerializableAttribute TypeConverterAttribute

実装

IEquatable<Uri> IFormattable ISpanFormattable ISerializable

例

次の例では、 Uri クラスのインスタンスを作成し、それを使用して HttpClient を使用して GET 要求を実行します。

Uri siteUri = new Uri("http://www.contoso.com/");

// HttpClient lifecycle management best practices:
// https://learn.microsoft.com/dotnet/fundamentals/networking/http/httpclient-guidelines#recommended-use
HttpClient client = new HttpClient();
HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Get, siteUri);
HttpResponseMessage response = client.Send(request);

let siteUri = Uri "http://www.contoso.com/"

// HttpClient lifecycle management best practices:
// https://learn.microsoft.com/dotnet/fundamentals/networking/http/httpclient-guidelines#recommended-use
use client = new HttpClient ()
use request = new HttpRequestMessage (HttpMethod.Get, siteUri)
use response = client.Send request

Dim siteUri As New Uri("http://www.contoso.com/")

' HttpClient lifecycle management best practices:
' https://learn.microsoft.com/dotnet/fundamentals/networking/http/httpclient-guidelines#recommended-use
Dim client As New HttpClient()
Dim request As New HttpRequestMessage(HttpMethod.Get, siteUri)
Dim response As HttpResponseMessage = client.Send(request)

次のコード スニペットは、クラスのさまざまなプロパティの値の例を示しています。

Uri uri = new Uri("https://user:password@www.contoso.com:80/Home/Index.htm?q1=v1&q2=v2#FragmentName");

Console.WriteLine($"AbsolutePath: {uri.AbsolutePath}");
Console.WriteLine($"AbsoluteUri: {uri.AbsoluteUri}");
Console.WriteLine($"DnsSafeHost: {uri.DnsSafeHost}");
Console.WriteLine($"Fragment: {uri.Fragment}");
Console.WriteLine($"Host: {uri.Host}");
Console.WriteLine($"HostNameType: {uri.HostNameType}");
Console.WriteLine($"IdnHost: {uri.IdnHost}");
Console.WriteLine($"IsAbsoluteUri: {uri.IsAbsoluteUri}");
Console.WriteLine($"IsDefaultPort: {uri.IsDefaultPort}");
Console.WriteLine($"IsFile: {uri.IsFile}");
Console.WriteLine($"IsLoopback: {uri.IsLoopback}");
Console.WriteLine($"IsUnc: {uri.IsUnc}");
Console.WriteLine($"LocalPath: {uri.LocalPath}");
Console.WriteLine($"OriginalString: {uri.OriginalString}");
Console.WriteLine($"PathAndQuery: {uri.PathAndQuery}");
Console.WriteLine($"Port: {uri.Port}");
Console.WriteLine($"Query: {uri.Query}");
Console.WriteLine($"Scheme: {uri.Scheme}");
Console.WriteLine($"Segments: {string.Join(", ", uri.Segments)}");
Console.WriteLine($"UserEscaped: {uri.UserEscaped}");
Console.WriteLine($"UserInfo: {uri.UserInfo}");

// AbsolutePath: /Home/Index.htm
// AbsoluteUri: https://user:password@www.contoso.com:80/Home/Index.htm?q1=v1&q2=v2#FragmentName
// DnsSafeHost: www.contoso.com
// Fragment: #FragmentName
// Host: www.contoso.com
// HostNameType: Dns
// IdnHost: www.contoso.com
// IsAbsoluteUri: True
// IsDefaultPort: False
// IsFile: False
// IsLoopback: False
// IsUnc: False
// LocalPath: /Home/Index.htm
// OriginalString: https://user:password@www.contoso.com:80/Home/Index.htm?q1=v1&q2=v2#FragmentName
// PathAndQuery: /Home/Index.htm?q1=v1&q2=v2
// Port: 80
// Query: ?q1=v1&q2=v2
// Scheme: https
// Segments: /, Home/, Index.htm
// UserEscaped: False
// UserInfo: user:password

let uri = Uri "https://user:password@www.contoso.com:80/Home/Index.htm?q1=v1&q2=v2#FragmentName"

printfn $"AbsolutePath: {uri.AbsolutePath}"
printfn $"AbsoluteUri: {uri.AbsoluteUri}"
printfn $"DnsSafeHost: {uri.DnsSafeHost}"
printfn $"Fragment: {uri.Fragment}"
printfn $"Host: {uri.Host}"
printfn $"HostNameType: {uri.HostNameType}"
printfn $"IdnHost: {uri.IdnHost}"
printfn $"IsAbsoluteUri: {uri.IsAbsoluteUri}"
printfn $"IsDefaultPort: {uri.IsDefaultPort}"
printfn $"IsFile: {uri.IsFile}"
printfn $"IsLoopback: {uri.IsLoopback}"
printfn $"IsUnc: {uri.IsUnc}"
printfn $"LocalPath: {uri.LocalPath}"
printfn $"OriginalString: {uri.OriginalString}"
printfn $"PathAndQuery: {uri.PathAndQuery}"
printfn $"Port: {uri.Port}"
printfn $"Query: {uri.Query}"
printfn $"Scheme: {uri.Scheme}"
printfn $"""Segments: {String.Join(", ", uri.Segments)}"""
printfn $"UserEscaped: {uri.UserEscaped}"
printfn $"UserInfo: {uri.UserInfo}"

// AbsolutePath: /Home/Index.htm
// AbsoluteUri: https://user:password@www.contoso.com:80/Home/Index.htm?q1=v1&q2=v2#FragmentName
// DnsSafeHost: www.contoso.com
// Fragment: #FragmentName
// Host: www.contoso.com
// HostNameType: Dns
// IdnHost: www.contoso.com
// IsAbsoluteUri: True
// IsDefaultPort: False
// IsFile: False
// IsLoopback: False
// IsUnc: False
// LocalPath: /Home/Index.htm
// OriginalString: https://user:password@www.contoso.com:80/Home/Index.htm?q1=v1&q2=v2#FragmentName
// PathAndQuery: /Home/Index.htm?q1=v1&q2=v2
// Port: 80
// Query: ?q1=v1&q2=v2
// Scheme: https
// Segments: /, Home/, Index.htm
// UserEscaped: False
// UserInfo: user:password

注釈

UNIFORM Resource Identifier (URI) は、イントラネットまたはインターネット上のアプリケーションで使用できるリソースのコンパクトな表現です。 Uri クラスは、解析、比較、結合など、URI を処理するためのプロパティとメソッドを定義します。 Uri クラスのプロパティは読み取り専用です。変更可能なオブジェクトを作成するには、UriBuilder クラスを使用します。

相対 URI ("/new/index.htm"など) は、基本 URI に対して展開して、絶対 URI になるようにする必要があります。 MakeRelativeUriメソッドは、必要に応じて絶対 URI を相対 URI に変換するために提供されます。

文字列がスキーム識別子を含む整形式 URI の場合、 Uri コンストラクターは URI 文字列をエスケープしません。

Uriプロパティは、エスケープエンコードで正規のデータ表現を返し、Unicode 値が 127 より大きいすべての文字は 16 進数に置き換えられます。 URI を正規形式で配置するために、 Uri コンストラクターは次の手順を実行します。

• URI スキームを小文字に変換します。
• ホスト名を小文字に変換します。
• ホスト名が IPv6 アドレスの場合は、正規の IPv6 アドレスが使用されます。 ScopeId およびその他のオプションの IPv6 データが削除されます。
• 既定のポート番号と空のポート番号を削除します。
• file:// スキームのない暗黙的なファイル パス ("C:\my\file" など) を、file:// スキームを使用して明示的なファイル パスに変換します。
• 予約目的を持たないエスケープ文字 (パーセントエンコードオクテットとも呼ばれます) はデコードされます (エスケープ解除とも呼ばれます)。 これらの予約されていない文字には、大文字と小文字 (%41-%5A と %61-%7A)、10 進数 (%30-%39)、ハイフン (%2D)、ピリオド (%2E)、アンダースコア (%5F)、チルダ (%7E) が含まれます。
• /./や/../などのシーケンス (シーケンスがエスケープされているかどうか) を圧縮して、階層 URI のパスを正規化します。 これらのシーケンスが圧縮されないスキームがあることに注意してください。
• 階層 URI の場合、ホストがスラッシュ (/) で終了しない場合は、1 つが追加されます。
• 既定では、URI 内の予約文字はすべて RFC 2396 に従ってエスケープされます。 この動作は、国際リソース識別子または国際ドメイン名の解析が有効になっている場合に、RFC 3986 および RFC 3987 に従って URI の予約文字がエスケープされる場合に変更されます。

一部のスキームのコンストラクターでの正規化の一環として、ドット セグメント (/./ と /../) が圧縮されます (つまり、削除されます)。 セグメントを圧縮 Uri スキームには、http、https、tcp、net.pipe、および net.tcp が含まれます。 その他のスキームでは、これらのシーケンスは圧縮されません。 次のコード スニペットは、実際の圧縮の外観を示しています。 エスケープされたシーケンスは、必要に応じてエスケープ解除されたうえで、圧縮されます。

var uri = new Uri("http://myUrl/../.."); // http scheme, unescaped
OR
var uri = new Uri("http://myUrl/%2E%2E/%2E%2E"); // http scheme, escaped
OR
var uri = new Uri("ftp://myUrl/../.."); // ftp scheme, unescaped
OR
var uri = new Uri("ftp://myUrl/%2E%2E/%2E%2E"); // ftp scheme, escaped

Console.WriteLine($"AbsoluteUri: {uri.AbsoluteUri}");
Console.WriteLine($"PathAndQuery: {uri.PathAndQuery}");

このコードを実行すると、次のテキストのような出力が返されます。

AbsoluteUri: http://myurl/
PathAndQuery: /

Uri メソッドを使用して、ToString クラスの内容をエスケープ エンコードされた URI 参照から読み取り可能な URI 参照に変換できます。 ToString メソッドの出力では、一部の予約文字がエスケープされる可能性があることに注意してください。 これは、 ToStringによって返される値からの URI の明確な再構築をサポートするためです。

一部の URI には、フラグメント識別子またはクエリ、またはその両方が含まれます。 フラグメント識別子は、番号記号 (#)の後に続く任意のテキストであり、番号記号は含まれません。フラグメント テキストは、 Fragment プロパティに格納されます。 クエリ情報は、URI の疑問符 (?) に続くテキストです。クエリ テキストは、 Query プロパティに格納されます。

国際リソース識別子のサポート

Web アドレスは通常、非常に制限された文字セットで構成される URI を使用して表されます。

• 英字の大文字と小文字の ASCII 文字。
• 0 ~ 9 の数字。
• 他の少数の ASCII シンボル。

URI の仕様は、インターネット エンジニアリング タスク フォース (IETF) によって公開されている RFC 2396、RFC 2732、RFC 3986、RFC 3987 に記載されています。

英語以外の言語を使用してリソースを識別し、非 ASCII 文字 (Unicode/ISO 10646 文字セットの文字) を許可する必要がある識別子は、国際リソース識別子 (IRI) と呼ばれます。 IRI の仕様は、IETF によって公開された RFC 3987 に記載されています。 IRI を使用すると、URL に Unicode 文字を含めることができます。 正規化と文字チェックは、RFC 3986 および RFC 3987 の最新の IRI 規則に従って行われます。

Uri クラスの IRI および IDN 処理は、System.Configuration.IriParsingElement、System.Configuration.IdnElement、およびSystem.Configuration.UriSection構成設定クラスを使用して制御できます。 System.Configuration.IriParsingElement設定では、Uri クラスでの IRI 処理を有効または無効にします。 System.Configuration.IdnElement設定では、Uri クラスでの IDN 処理を有効または無効にします。

System.Configuration.IriParsingElementとSystem.Configuration.IdnElementの構成設定は、最初のSystem.Uri クラスが構築されるときに 1 回読み取られます。 その後の構成設定の変更は無視されます。

System.GenericUriParser クラスも拡張され、IRI と IDN をサポートするカスタマイズ可能なパーサーを作成できます。 System.GenericUriParser オブジェクトの動作は、System.GenericUriParserOptions列挙で使用可能な値のビットごとの組み合わせをSystem.GenericUriParserコンストラクターに渡すことによって指定されます。 GenericUriParserOptions.IriParsing型は、パーサーが RFC 3987 で国際リソース識別子 (IRI) に指定されている解析規則をサポートすることを示します。

GenericUriParserOptions.Idn型は、パーサーがホスト名の国際化ドメイン名 (IDN) の解析をサポートしていることを示します。 .NET (Core) および .NET Framework 4.5 以降では、IDN が常に使用されます。 以前のバージョンでは、構成オプションによって IDN が使用されるかどうかが決まります。

暗黙的なファイル パスのサポート

Uri は、ローカル ファイル システム パスを表すためにも使用できます。 これらのパスは、file:// スキームで始まる URI で 明示的に 表し、file:// スキームを持たない URI では 暗黙的に 表すことができます。 具体的な例として、次の 2 つの URI はどちらも有効であり、同じファイル パスを表します。

Uri uri1 = new Uri("C:/test/path/file.txt") // Implicit file path.
Uri uri2 = new Uri("file:///C:/test/path/file.txt") // Explicit file path.

これらの暗黙的なファイル パスは URI 仕様に準拠していないため、可能な場合は避ける必要があります。 Unix ベースのシステムで .NET Core を使用する場合、絶対暗黙的なファイル パスが相対パスと 区別できないため 、暗黙的なファイル パスが特に問題になる可能性があります。 このような曖昧さが存在する場合、Uri は既定でパスを絶対 URI として解釈します。

セキュリティに関する考慮事項

セキュリティ上の懸念から、信頼できないソースから Uri インスタンスを受け取り、dontEscapeで true を に設定する場合は、アプリケーションで注意が必要です。 IsWellFormedOriginalString メソッドを呼び出すことで、URI 文字列の有効性を確認できます。

信頼されていないユーザー入力を処理する場合は、そのプロパティを信頼する前に、新しく作成された Uri インスタンスに関する前提条件を確認します。 これは、次の方法で実行できます。

string userInput = ...;

Uri baseUri = new Uri("https://myWebsite/files/");

if (!Uri.TryCreate(baseUri, userInput, out Uri newUri))
{
    // Fail: invalid input.
}

if (!baseUri.IsBaseOf(newUri))
{
    // Fail: the Uri base has been modified - the created Uri is not rooted in the original directory.
}

この検証は、UNC パスを処理する場合など、 baseUriを変更するだけで、他の場合に使用できます。

Uri baseUri = new Uri(@"\\host\share\some\directory\name\");

UriとUriBuilderの設計とセキュリティに関する考慮事項の詳細については、次の脅威モデルドキュメントを確認してください。

• System.Uri 脅威モデル
• System.UriBuilder 脅威モデル

パフォーマンスに関する考慮事項

URI を含む Web.config ファイルを使用してアプリケーションを初期化する場合、URI のスキーム識別子が標準でない場合は、URI の処理に追加の時間が必要です。 このような場合は、URI が必要なときに、アプリケーションの影響を受ける部分を初期化します。開始時刻には初期化しません。

スレッド セーフ

Uriのすべてのメンバーはスレッド セーフであり、複数のスレッドから同時に使用できます。

こちらもご覧ください

• IdnElement
• IriParsingElement
• UriSection
• DnsSafeHost
• MakeRelative(Uri)
• IsWellFormedOriginalString()
• UriBuilder
• バージョン 2.0 での System.Uri 名前空間の変更
• System.UriSystem.Uri での国際リソース識別子のサポート
• .NET Framework でのネットワーク プログラミング