Why should I use JSON serialization in NCache?

JSON serialization is preferred when working with ASP.NET 5.0 and later versions because the BinaryFormatter is obsolete. It also helps in sharing data across various platforms (like .NET and Java).

What is the default serialization format in NCache?

The default serialization format in NCache is JSON Format Serialization.

How do I configure serialization manually?

You can change the `config.ncconf` file by setting the `serialization` attribute in the ` ` tag to either 'Binary' or 'Json'.

Configure Serialization Format - JSON & Binary Serialization

NCache offers support for both JSON and Binary serialization formats. By default, it uses the JSON Format Serialization. To enable JSON/Binary serialization on your cache, you can follow the steps below.

Warning

Starting with NCache 5.3.7, serialization is no longer configurable. Therefore, the information on this page does not apply to NCache 5.3.7 and later versions, regardless of edition. Additionally, for applications using ASP.NET 5.0 or later, JSON serialization is recommended. For more information, refer to Microsoft's documentation on BinaryFormatter serialization becoming obsolete.

Using the NCache Management Center

Launch the NCache Management Center by browsing to http://localhost:8251 or <server-ip>:8251.
In the left navigation bar, click on Clustered Caches or Local Caches, based on the cache to be configured.

Important

Ensure the cache is stopped before proceeding.

Against the cache name, click on View Details.

View Details Cache

This opens up the detailed configuration page for the cache. Go to the Advanced Settings tab and click on Cluster Settings in the left bar.
Change the Serialization to either Binary or JSON.

Serialization

Click on Save Changes to apply this configuration to the cache.
Start the cache to resume operations.

Manually Editing NCache Configuration

You can also specify the cache serialization format through config.ncconf.

<cache-config ...>
    <cache-settings inproc="False" last-modified="" auto-start="False" data-format="Serialized" serialization="Json"/>
</cache-config>

Once the changes are made, start the cache, and restart the NCache Service.

Note

If JSON serialization does not properly handle a specific custom type, you can configure an external Newtonsoft JsonConverter for that type. For more details, refer to External Newtonsoft JsonConverter Support.