dotnet-core/samples/dotnet-svcutil.xmlserializer-instructions.md

Using dotnet-svcutil.xmlserializer on .NET Core

Just like the svcutil XmlSerializer Type Generation function on desktop, dotnet-svcutil.xmlserializer NuGet package is the solution for WCF applications on .NET Core and .NET Standard Libraries. It pre-generates c# serialization code for the types used by Service Contract in the WCF client applications that can be serialized using the XmlSerializer to improve the startup performance of Xml Serialization when serializing or de-serializing objects of those types using XmlSerializer.

You can start using the tool today following the instructions below.

Prerequisites

The following is required for dotnet-svcutil.xmlserializer to work.

• .NET Core SDK 2.1 or later

You can use the command dotnet --info to check which versions of .NET Core SDK and runtime you already have installed.

Instructions

Here are the step by step instructions on how to use dotnet-svcutil.xmlserializer in a .NET Core console application.

1. Create a WCF Service named 'MyWCFService' using the default template 'WCF Service Application' in .NET Framework. Add [XmlSerializerFormat] attribute on the service method like the following

   [ServiceContract]
   public interface IService1
   {
       [XmlSerializerFormat]
       [OperationContract(Action = "http://tempuri.org/IService1/GetData", ReplyAction = "http://tempuri.org/IService1/GetDataResponse")]
       string GetData(int value);
   }
   

2. Create a .NET Core console application as WCF client application that targets at netcoreapp 2.1, e.g. create an app named 'MyWCFClient' with the command,

   dotnet new console --name MyWCFClient
   

   Make sure your csproj targets a netcoreapp 2.1 as the following in .csproj. This is done using the following XML element in your .csproj

   <TargetFramework>netcoreapp2.1</TargetFramework>
   

3. Add a package reference to System.ServiceModel.Http

   Run command: dotnet add package System.ServiceModel.Http -v 4.5.0

4. Add WCF Client code

   using System.ServiceModel;
   
   class Program
   {
       static void Main(string[] args)
       {
           var myBinding = new BasicHttpBinding();
           var myEndpoint = new EndpointAddress("http://localhost:2561/Service1.svc"); //Fill your service url here
           var myChannelFactory = new ChannelFactory<IService1>(myBinding, myEndpoint);
           IService1 client = myChannelFactory.CreateChannel();
           string s = client.GetData(1);
           ((ICommunicationObject)client).Close();
       }
   }
   
   [ServiceContract]
   public interface IService1
   {
       [XmlSerializerFormat]
       [OperationContract(Action = "http://tempuri.org/IService1/GetData", ReplyAction = "http://tempuri.org/IService1/GetDataResponse")]
       string GetData(int value);
   }
   

5. Edit the .csproj and add a reference to the dotnet-svcutil.xmlserializer package. For example,

   i. Run command: dotnet add package dotnet-svcutil.xmlserializer -v 1.0.0

   ii. Add the following lines in MyWCFClient.csproj,

   <ItemGroup>
     <DotNetCliToolReference Include="dotnet-svcutil.xmlserializer" Version="1.0.0" />
   </ItemGroup>
   

6. Build the application by running dotnet build. If everything succeeds, an assembly named MyWCFClient.XmlSerializers.dll will be generated in the output folder. You will see warnings in the build output if the tool failed to generate the assembly.

7. Start the WCF service e.g. running http://localhost:2561/Service1.svc in the IE. Then start the client application and it will automatically load and use the pre-generated serializers at runtime.