Mercurial > pub > ImplabNet
annotate Implab/ServiceLocator.cs @ 68:9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
| author | cin |
|---|---|
| date | Thu, 28 Aug 2014 02:28:00 +0400 |
| parents | fe33f4e02ad5 |
| children | 48763f3b5db8 |
| rev | line source |
|---|---|
| 40 | 1 using System; |
| 2 using System.Collections.Generic; | |
| 3 using System.Linq; | |
| 4 using System.Web; | |
| 5 | |
| 6 namespace Implab { | |
| 7 /// <summary> | |
| 8 /// Коллекция сервисов, позволяет регистрировать и получать сервисы. | |
| 9 /// </summary> | |
| 10 public class ServiceLocator: Component, IServiceLocator, IServiceProvider { | |
| 11 // запись об сервисе | |
| 12 struct ServiceEntry { | |
| 13 public object service; // сервис | |
| 14 public bool shared; // признак того, что сервис НЕ нужно освобождать | |
| 15 public Func<object> activator; // активатор сервиса при первом обращении | |
| 16 public List<Type> associated; // ссылки на текущую запись | |
| 17 public Type origin; // ссылка на оригинальную запись о сервисе | |
| 18 } | |
| 19 | |
| 20 // словарь существующих сервисов | |
| 21 Dictionary<Type, ServiceEntry> m_services = new Dictionary<Type,ServiceEntry>(); | |
| 22 | |
| 23 /// <summary> | |
| 24 /// Получает объект предоставляющий сервис <typeparamref name="T"/>. | |
| 25 /// </summary> | |
| 26 /// <typeparam name="T">Тип запрашиваемого сервиса</typeparam> | |
| 27 /// <returns>Объект, реализующий сервис</returns> | |
| 28 /// <exception cref="KeyNotFoundException">Сервис не зарегистрирован</exception> | |
| 29 public T GetService<T>() { | |
| 30 return (T)GetService(typeof(T)); | |
| 31 } | |
| 32 | |
| 33 | |
| 34 /// <summary> | |
| 35 /// Пытается получить указанный сервис, в случае, если компонента не предоставляет требуемый сервис | |
| 36 /// не возникает исключений. | |
| 37 /// </summary> | |
| 38 /// <typeparam name="T">Тип требуемого сервиса.</typeparam> | |
| 39 /// <param name="service">Объект реализующий сервис, или <c>default(T)</c> если такового нет.</param> | |
| 40 /// <returns><c>true</c> - сервис найден, <c>false</c> - сервис не зарегистрирован.</returns> | |
| 41 public bool TryGetService<T>(out T service) { | |
| 42 AssertNotDisposed(); | |
| 43 | |
|
68
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
44 var result = GetService(typeof(T), false); |
|
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
45 if (result == null) { |
|
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
46 service = default(T); |
|
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
47 return false; |
|
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
48 } else { |
|
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
49 service = (T)result; |
|
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
50 return true; |
|
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
51 } |
| 40 | 52 } |
| 53 | |
| 54 /// <summary> | |
| 55 /// Получает объект предоставляющий сервис <paramref name="serviceType"/> | |
| 56 /// </summary> | |
| 57 /// <param name="serviceType">Тип запрашиваемого сервиса</param> | |
| 58 /// <returns>Объект, реализующий сервис</returns> | |
| 59 /// <exception cref="KeyNotFoundException">Сервис не зарегистрирован</exception> | |
|
68
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
60 public object GetService(Type serviceType) { |
|
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
61 return GetService (serviceType, true); |
|
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
62 } |
|
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
63 |
|
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
64 public virtual object GetService(Type serviceType, bool throwOnError) { |
| 40 | 65 if (serviceType == null) |
| 66 throw new ArgumentNullException("serviceType"); | |
| 67 AssertNotDisposed(); | |
| 68 | |
| 69 ServiceEntry se; | |
| 70 if (!m_services.TryGetValue(serviceType, out se)) { | |
| 71 // ищем ближайщий объект, реализующий нужный сервис | |
| 72 Type pt = null; | |
| 73 foreach (var t in m_services.Keys) | |
| 74 if (serviceType.IsAssignableFrom(t) && (pt == null || t.IsAssignableFrom(pt))) | |
| 75 pt = t; | |
| 76 if (pt == null) | |
| 77 throw new ApplicationException(String.Format("{0} doesn't provide {1} service",this,serviceType)); | |
| 78 | |
| 79 var pe = m_services[pt]; | |
| 80 | |
| 81 // найденная запись может ссылаться на оригинальную запись с сервисом | |
| 82 if(pe.origin != null) { | |
| 83 pt = pe.origin; | |
| 84 pe = m_services[pt]; | |
| 85 } | |
| 86 | |
| 87 // добавляем список с обратными ссылками | |
| 88 if (pe.associated == null) | |
| 89 pe.associated = new List<Type>(); | |
| 90 | |
| 91 pe.associated.Add(serviceType); | |
| 92 | |
| 93 // обновляем родительскую запись | |
| 94 m_services[pt] = pe; | |
| 95 | |
| 96 // создаем запись со ссылкой | |
| 97 se = new ServiceEntry { | |
| 98 service = pe.service, | |
| 99 origin = pt, | |
| 100 shared = true // предотвращаем множественные попытки освобождения | |
| 101 }; | |
| 102 | |
| 103 m_services[serviceType] = se; | |
| 104 } | |
| 105 | |
| 106 // запись содержит в себе информацию о сервисе | |
| 107 if (se.service != null) | |
| 108 return se.service; | |
| 109 | |
| 110 // текущая запись является ссылкой | |
| 111 if (se.origin != null) { | |
| 112 se.service = GetService(se.origin); | |
| 113 m_services[serviceType] = se; | |
| 114 return se.service; | |
| 115 } | |
| 116 | |
| 117 // текущая запись не является ссылкой и не имеет информации о сервисе | |
| 118 // она должна сожержать информацию об активации | |
| 119 if (se.activator != null) { | |
| 120 se.service = se.activator(); | |
| 121 | |
| 122 m_services[serviceType] = se; | |
| 123 | |
| 124 return se.service; | |
| 125 } | |
| 126 | |
|
68
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
127 if (throwOnError) |
|
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
128 throw new Exception("Unable to create a service instance"); |
|
9dd6a896a385
ServiceLocator: small refactoring, GetService method is made virtual
cin
parents:
40
diff
changeset
|
129 return null; |
| 40 | 130 } |
| 131 | |
| 132 /// <summary> | |
| 133 /// Регистрирует фабрику для активации сервиса по первому требованию. | |
| 134 /// </summary> | |
| 135 /// <typeparam name="T">Тип регистрируемого сервиса.</typeparam> | |
| 136 /// <param name="activator">Фабрика для создания/получения объекта, предоставляющего сервис.</param> | |
| 137 /// <exception cref="InvalidOperationException">Указанный сервис уже зарегистрирован.</exception> | |
| 138 /// <remarks>При освобождении сервис-локатора, сервисы полученные в результате активации также будут освобождены.</remarks> | |
| 139 public void Register<T>(Func<T> activator) { | |
| 140 if (activator == null) | |
| 141 throw new ArgumentNullException("activator"); | |
| 142 | |
| 143 AssertNotDisposed(); | |
| 144 | |
| 145 Unregister(typeof(T)); | |
| 146 | |
| 147 m_services[typeof(T)] = new ServiceEntry { | |
| 148 activator = () => activator() as object | |
| 149 }; | |
| 150 } | |
| 151 | |
| 152 /// <summary> | |
| 153 /// Регистрирует объект, предоставляющий сервис. | |
| 154 /// </summary> | |
| 155 /// <typeparam name="T">Тип регистрируемого сервиса.</typeparam> | |
| 156 /// <param name="service">Объект, предоставляющий сервис.</param> | |
| 157 /// <exception cref="InvalidOperationException">Указанный сервис уже зарегистрирован.</exception> | |
| 158 /// <remarks>Сервис-локатором не управляет временем жизни объекта для зарегистрированного сервиса.</remarks> | |
| 159 public void Register<T>(T service) { | |
| 160 Register(service, true); | |
| 161 } | |
| 162 | |
| 163 /// <summary> | |
| 164 /// Регистрирует объект, предоставляющий сервис. | |
| 165 /// </summary> | |
| 166 /// <typeparam name="T">Тип регистрируемого сервиса.</typeparam> | |
| 167 /// <param name="service">Объект, предоставляющий сервис.</param> | |
| 168 /// <param name="shared">Признак того, что объект является разделяемым и сервис-локатор не должен его освобождать.</param> | |
| 169 /// <exception cref="InvalidOperationException">Указанный сервис уже зарегистрирован.</exception> | |
| 170 public void Register<T>(T service, bool shared) { | |
| 171 if (service == null) | |
| 172 throw new ArgumentNullException("service"); | |
| 173 | |
| 174 AssertNotDisposed(); | |
| 175 | |
| 176 Unregister(typeof(T)); | |
| 177 | |
| 178 m_services[typeof(T)] = new ServiceEntry { service = service, shared = shared }; | |
| 179 } | |
| 180 | |
| 181 public void Unregister(Type serviceType) { | |
| 182 if (serviceType == null) | |
| 183 throw new ArgumentNullException("serviceType"); | |
| 184 | |
| 185 AssertNotDisposed(); | |
| 186 | |
| 187 ServiceEntry se; | |
| 188 if (m_services.TryGetValue(serviceType, out se)) { | |
| 189 // освобождаем ресурсы | |
| 190 if (se.service != null && !se.shared) | |
| 191 ((IDisposable)se.service).Dispose(); | |
| 192 m_services.Remove(serviceType); | |
| 193 | |
| 194 // убираем связанные записи | |
| 195 if (se.associated != null) | |
| 196 foreach (var item in se.associated) | |
| 197 m_services.Remove(item); | |
| 198 } | |
| 199 } | |
| 200 | |
| 201 /// <summary> | |
| 202 /// Освобождает зарегистрированные сервисы (которые требуется освобоить). | |
| 203 /// </summary> | |
| 204 /// <param name="disposing">Призанак того, что нужно освободить ресурсы.</param> | |
| 205 protected override void Dispose(bool disposing) { | |
| 206 if (disposing) { | |
| 207 | |
| 208 foreach (var entry in m_services.Values) | |
| 209 if (!entry.shared && entry.service is IDisposable) | |
| 210 ((IDisposable)entry.service).Dispose(); | |
| 211 | |
| 212 } | |
| 213 base.Dispose(disposing); | |
| 214 } | |
| 215 } | |
| 216 } |