コントラクト優先ツール

[アーティクル]
05/09/2023

サービスコントラクトは、多くの場合、既存のサービスから作成する必要があります。 .NET Framework 4.5 以降では、コントラクト優先ツールを使用して、データコントラクトクラスを既存のサービスから自動的に作成できます。コントラクト優先ツールを使用するには、XML スキーマ定義ファイル (XSD) をローカルにダウンロードする必要があります。ツールは、HTTP 経由でリモートデータコントラクトをインポートすることはできません。

コントラクト優先ツールは、ビルドタスクとして、Visual Studio 2012 に統合されています。ビルドタスクによって生成されるコードファイルは、基になるサービスコントラクトの変更をプロジェクトが簡単に取り込むことができるように、プロジェクトがビルドされるたびに作成されます。

コントラクト優先ツールがインポートできるスキーマ型には、次のようなものがあります。

<xsd:complexType>
 <xsd:simpleType>
 </xsd:simpleType>
</xsd:complexType>

単純型は、Int16 または String のようなプリミティブである場合は生成されません。複合型は、Collection 型である場合は生成されません。他の xsd:complexType の一部である型も、生成されません。これらのすべての場合に、型はプロジェクト内の既存の型を参照するようになります。

プロジェクトへのデータコントラクトの追加

コントラクト優先ツールを使用する前に、サービスコントラクト (XSD) をプロジェクトに追加する必要があります。この概要説明では、コントラクト優先機能を示すために、次のコントラクトを使用します。このサービス定義は、Bing の検索 API で使用されているサービスコントラクトのごく一部です。

<?xml version="1.0" encoding="utf-8"?>
<xs:schema id="ServiceSchema"
    targetNamespace="http://tempuri.org/ServiceSchema.xsd"
    elementFormDefault="qualified"
    xmlns="http://tempuri.org/ServiceSchema.xsd"
    xmlns:mstns="http://tempuri.org/ServiceSchema.xsd"
    xmlns:xs="http://www.w3.org/2001/XMLSchema"
>
  <xs:complexType name="SearchRequest">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="1" name="Version" type="xs:string" default="2.2" />
      <xs:element minOccurs="0" maxOccurs="1" name="Market" type="xs:string" />
      <xs:element minOccurs="0" maxOccurs="1" name="UILanguage" type="xs:string" />
      <xs:element minOccurs="1" maxOccurs="1" name="Query" type="xs:string" />
      <xs:element minOccurs="1" maxOccurs="1" name="AppId" type="xs:string" />
      <xs:element minOccurs="0" maxOccurs="1" name="Latitude" type="xs:double" />
      <xs:element minOccurs="0" maxOccurs="1" name="Longitude" type="xs:double" />
      <xs:element minOccurs="0" maxOccurs="1" name="Radius" type="xs:double" />
    </xs:sequence>
  </xs:complexType>
  <xs:simpleType name="WebSearchOption">
    <xs:restriction base="xs:string">
      <xs:enumeration value="DisableHostCollapsing" />
      <xs:enumeration value="DisableQueryAlterations" />
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

上のサービスコントラクトをプロジェクトに追加するには、プロジェクトを右クリックして、 [新規追加] をクリックします。 [テンプレート] ダイアログボックスの [WCF] ペインで [スキーマ定義] を選択し、新しいファイルの名前を SampleContract.xsd にします。上のコードをコピーし、新しいファイルのコードビューに貼り付けます。

コントラクト優先のオプションの構成

コントラクト優先のオプションは、WCF プロジェクトの [プロパティ] メニューで構成できます。コントラクト優先の開発を行うには、プロジェクトプロパティウィンドウの WCF ページで [XSD を型定義言語として有効にする] チェックボックスをオンにします。

Screenshot of the WCF Options with contract-first development enabled.

高度なプロパティを構成するには、[詳細設定] をクリックします。

Advanced Contract Code Generation Settings dialog box.

次の詳細設定は、コントラクトからコードを生成するために構成できます。設定は、プロジェクト内のすべてのファイルに対してのみ構成できます。現時点では、ファイルごとの構成はできません。

