Converting JSON to a string (as JSON serialization) is often necessary in various scenarios, such as data serialization, handling HTTP requests and responses, etc purposes.

JSON-to-string conversion or JSON-to-string Serialization is often needed for various needs.

We will dive into various reasons required for this conversion.

• Data Serialization:
  • Nee to transmit data over a network or store it in a file, you often need to convert it to a string format for transmission or storage. JSON strings are a common choice for data serialization due to their lightweight and human-readable nature.

• Interoperability:
  • JSON strings are a universal format for data exchange between different systems and programming languages. Converting JSON objects to strings allows them to be easily transmitted and interpreted by systems that may not directly support JSON objects.

• API Requests and Responses:
  • When interacting with web APIs, data is often sent and received in JSON format. Serializing JSON objects to strings allows you to include them in HTTP requests or responses, facilitating communication between clients and servers.

• Caching and Persistence:
  • In caching systems or persistent storage mechanisms like databases, JSON strings may be stored as text fields. Serializing JSON objects to strings allows them to be stored and retrieved efficiently.

• Configuration Files:
  • JSON strings are commonly used for configuration files in software applications. Converting JSON objects to strings allows them to be written to and read from configuration files easily.

• Logging and Debugging:
  • When logging data or debugging applications, JSON strings provide a structured and readable format for representing complex data structures. Converting JSON objects to strings allows them to be logged or displayed in a human-readable format.

Converting JSON to a JSON string (serialization) is often necessary in various scenarios, such as:

What is JSON Object

Example

{
        "name": "Alice",
        "date_field": "2022-03-30",
        "demo": {
            "projects": [
                {"code": "sdas", "date_field": "2022-03-30"}
            ]
        }
    }

• This is a standard representation of a list containing JSON objects.
• Each element in the list is a separate JSON object.
• This format is commonly used when dealing with structured data, such as when storing records in databases or transmitting data over networks.
• It allows easy access to individual objects in the list and facilitates operations such as filtering, mapping, and aggregation.

Example Use Cases – Convert JSON object to string :

• Sending JSON data as part of HTTP requests in RESTful APIs.
• Storing JSON data in NoSQL databases like MongoDB or document-oriented databases.
• Caching JSON responses from external APIs or database queries.
• Writing JSON data to configuration files for application settings.
• Logging JSON data for debugging purposes in applications.

JSON as Strings – Significance

{
        "name": "Alice",
        "date_field": "2022-03-30",
        "demo": {
            "projects": [
                {"code": "sdas", "date_field": "2022-03-30"}
            ]
        }
    }

• This is a representation where each element is a JSON string.
• The JSON strings themselves represent JSON objects.
• This format is useful when you need to serialize a list of JSON objects into a single string, such as when storing the data in a file or transmitting it over a communication channel.
• It preserves the structure of individual JSON objects allowing you to reconstruct the original objects when needed.
• However, operations such as filtering or accessing individual objects become more cumbersome since you need to parse each JSON string to work with the underlying JSON objects.
• his is a list of JSON strings where each string represents a JSON object. The string representation includes newline characters (\n) and indentation (\t) for readability. Each string is enclosed in quotes and can be interpreted as a JSON object when parsed. This format is suitable for scenarios where you need to store JSON data as text, for example, when writing to a file or transmitting over a network.

Example – JSON to raw JSON string

['{\n  "name": "Alice",\n  "date_field": "2022-03-30",\n  "demo": {\n    "projects": [\n      {\n        "code": "sdas",\n        "date_field": "2022-03-30"\n      }\n    ]\n  }\n}']

Python Example – How to Convert JSON to JSON string

import json

json_data = [
    {
        "name": "Alice",
        "date_field": "2022-03-30",
        "demo": {
            "projects": [
                {"code": "sdas", "date_field": "2022-03-30"}
            ]
        }
    }
]

# Convert each dictionary in json_data to a JSON string
json_strings = [json.dumps(item, indent=2) for item in json_data]

