App. Config, cadenas de conexión

Hola a todos:

En este articulo haremos una incursión al archivo de configuración o App.Cofig para definir una cadena de conexión a una Base de Datos:

• Agregar un archivo de configuración a un proyecto
• Definir una cadena de conexión a una Base de datos
• Utilizar el archivo de configuración para obtener la cadena de conexión

Entrando en contexto..
Imagine, que hoy desarrolla un sistema con 20 Formularios, la cual va a instalar en 50 Pc’s que utilizaran para la administración de su empresa, su conocimiento sobre las ventajas de usar un archivo de configuración es nula, así que usted uso lo que muchos programadores llegamos a utilizar en nuestro inicios, establecer la cadena de conexión en cada método o función donde necesitemos comunicarnos con la Bd, algo como esto:

C#:

using System.Data.SqlClient;

private void btnProbar_Click(object sender, EventArgs e)
{
    using(SqlConnection cnx = new SqlConnection("Data Source=LUISESCOBAR-PC;Initial Catalog=Directorio;Integrated Security=True"))
    {
        cnx.Open();
        MessageBox.Show(cnx.State.ToString());
    }
}

Vb.Net:

    Private Sub btnProbar_Click(sender As System.Object, e As System.EventArgs) Handles btnProbar.Click
        Using cnx = New SqlConnection("Data Source=LUISESCOBAR-PC;Initial Catalog=Directorio;Integrated Security=True")
            cnx.Open()
            MessageBox.Show(cnx.State.ToString())
        End Using
    End Sub

y para los que tienen mas experiencia pero aun no llegan a conocer los beneficios del archivo de configuración, establecer la cadena de conexión en una variable global del tipo String podría aparentar ser una buena solución ya que se asigna una sola vez y se usa en todas las consultas requeridas.

C#:

using System.Data.SqlClient;

namespace sinAppConfig
{
    public class Connection
    {
        public static SqlConnection Conexion()
        {
            return new SqlConnection("Data Source=LUISESCOBAR-PC;Initial Catalog=Directorio;Integrated Security=True");
        }
    }
}

Usamos la clase Connection:

private void btnProbar_Click(object sender, EventArgs e)
{
    //Utilizamos la clase connection para abrir la cadena de conexion
    using(SqlConnection cnx = Connection.Conexion())
    {
        cnx.Open();

        MessageBox.Show(cnx.State.ToString());
    }
}

Vb.Net:

Imports System.Data.SqlClient

Module Module1

    Public Function Connection() As SqlConnection
        Return New SqlConnection("Data Source=LUISESCOBAR-PC;Initial Catalog=Directorio;Integrated Security=True")
    End Function

End Module

Usamos la función Connection declarado en el modulo Module1:

Public Class Form1

    Private Sub btnProbar_Click(sender As System.Object, e As System.EventArgs) Handles btnProbar.Click

        'Usamos la funcion publica Connection declarada en el modulo Module1
        Using cnx = Connection()
            cnx.Open()

            MessageBox.Show(cnx.State.ToString())
        End Using
    End Sub
End Class

Bien, continuando con nuestro caso hipotético, imagínese que después de algún tiempo se le notifica de la necesidad de modificar el nombre del server o la ubicación física del mismo, trayendo con esto la necesidad de modificar nuestra cadena de conexión pero, como declaro su cadena de conexión en alguna clase publica o modulo para los de Vb.net y esta clase o modulo se comprimió junto con el Exe al momento de crear su installer ya no tiene acceso a ella desde fuera del proyecto, así que no tendrá otra opción que abrir su proyecto desde el Vs y modificar su cadena de conexión en el lugar donde lo haya declarado, si es en una clase publica o modulo solo tendrá que modificar una sola vez pero, si declaro la cadena en cada método o función donde se requería la comunicación con la Bd tendrá un problema mas grande (aunque no monstruoso), en realidad modificar la cadena de conexión no será el problema puesto que usando la combinación de teclas Ctrl + F podrá fácilmente buscarla y reemplazarla por la nueva.

El problema viene al momento de pasar esta actualización a todas las instalaciones de su Software, ya que como sabrá, al momento de hacer la modificación tendrá que compilar de nuevo los proyectos (el que contiene su desarrollo y el proyecto Setup) e ir a cada equipo donde su software este instalado, desinstalar y posteriormente instalar de nuevo su software, este es el verdadero problema ya que como se abra dado cuenta, no es tarea sencilla ya que la actividad no se resume en una acción si no en varias, ahora si consideramos la disponibilidad de los usuarios para dejarnos trabajar a nosotros mientras ellos se retrasan en sus actividades, estaremos en un problema.

¿ Solución? usar el archivo de configuración….

Si utiliza un archivo de configuración no tendrá tantos problemas, ya que el utilizarlo simplifica la tarea a únicamente ir al directorio de instalación ubicar el archivo App.Config, abrirlo con un editor de texto como NotePad, modificar su cadena de conexión, guardar y listo a seguir usando su aplicación sin mas ni mas; no necesita abrir el proyecto en el Vs ni compilar, mucho menos instalar de nuevo.

¿Comprende ahora la gran utilidad de este archivo tan simple?…

Hasta este punto creo que ya esta convencidos de la utilidad del archivo de configuración, ahora vayamos viendo como agregarlo a nuestro proyecto y como utilizarlo:

Agregar un archivo de configuración a un proyecto

En este ejemplo utilizaremos una Bd creada en SqlServer Express 2008 y Vs2010 Ultimate, la Bd es únicamente para probar la conexión, puede crear cualquiera en su Server.

Antes de comenzar cree un proyecto del tipo Windows Forms, abra el formulario y agregue un botón.