シリアライザーモード: この設定は、サービスコントラクトファイルの読み取りにどのシリアライザーを使用するかを決定します。 [XML シリアライザー] を選択すると、 [コレクションの型] と [再利用の型] オプションは無効になります。これらのオプションは、 [データコントラクトシリアライザー] だけに適用されます。
再利用の型: この設定は、型の再利用にどのライブラリを使用するかを指定します。この設定は、 [シリアライザーモード] が [データコントラクトシリアライザー] に設定されている場合にだけ適用されます。
コレクションの型: この設定は、コレクションデータ型に使用する完全修飾型またはアセンブリ修飾型を指定します。この設定は、 [シリアライザーモード] が [データコントラクトシリアライザー] に設定されている場合にだけ適用されます。
ディクショナリの型: この設定は、ディクショナリデータ型に使用する完全修飾型またはアセンブリ修飾型を指定します。
EnableDataBinding: この設定は、データバインディングを実装するために、すべてのデータ型に INotifyPropertyChanged インターフェイスを実装するかどうかを指定します。
ExcludedTypes: この設定は、参照アセンブリから除外する完全修飾型またはアセンブリ修飾型のリストを指定します。この設定は、 [シリアライザーモード] が [データコントラクトシリアライザー] に設定されている場合にだけ適用されます。
GenerateInternalTypes: この設定は、internal としてマークされるクラスを生成するかどうかを指定します。この設定は、 [シリアライザーモード] が [データコントラクトシリアライザー] に設定されている場合にだけ適用されます。
GenerateSerializableTypes: この設定は、SerializableAttribute 属性を持つクラスを生成するかどうかを指定します。この設定は、 [シリアライザーモード] が [データコントラクトシリアライザー] に設定されている場合にだけ適用されます。
ImportXMLTypes: この設定は、DataContractAttribute 属性がないクラスに SerializableAttribute 属性を適用するようにデータコントラクトシリアライザーを構成するかどうかを指定します。この設定は、 [シリアライザーモード] が [データコントラクトシリアライザー] に設定されている場合にだけ適用されます。
SupportFx35TypedDataSets: この設定は、.NET Framework 3.5 用に作成された、型指定されたデータセットのために、追加機能を提供するかどうかを指定します。 [シリアライザーモード] が [XML シリアライザー] に設定されている場合、この値が True に設定されていると、TypedDataSetSchemaImporterExtensionFx35 拡張機能が XML スキーマインポーターに追加されます。 [シリアライザーモード] が [データコントラクトシリアライザー] に設定されている場合、この値が False に設定されていると、DateTimeOffset 型が [参照] から除外され、古いフレームワークバージョン用に DateTimeOffset が常に生成されるようになります。
InputXsdFiles: この設定は、入力ファイルのリストを指定します。各ファイルは、有効な XML スキーマを含んでいる必要があります。
言語: この設定は、生成されるコントラクトコードの言語を指定します。設定は、CodeDomProvider が認識できるものである必要があります。
NamespaceMappings: この設定は、XSD ターゲット名前空間から CLR 名前空間へのマッピングを指定します。各マッピングは、次の形式を使用する必要があります。
```
"Schema Namespace, CLR Namespace"
```
XML シリアライザーは、次の形式の 1 つのマッピングだけを受け取ります。
```
"*, CLR Namespace"
```
OutputDirectory: この設定は、コードファイルが生成されるディレクトリを指定します。

設定は、プロジェクトのビルド時に、サービスコントラクトファイルからサービスコントラクト型を生成するために使用されます。

コントラクト優先の開発の使用

サービスコントラクトをプロジェクトに追加し、ビルド設定を確認した後、F6 キーを押してプロジェクトをビルドします。これで、サービスコントラクトで定義された型が、プロジェクト内で利用できるようになります。

サービスコントラクトで定義した型を使用するには、現在の名前空間に ContractTypes への参照を追加します。

using MyProjectNamespace.ContractTypes;

これで、サービスコントラクトで定義された型が、以下に示すように、プロジェクト内で解決可能になります。

SearchRequest class showing in IntelliSense after typing the first few letters.

ツールによって生成された型は、GeneratedXSDTypes.cs ファイル内に作成されます。このファイルは、既定で <プロジェクトディレクトリ>/obj/<ビルド構成>/XSDGeneratedCode/ ディレクトリに作成されます。この記事の冒頭のサンプルスキーマは、次のように変換されています。

//------------------------------------------------------------------------------
// <auto-generated>
//     This code was generated by a tool.
//     Runtime Version:4.0.30319.17330
//
//     Changes to this file may cause incorrect behavior and will be lost if
//     the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------

namespace TestXSD3.ContractTypes
{
    using System.Xml.Serialization;

