Home > Articles > Programming > Windows Programming

This chapter is from the book

Serialization

Using the File and Stream classes can be quite cumbersome if you have to save a complicated data structure with linked objects. You have to save the individual fields to disk, remembering which field belongs to which object, and which object instance was linked to another object instance. When restoring the data structure, you have to reconstitute that arrangement of fields and object references.

The serialization technology provided by the .NET Framework does this for you. Serialization converts objects, such as classes, structs, and arrays, to a byte stream. Deserialization converts the byte stream back into the objects. Serializing and deserializing can be done on different machines as long as they both host the CLR.

Objects can be serialized without writing special code because, as we have seen, the runtime can query the object's metadata to allow it to understand the memory layout of the object. To inform the framework that a class can be serialized, mark the class with the System::Serializable attribute. Any field or property that should not be serialized can be marked with the System::NonSerialized attribute. For example, fields that represent cached values need not be serialized. All you have to do is mark the class with the serializable attribute, and you then do not have to write any other code to serialize the object's fields.

The Serialization example shows how to apply serialization to the case study's HotelBroker class in the Hotel assembly.4 The Serializable attribute has been applied to the HotelBroker class definition. The Serializable attribute has also been applied to all the classes that get used by HotelBroker or that HotelBroker derives from—Broker, Hotel, HotelReservation, Reservable, and Reservation—because in order for HotelBroker to be serializable, those classes must be serializable as well. If any of those classes were not marked, a runtime exception would be thrown when the framework tries to serialize an object of that type.

[Serializable]
public __gc class HotelBroker :
   public Broker,
   public IHotelInfo,
   public IHotelAdmin,
   public IHotelReservation
{
private:
   const int MAXDAY;
   const int MAXUNIT;
   [NonSerialized] ArrayList *cities;
   ...
};

[Serializable]
public __gc class Hotel : public Reservable
{
   ...
};

[Serializable]
public __gc class HotelReservation : public Reservation
{
   ...
};

[Serializable]
public __gc __abstract class Reservable
{
   ...
};

[Serializable]
public __gc __abstract class Reservation
{
   ...
};

[Serializable]
public __gc __abstract class Broker
{
   ...
};

The cities field has been marked as NonSerialized, since the hotel's city is saved with the serialized hotels, and therefore can be restored as the modified AddCity method demonstrates. The cities field would be null if the HotelBroker class had been deserialized, because the cities field was not saved.5

private:
   void AddCity(String *city)
   {
      if (cities == 0)
      {
         cities = new ArrayList;
         IEnumerator *pEnum = units->GetEnumerator();
         while (pEnum->MoveNext())
         {
            Hotel *h =
               dynamic_cast<Hotel *>(pEnum->Current);
            AddCity(h->City);
         }
      }
      // check if city already on list, add if not
      if (!cities->Contains(city))
         cities->Add(city);
   }

Serialization Objects

Although the framework knows how to save an object marked with the Serializable attribute, you still have to specify the format in which the object is saved and the storage medium. To specify the format that an object is saved in, you use an instance of an object that supports the IFormatter interface.6

The Framework ships with two such classes: System::Runtime::Serialization::Formatters::Binary::BinaryFormatter and System::Runtime:: Serialization::Formatters::Soap::SoapFormatter. The BinaryFormatter uses a binary, compact format for serializing and deserializing on platforms that support the CLR. The SoapFormatter uses the industry standard SOAP protocol that is discussed in Chapter 11, "Web Services." Since it is an XML-based, and therefore text-based, protocol, it can be used to communicate with a non-CLR-based platform. The binary format is faster when serializing and deserializing data.

You can, of course, implement your own formatter classes. You might do this if you have to talk to a foreign system with its own persistent object byte format.

The Serialization example has code to demonstrate saving and restoring both binary and SOAP formats using a FileStream. Of course you could use any Stream-based class representing some data medium. Notice the special care taken to ensure that the Load method is able to modify the parameter that points to the HotelBroker. To enable this, the parameter is declared to be a reference to a pointer to a HotelBroker.

   static void Save(
      HotelBroker *broker, String *formatter)
   {
      FileStream *s;
      if (String::Equals(formatter, "b"))
      {
         s = new FileStream(
            "hotels.bin", FileMode::Create);
         BinaryFormatter *b = new BinaryFormatter;
         b->Serialize(s, broker);
      }
      else
      {
         s = new FileStream(
            "hotels.txt", FileMode::Create);
         SoapFormatter *sf = new SoapFormatter;
         sf->Serialize(s, broker);
      }
      s->Close();
   }

   static void Load(
      HotelBroker *&broker, /*ref to pointer */
      String *formatter)
   {
      FileStream *s;
      if (String::Equals(formatter, "b"))
      {
         s = new FileStream("hotels.bin", FileMode::Open);
         BinaryFormatter *b = new BinaryFormatter;
         broker =
            dynamic_cast<HotelBroker *>
               (b->Deserialize(s));
      }
      else
      {
         s = new FileStream("hotels.txt", FileMode::Open);
         SoapFormatter *sf = new SoapFormatter;
         broker =
            dynamic_cast<HotelBroker *>(sf->Deserialize(s));
      }
      s->Close();
      ShowHotelList(broker->GetHotels());
   }

