En este artículo vamos a ver cómo usar WCF Data Services para interactuar con nuestra base de datos mediante REST, para esto vamos a realizar un formulario de CRUD básico y seguiremos los siguientes pasos:
- Crear aplicación Asp.net
- Crear modelo de datos con Entity Framework
- Crear WCF Data Service
- Configurar WCF Data Service para acceso a nuestras entidades.
- Interactuar con nuestro servicio desde una aplicación asp.net
¿Qué es WCF Data Services?
También conocido como ADO.NET data services, es un componente del .net Framework que permite crear servicios web usando ODATA (Open Data Protocol), para exponer y consumir datos en la web mediante REST, ODATA expone los datos como recursos que son accesibles y modificados a través de URIs, usando los verbos HTTP GET(Consultar), PUT(Modificar), POST(Ingresar) y DELETE(Eliminar).
Creando nuestro modelo de datos con la DB ejemplo Northwind.
Antes que nada para crear el modelo debemos tener la base de datos Northwind en nuestra instancia de SQl Server, dichas base de datos se adjunta en este artículo para que se sea descargada y restaurada. Una vez tengamos esta DB, en nuestro proyecto web hacemos click derecho, agregar un nuevo elemento y seleccionamos, ADO:NET Entity Data Model.
Luego configuramos la conexión con la base de datos:
Y seleccionamos las tablas que necesitemos de nuestra base de datos.
Creando nuestro WCF Data Service.
Ahora que tenemos creado nuestro modelo de datos, procedemos a crear nuestro servicio de datos, para esto hacemos clic derecho, agregar nuevo elemento, y elegimos Servicio de datos WCF.
Enseguida nos crea nuestro Data service, y nos indica que debemos especificar el origen de datos y configurar los permisos para las entidades que vamos a exponer en el servicio.
public class WcfDataService1 : DataService< /* TODO: escriba aquí el nombre de clase del origen de datos */ >
// Se llama a este método una única vez para inicializar directivas aplicables a todo el ámbito del servicio.
public static void InitializeService(DataServiceConfiguration config)
{
// TODO: establezca reglas para indicar qué operaciones de servicio y conjuntos de entidades son visibles, actualizables, etc.
// config.SetEntitySetAccessRule("MiConjuntoDeEntidades", EntitySetRights.AllRead);
// config.SetServiceOperationAccessRule("MiOperaciónDeServicio", ServiceOperationRights.All);
config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V2;
En nuestro caso el origen de datos es NorthwindEntities que hace referencia al modelo que creamos con entity Framework, y vamos a especificar permisos de crear, leer, actualizar y eliminar datos en la tabla Customers de nuestra DB, la configuración del servicio nos queda así:
public class NorttwindAccess : DataService<NorthwindEntities>{
// Se llama a este método una única vez para inicializar directivas aplicables a todo el ámbito del servicio.
public static void InitializeService(DataServiceConfiguration config){
// TODO: establezca reglas para indicar qué operaciones de servicio y conjuntos de entidades son visibles, actualizables, etc.
// config.SetEntitySetAccessRule("MiConjuntoDeEntidades", EntitySetRights.AllRead);
// config.SetServiceOperationAccessRule("MiOperaciónDeServicio", ServiceOperationRights.All);
config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V2;
config.SetEntitySetAccessRule("Customers", EntitySetRights.All);
config.UseVerboseErrors = true;
Cabe resaltar la configuración de UseVerboseErrors en True, esto para lograr obtener el detalle completo de la excepción desde el web services, en caso de que ocurra algún error.
Nos muestra las tablas a la cuales otorgamos permisos, en este caso solo la tabla Customers.
También podemos hacer cualquier query a través de la URI de nuestro servicio, algunos ejemplos a continuación:
- Seleccionar todos los registros de la tabla Customers:
- Seleccionar los registros donde el Campo CustomerID sea igual a “ALFKI”:
- Seleccionar todos los registros de la tabla Customers ordenados por el campo ContactNAme:
- Seleccionar todos los registros de la tabla Customers donde el campo ContactName termine en “no”:
http://localhost:1995/NorttwindAccess.svc/Customers?$filter=endswith(ContactName, 'no')
- Seleccionar los campos CustomerID y ContactName de la tabla Customers:
Estos son algunos ejemplos de los tantos que se pueden hacer.
Ahora procedemos a referenciar nuestro nuevo servicio de datos a nuestra aplicación web asp.net, para poder interactuar con él.
Una vez tenemos nuestro servicio de datos referenciado podemos interactuar con el desde nuestra aplicación.
En nuestro ejemplo vamos a crear un CRUD básico para la tabla Customers, visualmente es de la siguiente forma:
Para poblar el GridView con todos los Clientes, creamos el siguiente método el cual será invocado en el evento Load de nuestra página.
private void LlenarGrid(){
var serv = new NorthwindService.NorthwindEntities(new Uri("http://localhost:1995/NorttwindAccess.svc"));
var clientes = (from c in serv.Customers
this.gvCustomers.DataSource = clientes;
this.gvCustomers.DataBind();
Observemos que inicializamos nuestro modelo de datos a partir de nuestro servicios de datos, y sobre el podemos ejecutar cualquier consulta linq to entities, en este caso obtenemos todos los registros de la tabla Customers y cargamos el GridView con los resultados.
Ahora para eliminar un registro de la tabla Customers, en el vento gvCustomers_RowDeleting de nuestro gridView asignamos el siguiente fragmento de código:
string strID = this.gvCustomers.Rows[e.RowIndex].Cells[0].Text;
var serv = new NorthwindService.NorthwindEntities(new Uri("http://localhost:1995/NorttwindAccess.svc"));
NorthwindService.Customers eliminarCliente = (from c in serv.Customers
where c.CustomerID.Equals(strID)
serv.DeleteObject(eliminarCliente);
this.lblError.Text = "El cliente se elimino correctamente.";
this.lblError.Text = string.Format("Ocurrió un error al eliminar el cliete: {0}", ex.Message);
Para terminar con nuestro ejemplo, vamos a observar el código alojado en el evento click del botón guardar, en el cual se ejecutan las inserciones y actualizaciones a nuestra DB:
var serv = new NorthwindService.NorthwindEntities(new Uri("http://localhost:1995/NorttwindAccess.svc"));
if (this.hfAccion.Value.Equals("Nuevo")){
NorthwindService.Customers customer = new NorthwindService.Customers{
CustomerID = this.txtID.Text,
ContactName = this.txtNombre.Text,
CompanyName = this.txtCompania.Text
serv.AddToCustomers(customer);
NorthwindService.Customers modificarCustomer =
(from c in serv.Customers
where c.CustomerID.Equals(this.txtID.Text)
modificarCustomer.ContactName = this.txtNombre.Text;
modificarCustomer.CompanyName = this.txtCompania.Text;
serv.UpdateObject(modificarCustomer);
this.lblError.Text = "El cliente se actualizó correctamente.";
this.hfAccion.Value = "Nuevo";
this.txtID.Enabled = true;
this.lblError.Text = string.Format("Ocurrió un error al ingresar el cliete: {0}", ex.Message);
Con esto doy por terminado el artículo, espero que sea de gran utilidad para muchos, adicional el link de los fuentes de la solución y el .bak de la base de datos a continuación. En un próximo artículo estaré mostrando como consumir estos Data Services mediante Jquery a través de una petición AJAX.