Merge pull request #57 from NeverMorewd/refactor-alias

NeverMorewd · web-flow · commit bbef140ac149 · 2025-06-25T16:19:04.000+08:00
Move Alias to INavigationAware
diff --git a/samples/Lemon.ModuleNavigation.Sample/ViewModels/MainViewModel.cs b/samples/Lemon.ModuleNavigation.Sample/ViewModels/MainViewModel.cs
@@ -47,8 +47,7 @@ public MainViewModel(IEnumerable<IModule> modules,
                 new NavigationParameters { { "requestNew", requestNew } });
             _navigationService.RequestViewNavigation("TabRegion", 
                 viewName, 
-                new NavigationParameters { { "requestNew", requestNew } },
-                $"alias-{viewName}");
+                new NavigationParameters { { "requestNew", requestNew } });
             _navigationService.RequestViewNavigation("ItemsRegion", 
                 viewName, 
                 new NavigationParameters { { "requestNew", requestNew } });
diff --git a/samples/Lemon.ModuleNavigation.SampleViewModel/BaseNavigationViewModel.cs b/samples/Lemon.ModuleNavigation.SampleViewModel/BaseNavigationViewModel.cs
@@ -8,7 +8,7 @@ namespace Lemon.ModuleNavigation.SampleViewModel;
 public class BaseNavigationViewModel : ReactiveObject, INavigationAware, ICanUnload
 {
     public virtual string Greeting => $"Welcome to {GetType().Name}[{Environment.ProcessId}][{Environment.CurrentManagedThreadId}]{Environment.NewLine}{DateTime.Now:yyyy-MM-dd HH-mm-ss.ffff}";
-
+    public virtual string? Alias => GetType().Name;
     public BaseNavigationViewModel()
     {
         UnloadViewCommand = ReactiveCommand.Create(() =>
diff --git a/samples/Lemon.ModuleNavigation.SampleViewModel/MainWindowViewModel.cs b/samples/Lemon.ModuleNavigation.SampleViewModel/MainWindowViewModel.cs
@@ -33,7 +33,7 @@ public MainWindowViewModel(INavigationService navigationService,
 
             }
             _navigationService.RequestViewNavigation("ContentRegion", viewName, new NavigationParameters { { "requestNew", requestNew } });
-            _navigationService.RequestViewNavigation("TabRegion", viewName, new NavigationParameters { { "requestNew", requestNew } }, $"alias-{viewName}");
+            _navigationService.RequestViewNavigation("TabRegion", viewName, new NavigationParameters { { "requestNew", requestNew } });
             _navigationService.RequestViewNavigation("ItemsRegion", viewName, new NavigationParameters { { "requestNew", requestNew } });
         });
 
diff --git a/samples/Lemon.ModuleNavigation.SampleViewModel/ViewAlphaViewModel.cs b/samples/Lemon.ModuleNavigation.SampleViewModel/ViewAlphaViewModel.cs
@@ -11,6 +11,7 @@ public ViewAlphaViewModel()
     {
     }
 
+    public override string? Alias => "AlphaView";
     public string Title => nameof(ViewAlphaViewModel);
 
     public event Action<IDialogResult>? RequestClose;
diff --git a/samples/Lemon.ModuleNavigation.SampleViewModel/ViewBetaViewModel.cs b/samples/Lemon.ModuleNavigation.SampleViewModel/ViewBetaViewModel.cs
@@ -8,7 +8,7 @@ namespace Lemon.ModuleNavigation.SampleViewModel;
 public class ViewBetaViewModel : BaseNavigationViewModel, IDialogAware
 {
     public string Title => nameof(ViewBetaViewModel);
-
+    public override string? Alias => "BetaView";
     public event Action<IDialogResult>? RequestClose;
     public ReactiveCommand<Unit, Unit> CloseCommand => ReactiveCommand.Create(() => 
     {
diff --git a/src/Lemon.ModuleNavigation.Avaloniaui/Regions/Region.cs b/src/Lemon.ModuleNavigation.Avaloniaui/Regions/Region.cs
@@ -140,6 +140,7 @@ private IDataTemplate CreateRegionDataTemplate()
 
                 view.DataContext = navigationAware;
                 navigationAware.OnNavigatedTo(context);
+                context.Alias = navigationAware.Alias;
                 if (navigationAware is ICanUnload canUnloadNavigationAware)
                 {
                     canUnloadNavigationAware.RequestUnload += () =>
diff --git a/src/Lemon.ModuleNavigation.Wpf/Regions/Region.cs b/src/Lemon.ModuleNavigation.Wpf/Regions/Region.cs
@@ -80,6 +80,7 @@ public virtual void ScrollIntoView(NavigationContext item)
 
             view.DataContext = navigationAware;
             navigationAware.OnNavigatedTo(context);
+            context.Alias = navigationAware.Alias;
             if (navigationAware is ICanUnload canUnloadNavigationAware)
             {
                 canUnloadNavigationAware.RequestUnload += () =>
diff --git a/src/Lemon.ModuleNavigation/Abstractions/INavigationAware.cs b/src/Lemon.ModuleNavigation/Abstractions/INavigationAware.cs
@@ -2,6 +2,7 @@
 
 public interface INavigationAware
 {
+    string? Alias { get; }
     void OnNavigatedTo(NavigationContext navigationContext);
     bool IsNavigationTarget(NavigationContext navigationContext);
     void OnNavigatedFrom(NavigationContext navigationContext);
diff --git a/src/Lemon.ModuleNavigation/Abstractions/IRegionManager.cs b/src/Lemon.ModuleNavigation/Abstractions/IRegionManager.cs
@@ -6,7 +6,7 @@ public interface IRegionManager : IObservable<NavigationContext>, IObservable<IR
 {
     void AddRegion(string regionName, IRegion region);
     IRegion? GetRegion(string regionName);
-    void RequestViewNavigate(string regionName, string viewName, NavigationParameters? parameters = null, string? alias = null);
+    void RequestViewNavigate(string regionName, string viewName, NavigationParameters? parameters = null);
     [Obsolete("requestNew was obsolete.Consider IsNavigationTarget() in INavigationAware instead.")]
     void RequestNavigate(string regionName, string viewName, bool requestNew, NavigationParameters? parameters = null);
     void RequestViewUnload(string regionName, string viewName);
diff --git a/src/Lemon.ModuleNavigation/Abstractions/IViewNavigationHandler.cs b/src/Lemon.ModuleNavigation/Abstractions/IViewNavigationHandler.cs
@@ -5,12 +5,10 @@ namespace Lemon.ModuleNavigation.Abstractions;
 public interface IViewNavigationHandler
 {
     void OnNavigateTo(string regionName, 
-        string viewName,
-        string? alias = null);
+        string viewName);
     void OnNavigateTo(string regionName, 
         string viewName,
-        NavigationParameters parameters,
-        string? alias = null);
+        NavigationParameters parameters);
     void OnViewUnload(string regionName,
         string viewName);
 }
diff --git a/src/Lemon.ModuleNavigation/Abstractions/IViewNavigationService.cs b/src/Lemon.ModuleNavigation/Abstractions/IViewNavigationService.cs
@@ -20,8 +20,7 @@ void RequestViewNavigation(string regionName,
         bool requestNew);
 
     void RequestViewNavigation(string regionName,
-        string viewName, 
-        string? alias = null);
+        string viewName);
 
     /// <summary>
     /// RequestViewNavigation
@@ -41,8 +40,7 @@ void RequestViewNavigation(string regionName,
 
     void RequestViewNavigation(string regionName,
         string viewName,
-        NavigationParameters parameters,
-        string? alias = null);
+        NavigationParameters parameters);
 
     /// <summary>
     /// RequestViewUnload
diff --git a/src/Lemon.ModuleNavigation/NavigationContext.cs b/src/Lemon.ModuleNavigation/NavigationContext.cs
@@ -1,12 +1,14 @@
 ﻿using Lemon.ModuleNavigation.Abstractions;
 using Lemon.ModuleNavigation.Core;
+using System.ComponentModel;
+using System.Runtime.CompilerServices;
 
 namespace Lemon.ModuleNavigation;
 
-public class NavigationContext
+public class NavigationContext : INotifyPropertyChanged
 {
     [Obsolete("requestNew was obsolete.Consider IsNavigationTarget() in INavigationAware instead.")]
-    internal NavigationContext(string viewName, 
+    internal NavigationContext(string viewName,
         string regionName,
         IServiceProvider serviceProvider,
         bool requestNew,
@@ -21,42 +23,45 @@ internal NavigationContext(string viewName,
     internal NavigationContext(string viewName,
         string regionName,
         IServiceProvider serviceProvider,
-        NavigationParameters? navigationParameters,
-        string? alias)
+        NavigationParameters? navigationParameters)
     {
         ViewName = viewName;
         Parameters = navigationParameters;
         RegionName = regionName;
         ServiceProvider = serviceProvider;
-        Alias = alias;
     }
     public static ViewNameComparer ViewNameComparer => new();
     public static StrictComparer StrictComparer => new();
-    public string ViewName 
-    { 
-        get; 
-        private set; 
+    public string ViewName
+    {
+        get;
+        private set;
     }
+    private string? _alias;
     public string? Alias
+    {
+        get => _alias;
+        set
+        {
+            _alias = value;
+            OnPropertyChanged();
+        }
+    }
+    public NavigationParameters? Parameters
     {
         get;
         private set;
     }
-    public NavigationParameters? Parameters 
-    { 
-        get; 
-        private set; 
-    }
     [Obsolete("requestNew was obsolete.Consider IsNavigationTarget() in INavigationAware instead.")]
     public bool RequestNew
     {
         get;
         private set;
     }
     public string RegionName
-    { 
-        get; 
-        private set; 
+    {
+        get;
+        private set;
     }
     public int Key => GetHashCode();
     public IServiceProvider ServiceProvider
@@ -72,6 +77,12 @@ public override string ToString()
     {
         return $"{RegionName}.{ViewName}";
     }
+
+    public event PropertyChangedEventHandler? PropertyChanged;
+    protected void OnPropertyChanged([CallerMemberName] string? propertyName = null)
+    {
+        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
+    }
 }
 public class ViewNameComparer : IEqualityComparer<NavigationContext>
 {
diff --git a/src/Lemon.ModuleNavigation/NavigationHandler.cs b/src/Lemon.ModuleNavigation/NavigationHandler.cs
@@ -33,17 +33,15 @@ public void OnNavigateTo(string moduleKey, NavigationParameters? parameters)
         _moduleManager.RequestNavigate(moduleKey, parameters);
     }
     public void OnNavigateTo(string regionName,
-         string viewName,
-         string? alias = null)
+         string viewName)
     {
-        RegionManager.RequestViewNavigate(regionName, viewName, null, alias);
+        RegionManager.RequestViewNavigate(regionName, viewName, null);
     }
     public void OnNavigateTo(string regionName,
         string viewName,
-        NavigationParameters navigationParameters,
-        string? alias = null)
+        NavigationParameters navigationParameters)
     {
-        RegionManager.RequestViewNavigate(regionName, viewName, navigationParameters, alias);
+        RegionManager.RequestViewNavigate(regionName, viewName, navigationParameters);
     }
 
     public void OnViewUnload(string regionName, string viewName)
diff --git a/src/Lemon.ModuleNavigation/NavigationService.cs b/src/Lemon.ModuleNavigation/NavigationService.cs
@@ -40,23 +40,21 @@ public void RequestModuleNavigate(string moduleName, NavigationParameters? param
         _bufferModuleName.Push((moduleName, parameters));
     }
     public void RequestViewNavigation(string regionName,
-       string viewName,
-       string? alias = null)
+       string viewName)
     {
         foreach (var handler in _viewHandlers)
         {
-            handler.OnNavigateTo(regionName, viewName, alias);
+            handler.OnNavigateTo(regionName, viewName);
         }
         _bufferViewName.Push((regionName, viewName, null));
     }
     public void RequestViewNavigation(string regionName,
         string viewName,
-        NavigationParameters parameters,
-        string? alias = null)
+        NavigationParameters parameters)
     {
         foreach (var handler in _viewHandlers)
         {
-            handler.OnNavigateTo(regionName, viewName, parameters, alias);
+            handler.OnNavigateTo(regionName, viewName, parameters);
         }
         _bufferViewName.Push((regionName, viewName, parameters));
     }
diff --git a/src/Lemon.ModuleNavigation/RegionManager.cs b/src/Lemon.ModuleNavigation/RegionManager.cs
@@ -41,9 +41,9 @@ public void RequestNavigate(string regionName, string viewName, bool requestNew,
                 });
         }
     }
-    public void RequestViewNavigate(string regionName, string viewName, NavigationParameters? parameters = null, string? alias = null)
+    public void RequestViewNavigate(string regionName, string viewName, NavigationParameters? parameters = null)
     {
-        var context = new NavigationContext(viewName, regionName, _serviceProvider, parameters, alias);
+        var context = new NavigationContext(viewName, regionName, _serviceProvider, parameters);
         if (_regions.TryGetValue(regionName, out var region))
         {
             region.Activate(context);

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ namespace Lemon.ModuleNavigation.SampleViewModel;`
`8`	`8`	`public class BaseNavigationViewModel : ReactiveObject, INavigationAware, ICanUnload`
`9`	`9`	`{`
`10`	`10`	`public virtual string Greeting => $"Welcome to {GetType().Name}[{Environment.ProcessId}][{Environment.CurrentManagedThreadId}]{Environment.NewLine}{DateTime.Now:yyyy-MM-dd HH-mm-ss.ffff}";`
`11`		`-`
	`11`	`+ public virtual string? Alias => GetType().Name;`
`12`	`12`	`public BaseNavigationViewModel()`
`13`	`13`	`{`
`14`	`14`	`UnloadViewCommand = ReactiveCommand.Create(() =>`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public MainWindowViewModel(INavigationService navigationService,`
`33`	`33`
`34`	`34`	`}`
`35`	`35`	`_navigationService.RequestViewNavigation("ContentRegion", viewName, new NavigationParameters { { "requestNew", requestNew } });`
`36`		`- _navigationService.RequestViewNavigation("TabRegion", viewName, new NavigationParameters { { "requestNew", requestNew } }, $"alias-{viewName}");`
	`36`	`+ _navigationService.RequestViewNavigation("TabRegion", viewName, new NavigationParameters { { "requestNew", requestNew } });`
`37`	`37`	`_navigationService.RequestViewNavigation("ItemsRegion", viewName, new NavigationParameters { { "requestNew", requestNew } });`
`38`	`38`	`});`
`39`	`39`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ public ViewAlphaViewModel()`
`11`	`11`	`{`
`12`	`12`	`}`
`13`	`13`
	`14`	`+ public override string? Alias => "AlphaView";`
`14`	`15`	`public string Title => nameof(ViewAlphaViewModel);`
`15`	`16`
`16`	`17`	`public event Action<IDialogResult>? RequestClose;`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ namespace Lemon.ModuleNavigation.SampleViewModel;`
`8`	`8`	`public class ViewBetaViewModel : BaseNavigationViewModel, IDialogAware`
`9`	`9`	`{`
`10`	`10`	`public string Title => nameof(ViewBetaViewModel);`
`11`		`-`
	`11`	`+ public override string? Alias => "BetaView";`
`12`	`12`	`public event Action<IDialogResult>? RequestClose;`
`13`	`13`	`public ReactiveCommand<Unit, Unit> CloseCommand => ReactiveCommand.Create(() =>`
`14`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,7 @@ private IDataTemplate CreateRegionDataTemplate()`
`140`	`140`
`141`	`141`	`view.DataContext = navigationAware;`
`142`	`142`	`navigationAware.OnNavigatedTo(context);`
	`143`	`+ context.Alias = navigationAware.Alias;`
`143`	`144`	`if (navigationAware is ICanUnload canUnloadNavigationAware)`
`144`	`145`	`{`
`145`	`146`	`canUnloadNavigationAware.RequestUnload += () =>`
Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,7 @@ public virtual void ScrollIntoView(NavigationContext item)`
`80`	`80`
`81`	`81`	`view.DataContext = navigationAware;`
`82`	`82`	`navigationAware.OnNavigatedTo(context);`
	`83`	`+ context.Alias = navigationAware.Alias;`
`83`	`84`	`if (navigationAware is ICanUnload canUnloadNavigationAware)`
`84`	`85`	`{`
`85`	`86`	`canUnloadNavigationAware.RequestUnload += () =>`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`public interface INavigationAware`
`4`	`4`	`{`
	`5`	`+ string? Alias { get; }`
`5`	`6`	`void OnNavigatedTo(NavigationContext navigationContext);`
`6`	`7`	`bool IsNavigationTarget(NavigationContext navigationContext);`
`7`	`8`	`void OnNavigatedFrom(NavigationContext navigationContext);`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ public interface IRegionManager : IObservable<NavigationContext>, IObservable<IR`
`6`	`6`	`{`
`7`	`7`	`void AddRegion(string regionName, IRegion region);`
`8`	`8`	`IRegion? GetRegion(string regionName);`
`9`		`- void RequestViewNavigate(string regionName, string viewName, NavigationParameters? parameters = null, string? alias = null);`
	`9`	`+ void RequestViewNavigate(string regionName, string viewName, NavigationParameters? parameters = null);`
`10`	`10`	`[Obsolete("requestNew was obsolete.Consider IsNavigationTarget() in INavigationAware instead.")]`
`11`	`11`	`void RequestNavigate(string regionName, string viewName, bool requestNew, NavigationParameters? parameters = null);`
`12`	`12`	`void RequestViewUnload(string regionName, string viewName);`