# Print the list of JSON strings
print(json_strings)

ASP.NET Core Example – How to Convert JSON to JSON string

• How to return Raw JSON string from API Controller

Do you have any comments or ideas or any better suggestions to share?

Please sound off your comments below.

Happy Coding !!

The post Convert JSON object to string – Guidelines first appeared on TheCodeBuzz.

Issue Description

Newtonsoft.Json serialization gives error while converting the string to boolean types.

Newtonsoft.Json.JsonReaderException: ‘Could not convert string to boolean: 1. Path ‘[0].ID’, line 1, position 10.’

Resolution

This issue can be resolved by using a few approaches. The simplest approach would be to use a custom JSON converter so as to be able to serialize the required properties as required in the target object.

In the above case, i can create a Custom boolean converter to generate the required serialization objects.

Sample converter used as below,

        var result = JsonConvert.SerializeObject(excelasTable);
                var generatedType = JsonConvert.DeserializeObject<T>(result, new CustomBooleanJsonConverter());
                return (T)Convert.ChangeType(generatedType, typeof(T));

Custom Boolean JSON Converter

Custom Boolean Json Converter created as below which can be passed as the second argument to DeserializeObject method.

JsonConvert.DeserializeObject<T>(result, new CustomBooleanJsonConverter());

Please remember to override two below method,

• ReadJson
• WriteJson

public class CustomBooleanJsonConverter : JsonConverter<bool>
        {
            public override bool ReadJson(JsonReader reader, Type objectType, bool existingValue, bool hasExistingValue, JsonSerializer serializer)
            {
                return Convert.ToBoolean(reader.ValueType == typeof(string) ? Convert.ToByte(reader.Value) : reader.Value);
            }

            public override void WriteJson(JsonWriter writer, bool value, JsonSerializer serializer)
            {
                serializer.Serialize(writer, value);
            }
        }

That’s all. The issue is resolved!

Did I miss anything else in these resolution steps?

Did the above steps resolve your issue? Please sound off your comments below!

Happy Coding !!

Please bookmark this page and share it with your friends. Please Subscribe to the blog to receive notifications on freshly published (2025) best practices and guidelines for software design and development.

The post Newtonsoft JsonReaderException: Could not convert string to boolean first appeared on TheCodeBuzz.

Today in this article, we will learn how to read or Get Client IP addresses in ASP.NET Core programmatically in ASP.NET Core.

This could be a legitimate requirement for your application where you may want to record the IP address of the Client using your restricted resources.

We shall see how to get IP addresses locally and applications that are hosted in IIS or hosted behind Load balancers etc.

We will cover below aspects in the article,

Please note that due to Proxy servers or Load balancers, request data could be removed before reaching the client application.

In such cases, you must forward the client IP address in a header by some means which we shall see in today’s article.

In this article, however, we will only be dealing with client IP address retrieval but you may look at similar techniques to address other requirements like Redirect, Authentication, Policy authorization, etc.

Getting started

Kindly add Microsoft.AspNetCore.HttpOverrides Nuget package to your project references. This step is needed if you are using ASp.NET Core 3.1 and lower packages.

This package is available for ASP.NET Core 6.0 and above as inbuilt (within the framework.)

Using Nuget Package Manager,

PM> Install-Package Microsoft.AspNetCore.HttpOverrides

OR

Using .NET CLI

> dotnet add package Microsoft.AspNetCore.HttpOverrides

Note: Please use the latest available version.

Add UserForwardedHeaders middleware in the API Pipeline

Please add UserForwardedHeaders middleware in the API Pipeline by updating Configure and ConfigureServices methods in Startup.cs.

Update the Configure method as below,

Forwarded Headers Middleware execution order important – Forwarded Headers Middleware should run before any other middleware.

If no middleware is specified then default headers will be set as ForwardedHeaders.None

The above setting is recommended when using a reverse proxy server.

In the Header option,

