How to generate client-side code for multiple WCF services with shared types

azheglov picture azheglov · Jan 26, 2010 · Viewed 7.2k times · Source

I have multiple WCF services that share some data contracts and need to generate client-side code using svcutil.exe. I've run into errors using two most obvious ways to do this and need some help.

But first, here are the services:

[ServiceContract( Namespace = "http://www.me.com/services/" )]
public interface IFooService {
    [OperationContract]
    Response RunFoo( Request request );
}
[ServiceContract( Namespace = "http://www.me.com/services/" )]
public interface IBarService {
    [OperationContract]
    Response RunBar( Request request );
}

Response and Request are defined in a separate assembly:

[DataContract( Namespace = "http://www.me.com/shared/" )]
public class Request {
    [DataMember]
    public int Input { get; set; }
}
[DataContract( Namespace = "http://www.me.com/shared/" )]
public class Response {
    [DataMember]
    public int Result { get; set; }
}

The services are implemented in some trivial way, compiled, published - let's switch to the client side now.

Including both services on the svcutil command line - like this:

svcutil /o:Client.cs http://hostname.com/FooService.svc http://hostname.com/BarService.svc

will result in numerous error messages about duplicated data types, starting with

Error: There was a validation error on a schema generated during export: Source: Line: 1 Column: 9087 Validation Error: The global element 'http://schemas.microsoft.com/2003/10/Serialization/:anyType' has already been declared.

and ending with

Error: There was a validation error on a schema generated during export: Source: Line: 1 Column: 12817 Validation Error: The complexType 'http://www.me.com/shared/:Response' has already been declared.

Generating a client-side file separately for each service avoids these errors:

svcutil /o:Foo.cs http://hostname.com/FooService.svc
svcutil /o:Bar.cs http://hostname.com/BarService.svc

But then definitions of shared types (such as Request and Response) will be duplicated in Foo.cs and then in Bar.cs, resulting obviously in compiler errors.

So, what is the conventional way to generate client-side code consuming such services?

Limitations:

  • cannot ship an assembly containing shared types to the client (so that they could use svcutil.exe's /r option)
  • cannot use the "Add Service Reference..." command in Visual Studio - need an svcutil command line (or another command-line tool).

Answer

marc_s picture marc_s · Jan 26, 2010

Well, basically you can

  • either put your shared types into a separate assembly that the clients can use when generating the client code (which you already dismiss as impossible)

or then:

  • you have to generate each proxy for the services separately, and each service will get its own "copy" of the "Request" and "Response" classes

Either you can share the common assembly - or you can't - I don't see any other choice, really.