##// END OF EJS Templates
ServiceLocator: fixed services cleanup
cin -
r88:c4877ae77cee v2
parent child
Show More
@@ -1,249 +1,248
1 using System;
1 using System;
2 using System.Collections.Generic;
2 using System.Collections.Generic;
3
3
4 namespace Implab {
4 namespace Implab {
5 /// <summary>
5 /// <summary>
6 /// Коллекция сервисов, позволяет регистрировать и получать сервисы.
6 /// Коллекция сервисов, позволяет регистрировать и получать сервисы.
7 /// </summary>
7 /// </summary>
8 public class ServiceLocator: Component, IServiceLocator, IServiceProvider {
8 public class ServiceLocator: Component, IServiceLocator, IServiceProvider {
9 // запись о сервисе
9 // запись о сервисе
10 struct ServiceEntry : IDisposable {
10 struct ServiceEntry : IDisposable {
11 public object service; // сервис
11 public object service; // сервис
12 public bool shared; // признак того, что сервис НЕ нужно освобождать
12 public bool shared; // признак того, что сервис НЕ нужно освобождать
13 public Func<object> activator; // активатор сервиса при первом обращении
13 public Func<object> activator; // активатор сервиса при первом обращении
14 public Action<object> cleanup; // функция для очистки сервиса
14 public Action<object> cleanup; // функция для очистки сервиса
15 public List<Type> associated; // ссылки на текущую запись
15 public List<Type> associated; // ссылки на текущую запись
16 public Type origin; // ссылка на оригинальную запись о сервисе
16 public Type origin; // ссылка на оригинальную запись о сервисе
17
17
18 #region IDisposable implementation
18 #region IDisposable implementation
19
19
20 public void Dispose() {
20 public void Dispose() {
21 if (shared)
21 if (shared)
22 return;
22 return;
23 if (cleanup != null)
23 if (cleanup != null) {
24 cleanup(service);
24 if (service != null)
25 else {
25 cleanup(service);
26 var d = service as IDisposable;
26 } else
27 if (d != null)
27 Safe.Dispose(service);
28 d.Dispose();
29 }
30 }
28 }
31
29
32 #endregion
30 #endregion
33 }
31 }
34
32
35 // словарь существующих сервисов
33 // словарь существующих сервисов
36 readonly Dictionary<Type, ServiceEntry> m_services = new Dictionary<Type,ServiceEntry>();
34 readonly Dictionary<Type, ServiceEntry> m_services = new Dictionary<Type,ServiceEntry>();
37
35
38 /// <summary>
36 /// <summary>
39 /// Получает объект предоставляющий сервис <typeparamref name="T"/>.
37 /// Получает объект предоставляющий сервис <typeparamref name="T"/>.
40 /// </summary>
38 /// </summary>
41 /// <typeparam name="T">Тип запрашиваемого сервиса</typeparam>
39 /// <typeparam name="T">Тип запрашиваемого сервиса</typeparam>
42 /// <returns>Объект, реализующий сервис</returns>
40 /// <returns>Объект, реализующий сервис</returns>
43 /// <exception cref="KeyNotFoundException">Сервис не зарегистрирован</exception>
41 /// <exception cref="KeyNotFoundException">Сервис не зарегистрирован</exception>
44 public T GetService<T>() {
42 public T GetService<T>() {
45 object result;
43 object result;
46 if (TryGetService(typeof(T), out result))
44 if (TryGetService(typeof(T), out result))
47 return (T)result;
45 return (T)result;
48 throw new ApplicationException (String.Format ("{0} doesn't provide {1} service", this, typeof(T)));
46 throw new ApplicationException (String.Format ("{0} doesn't provide {1} service", this, typeof(T)));
49 }
47 }
50
48
51
49
52 /// <summary>
50 /// <summary>
53 /// Пытается получить указанный сервис, в случае, если компонента не предоставляет требуемый сервис
51 /// Пытается получить указанный сервис, в случае, если компонента не предоставляет требуемый сервис
54 /// не возникает исключений.
52 /// не возникает исключений.
55 /// </summary>
53 /// </summary>
56 /// <typeparam name="T">Тип требуемого сервиса.</typeparam>
54 /// <typeparam name="T">Тип требуемого сервиса.</typeparam>
57 /// <param name="service">Объект реализующий сервис, или <c>default(T)</c> если такового нет.</param>
55 /// <param name="service">Объект реализующий сервис, или <c>default(T)</c> если такового нет.</param>
58 /// <returns><c>true</c> - сервис найден, <c>false</c> - сервис не зарегистрирован.</returns>
56 /// <returns><c>true</c> - сервис найден, <c>false</c> - сервис не зарегистрирован.</returns>
59 public bool TryGetService<T>(out T service) {
57 public bool TryGetService<T>(out T service) {
60 object result;
58 object result;
61 if (TryGetService(typeof(T), out result)) {
59 if (TryGetService(typeof(T), out result)) {
62 service = (T)result;
60 service = (T)result;
63 return true;
61 return true;
64 }
62 }
65 service = default(T);
63 service = default(T);
66 return false;
64 return false;
67 }
65 }
68
66
69 /// <summary>
67 /// <summary>
70 /// Получает объект предоставляющий сервис <paramref name="serviceType"/>
68 /// Получает объект предоставляющий сервис <paramref name="serviceType"/>
71 /// </summary>
69 /// </summary>
72 /// <param name="serviceType">Тип запрашиваемого сервиса</param>
70 /// <param name="serviceType">Тип запрашиваемого сервиса</param>
73 /// <returns>Объект, реализующий сервис</returns>
71 /// <returns>Объект, реализующий сервис</returns>
74 /// <exception cref="KeyNotFoundException">Сервис не зарегистрирован</exception>
72 /// <exception cref="KeyNotFoundException">Сервис не зарегистрирован</exception>
75 public object GetService(Type serviceType) {
73 public object GetService(Type serviceType) {
76 object result;
74 object result;
77 if (TryGetService(serviceType, out result))
75 if (TryGetService(serviceType, out result))
78 return result;
76 return result;
79 throw new ApplicationException (String.Format ("{0} doesn't provide {1} service", this, serviceType));
77 throw new ApplicationException (String.Format ("{0} doesn't provide {1} service", this, serviceType));
80 }
78 }
81
79
82 /// <summary>
80 /// <summary>
83 /// Пытается получить требуемый сервис или совместимый с ним.
81 /// Пытается получить требуемый сервис или совместимый с ним.
84 /// </summary>
82 /// </summary>
85 /// <returns><c>true</c>, если сервис был найден, <c>false</c> в противном случае..</returns>
83 /// <returns><c>true</c>, если сервис был найден, <c>false</c> в противном случае..</returns>
86 /// <param name="serviceType">Тип запрашиваемого сервиса.</param>
84 /// <param name="serviceType">Тип запрашиваемого сервиса.</param>
87 /// <param name="service">Искомый сервис.</param>
85 /// <param name="service">Искомый сервис.</param>
88 public virtual bool TryGetService(Type serviceType, out object service) {
86 public virtual bool TryGetService(Type serviceType, out object service) {
89 Safe.ArgumentNotNull(serviceType, "serviceType");
87 Safe.ArgumentNotNull(serviceType, "serviceType");
90 AssertNotDisposed();
88 AssertNotDisposed();
91
89
92 ServiceEntry se;
90 ServiceEntry se;
93 if (!m_services.TryGetValue(serviceType, out se)) {
91 if (!m_services.TryGetValue(serviceType, out se)) {
94 // ищем ближайщий объект, реализующий нужный сервис
92 // ищем ближайщий объект, реализующий нужный сервис
95 Type pt = null;
93 Type pt = null;
96 foreach (var t in m_services.Keys)
94 foreach (var t in m_services.Keys)
97 if (serviceType.IsAssignableFrom(t) && (pt == null || t.IsAssignableFrom(pt)))
95 if (serviceType.IsAssignableFrom(t) && (pt == null || t.IsAssignableFrom(pt)))
98 pt = t;
96 pt = t;
99
97
100 if (pt == null) {
98 if (pt == null) {
101 // нет нужного сервиса
99 // нет нужного сервиса
102 service = null;
100 service = null;
103 return false;
101 return false;
104 }
102 }
105
103
106 var pe = m_services[pt];
104 var pe = m_services[pt];
107
105
108 // найденная запись может ссылаться на оригинальную запись с сервисом
106 // найденная запись может ссылаться на оригинальную запись с сервисом
109 if(pe.origin != null) {
107 if(pe.origin != null) {
110 pt = pe.origin;
108 pt = pe.origin;
111 pe = m_services[pt];
109 pe = m_services[pt];
112 }
110 }
113
111
114 // добавляем список с обратными ссылками
112 // добавляем список с обратными ссылками
115 if (pe.associated == null)
113 if (pe.associated == null)
116 pe.associated = new List<Type>();
114 pe.associated = new List<Type>();
117
115
118 pe.associated.Add(serviceType);
116 pe.associated.Add(serviceType);
119
117
120 // обновляем родительскую запись
118 // обновляем родительскую запись
121 m_services[pt] = pe;
119 m_services[pt] = pe;
122
120
123 // создаем запись со ссылкой
121 // создаем запись со ссылкой
124 se = new ServiceEntry {
122 se = new ServiceEntry {
125 service = pe.service,
123 service = pe.service,
126 origin = pt,
124 origin = pt,
127 shared = true // предотвращаем множественные попытки освобождения
125 shared = true // предотвращаем множественные попытки освобождения
128 };
126 };
129
127
130 m_services[serviceType] = se;
128 m_services[serviceType] = se;
131 }
129 }
132
130
133 // запись содержит в себе информацию о сервисе
131 // запись содержит в себе информацию о сервисе
134 if (se.service != null) {
132 if (se.service != null) {
135 service = se.service;
133 service = se.service;
136 return true;
134 return true;
137 }
135 }
138
136
139 // текущая запись является ссылкой
137 // текущая запись является ссылкой
140 if (se.origin != null) {
138 if (se.origin != null) {
141 se.service = GetService(se.origin);
139 se.service = GetService(se.origin);
142 m_services[serviceType] = se;
140 m_services[serviceType] = se;
143 service = se.service;
141 service = se.service;
144 return true;
142 return true;
145 }
143 }
146
144
147 // текущая запись не является ссылкой и не имеет информации о сервисе
145 // текущая запись не является ссылкой и не имеет информации о сервисе
148 // она должна сожержать информацию об активации
146 // она должна сожержать информацию об активации
149 if (se.activator != null) {
147 if (se.activator != null) {
150 se.service = se.activator();
148 se.service = se.activator();
151
149
152 m_services[serviceType] = se;
150 m_services[serviceType] = se;
153
151
154 service = se.service;
152 service = se.service;
155 return true;
153 return true;
156 }
154 }
157
155
158 service = null;
156 service = null;
159 return false;
157 return false;
160 }
158 }
161
159
162 /// <summary>
160 /// <summary>
163 /// Регистрирует фабрику для активации сервиса по первому требованию.
161 /// Регистрирует фабрику для активации сервиса по первому требованию.
164 /// </summary>
162 /// </summary>
165 /// <typeparam name="T">Тип регистрируемого сервиса.</typeparam>
163 /// <typeparam name="T">Тип регистрируемого сервиса.</typeparam>
166 /// <param name="activator">Фабрика для создания/получения объекта, предоставляющего сервис.</param>
164 /// <param name="activator">Фабрика для создания/получения объекта, предоставляющего сервис.</param>
167 /// <param name = "cleanup">Метод для освобождения экземпляра сервиса, будет вызыван при освобождении сервис-локатора.</param>
165 /// <param name = "cleanup">Метод для освобождения экземпляра сервиса, будет вызыван при освобождении сервис-локатора.</param>
168 /// <remarks>При освобождении сервис-локатора, сервисы полученные в результате активации также будут освобождены.</remarks>
166 /// <remarks>При освобождении сервис-локатора, сервисы полученные в результате активации также будут освобождены.</remarks>
169 public void Register<T>(Func<T> activator, Action<T> cleanup) {
167 public void Register<T>(Func<T> activator, Action<T> cleanup) {
170 Safe.ArgumentNotNull(activator, "activator");
168 Safe.ArgumentNotNull(activator, "activator");
171
169
172 AssertNotDisposed();
170 AssertNotDisposed();
173
171
174 Unregister(typeof(T));
172 Unregister(typeof(T));
175
173
176 m_services[typeof(T)] = new ServiceEntry {
174 var serviceEntry = new ServiceEntry();
177 activator = () => activator(),
175 serviceEntry.activator = () => activator();
178 cleanup = instance => cleanup((T)instance)
176 if (cleanup != null)
179 };
177 serviceEntry.cleanup = instance => cleanup((T)instance);
178 m_services[typeof(T)] = serviceEntry;
180 }
179 }
181
180
182 public void Register<T>(Func<T> activator) {
181 public void Register<T>(Func<T> activator) {
183 Register(activator, null);
182 Register(activator, null);
184 }
183 }
185
184
186 /// <summary>
185 /// <summary>
187 /// Регистрирует объект, предоставляющий сервис.
186 /// Регистрирует объект, предоставляющий сервис.
188 /// </summary>
187 /// </summary>
189 /// <typeparam name="T">Тип регистрируемого сервиса.</typeparam>
188 /// <typeparam name="T">Тип регистрируемого сервиса.</typeparam>
190 /// <param name="service">Объект, предоставляющий сервис.</param>
189 /// <param name="service">Объект, предоставляющий сервис.</param>
191 /// <exception cref="InvalidOperationException">Указанный сервис уже зарегистрирован.</exception>
190 /// <exception cref="InvalidOperationException">Указанный сервис уже зарегистрирован.</exception>
192 /// <remarks>Сервис-локатором не управляет временем жизни объекта для зарегистрированного сервиса.</remarks>
191 /// <remarks>Сервис-локатором не управляет временем жизни объекта для зарегистрированного сервиса.</remarks>
193 public void Register<T>(T service) {
192 public void Register<T>(T service) {
194 Register(service, true);
193 Register(service, true);
195 }
194 }
196
195
197 /// <summary>
196 /// <summary>
198 /// Регистрирует объект, предоставляющий сервис. Повторная регистрация отменяет уже существующую.
197 /// Регистрирует объект, предоставляющий сервис. Повторная регистрация отменяет уже существующую.
199 /// </summary>
198 /// </summary>
200 /// <typeparam name="T">Тип регистрируемого сервиса.</typeparam>
199 /// <typeparam name="T">Тип регистрируемого сервиса.</typeparam>
201 /// <param name="service">Объект, предоставляющий сервис.</param>
200 /// <param name="service">Объект, предоставляющий сервис.</param>
202 /// <param name="shared">Признак того, что объект является разделяемым и сервис-локатор не должен его освобождать.</param>
201 /// <param name="shared">Признак того, что объект является разделяемым и сервис-локатор не должен его освобождать.</param>
203 public void Register<T>(T service, bool shared) {
202 public void Register<T>(T service, bool shared) {
204 Safe.ArgumentNotNull(service, "service");
203 Safe.ArgumentNotNull(service, "service");
205
204
206 AssertNotDisposed();
205 AssertNotDisposed();
207
206
208 Unregister(typeof(T));
207 Unregister(typeof(T));
209
208
210 m_services[typeof(T)] = new ServiceEntry { service = service, shared = shared };
209 m_services[typeof(T)] = new ServiceEntry { service = service, shared = shared };
211 }
210 }
212
211
213 public void Unregister(Type serviceType) {
212 public void Unregister(Type serviceType) {
214 Safe.ArgumentNotNull(serviceType, "serviceType");
213 Safe.ArgumentNotNull(serviceType, "serviceType");
215
214
216 AssertNotDisposed();
215 AssertNotDisposed();
217
216
218 ServiceEntry se;
217 ServiceEntry se;
219 if (m_services.TryGetValue(serviceType, out se)) {
218 if (m_services.TryGetValue(serviceType, out se)) {
220 if (se.origin != null) {
219 if (se.origin != null) {
221 var pe = m_services[se.origin];
220 var pe = m_services[se.origin];
222 pe.associated.Remove(serviceType);
221 pe.associated.Remove(serviceType);
223 }
222 }
224 // освобождаем ресурсы
223 // освобождаем ресурсы
225 se.Dispose();
224 se.Dispose();
226 m_services.Remove(serviceType);
225 m_services.Remove(serviceType);
227
226
228 // убираем связанные записи
227 // убираем связанные записи
229 if (se.associated != null)
228 if (se.associated != null)
230 foreach (var item in se.associated)
229 foreach (var item in se.associated)
231 m_services.Remove(item);
230 m_services.Remove(item);
232 }
231 }
233 }
232 }
234
233
235 /// <summary>
234 /// <summary>
236 /// Освобождает зарегистрированные сервисы (которые требуется освобоить).
235 /// Освобождает зарегистрированные сервисы (которые требуется освобоить).
237 /// </summary>
236 /// </summary>
238 /// <param name="disposing">Призанак того, что нужно освободить ресурсы.</param>
237 /// <param name="disposing">Призанак того, что нужно освободить ресурсы.</param>
239 protected override void Dispose(bool disposing) {
238 protected override void Dispose(bool disposing) {
240 if (disposing) {
239 if (disposing) {
241
240
242 foreach (var entry in m_services.Values)
241 foreach (var entry in m_services.Values)
243 entry.Dispose();
242 entry.Dispose();
244
243
245 }
244 }
246 base.Dispose(disposing);
245 base.Dispose(disposing);
247 }
246 }
248 }
247 }
249 } No newline at end of file
248 }
General Comments 0
You need to be logged in to leave comments. Login now