Here is some sample output from the Serialization example: First, we add a hotel and save it with the SOAP formatter. We then exit the program.

Enter command: cities
Atlanta
Boston
Commands: quit, cities, list, add, fetch, save

Enter command: list
City            Name                 Rooms      Rate
Atlanta         Dixie                100        115
Atlanta         Marriott             500        70
Boston          Sheraton             250        95
Commands: quit, cities, list, add, fetch, save

Enter command: add
Hotel City: Philadelphia
Hotel Name: Franklin
Number Rooms: 100
Room Rate: 200
Commands: quit, cities, list, add, fetch, save

Enter command: save
Formatter: b(inary), s(oap)s
Commands: quit, cities, list, add, fetch, save

Enter command: cities
Atlanta
Boston
Philadelphia
Commands: quit, cities, list, add, fetch, save

Enter command: list
City            Name                 Rooms      Rate
Atlanta         Dixie                100        115
Atlanta         Marriot              500        70
Boston          Sheraton             250        95
Philadelphia    Franklin             100        200
Commands: quit, cities, list, add, fetch, save

Enter command: quit

We then run the program again and restore what we saved7 in the first run.

Enter command: cities
Atlanta
Boston
Commands: quit, cities, list, add, fetch, save

Enter command: list
City            Name                 Rooms      Rate
Atlanta         Dixie                100        115
Atlanta         Marriot              500        70
Boston          Sheraton             250        95
Commands: quit, cities, list, add, fetch, save

Enter command: fetch
Formatter: b(inary), s(oap)s
City            Name                 Rooms      Rate
Atlanta         Dixie                100        115
Atlanta         Marriot              500        70
Boston          Sheraton             250        95
Philadelphia    Franklin             100        200
Commands: quit, cities, list, add, fetch, save

Enter command: cities
Atlanta
Boston
Philadelphia

ISerializable

Sometimes the serialization provided by the framework is not satisfactory. You can provide custom serialization for a class by implementing the ISerializable interface and adding a constructor to the class, as shown in the Serialization project in the ISerializable directory. The ISerializable interface has one member: GetObjectData. This method is used when data is serialized.

The ISerializable example8 demonstrates how this is done. As before, the class has to be marked as Serializable.

[Serializable]
public __gc class HotelBroker :
   public Broker,
   public IHotelInfo,
   public IHotelAdmin,
   public IHotelReservation,
   public ISerializable
{
   ...
};

The SerializationInfo class is used to store all the data that needs to be saved in the ISerializable::GetObjectData method. The AddValue method of SerializationInfo is overloaded to handle the saving of various types, including Object*.9 When you save the type, you provide a name so that it can be restored later. The StreamingContext class gives you information about the stream being used in the serialization. For example, you can find out if the stream being used is a file or is being remoted to another computer.

public:
   void GetObjectData(SerializationInfo *info,
      StreamingContext context)
   {
      long numberHotels = units->Count;
      info->AddValue("NumberHotels", numberHotels);
      info->AddValue("Hotels", units);
   }

You also have to implement a special constructor that is used by the framework when the object is deserialized. It has the same arguments as GetObjectData has. Here you use the various GetXXX methods on SerializationInfo to restore the data. Note that since we did not save the cities field, we had to manually restore it. The constructor is private because only the framework uses it. If you forget to add the constructor, you will get a SerializationException when you try to restore the object.

private:
   HotelBroker(SerializationInfo *info,
      StreamingContext context)
      : Broker(366, 10), MAXDAY(366), MAXUNIT(10)
   {
      long numberHotels =
         info->GetInt32("NumberHotels");
      units = dynamic_cast<ArrayList *>(
         info->GetValue(
            "Hotels", units->GetType()));
      if (numberHotels == units->Count)
         Console::WriteLine("All hotels deserialized.");
      else
         Console::WriteLine("Error in deserialization.");
      cities = new ArrayList;
      IEnumerator *pEnum = units->GetEnumerator();
      while (pEnum->MoveNext())
      {
         Hotel *h =
            dynamic_cast<Hotel *>(pEnum->Current);
         AddCity(h->City);
      }
   }

Remember, after you make any changes and build the Hotel project, will need to copy the Hotel.dll to the directory of the Serialization.exe client program. This does not get done automatically, as in C#, unless you add a custom build step to the project.

In this example we only did custom serialization for the HotelBroker object. For all the other objects, we still relied on the framework's serialization. This example works the same way that the Serialization example did. The sample output would therefore look the same.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020