app.UseForwardedHeaders(new ForwardedHeadersOptions
            {
                ForwardedHeaders = ForwardedHeaders.XForwardedFor | ForwardedHeaders.XForwardedProto
            });

ForwardedHeaders.XForwardedFor – Identifies which forwarders should be processed.

ForwardedHeaders.XForwardedProto – The middleware updates the Request.Scheme for security policies to work properly.

If you are using a known reverse proxy or network then ForwardedHeadersOptions can be updated for those configurations as below,

Get IP Address in Controller

With the above settings, you should be all set to get an IP address using the below code,

 IPAddress remoteIpAddress = Request.HttpContext.Connection.RemoteIpAddress;

Get IP Address in Other Module or classes

You can get access to IP Addresses in other Modules or Classes by using the interface IHttpContextAccessor. Please see this article for more details.

If running the service locally localhost (::1 / 127.0.0.1), Additionally, I had to use the below code to read the actual IP address locally.

References:

• Using HttpContext Thread safe – Best Practices in .NET

Once executed above method will give the client an IP address successfully.

That’s All!

Do you have any comments or ideas or any better suggestions to share?

Please sound off your comments below.

Happy Coding !!

Please bookmark this page and share it with your friends. Please Subscribe to the blog to receive notifications on freshly published (2025) best practices and guidelines for software design and development.

The post Get Client IP Address in ASP.NET Core – Guidelines first appeared on TheCodeBuzz.

In our last post, we saw the usage of NPOI to work with Excel and perform basic read and Write operations on Excel files.

Today in this article, we shall try to insert the image into an Excel file at a particular location using the NPOI library.

I shall be using the same logic which we learned in our previous article.

Today in this article, we will cover below aspects,

Please refer to the article below article on Read/Write Excel files using NPOI

• Read/Write Excel files in .NET Core using NPOI

Kindly add the below logic to your writing method,

Adding Image(JPEG, PNG) in the Excel File

I already have a sample jpeg file – Read-write-excel-npoi.jpg which we shall be trying to insert at Index (5,5) i.e @ row 5 and column 5

At row 5 and column 5, the above image will be inserted programmatically.

                byte[] data = File.ReadAllBytes("Read-write-excel-npoi.jpg");
                int pictureIndex = workbook.AddPicture(data, PictureType.JPEG);
                ICreationHelper helper = workbook.GetCreationHelper();
                IDrawing drawing = excelSheet.CreateDrawingPatriarch();
                IClientAnchor anchor = helper.CreateClientAnchor();
                anchor.Col1 = 5;
                anchor.Row1 = 5;
                IPicture picture = drawing.CreatePicture(anchor, pictureIndex);
                picture.Resize();

Write EXCEL with Image

Here below is a sample POC complete Code as below,

 static void WriteExcel()
        {
            List<UserDetails> persons = new List<UserDetails>()
            {
                new UserDetails() {ID="1001", Name="ABCD", City ="City1", Country="USA"},
                new UserDetails() {ID="1002", Name="PQRS", City ="City2", Country="INDIA"},
                new UserDetails() {ID="1003", Name="XYZZ", City ="City3", Country="CHINA"},
                new UserDetails() {ID="1004", Name="LMNO", City ="City4", Country="UK"},
           };

            // Lets converts our object data to Datatable for a simplified logic.
            // Datatable is most easy way to deal with complex datatypes for easy reading and formatting. 
            DataTable table = (DataTable)JsonConvert.DeserializeObject(JsonConvert.SerializeObject(persons), (typeof(DataTable)));


            var memoryStream = new MemoryStream();

            using (var fs = new FileStream("Result.xlsx", FileMode.OpenOrCreate, FileAccess.Write))
            {
                IWorkbook workbook = new XSSFWorkbook();
                ISheet excelSheet = workbook.CreateSheet("TestSheet1");

                List<String> columns = new List<string>();
                IRow row = excelSheet.CreateRow(0);
                int columnIndex = 0;

                foreach (System.Data.DataColumn column in table.Columns)
                {
                    columns.Add(column.ColumnName);
                    row.CreateCell(columnIndex).SetCellValue(column.ColumnName);
                    columnIndex++;
                }

                int rowIndex = 1;
                foreach (DataRow dsrow in table.Rows)
                {
                    row = excelSheet.CreateRow(rowIndex);
                    int cellIndex = 0;
                    foreach (String col in columns)
                    {
                        row.CreateCell(cellIndex).SetCellValue(dsrow[col].ToString());
                        cellIndex++;
                    }

                    rowIndex++;
                }

                byte[] data = File.ReadAllBytes("Read-write-excel-npoi.jpg");
                int pictureIndex = workbook.AddPicture(data, PictureType.JPEG);
                ICreationHelper helper = workbook.GetCreationHelper();
                IDrawing drawing = excelSheet.CreateDrawingPatriarch();
                IClientAnchor anchor = helper.CreateClientAnchor();
                anchor.Col1 = 5;
                anchor.Row1 = 5;
                IPicture picture = drawing.CreatePicture(anchor, pictureIndex);
                picture.Resize();

                workbook.Write(fs);
            }
        }

