Paso 4: Conexión de forma resistente a SQL con ADO.NET
- Artículo anterior:Paso 3: Prueba de concepto de la conexión a SQL mediante ADO.NET
Este tema brinda un ejemplo de código C# que muestra lógica de reintento personalizada. La lógica de reintento ofrece confiabilidad. La lógica de reintento está diseñada para procesar correctamente los errores temporales o los errores transitorios que tienden a desaparecer si el programa espera varios segundos y vuelve a intentarlo.
Estos son algunos de los orígenes de los errores transitorios:
- Un breve error de las redes que admite Internet.
- Un sistema en la nube podría estar equilibrando la carga de sus recursos en el momento en que se envió la consulta.
Las clases ADO.NET para conectarse al servidor Microsoft SQL Server local también se pueden conectar a Azure SQL Database. Sin embargo, por sí mismas las clases ADO.NET no pueden proporcionar la solidez y confiabilidad necesarias en el uso de producción. Su programa cliente puede detectar errores transitorios de los que debería recuperarse de forma silenciosa y correcta y continuar por sí mismo.
Paso 1: Identificar los errores transitorios
El programa debe distinguir entre errores transitorios frente a errores persistentes. Los errores transitorios son condiciones de error que pueden borrarse en un breve período, como problemas de red transitorios. Un ejemplo de un error persistente sería si el programa tiene un error ortográfico en el nombre de la base de datos de destino; en este caso, el error "No se encontró esa base de datos" persistirá y no se podría borrar en un breve período.
La lista de números de error que se clasifican como errores transitorios está disponible en el artículo sobre mensaje de error de las aplicaciones cliente de SQL Database.
Paso 2: Crear y ejecutar la aplicación de ejemplo
En el ejemplo se da por supuesto que está instalado .NET Framework 4.6.2 o posterior. La muestra de código C# consta de un archivo denominado Program.cs. En la sección siguiente se proporciona su código.
Paso 2.a: Capturar y compilar el ejemplo de código
Puede compilar el ejemplo con los pasos siguientes:
- En la edición gratuita de Visual Studio Community, cree un nuevo proyecto desde la plantilla de aplicación de consola de C#.
- Archivo > Nuevo > Proyecto > Instalado > Plantillas > Visual C# > Windows > Escritorio clásico > Aplicación de consola
- Asigne al proyecto el nombre RetryAdo2.
- Abra el panel Explorador de soluciones.
- Vea el nombre del proyecto.
- En el proyecto, añada una dependencia NuGet del paquete Microsoft.Data.SqlClient.
- Vea el nombre del archivo Program.cs.
- Abra el archivo Program.cs.
- Reemplace el contenido del archivo Program.cs por el código siguiente:
- Haga clic en el menú Compilar > Compilar solución.
Paso 2.b: Copiar y pegar el ejemplo de código
Pegue este código en su archivo Program.cs .
A continuación, debe modificar las cadenas del nombre de servidor, la contraseña y así sucesivamente. Encontrará estas cadenas en el método denominado GetSqlConnectionString.
NOTA: La cadena de conexión para el nombre del servidor está orientada hacia Azure SQL Database, porque incluye el prefijo de cuatro caracteres de tcp: . Sin embargo, puede ajustar la cadena de servidor para conectarse a su Microsoft SQL Server.
using System;
using System.Collections.Generic;
using Microsoft.Data.SqlClient;
using System.Threading;
namespace RetryAdo2;
public class Program
{
public static int Main(string[] args)
{
bool succeeded = false;
const int totalNumberOfTimesToTry = 4;
int retryIntervalSeconds = 10;
for (int tries = 1; tries <= totalNumberOfTimesToTry; tries++)
{
try
{
if (tries > 1)
{
Console.WriteLine(
"Transient error encountered. Will begin attempt number {0} of {1} max...",
tries,
totalNumberOfTimesToTry
);
Thread.Sleep(1000 * retryIntervalSeconds);
retryIntervalSeconds = Convert.ToInt32(retryIntervalSeconds * 1.5);
}
AccessDatabase();
succeeded = true;
break;
}
catch (SqlException sqlExc) {
if (TransientErrorNumbers.Contains(sqlExc.Number))
{
Console.WriteLine("{0}: transient occurred.", sqlExc.Number);
continue;
}
Console.WriteLine(sqlExc);
succeeded = false;
break;
}
catch (TestSqlException sqlExc) {
if (TransientErrorNumbers.Contains(sqlExc.Number))
{
Console.WriteLine("{0}: transient occurred. (TESTING.)", sqlExc.Number);
continue;
}
Console.WriteLine(sqlExc);
succeeded = false;
break;
}
catch (Exception e)
{
Console.WriteLine(e);
succeeded = false;
break;
}
}
if (!succeeded) {
Console.WriteLine("ERROR: Unable to access the database!");
return 1;
}
return 0;
}
/// <summary>
/// Connects to the database, reads,
/// prints results to the console.
/// </summary>
static void AccessDatabase() {
//throw new TestSqlException(4060); //(7654321); // Uncomment for testing.
using var sqlConnection = new SqlConnection(GetSqlConnectionString());
using var dbCommand = sqlConnection.CreateCommand();
dbCommand.CommandText =
@"
SELECT TOP 3
ob.name,
CAST(ob.object_id as nvarchar(32)) as [object_id]
FROM sys.objects as ob
WHERE ob.type='IT'
ORDER BY ob.name;";
sqlConnection.Open();
var dataReader = dbCommand.ExecuteReader();
while (dataReader.Read())
{
Console.WriteLine(
"{0}\t{1}",
dataReader.GetString(0),
dataReader.GetString(1)
);
}
}
/// <summary>
/// You must edit the four 'my' string values.
/// </summary>
/// <returns>An ADO.NET connection string.</returns>
static private string GetSqlConnectionString()
{
// Prepare the connection string to Azure SQL Database.
var sqlConnectionSB = new SqlConnectionStringBuilder
{
// Change these values to your values.
DataSource = "tcp:myazuresqldbserver.database.windows.net,1433", //["Server"]
InitialCatalog = "MyDatabase", //["Database"]
UserID = "MyLogin", // "@yourservername" as suffix sometimes.
Password = "MyPassword",
// Adjust these values if you like. (ADO.NET 4.5.1 or later.)
ConnectRetryCount = 3,
ConnectRetryInterval = 10, // Seconds.
// Leave these values as they are.
IntegratedSecurity = false,
Encrypt = true,
ConnectTimeout = 30
};
return sqlConnectionSB.ToString();
}
static List<int> TransientErrorNumbers = new()
{
4060, 40197, 40501, 40613, 49918, 49919, 49920, 11001
};
}
/// <summary>
/// For testing retry logic, you can have method
/// AccessDatabase start by throwing a new
/// TestSqlException with a Number that does
/// or does not match a transient error number
/// present in TransientErrorNumbers.
/// </summary>
internal class TestSqlException : ApplicationException
{
internal TestSqlException(int testErrorNumber)
{
Number = testErrorNumber;
}
internal int Number { get; set; }
}
Paso 2.c: Ejecución del programa
El archivo ejecutable RetryAdo2.exe no emite ningún parámetro. Para ejecutar el archivo .exe:
- Abra una ventana de consola donde haya compilado el binario RetryAdo2.exe.
- Ejecute RetryAdo2.exe sin parámetros de entrada.
database_firewall_rules_table 245575913
filestream_tombstone_2073058421 2073058421
filetable_updates_2105058535 2105058535
Paso 3: Formas de probar la lógica de reintento
Hay varias maneras de simular un error transitorio para probar la lógica de reintento.
Paso 3.a: Producir una excepción de prueba
El ejemplo de código incluye:
- Una segunda clase pequeña denominada TestSqlException, con una propiedad denominada Number.
//throw new TestSqlException(4060);, cuyos comentarios se pueden eliminar.
Si quita los comentarios de la instrucción throw y vuelve a compilar, la siguiente ejecución de RetryAdo2.exe genera algo parecido a lo siguiente.
[C:\VS15\RetryAdo2\RetryAdo2\bin\Debug\]
>> RetryAdo2.exe
4060: transient occurred. (TESTING.)
Transient error encountered. Will begin attempt number 2 of 4 max...
4060: transient occurred. (TESTING.)
Transient error encountered. Will begin attempt number 3 of 4 max...
4060: transient occurred. (TESTING.)
Transient error encountered. Will begin attempt number 4 of 4 max...
4060: transient occurred. (TESTING.)
ERROR: Unable to access the database!
[C:\VS15\RetryAdo2\RetryAdo2\bin\Debug\]
>>
Paso 3.b: Volver a probar con un error persistente
Para demostrar que el código gestiona los errores persistentes de forma correcta, vuelva a ejecutar la prueba anterior sin usar el número de un error transitorio real como 4060. En su lugar, use el número sin sentido 7654321. El programa debería tratarlo como un error persistente y omitir cualquier reintento.
Paso 3.c: Desconectarse de la red
- Desconecte el equipo cliente de la red.
- En el caso de un equipo de escritorio, desconecte el cable de red.
- En el caso de un equipo portátil, presione la combinación de función de teclas para desactivar el adaptador de red.
- Inicie RetryAdo2.exe y espere a que la consola muestre el primer error transitorio, probablemente 11001.
- Vuelva a conectar a la red mientras RetryAdo2.exe continúa ejecutándose.
- Verá cómo la consola informa de que todo es correcto en un reintento posterior.
Paso 3.d: Escribir mal temporalmente el nombre del servidor
- Agregue temporalmente 40615 como otro número de error a TransientErrorNumbersy vuelva a compilar.
- Establezca un punto de interrupción en la línea:
new QC.SqlConnectionStringBuilder(). - Use la característica Editar y continuar para escribir mal deliberadamente el nombre del servidor un par de líneas por debajo.
- Deje que el programa se ejecute y vuelva al punto de interrupción.
- Se produce el error 40615.
- Corrija el error ortográfico.
- Deje que el programa se ejecute y finalice correctamente.
- Quite 40615 y vuelva a compilar.
Pasos siguientes
Para explorar otras prácticas recomendadas y directrices de diseño, visite Conexión a SQL Database: vínculos, prácticas recomendadas y directrices de diseño.