Dependency Injection w Windows Universal Apps (UWP)

Ostatnio zacząłem pisać aplikację na platformę Windows Universal Apps, która już jakiś czas temu mnie bardzo zaciekawiła. Poza tym jest to okazja aby się trochę rozwinąć i oderwać od świata javy ;). Aplikacja prawdopodobnie pojawi się niedługo na GitHub ale w związku z tym pojawi się pewnie kolejny post.
W trakcie pisania pojawia się jak to zwykle bywa mnóstwo problemów. Staram się rozwiązywać je sukcesywnie, a jedno z tych rozwiązać przedstawię w tym wpisie.

Problem

Okazuje się, iż platforma UWP jest na tyle uboga, iż brakuje w niej mechanizmów pozwalających na skorzystanie ze wstrzykiwania zależności. Dla mnie jest to jeden z najważniejszych wzorców, który chce mieć wdrożony w niemal każdej aplikacji, którą piszę. W sieci nie ma zbyt wielu materiałów na ten temat, szczególnie takich zrozumiałych dla mnie - programisty mającego mało dotychczas wspólnego z technologiami ze stajni Microsoftu. Znalazłem jednak fajne rozwiązanie, które jest proste i sprawdza się w moim przypadku. Zainspirowane zostało wpisem Dominika Webera na jego blogu.

Rozwiązanie

Aplikacja UWP składa się ze stron [ang. page]. Każda taka strona to jeden widok aplikacji. Celem jest wstrzyknięcie do danej strony wybranych zależności. Zależnościami do tych zależności zajmie się już wybrany kontener IoC. Strony są tworzone przez framework więc nie ma zbytnio możliwości zlecenia tworzenia stron do kontenera. Odpada zatem preferowana przeze mnie możliwość wstrzykiwania przez konstruktor. W takim wypadku jest możliwość wstrzykiwania adekwatności [ang. property], którą umożliwia wybrany przeze mnie kontener IoC, o którym póżniej.
Ok, ale żeby wstrzyknąć coś do obiektu, trzeba mieć najpierw do niego referencje.Okazuje się, iż najłatwiej o taką referencje z poziomu ramki [ang. frame]. Ramka ta jest tworzona w pliku App.xaml.cs i reprezentuje okno naszej aplikacji:
rootFrame = new Frame();Okazuje się, iż wystarczy rozszerzyć klasę Frame i nadpisać metodę OnContentChanged aby mieć dostęp do właśnie uruchamianej strony. W tym właśnie miejscu postanowiłem wstrzykiwać brakujące zależności do przełączanych stron.

Kontener

Wybrany przeze mnie kontener DI to Autofac. W moim przypadku, cała konfiguracja kontenera znajduje się w konstruktorze ramki, natomiast wykorzystanie go do wstrzyknięcia zależności we wspomnianej wcześniej metodzie OnContentChanged. Poniżej kod gotowej ramki:
public class AutofacFrame : Frame
{
private readonly IContainer _container;

public AutofacFrame()
{
var containerBuilder = new ContainerBuilder();

//Dependencies registration
containerBuilder.RegisterType<VideoLibraryVideoDownloader>()
.As<IVideoDownloader>()
.SingleInstance();
containerBuilder.RegisterType<MediaTranscoderAudioExtractor>()
.As<IAudioExtractor>()
.SingleInstance();
containerBuilder.RegisterType<YouTubeSearchEngine>()
.As<ISearchEngine>()
.SingleInstance();
containerBuilder.RegisterType<SearchResultsVm>();
containerBuilder.RegisterType<YouTubeSearchEngine>()
.As<ISearchEngine>()
.SingleInstance();
containerBuilder.RegisterType<YouTubeApi>()
.SingleInstance();
containerBuilder.RegisterType<HttpClient>()
.SingleInstance();
containerBuilder.RegisterType<Settings>()
.SingleInstance();
//Dependencies registration

_container = containerBuilder.Build();
}

protected override void OnContentChanged(object oldContent, object newContent)
{
base.OnContentChanged(oldContent, newContent);
_container.InjectUnsetProperties(newContent);
}
}I tworzenie ramki aplikacji zmieniamy na:
rootFrame = new AutofacFrame();Metoda InjectUnsetProperties pozwala wstrzyknąć zależności do wszystkich adekwatności strony, które mają wartości null. Należy również pamiętać aby zapewnić settery dla tych adekwatności. U mnie wygląda to tak:
private Settings _settings;

public Settings Settings
{
set => _settings = value;
}
Póki co rozwiązanie uważam za spełniające wymagania, a przy tym bardzo proste ;)