Para crear el archivo de configuración tenemos dos opciones:

Utilizar el “Asistente para la configuración de orígenes de base de datos” o insertar un nuevo elemento al proyecto del tipo App.Config, veamos paso a paso cada uno de ellos,

Utilizar el “Asistente para la configuración de orígenes de base de datos”

Menú Datos –> Agregar nuevo origen de datos













En esta parte, el asiste nos pregunta el nombre que asignaremos a la cadena de conexión, podemos dejar el nombre por default o poner el nombre que creamos conveniente, en esta ocasión dejemos el que nos pone por default mas adelante lo modificaremos:





Después de realizar todo lo anterior podrá ver en el “Explorador de soluciones” dos nuevos archivos, que son el archivo de configuración y un DataSet:



El archivo DataSet por favor elimínelo, ya que no nos servirá de nada…

Si abre el archivo de configuración que acabamos de agregar a nuestro proyecto, podrá ver dentro una estructura de código Xml como el siguiente:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <configSections>
    </configSections>
    <connectionStrings>
        <add name="connectionString_CSharp.Properties.Settings.DirectorioConnectionString"
             connectionString="Data Source=LUISESCOBAR-PC;Initial Catalog=Directorio;Integrated Security=True"
            providerName="System.Data.SqlClient" />
    </connectionStrings>
</configuration>

Veamos que representa cada línea:

Esta línea representa el nombre de nuestra cadena de conexión, si recuerda en uno de los pasos anteriores el asistente le preguntaba el nombre de la cadena de conexión, como dejamos el nombre por default es este el que aparece como nombre de nuestra cadena:

<add name="connectionString_CSharp.Properties.Settings.DirectorioConnectionString"

Modifiquemos esta línea con el fin de tener un nombre mas corto (con este nombre será como obtendremos el valor de nuestra Cadena):

<add name="cnxString"

La siguiente línea representa el valor de nuestra cadena de conexión:

connectionString="Data Source=LUISESCOBAR-PC;Initial Catalog=Directorio;Integrated Security=True"

y por ultimo tendremos el nombre del motor de Base de Datos que estaremos usando:

providerName="System.Data.SqlClient" />

Bien, ya vimos como usar el asistente para definir una cadena de conexión…ahora vayamos a ver

Insertar un nuevo elemento al proyecto del tipo App.Config

Haga Click derecho sobre el proyecto –> Agregar –> Nuevo Elemento:



Seleccione “Archivo de configuración de aplicaciones”, deje el nombre por default y presione el botón “Aceptar”



Observe que tenemos un nuevo archivo en el “Explorador de soluciones” ábralo dentro podrá ver una estructura de código como la siguiente:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
</configuration>

Dentro de la etiqueta <configuration> usted tendrá que agregar el nombre de la cadena de conexión, el valor de la cadena de conexión y el nombre del motor de Base de datos que estará utilizando, esto ultimo no siempre es necesario ya que depende mucho del motor que estemos utilizando porque para Bases de datos como Access, SqlCe…son necesarios para SqlServer no lo es.

Al final usted deberá de tener un archivo con la siguiente estructura de código Xml:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <connectionStrings>
    <add name="cnxString"
         connectionString="Data Source=LUISESCOBAR-PC;Initial Catalog=Directorio;Integrated Security=True"
         providerName="System.Data.SqlClient" />
  </connectionStrings>
</configuration>

Utilizar el archivo de configuración para obtener la cadena de conexión

Ahora veamos como utilizar la cadena de conexión que acabamos de crear por cualquiera de los pasos anteriores.

Antes de poder utilizar el valor de cadena de conexión almacenada en la etiqueta connectionString de nuestro archivo de configuración, debe de agregar una referencia al ensamblado System.Configuration para esto:

Haga click derecho sobre el proyecto –> Agregar referencia –> Ficha .Net –> seleccione System.Configuration –> Aceptar



Una vez echo esto, vayamos a la clase donde queramos abrir la conexión e importemos el espacio de nombres System.Configuration, echo lo anterior estamos listos para utilizar nuestro App.Config.

para C#:

using System;
using System.Windows.Forms;
using System.Data.SqlClient;
using System.Configuration;

namespace connectionString_CSharp
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void btnconectar_Click(object sender, EventArgs e)
        {
            TestConnection();
        }

        private void TestConnection()
        {
            using(SqlConnection cnx = new SqlConnection(ConfigurationManager.ConnectionStrings["cnxString"].ToString()))
            {
                cnx.Open();

                MessageBox.Show(cnx.State.ToString());
            }
        }
    }
}

Para Vb.Net:

Imports System.Data.SqlClient
Imports System.Configuration
Public Class Form1

    Private Sub btnProbar_Click(sender As System.Object, e As System.EventArgs) Handles btnProbar.Click
        TestConnection()
    End Sub

    Private Sub TestConnection()
        Using cnx As New SqlConnection(ConfigurationManager.ConnectionStrings("cnxString").ToString())
            cnx.Open()
            MessageBox.Show(cnx.State.ToString())
        End Using
    End Sub
End Class

Bien, cuando compile su proyecto, lo instale y se le presente la necesidad de modificar la cadena de conexión, simplemente diríjase al directorio de instalación ubique el archivo de configuración (una vez instalado su software la nomenclatura de su archivo será NombredelProyecto.Exe.Config), ábralo con el notepad, modifique su cadena, guarde los cambios y sin mas ni mas podrá seguir trabajando…

Saludos desde Monterrey, Nuevo León México!
Ejemplo C#
Ejemplo Vb.Net
Nota: El proyecto fue desarrollado en Vs2010 usando una Bd SqlServer 2008 Express y Framework 4.0 Client Profile