I have kept the image file in the same project directory so that it can be used by Excel API and loaded in the proper location in Excel.

Finally Image will be entered at the required location successfully,

Do you have any comments or ideas or any better suggestions to share?

Please sound off your comments below.

Happy Coding !!

Please bookmark this page and share it with your friends. Please Subscribe to the blog to receive notifications on freshly published (2025) best practices and guidelines for software design and development.

The post How to Add Image to Excel Files using NPOI first appeared on TheCodeBuzz.

Issue Description

NuGet commands give errors in CLI or PMC (Package manager console)

CLI

'nuget' is not recognized as an internal or external command,
operable program or batch file.

Package Manager Console,

The term ‘nuget’ is not recognized as the name of a cmdlet, function, script file, or operable program

Resolution

NuGet is a tool for development platform using which developers can create, share, and consume useful code.

It provides the ability to create and consume packages.

The issue seems to be missing Nuget.exe in either the local project Space or at the global level settings on the target machine.

This issue can be solved easily at the project scope or global scope by following the below instruction.

Install NuGet at Local Project Scope

Nuget.exe can be installed easily using the Nuget repository.

This exe is available as NuGet, CommandLine package in nuget.org repository

Now let’s run the NuGet commands using PMC, Nuget command will be recognized as below,

Install Nuget package command line – Globally accessible

Certainly, sometimes we don’t want to install nuget.exe at the individual project level.

Installing or accessing Nuget.exe and its commands could be useful many times.

The one-time setup helps multiple downloads and helps to centralize commands usage of nuget.exe on local machines and Build machines.

This can be achieved in 2 steps

Step 1:

Get the location of nuget.exe already installed.

[If installing the first time – You can get the nuget.exe either directly downloading it from https://www.nuget.org/downloads]

OR

In the above steps when we already installed nuget.commandline its default location will be stored at the below location,

Default location

C:Users[user-name].nugetpackagesnuget.commandline5.5.1tools

Note: Please check your version depending on the system settings

Additionally, the NuGet exe location can be found by right-clicking the package in the project solution and finding the location.

Step2:

Either way, if you obtain the path of the nuget.exe, please copy the path and add it to the PATH variable in the Environment Variable settings.

You shall see NuGet commands are available and accessible from anywhere in the Machine.

From PMC:

From Command Prompt CLI

From Powershell

If issue still persisting?

• Please close any open command prompt or shell windows and try running the command again.

• Please try restarting the machine for any other issues.

References:

• Create and Publish a NuGet Package using Visual Studio

Did the above steps resolve your issue? Please sound off your comments below!

Happy Coding !!

Please bookmark this page and share it with your friends. Please Subscribe to the blog to receive notifications on freshly published (2025) best practices and guidelines for software design and development.

The post Resolved – ‘nuget’ is not recognized as an internal or external command, operable program or batch file first appeared on TheCodeBuzz.