In this blog post, you will learn how to use Prism in existing Xamarin.Forms app.
Introduction
Xamarin.Forms code runs on multiple platforms - each of which has its own filesystem. This means that reading and writing files are most easily done using the native file APIs on each platform. Alternatively, embedded resources are a simpler solution to distribute data files with an app.
MVVM
MVVM - Model View ViewModel
MVVM Is the design pattern to separate the user interface & business logic concerns. I suppose that you heard something about it. This pattern created by Microsoft is widely used with applications created with .NET Framework but not only because you can also use it with Xamarin.
Prism
Prism is a framework for building loosely coupled, maintainable, and testable XAML applications in WPF, Windows 10 UWP, and Xamarin Forms. Prism provides an implementation of a collection of design patterns that are helpful in writing well-structured and maintainable XAML applications, including MVVM, dependency injection, commands, EventAggregator, and others.
Prism Containers
- Unity
- DryIoc
Unity is the container I use and recommend the most. Unity is the most popular container due to it being the container that Brian has used for years and it is the first (and for a long time only) container available in the Templates. Unity is also about average with regards to its benchmark performance.
DryIoc is the container It's under active development, it's very fast, and works well with the current release of Prism. Also important is that when I have had questions or issues the maintainer has been very quick to address the issue or answer the question I had. It's for all of these reasons I continue to recommend the container.
Go with Prism Unity Container
Prerequisites
- Visual Studio 2017 or later (Windows or Mac)
Setting up a Xamarin.Forms Project
Start by creating a new Xamarin.Forms project. You wíll learn more by going through the steps yourself.
Create a new or existing Xamarin forms(.Net standard) Project. With Android and iOS Platform.
Install "Prism.Unity.Forms" Nuget
Now, add the following NuGet Packages.
Go to Solution Explorer and select your solution. Right-click and select "Manage NuGet Packages for Solution". Search "Prism.Unity.Forms" and add Package. Remember to install it for each project (.NET Standard, Android, iO, and UWP).
Change Application to PrismApplication
After install Prism.Unity.Prism, Change Application to PrismApplication in App.Xaml
App.xaml
Register NavigationService
Change Application to PrismApplication and add IPlatformInitializer to App Constructor.
Then register your content page and ViewModel using IContainerRegistry
- override OnInitialized (Initialize Components)
- override RegisterTypes (Navigation Service Register)
Refer following code snippet.
App.xaml.cs
Platform Setup
Android
Need to change IPlatformInitializer in LoadApplication.
MainActivity.cs
iOS
Need to change IPlatformInitializer in LoadApplication.
AppDelegate.cs
MVVM BindingContext
You no need to set BindingContext your ViewModel to ContentPage. Just create a ContentPage name ending with Page. (Ex: MyPage). Create a ViewModel name staring with ContentPage Name (ex: MyPageViewModel).
ViewModelLocator
If Viewmodel BindingContext is not working. Follow the below step.
ContentPage.xaml.cs
ContentPage.Xaml
Click the "Play" button to try it out.
Wow, it's working. 😍
I hope you have understood how to how to use Prism in existing Xamarin.Forms app.
Thanks for reading. Please share your comments and feedback. Happy Coding :)
