giovedì 16 giugno 2011

Caliburn.Micro, NuGet e Visual Basic.Net

In questi giorni mi trovo, per lavoro e per la community, a smanettare con Caliburn.Micro (che tra le altre cose consiglio perché se ci riesco a lavorare io, significa che è veramente fatto bene).

Ho notato che, agganciando il framework con NuGet all’interno di un progetto Visual Basic.Net, compaiono le classi di bootstrap, la shell e l’interfaccia che definisce la shell ma con la spiacevole controindicazione che sono in C#.

Questo post ha lo scopo di spiegare come agganciare Caliburn con NuGet in un progetto VB.NET.

Agganciare il framework con NuGet è semplicissimo (come lo è sempre utilizzando NuGet). In questo caso stiamo parlando di un progetto WPF, ma la procedura è identica per Silverlight o WP7.

Per cominciare accertiamoci di aver installato ed abilitato NuGet tra le estensioni di VS (basta vedere se con il tasto destro su un progetto appare il menù contestuale “Add Library Package Reference…”).

Lanciamo il comando precedente sul progetto in cui vogliamo aggiungere Caliburn.Micro e selezioniamo il package dalla maschera:

SNAGHTMLa8d9aa0

Il tasto install ci consente di istallare e configurare Caliburn.Micro.

Al termine dell’installazione il progetto apparirà nel seguente modo:

image

Rimuoviamo i file .cs e inseriamo gli omonimi file .vb con le classi che riporto di seguito:

Appbootstrapper.vb

  1. Imports Caliburn.Micro
  2. Imports System.ComponentModel.Composition.Hosting
  3. Imports System.ComponentModel.Composition.Primitives
  4.   ImportsSystem.ComponentModel.Composition
  5.  
  6. Public Class AppBootstrapper
  7.     Inherits Bootstrapper(Of IShell)
  8.  
  9.     Private container As CompositionContainer
  10.  
  11.     ' <summary>
  12.     ' By default, we are configured to use MEF
  13.     ' </summary>
  14.     Protected Overrides Sub Configure()
  15.         Dim catalog = New AggregateCatalog(AssemblySource.Instance.Select(Function(x) New AssemblyCatalog(x)).OfType(Of ComposablePartCatalog)())
  16.  
  17.         container = New CompositionContainer(catalog)
  18.  
  19.         Dim batch = New CompositionBatch()
  20.  
  21.         batch.AddExportedValue(Of IWindowManager)(New WindowManager())
  22.         batch.AddExportedValue(Of IEventAggregator)(New EventAggregator())
  23.         batch.AddExportedValue(container)
  24.         batch.AddExportedValue(catalog)
  25.  
  26.         container.Compose(batch)
  27.     End Sub
  28.  
  29.  
  30.     Protected Overrides Function GetInstance(service As System.Type, key As String) As Object
  31.         Dim contract = If(String.IsNullOrEmpty(key), AttributedModelServices.GetContractName(service), key)
  32.         Dim exports = container.GetExportedValues(Of Object)(contract)
  33.  
  34.         If exports.Count() > 0 Then Return exports.First()
  35.  
  36.         Throw New Exception(String.Format("Could not locate any instances of contract {0}.", contract))
  37.     End Function
  38.  
  39.     Protected Overrides Function GetAllInstances(service As System.Type) As System.Collections.Generic.IEnumerable(Of Object)
  40.         Return container.GetExportedValues(Of Object)(AttributedModelServices.GetContractName(service))
  41.     End Function
  42.  
  43.     Protected Overrides Sub BuildUp(instance As Object)
  44.         container.SatisfyImportsOnce(instance)
  45.     End Sub
  46.  
  47.  
  48. End Class

IShell.vb

  1. Public Interface IShell
  2.  
  3. End Interface

ShellViewModel.vb

  1. Imports System.ComponentModel.Composition
  2.  
  3. <Export(GetType(IShell))>
  4. Public Class ShellViewModel
  5.     Implements IShell
  6.  
  7. End Class

Le classi possono ovviamente essere personalizzate sia nel comportamento che nei namespace.

Con l’inserimento di queste classi, il progetto assume la forma:

image

Per la configurazione dello startup dell’applicazione fate riferimento alla documentazione di Caliburn.Micro (http://caliburnmicro.codeplex.com/wikipage?title=Nuget&referringTitle=Documentation) che spiega passo passo cosa fare.

Ricordatevi di fare attenzione ai namespace della ShellView e della ShellViewModel per fare in modo che Caliburn riesca ad associarle.

In particolare è necessario prestare attenzione alla ShellView. Il package NuGet, infatti, crea il seguente Xaml:

  1. <Window x:Class="NomeProgetto.ShellView"
  2.         xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  3.         xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
  4.  
  5.     <Grid Background="White">
  6.         <TextBlock Text="Hello Caliburn Micro!"
  7.                    VerticalAlignment="Center"
  8.                    HorizontalAlignment="Center"
  9.                    FontSize="20" />
  10.     </Grid>
  11.  
  12. </Window>

Come possiamo osservare la classe ShellView si trova nel namespace “NomeProgetto.ShellView”, mentre la ShellViewModel (così come definita in precedenza) nel namespace root. In questo caso la convenzione che sta alla base del funzionamento di Caliburn non è in grado di associare View e ViewModel ed otterrete:

SNAGHTMLaf22a05

Per risolvere il problema è sufficiente togliere il namespace davanti al nome della classe nella view.

 

Nessun commento: