C#のUri.IsWellFormedOriginalString()メソッドの使い方とサンプルコード

C#のUri.IsWellFormedOriginalString()メソッドは、Uriオブジェクトの構築に使用された文字列が整形式（well-formed）であるか、また追加のエスケープ処理が必要かどうかを判定するメソッドです。戻り値がtrueの場合、元の文字列は有効なURIとして正しく形成されており、それ以上エスケープする必要がないことを意味します。

構文

IsWellFormedOriginalString()メソッドの構文は以下のとおりです。

public bool IsWellFormedOriginalString ();

使用例

ここでは、Uri.IsWellFormedOriginalString()メソッドを実装した具体的な例を見てみましょう。以下のコードでは、2つのUriインスタンスを作成し、等価性の比較と整形式の判定を行っています。

using System;
public class Demo {
   public static void Main(){
      Uri newURI1 = new Uri("https://www.tutorialspoint.com/index.htm");
      Console.WriteLine("URI = "+newURI1);
      Uri newURI2 = new Uri("https://www.qries.com/");
      Console.WriteLine("URI = "+newURI2);
      if(newURI1.Equals(newURI2))
         Console.WriteLine("Both the URIs are equal!");
      else
         Console.WriteLine("Both the URIs aren't equal!");
      if(newURI1.IsWellFormedOriginalString())
         Console.WriteLine("newURI1 is well formed!");
      else
         Console.WriteLine("newURI1 isn't well formed!");
   }
}

実行結果

上記のプログラムを実行すると、以下のような出力が得られます。

URI = https://www.tutorialspoint.com/index.htm
URI = https://www.tutorialspoint.com/
Both the URIs aren't equal!
newURI1 is well formed!

解説

この例では、まず2つの異なるURLからUriインスタンスを生成しています。Equals()メソッドによる比較では、両者のURIが異なるため「等しくない」という結果が出力されます。その後、IsWellFormedOriginalString()メソッドを呼び出すことで、newURI1の構築に使われた文字列「https://www.tutorialspoint.com/index.htm」が整形式であり、追加のエスケープが不要であることが確認できます。

このメソッドは、ユーザー入力や外部システムから受け取ったURL文字列の妥当性を検証したい場合に特に役立ちます。RFC 2396およびRFC 2732に準拠した形式かどうかをチェックすることで、不正なURIによるエラーを事前に防ぐことができます。