Why Serialization?

• To store the content of the object to file (to save the state of the object)
• To send an object to another process
• To transmit the object across network

Serializing is the process of converting an object into a linear sequence of bytes that can be stored or transferred.

Deserializing is the process of converting previously serialized sequence bytes into an object.

How to serialize an object

1. Create a stream object to hold the serialize output
2. create a BinaryFormatter object
3. Call the BinaryFormatter.Serialize method to serialize the object, and output the result to the stream

using System.Runtime.Serialization;
using System.Runtime.Serialization.Formatters.Binary;
using System.Runtime.Serialization.Formatters.Soap;

public void serializeToFile()

{
string data = “This must be stored in the file”

//Create file to save the data to

FileStream fs = new FileStream(“SerializedString.data”, FileMode.Create);

//Create a BinaryFormatter object to

//perform the serialization

BinaryFormatter bf = new BinaryFormatter();

//Use the BinaryFormatter object to

//serialize the data to the File

bf.Serialize(fs, data);

//Close the file

fs.Close();

}

How to deserialize

1. Create a stream object to read the serialized output
2. Create a BinaryFormatter object
3. Create a new object to store the deserialized data
4. Call the BinaryFormatter.Deserialize method to deserialize the object, and cast it to the correct type.

 

using System.Runtime.Serialization
using System.Runtime.Serialization.Formatters.Binary;
using System.Runtime.Serialization.Formatters.Soap;

public void deserializeFromFile()

{

//Open file to read the data from

FileStream fs = new FileStream(“Serializedstring.data”, FileMode.Open);

//Create a BinaryFormatter object
//to perform the deserialization

BinaryFormatter bf = new BinaryFormatter();

//Create the object to store the

//deserialized data
string data = “”;

//Use the Binaryformatter object to
//deserialize the data from the File
data = (string)bf.Deserialize(fs);

//Close the file
fs.Close();

//Display the deserialized string
Console.WriteLine(data);

}

Create a Class that can be serialized

 

    [Serializable]

    class ShopingCartItem : IDeserializationCallback

    {

        public int productId;

        public decimal price;

        public int quantity;

        [NonSerialized] public decimal total;

        [OptionalField] public Boolean taxable;

        public ShopingCartItem(int _prodId, decimal _price, int _quantity)

        {

            productId = _prodId;

            price = _price;

            quantity = _quantity;

            total = price * quantity;

        }

        #region IDeserializationCallback Members

        public void OnDeserialization(object sender)

        {

            total = price * quantity;

        }

        #endregion

    }

Choosing serialization

• BinaryFormatter: Located in the System.Runtime.Serialization.Formatters.Binary namespace, this is the most efficient way to serialize objects that will be read by only .NET Framework-based applications.
• SoapFormatter: Located in the System.Runtime.Serialization.Formatters.Soap namespace, this XML-based formatter is the most reliable way to serialize objects that will be transmitted across a network or read by non- .NET Framework applications. SoapFormatter is more likely to successfully traverse firewalls than BinaryFormatters. Note: you have to manually add the reference the Soap dll unlike Binary.

 

XML Serialization

• It only serializes the public members.
• We can control the serialization using XML attributes if we want to alter the default naming of XML serialization, other default behaviors

Finally – Types of serialization

• Binary Serialization
• Soap Serialization
• XML Serialization
• Custom Serialization

The need for isolated storage comes because we are running application in a limited privilege environment. Running the application in a limited privilege has many benefits such as protecting users from predators who are foisting users with viruses and Spy Ware. But what can we do when we want to persist the state or other data with out using the database or cache? With limited privilege we don’t have a full access to the hard drive.

By using isolated storage to save our data, we will have access to a safe place to store information without needing to restore to having users grant access to specific files or folders in the file system. Therefore the main benefit of using isolated storage is that your application will run regardless of whether it is running under partial, limited, or full-trust.

The IsolatedStorageFile Class

The IsolatedStorageFile Class provides the basic functionality to create files and folders in isolated storage.

Static members of the IsolatedStorageFile Class

