{"id":5533,"date":"2007-08-30T16:53:00","date_gmt":"2007-08-30T16:53:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/vbteam\/2007\/08\/30\/a-walkthrough-of-wcf-support-in-visual-studio-2008\/"},"modified":"2024-07-05T14:41:26","modified_gmt":"2024-07-05T21:41:26","slug":"a-walkthrough-of-wcf-support-in-visual-studio-2008","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/vbteam\/a-walkthrough-of-wcf-support-in-visual-studio-2008\/","title":{"rendered":"A Walkthrough of WCF Support in Visual Studio 2008"},"content":{"rendered":"

<\/p>\n

One feature in Visual Studio 2008 I would like to highlight is our support of Windows Communication Foundation. WCF was introduced with .NET Fx3.0 as a next generation communications API. Previously if you wanted apps to talk you needed to make a lot of up-front decisions:<\/p>\n

<\/p>\n

o <\/p>\n

<\/font>How important is transmission speed?
<\/font>o <\/font>How will apps talk? Over the internet, intranet, or on the same machine?
<\/font>o <\/font>Is reliable messaging important?
<\/font>o <\/font>Is message encryption important?<\/p>\n

Once you made those decisions and started writing your app you were forced to learn a new protocol {.Net Remoting, ASMX web services, MSMQ, Named Pipes, etc.} and implement a solution specific to that API. The problem with this is that your code doesn’t age gracefully. If the requirements change too much, you need to rewrite the entire communication layer using an API which supports whatever mission-critical feature you need.<\/p>\n

WCF fixes this problem and more by providing a unified programming model for all the above scenarios so you now just have to learn one API and toolset. It does this by separating the various pieces of communication, E.g., protocols, message contracts, etc. Rather than worrying about the specifics of how each message is transferred between client and server, WCF just asks you to focus on the service and message contracts. That is, what methods will you be able to call from a client and the structure of the data returned. All the goo about communication protocols is highly configurable and out of code (in the app.config). That is WCF from a mile-high view, but let’s dive into what it can do for you in Visual Studio 2008.<\/p>\n

We will be creating a three-tiered application called Northwind Traders. Our solution will comprise of four projects: a data access layer, a WCF service, a WinForms client, and a shared business logic component. Along the way we will highlight key features new to Visual Studio 2008 and demonstrate just how easy it is to write killer data-centric apps.<\/p>\n

\n<\/b><\/p>\n

<\/font>Creating Data Access Layer<\/font><\/p>\n

Let’s start our app by creating a data access layer by creating a new class library aptly titled DataAccessLayer. <\/font><\/p>\n

One of the common problems developing N-tier applications in Visual Studio, is that the tools put the TableAdapters and the typed DataSets in the same project. Which unfortunately leaks out sensitive information such as connection strings. If you wanted to reuse your typed DataSets but keep your TableAdapters private, you have to resort to fighting against the tools which doesn’t provide a great developer experience. Fortunately in Visual Studio 2008 we’ve addressed this.<\/font><\/p>\n

Once you’ve created the data access layer in Visual Studio 2008 you can configure the DataSet Designer to generate the DataSet code into a separate project in your solution. So you can share\/reuse your typed DataSets without exposing things like connection strings.<\/font><\/p>\n

Add another class library project to your solution called NorthwindBuisnessObjects.<\/font><\/p>\n<\/p>\n

<\/font>\"DataSet<\/font><\/font><\/p>\n

Then, reopen the NorthwindDataSet and change the ‘DataSet Project’ property on the properties window to be NorthwindBuisnessObjects. Now, once you build your project, NorthwindDataSet.DataSet.Designer.vb will be generated in the NorthwindBuisnessObjects project.<\/font><\/font><\/p>\n

Next let’s add some simple validation logic to our DataSet. Double click the DataSet designer and insert the following code snippet. (Note that it automatically creates DataSet.vb in the correct project.)<\/font><\/p>\n

<\/p>\n

Partial<\/span> <\/font>Class<\/span> NorthwindDataSet<\/p>\n

<\/font><\/span><\/p>\n

    <\/font><\/span>Partial<\/span> <\/font>Class<\/span> OrdersDataTable<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

        <\/font><\/span>Private<\/span> <\/font>Sub<\/span> OrdersDataTable_OrdersRowChanging(<\/font>ByVal<\/span> sender <\/font>As<\/span> System.Object, <\/font>ByVal<\/span> e <\/font>As<\/span> OrdersRowChangeEvent) <\/font>Handles<\/span> <\/font>Me<\/span>.OrdersRowChanging<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

        <\/font><\/span>End<\/span> <\/font>Sub<\/p>\n

<\/span><\/span><\/p>\n

<\/p>\n

 <\/p>\n

<\/span><\/p>\n

        <\/font><\/span>Private<\/span> <\/font>Sub<\/span> OrdersDataTable_ColumnChanged(<\/font>ByVal<\/span> sender <\/font>As<\/span> <\/font>Object<\/span>, <\/font>ByVal<\/span> e <\/font>As<\/span> System.Data.DataColumnChangeEventArgs) <\/font>Handles<\/span> <\/font>Me<\/span>.ColumnChanged<\/p>\n

<\/font><\/span><\/p>\n

            <\/font><\/span>If<\/span> e.Column.ColumnName = <\/font>Me<\/span>.OrderDateColumn.ColumnName <\/font>Or<\/span> e.Column.ColumnName = <\/font>Me<\/span>.ShippedDateColumn.ColumnName <\/font>Then<\/p>\n

<\/span><\/span><\/p>\n

                <\/span>ValidateDates(e.Row)<\/p>\n

<\/font><\/span><\/p>\n

            <\/font><\/span>End<\/span> <\/font>If<\/p>\n

<\/span><\/span><\/p>\n

        <\/font><\/span>End<\/span> <\/font>Sub<\/p>\n

<\/span><\/span><\/p>\n

<\/p>\n

 <\/p>\n

<\/span><\/p>\n

        <\/font><\/span>‘*********************************************<\/p>\n

<\/span><\/span><\/p>\n

        <\/font><\/span>‘CUSTOM VALIDATION CODE FOR MY DATASET<\/p>\n

<\/span><\/span><\/p>\n

        <\/font><\/span>‘*********************************************<\/p>\n

<\/span><\/span><\/p>\n

        <\/font><\/span>Private<\/span> <\/font>Sub<\/span> ValidateDates(<\/font>ByVal<\/span> row <\/font>As<\/span> OrdersRow)<\/p>\n

<\/font><\/span><\/p>\n

            <\/font><\/span>If<\/span> row.OrderDate > row.ShippedDate <\/font>Then<\/p>\n

<\/span><\/span><\/p>\n

                <\/span>row.SetColumnError(<\/font>Me<\/span>.OrderDateColumn, <\/font>“Can’t ship before it’s been ordered”<\/span>)<\/p>\n

<\/font><\/span><\/p>\n

                <\/span>row.SetColumnError(<\/font>Me<\/span>.ShippedDateColumn, <\/font>“Can’t ship before it’s been ordered”<\/span>)<\/p>\n

<\/font><\/span><\/p>\n

            <\/font><\/span>Else<\/p>\n

<\/span><\/span><\/p>\n

                <\/span>row.SetColumnError(<\/font>Me<\/span>.OrderDateColumn, <\/font>“”<\/span>)<\/p>\n

<\/font><\/span><\/p>\n

                <\/span>row.SetColumnError(<\/font>Me<\/span>.ShippedDateColumn, <\/font>“”<\/span>)<\/p>\n

<\/font><\/span><\/p>\n

            <\/font><\/span>End<\/span> <\/font>If<\/p>\n

<\/span><\/span><\/p>\n

        <\/font><\/span>End<\/span> <\/font>Sub<\/p>\n

<\/span><\/span><\/p>\n

    <\/font><\/span>End<\/span> <\/font>Class<\/p>\n

<\/span><\/span><\/p>\n

End<\/span> <\/font>Class<\/p>\n

<\/span><\/span><\/p>\n

\n

<\/font><\/span><\/font><\/font><\/p>\n

 <\/p>\n

Let’s finish our data access layer by adding a class called NorthwindManager, which connects to the database and returns our tables.<\/font><\/p>\n

 <\/font><\/p>\n

<\/p>\n

Imports<\/span> NorthwindBuisnessObjects<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

Public<\/span> <\/font>Class<\/span> NorthwindManager<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

    <\/font><\/span>Public<\/span> <\/font>Shared<\/span> <\/font>Function<\/span> GetCustomers() <\/font>As<\/span> NorthwindDataSet.CustomersDataTable<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

        <\/font><\/span>Dim<\/span> customerAdapter <\/font>As<\/span> <\/font>New<\/span> NorthwindDataSetTableAdapters.CustomersTableAdapter()<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

        <\/font><\/span>Return<\/span> customerAdapter.GetData()<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

    <\/font><\/span>End<\/span> <\/font>Function<\/p>\n

<\/span><\/span><\/p>\n

<\/p>\n

 <\/p>\n

<\/span><\/p>\n

    <\/font><\/span>Public<\/span> <\/font>Shared<\/span> <\/font>Function<\/span> GetOrders() <\/font>As<\/span> NorthwindDataSet.OrdersDataTable<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

        <\/font><\/span>Dim<\/span> orderAdapter <\/font>As<\/span> <\/font>New<\/span> NorthwindDataSetTableAdapters.OrdersTableAdapter()<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

        <\/font><\/span>Return<\/span> orderAdapter.GetData()<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

    <\/font><\/span>End<\/span> <\/font>Function<\/p>\n

<\/span><\/span><\/p>\n

<\/p>\n

 <\/p>\n

<\/span><\/p>\n

End<\/span> <\/font>Class<\/p>\n

<\/span><\/span><\/p>\n

<\/p>\n

 <\/p>\n

<\/span><\/p>\n

\n

<\/font>Creating a WCF Service<\/font><\/b><\/p>\n

Now let’s move onto creating our WCF service. The tooling support should be on par with the ASMX Web Reference experience. Let’s begin by creating a new WCF Web Service project, which creates a new WCF service hosted in IIS.<\/p>\n

\"New<\/strong><\/p>\n<\/p>\n

<\/font>Note that WCF doesn’t have to just be a web-based service. In Visual Studio 2008 we also have project templates for service libraries, which are WCF services baked into class libraries. In addition we have a Test Form which allows you to debug you WCF services (not discussed here).<\/p>\n

Once our service project has been created, let’s add references to both our DataAccessLayer and BuisnessObjects projects.<\/p>\n

Next, let’s replace the default service contract from the project template with our own. Those <ServiceContract()> and <OperationContract()> interfaces indicate to the WCF runtime that this is a WCF service contract. <\/p>\n

<\/font><\/p>\n

Imports<\/span> NorthwindBuisnessObjects<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

<ServiceContract()> _<\/p>\n

<\/font><\/span><\/p>\n

Public<\/span> <\/font>Interface<\/span> IService<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

    <\/span><OperationContract()> _<\/p>\n

<\/font><\/span><\/p>\n

    <\/font><\/span>Function<\/span> GetCustomers() <\/font>As<\/span> NorthwindDataSet.CustomersDataTable<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

    <\/span><OperationContract()> _<\/p>\n

<\/font><\/span><\/p>\n

    <\/font><\/span>Function<\/span> GetOrders() <\/font>As<\/span> NorthwindDataSet.OrdersDataTable<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

End<\/span> <\/font>Interface<\/p>\n

<\/span><\/span><\/p>\n

<\/p>\n

<\/span><\/p>\n<\/p>\n

<\/font>Let’s change the service contract implementation accordingly.<\/b><\/font><\/p>\n

Imports<\/span> NorthwindBuisnessObjects<\/font><\/span><\/p>\n

Imports<\/span> DataAccessLayer<\/font><\/span><\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

Public<\/span> <\/font>Class<\/span> Service<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

    <\/font><\/span>Implements<\/span> IService<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

    <\/font><\/span>Public<\/span> <\/font>Function<\/span> GetCustomers() <\/font>As<\/span> NorthwindDataSet.CustomersDataTable <\/font>Implements<\/span> IService.GetCustomers<\/p>\n

<\/font><\/span><\/p>\n

<\/p>\n

 <\/font><\/p>\n

<\/span><\/p>\n

\n

<\/font><\/font><\/p>\n","protected":false},"excerpt":{"rendered":"

One feature in Visual Studio 2008 I would like to highlight is our support of Windows Communication Foundation. WCF was introduced with .NET Fx3.0 as a next generation communications API. Previously if you wanted apps to talk you needed to make a lot of up-front decisions: o How important is transmission speed?o How will apps […]<\/p>\n","protected":false},"author":260,"featured_media":8818,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[192,195],"tags":[82,177],"class_list":["post-5533","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-featured","category-visual-basic","tag-john-stallo","tag-wcf"],"acf":[],"blog_post_summary":"

One feature in Visual Studio 2008 I would like to highlight is our support of Windows Communication Foundation. WCF was introduced with .NET Fx3.0 as a next generation communications API. Previously if you wanted apps to talk you needed to make a lot of up-front decisions: o How important is transmission speed?o How will apps […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/vbteam\/wp-json\/wp\/v2\/posts\/5533","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/vbteam\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/vbteam\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/vbteam\/wp-json\/wp\/v2\/users\/260"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/vbteam\/wp-json\/wp\/v2\/comments?post=5533"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/vbteam\/wp-json\/wp\/v2\/posts\/5533\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/vbteam\/wp-json\/wp\/v2\/media\/8818"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/vbteam\/wp-json\/wp\/v2\/media?parent=5533"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/vbteam\/wp-json\/wp\/v2\/categories?post=5533"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/vbteam\/wp-json\/wp\/v2\/tags?post=5533"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}