Home > Articles > Web Services > XML

  • Print
  • + Share This
Like this article? We recommend

Like this article? We recommend

Serialization and Deserialization

A more elegant solution is to use the serialization and deserialization features of XML. A serialization is a series of data values, usually text, which represents an object. It contains the object's public and private variables, and any other information needed to completely describe the object. For example, suppose a Student object contains LastName and FirstName variables, and an array of test scores. The XML serialization of a Student object might look like this:

<Student>
 <LastName>Stephens</LastName>
 <FirstName>Rod</FirstName>
 <TestScore TestNumber="1" Score="80" />
 <TestScore TestNumber="2" Score="92" />
 <TestScore TestNumber="3" Score="87" />
 <TestScore TestNumber="4" Score="94" />
</Student>

Building a serialization for a class is simple enough following roughly the same steps you would take to save the object in a database, as described in the previous section. The class just concatenates the object's variable values into a string. Later, it could parse the serialization string to restore the object. To make an XML serialization, the class includes the proper tags.

This method works, but has some of the same drawbacks as the previous method. In particular, if you modify the class, you need to modify the code that reads and writes the serialization.

Here's the cool trick: VB.NET's XmlSerializer class can serialize and deserialize your classes for you. XmlSerializer uses VB.NET's reflection tools to examine the class and figure out what it needs to do to serialize and deserialize it. If you later modify your class, the XmlSerializer automatically changes the way it serializes and deserializes objects.

Serialization

The following code serializes a Person object named customer, and displays the serialization. It begins by creating an XmlSerialization object. The call to GetType(Person) tells the serializer about the Person class.

Next, the code calls the serializer's Serialize method. This method writes the serialization of the customer object into the StringWriter named string_writer.

The code finishes by using the StringWriter's ToString method to retrieve the serialization's value and display it in a message box.

Dim customer As Person
Dim xml_serializer As XmlSerializer
Dim string_writer As New StringWriter()

' Initialize the customer object somehow.
...

' Create the XmlSerializer. GetType(Person) tells the
' serializer about the Person class.
xml_serializer As New XmlSerializer(GetType(Person))

' Make the serialization, writing it into the StringWriter.
xml_serializer.Serialize(string_writer, customer)

' Display the results.
MsgBox(string_writer.ToString)

Notice that this code contains no information about the Person class. When the code creates the XmlSerializer object, the call to GetType(Person) gives the serializer all the information it needs.

Here's what an actual serialization produced by the XmlSerializer might look like:

<?xml version="1.0" encoding="utf-16"?>
<Person xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <LastName>Stephens</LastName>
 <FirstName>Rod</FirstName>
 <EmailAddress>RodStephens@vb-helper.com</EmailAddress>
</Person>

Don't worry about the XML declaration at the beginning of the serialization and the namespace information inside the opening Person tag. The XmlSerializer knows how to read them when it deserializes the XML data. The important thing is that this text contains a Person tag. The Person tag holds LastName, FirstName, and EmailAddress tags that record the original Person object's data.

Deserialization

The following code shows how a program can deserialize a serialization stored in a string variable. It begins by making a StringReader and filling it with the serialization.

It then calls the XmlSerializer's Deserialize method, passing it the StringReader. Deserialize creates and returns the new Person object. The code sets the variable customer to point to the new object.

Dim customer As Person
Dim serialization As String
Dim string_reader As StringReader
Dim xml_serializer As New XmlSerializer(GetType(Bouncer))

' Load the serialization string from a database,
' text file, or somewhere.
...

' Make a StringReader holding the serialization.
string_reader = New StringReader(serialization)

' Create the new Person object from the serialization.
customer = xml_serializer.Deserialize(string_reader)

The XmlSerializer is pretty amazing. Using it, you can build a database that stores any kind of object using its serialization. If you change the object's class, you can continue using the same storage method without any modifications to your code. You can even continue to use the same database tables to store the objects.

What's the Catch?

If this all sounds too good to be true, you're sort of right—there are two small catches. First, if a class definition changes, its serialization changes so the serializer may not know what to do with older serializations. Second, if you make changes to a class, you may want to change the way the database stores its objects. These two issues are described in the following sections.

Serialization Changes

If you change a class definition, the XmlSerializer will not know exactly what to do with old serializations. For example, suppose you have a Person class with a serialization that looks like this:

<?xml version="1.0" encoding="utf-16"?>
<Person xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <LastName>Stephens</LastName>
 <FirstName>Rod</FirstName>
 <EmailAddress>RodStephens@vb-helper.com</EmailAddress>
</Person>

Suppose you add a PhoneNumber field to the Person class. Now, suppose your program tries to load an older serialization that was generated before you added the PhoneNumber field. That serialization doesn't contain information about a PhoneNumber field, so the XmlSerializer cannot initialize that field from the information it is given.

Similarly, if you remove a field from the Person class definition, XmlSerializer won't know what to do with the information it sees in older serializations. For example, suppose you remove the EmailAddress field from the Person class. When XmlSerializer reads an old serialization, it won't know what to do with the EmailAddress information because Person no longer has an EmailAddress field.

Fortunately, the XmlSerializer is smart enough to not crash in these cases. It simply ignores any information it doesn't understand. In this example, it would leave the PhoneNumber field uninitialized, and it would ignore the obsolete EmailAddress field.

You can avoid some complications by making the class constructor initialize any fields that will later be required by the program. For instance, suppose you are building a company phone directory, and your program absolutely positively must have a value for the Person object's new PhoneExtension field. If the extension for the operator is 0, you could initialize new objects like this:

Public Sub New()
  PhoneExtension = "0"
End Sub

Now if the XmlSerializer loads an old serialization that doesn't include PhoneExtension information, the new object's PhoneExtension value is 0.

Database Changes

Sometimes, when you make a change to a class, you will want to change the way objects are stored in the database.

The simplest way to store an object is to put its serialization in a database table. The table could have a single field that contained object serializations. You can retrieve the serializations and restore the objects they represent.

Although the database knows nothing about the class definition, it still gives you some simple options for finding specific objects. For example, suppose you want to load the Person object with the name Terry Pratchett. You could find that object's serialization using this database query:

SELECT Serialization
FROM People
WHERE Serialization LIKE '%<FirstName>Terry</FirstName>%'
 AND Serialization LIKE '%<LastName>Pratchett</LastName>%'

This query finds records in the People table in which the Serialization field has a value containing the strings "<FirstName>Terry</FirstName>" and "<LastName>Pratchett</LastName>".

This method is simple and effective. You can even use it to perform partial matches, as in this example, which finds records with first name Terry and last name starting with P.

SELECT Serialization
FROM People
WHERE Serialization LIKE '%<FirstName>Terry</FirstName>%'
 AND Serialization LIKE '%<LastName>P%</LastName>%'

Unfortunately this kind of search can be slow. To locate the right record, the database needs to examine every record in the table individually. You can't speed things up by making a useful index on a serialization field that contains values stuck in the middle like this.

This method also restricts the flexibility of your queries. For example, suppose you are building a personnel system, and the Person class includes a Salary field. You cannot use wild card matches like those in the previous examples to select records in which the Salary is greater than 30,000.

In cases like these, you may want to store key information in separate fields to use in searching. For example, you could add a Salary field to the table. Then, you can perform searches like this one:

SELECT Serialization
FROM People
WHERE Salary > 30000

Of course if you add extra fields to the table, you will need to modify your code if you make changes to those fields. If you remove the Salary field, you will need to modify your code to use different table columns.

  • + Share This
  • 🔖 Save To Your Account

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