• GetMachineStoreForApplication: Obtains machine-scoped isolated storage corresponding to the calling code’s application identity.
• GetMachineStoreForAssembly: Obtains machine-scoped isolated storage corresponding to the calling code’s assembly identity.
• GetMachineStoreForDomain: Obtains machine-scoped isolated storage corresponding to the application domain identity and the assembly identity.
• GetStore: Overloaded. Obtains isolated storage corresponding to the given application domain and assembly evidence objects and isolated storage scope.
• GetUserStoreForApplication: Obtains user-scoped isolated storage corresponding to the calling code’s application identity.
• GetUserStoreForAssembly: Obtains user-scoped isolated storage corresponding to the calling code’s assembly identity.
• GetUserStoreForDomain: Obtains user-scoped isolated storage corresponding to the application domain identity and assembly identity.

Public Properties of the IsolatedStorageFile Class

• ApplicationIdentity: Gets an application identity that scopes isolated storage.
• AssemblyIdentity: Gets an assembly identity used to scope isolated storage.
• CurrentSize: Gets the current size of the isolated storage.
• DomainIdentity: Gets a domain identity that scopes isolated storage.
• MaximumSize: Gets a value representing the maximum amount of space available for isolated storage within the limits established by the quota.

Public Methods of the IsolatedStorageFile Class

• CreateDirectory: Creates a directory in the isolated storage scope.
• DeleteDirectory: Deletes a directory in the isolated storage scope.
• DeleteFile: Deletes a file in the isolated storage scope.
• GetDirectoryNames: Enumerates directories in an isolated storage scope that match a given pattern.
• GetFileNames: Enumerates files in isolated storage scope that match a given pattern.

How to create a store

Before you can save data in isolated storage, you must determine how to scope the data you want in your store.

Assembly/Machine: specific to the calling assembly and the local machine. This is useful for creating application-level data.

IsolatedStorageFile machineStorage = IsolatedStorageFile.GetMachineStoreForAssembly();

Assembly/User: specific to the calling assembly and the current user. This method is useful for creating user-level data.

IsolatedStorageFile userStorage = IsolatedStorageFile.GetUserStoreForAssembly();

IsolatedStorageFileStream Class

The IsolatedStorageFileStream Class encapsulates a stream that is used to create files in isolated storage. This class is derived from the FileStream class, so its usage after creation is almost identical to the FileStream class.

Reading and writing Data to Isolated Storage

It is pretty much similar to the normal file system after creating the Stream reader or writer.

IsolatedStorageFile userStorage = IsolatedStorageFile.GetUserStoreForAssembly();
IsolatedStorageFileStream userStream = new IsolatedStorageFileStream(“setting.set”, FileMode.Create,userStorage);

StreamWriter userWriter = new StreamWriter(userStream);
userWriter.WriteLine(“Sample User Setting”);
userWriter.Close();

Reading…

Preparing to read the data back is as simple as creating a stream object by opening the file

IsolatedStorageFileStream userStream = new IsolatedStorageFileStream(“setting.set”, FileMode.Open, userStorage);

To check if the file exist in the storage…

IsolatedStorageFile userStorage = IsolatedStorageFile.GetUserStoreForAssembly();
IsolatedStorageFileStream userStream = new IsolatedStorageFileStream(“setting.set”, FileMode.Open, userStorage);

string[] files = userStorage.GetFileNames(“*.set”);
if (files.Length == 0)
{
Console.WriteLine(“There is no User file in the specified storage”);
}
else
{
//…
}

Creating stream with Directory…

IsolatedStorageFile userStorage = IsolatedStorageFile.GetUserStoreForAssembly();

IsolatedStorageFileStream userStreamWithDir = new IsolatedStorageFileStream(@”SomeDir\setting.set”, FileMode.Create, userStorage);

//OR we can use this but making sure if the directory name

//already exists
string[] directories = userStorage.GetDirectoryNames(“SomeDir”);
if (directories == 0)
{
userStorage.CreateDirectory(“SomeDir”);
}