    /// <remarks/>
    [System.CodeDom.Compiler.GeneratedCodeAttribute("System.Xml", "4.0.30319.17330")]
    [System.SerializableAttribute()]
    [System.Diagnostics.DebuggerStepThroughAttribute()]
    [System.ComponentModel.DesignerCategoryAttribute("code")]
    [System.Xml.Serialization.XmlTypeAttribute(Namespace="http://tempuri.org/ServiceSchema.xsd")]
    [System.Xml.Serialization.XmlRootAttribute(Namespace="http://tempuri.org/ServiceSchema.xsd", IsNullable=true)]
    public partial class SearchRequest
    {

        private string versionField;

        private string marketField;

        private string uILanguageField;

        private string queryField;

        private string appIdField;

        private double latitudeField;

        private bool latitudeFieldSpecified;

        private double longitudeField;

        private bool longitudeFieldSpecified;

        private double radiusField;

        private bool radiusFieldSpecified;

        public SearchRequest()
        {
            this.versionField = "2.2";
        }

        /// <remarks/>
        [System.ComponentModel.DefaultValueAttribute("2.2")]
        public string Version
        {
            get
            {
                return this.versionField;
            }
            set
            {
                this.versionField = value;
            }
        }

        /// <remarks/>
        public string Market
        {
            get
            {
                return this.marketField;
            }
            set
            {
                this.marketField = value;
            }
        }

        /// <remarks/>
        public string UILanguage
        {
            get
            {
                return this.uILanguageField;
            }
            set
            {
                this.uILanguageField = value;
            }
        }

        /// <remarks/>
        public string Query
        {
            get
            {
                return this.queryField;
            }
            set
            {
                this.queryField = value;
            }
        }

        /// <remarks/>
        public string AppId
        {
            get
            {
                return this.appIdField;
            }
            set
            {
                this.appIdField = value;
            }
        }

        /// <remarks/>
        public double Latitude
        {
            get
            {
                return this.latitudeField;
            }
            set
            {
                this.latitudeField = value;
            }
        }

        /// <remarks/>
        [System.Xml.Serialization.XmlIgnoreAttribute()]
        public bool LatitudeSpecified
        {
            get
            {
                return this.latitudeFieldSpecified;
            }
            set
            {
                this.latitudeFieldSpecified = value;
            }
        }

        /// <remarks/>
        public double Longitude
        {
            get
            {
                return this.longitudeField;
            }
            set
            {
                this.longitudeField = value;
            }
        }

        /// <remarks/>
        [System.Xml.Serialization.XmlIgnoreAttribute()]
        public bool LongitudeSpecified
        {
            get
            {
                return this.longitudeFieldSpecified;
            }
            set
            {
                this.longitudeFieldSpecified = value;
            }
        }

        /// <remarks/>
        public double Radius
        {
            get
            {
                return this.radiusField;
            }
            set
            {
                this.radiusField = value;
            }
        }

        /// <remarks/>
        [System.Xml.Serialization.XmlIgnoreAttribute()]
        public bool RadiusSpecified
        {
            get
            {
                return this.radiusFieldSpecified;
            }
            set
            {
                this.radiusFieldSpecified = value;
            }
        }
    }

    /// <remarks/>
    [System.CodeDom.Compiler.GeneratedCodeAttribute("System.Xml", "4.0.30319.17330")]
    [System.SerializableAttribute()]
    [System.Xml.Serialization.XmlTypeAttribute(Namespace="http://tempuri.org/ServiceSchema.xsd")]
    [System.Xml.Serialization.XmlRootAttribute(Namespace="http://tempuri.org/ServiceSchema.xsd", IsNullable=false)]
    public enum WebSearchOption
    {

        /// <remarks/>
        DisableHostCollapsing,

        /// <remarks/>
        DisableQueryAlterations,
    }
}

エラーと警告

XSD スキーマの解析中に発生したエラーと警告は、ビルドのエラーと警告として表示されます。

インターフェイスの継承

コントラクト優先の開発でインターフェイスの継承を使用することはできません。これは、他の操作におけるインターフェイスの動作と一致しています。基底インターフェイスを継承するインターフェイスを使用するには、2 つの別個のエンドポイントを使用します。最初のエンドポイントは継承されるコントラクトを使用し、2 番目のエンドポイントは基底インターフェイスを実装します。

次の方法で共有

コントラクト優先ツール

プロジェクトへのデータコントラクトの追加

コントラクト優先のオプションの構成

コントラクト優先の開発の使用

エラーと警告

インターフェイスの継承

その他のリソース

次の方法で共有

コントラクト優先ツール

プロジェクトへのデータ コントラクトの追加

コントラクト優先のオプションの構成

コントラクト優先の開発の使用

エラーと警告

インターフェイスの継承

その他のリソース

プロジェクトへのデータコントラクトの追加