In C#, Task.Delay
and Thread.Sleep
are both used to introduce delays or pauses in the execution of your code, but they have different use cases and implications.
In summary, use Task.Delay
when working with asynchronous code and you want to avoid blocking the current thread. Use Thread.Sleep
when you explicitly want to block the current thread, but be cautious about using it in scenarios where responsiveness is important, such as in GUI applications. In modern C# applications, with the widespread use of async/await, Task.Delay
is often the more appropriate choice.
Further Resources:
This code snippet demonstrates configuring and retrieving custom settings from appsettings.json
. It defines a ClientSettings class to manage client-specific configurations such as name and URL. The appsettings.json
file is structured to hold these settings under a "Clients
" section. The code includes validation checks to ensure that the required settings are provided and the URL is valid.
// Configuration in appsettings.json
{
"Clients": {
"Client": {
"Name": "Acme Corporation",
"Url": "https://acme.example.com"
}
}
}
// Settings class
internal class ClientSettings
{
public const string ConfigSection = "Clients.Client";
public string ClientName { get; set; } = "DefaultClientName";
public string ClientUrl { get; set; } = string.Empty;
public static ClientSettings Load(IConfiguration configuration)
{
ClientSettings settings = configuration.GetSection(ConfigSection).Get<ClientSettings>() ?? throw new ConfigurationErrorsException($"'{ConfigSection}' section not found. Add configuration to appsettings.json");
if (string.IsNullOrWhiteSpace(settings.ClientName)) throw new ConfigurationErrorsException("ClientName is null or empty");
if (string.IsNullOrWhiteSpace(settings.ClientUrl)) throw new ConfigurationErrorsException("ClientUrl is null or empty");
if (!(Uri.TryCreate(settings.ClientUrl, UriKind.Absolute, out Uri? uri) && (uri.Scheme == Uri.UriSchemeHttp || uri.Scheme == Uri.UriSchemeHttps)))
{
throw new ConfigurationErrorsException("ClientUrl is not a valid URL");
}
return settings;
}
}
// Using setting
public Client(IConfiguration configuration)
{
_clientSettings = ClientSettings.Load(configuration);
}
Links and Explanation:
Makolyte - C# How to Read Custom Configuration from appsettings.json: This link provides a detailed guide on reading custom configurations from appsettings.json
in C#.
Stack Overflow - Configuration.GetSection easily gets primitive string values but not complex values: This Stack Overflow thread discusses issues related to retrieving complex values using Configuration.GetSection
in .NET applications and provides insights into resolving such problems.
In a console apps, there is often a need to obtain user input from the console while ensuring that the input is not empty or only whitespace characters.
In this sample, we define a method GetUserInput
that takes an optional message parameter. It continuously prompts the user until a non-empty, non-whitespace input is provided.
static string GetUserInput(string message = "Please enter some input:")
{
string input;
do
{
Console.WriteLine(message);
input = Console.ReadLine()?.Trim();
} while (string.IsNullOrWhiteSpace(input));
return input;
}
Explanation:
message
parameter allows customizing input prompt message.Console.ReadLine()?.Trim()
reads user input and trims leading/trailing whitespace.?.
operator is used for null-conditional access, ensuring that Console.ReadLine()
doesn't throw a null reference exception if the input is null.do-while
loop ensures user input is not empty or whitespace.Logging is an essential part of application development for debugging, monitoring, and understanding the flow of execution, especially in complex systems. When logging in a C# method with parameters that need validation, it's crucial to follow best practices to ensure clear and useful log messages. Below is a sample demonstrating how to log and validate parameters in a C# method:
public bool ValidateAndProcessData(string data)
{
// Log the start of the method
_logger.LogInformation("ValidateAndProcessData method started");
// Validate input data
if (string.IsNullOrEmpty(data))
{
_logger.LogError("Input data is null or empty");
throw new ArgumentException("Input data cannot be null or empty", nameof(data));
}
try
{
// Process data
_logger.LogInformation("Processing data: {data}", data);
// Simulating processing time
System.Threading.Thread.Sleep(1000);
_logger.LogInformation("Data processed successfully");
return true;
}
catch (Exception ex)
{
// Log any exceptions that occur during processing
_logger.LogError(ex, "Error processing data: {data}", data);
throw; // Re-throw the exception for higher-level handling
}
finally
{
// Log the end of the method
_logger.LogInformation("ValidateAndProcessData method completed");
}
}
By following this sample, you ensure that your method logs relevant information about parameter validation and method execution, making it easier to debug and monitor your application's behavior.
The Task asynchronous programming model (TAP) provides an abstraction over asynchronous code. You write code as a sequence of statements, just like always. You can read that code as though each statement completes before the next begins. The compiler performs many transformations because some of those statements may start work and return a Task representing the ongoing work.
In .NET, when you assign one list (list2
) to another list (list1
) directly, both lists will reference the same memory location. As a result, any modifications made to list2
will also affect list1. To create a separate copy of the list, you should use the List<T>
constructor to initialize a new list based on the elements of the original list (list1
).
To illustrate the issue the following code assigns list1
directly to list2
.
List<string> list1 = new List<string>();
List<string> list2 = list1;
list2.Add("Item A");
Console.WriteLine("List1 elements:");
list1.ForEach(item => Console.WriteLine(item));
This will output the list1
elements and show 'Item A'.
List1 elements:
Item A
As you can see, modifying list2
also modified list1
.
When you assign one list to another using list2 = list1
, you're not creating a new list. Instead, both list1
and list2
will point to the same list in memory. Any changes made to one list will be reflected in the other because they are essentially the same list.
The following code shows modifying of list2
does not affect list1
because list2
is a separate copy of list1
.
List<string> list1 = new List<string>();
List<string> list2 = new List<string>(list1);
list2.Add("Item A");
Console.WriteLine("List1 elements:");
list1.ForEach(item => Console.WriteLine(item));
This will output list1
without any item.
List1 elements:
You can use the List<T>
constructor with the original list as an argument to create a new list that is a separate copy of the original list. This constructor creates a new list with the same elements as the original list.
.NET APIs include classes, interfaces, delegates, and value types that expedite and optimize the development process and provide access to system functionality.
.NET types use a dot syntax naming scheme that connotes a hierarchy. This technique groups related types into namespaces, which can be searched and referenced more easily. The first part of the full name—up to the rightmost dot—is the namespace name.
The System namespace is the root namespace for fundamental types in .NET. This namespace includes classes representing the base data types used by all applications.
.NET includes a set of data structures that are the workhorses of many .NET apps. These are mostly collections, but also include other types.
.NET includes a set of utility APIs that provide functionality for many important tasks.
There are many app models that can be used with .NET.
Further reading at .NET class library overview - .NET | Microsoft Learn.
URI stands for Uniform Resource Identifier. A URI is a string of characters that identifies a particular resource. Resources can be anything with an identity, such as a document, image, service, or concept. URIs are used to uniquely identify and locate resources on the internet or within a network.
URIs are categorized into two main types: URLs (Uniform Resource Locators) and URNs (Uniform Resource Names).
URL (Uniform Resource Locator)
URN (Uniform Resource Name)
In .NET, the System.Uri
class is used to represent URIs. You can create a Uri object by passing a URI string to its constructor. The Uri class provides various properties and methods for working with different components of the URI, such as the scheme, host, path, query, and fragment.
Here's a simple example in C#:
// Creating a Uri object
Uri uri = new Uri("https://www.example.com/path/to/resource");
// Accessing components of the URI
Console.WriteLine($"Scheme: {uri.Scheme}");
Console.WriteLine($"Host: {uri.Host}");
Console.WriteLine($"Path: {uri.AbsolutePath}");
Console.WriteLine($"Query: {uri.Query}");
This example demonstrates creating a Uri object from a URL string and accessing different components of the URI using properties like Scheme, Host, AbsolutePath, and Query.
OriginalString and AbsoluteUri have different behaviors.
AbsoluteUri does escaping
Uri uri = new Uri("http://www.example.com/test.aspx?v=hello world");
Console.WriteLine(uri.OriginalString);
// http://www.example.com/test.aspx?v=hello world
Console.WriteLine(uri.AbsoluteUri);
// http://www.example.com/test.aspx?v=hello%20world <-- different
AbsoluteUri doesn't support relative URIs
var uri = new Uri("/test.aspx?v=hello world", UriKind.Relative);
Console.WriteLine(uri.OriginalString);
// /test.aspx?v=hello world
Console.WriteLine(uri.AbsoluteUri);
// InvalidOperationException: This operation is not supported for a relative URI.
In C#, you can replace multiple white spaces with a single white space using regular expressions. You can use the Regex
class from the System.Text.RegularExpressions
namespace to achieve this. Here's an example:
using System;
using System.Text.RegularExpressions;
class Program
{
static void Main()
{
string inputString = "This is a sample string with multiple spaces.";
// Use regular expression to replace multiple white spaces with a single white space
string result = Regex.Replace(inputString, @"\s+", " ");
Console.WriteLine("Original string: " + inputString);
Console.WriteLine("Modified string: " + result);
}
}
In this example, the \s+
regular expression pattern matches one or more white spaces, and the Regex.Replace
method replaces these occurrences with a single white space.
Additional Resources
The Task
class is a key component of the Task Parallel Library, providing a framework for asynchronous programming. It represents a unit of work that can run concurrently with other tasks, offering efficient and scalable execution. Programmers use it to create, manage, and coordinate asynchronous operations, enhancing application responsiveness.
Namespace: System.Threading.Tasks
The Task.Delay
Method creates a task that will complete after a time delay.
Task.Delay
is generally preferred when working with asynchronous programming using async
and await
.Task
that represents a time delay.Example:
async Task MyMethod()
{
// Do something before the delay
await Task.Delay(1000); // Delay for 1000 milliseconds (1 second)
// Do something after the delay
}
The Thread
class allows programmers to create and manage multithreaded applications. It enables concurrent code execution, allowing tasks to run independently for improved performance. Developers can utilize methods like Start, Join, and Sleep to control thread execution, facilitating efficient parallel processing in .NET applications.
Namespace: System.Threading
The Thread.Sleep
Method Suspends the current thread for the specified amount of time.
Thread.Sleep
is a synchronous method that blocks the current thread for the specified amount of time.Example:
void MyMethod()
{
// Do something before the delay
Thread.Sleep(1000); // Sleep for 1000 milliseconds (1 second)
// Do something after the delay
}