Files
cherrypick/cherrypick/lib/src/binding.dart
Sergey Penkovsky efed72cc39 refactor(core,logger)migrate to CherryPickObserver API and drop CherryPickLogger
BREAKING CHANGE:
- Removed the deprecated CherryPickLogger interface from cherrypick
- Logger/adapters (e.g., talker_cherrypick_logger) must now implement CherryPickObserver
- talker_cherrypick_logger: replace TalkerCherryPickLogger with TalkerCherryPickObserver
- All usages, docs, tests migrated to observer API
- Improved test mocks and integration tests for observer pattern
- Removed obsolete files: cherrypick/src/logger.dart, talker_cherrypick_logger/src/talker_cherrypick_logger.dart
- Updated README and example usages for new CherryPickObserver model

This refactor introduces a unified observer pattern (CherryPickObserver) to handle all DI lifecycle events, replacing the limited info/warn/error logger pattern.
All external logging adapters and integrations must migrate to use CherryPickObserver.
2025-08-12 00:29:41 +03:00

227 lines
6.7 KiB
Dart
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

//
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// https://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import 'package:cherrypick/src/binding_resolver.dart';
/// RU: Класс Binding<T> настраивает параметры экземпляра.
/// ENG: The Binding<T> class configures the settings for the instance.
///
import 'package:cherrypick/src/observer.dart';
class Binding<T> {
late Type _key;
String? _name;
BindingResolver<T>? _resolver;
CherryPickObserver? observer;
// Deferred logging flags
bool _createdLogged = false;
bool _namedLogged = false;
bool _singletonLogged = false;
Binding({this.observer}) {
_key = T;
// Deferred уведомения observer, не логировать здесь напрямую
}
void markCreated() {
if (!_createdLogged) {
observer?.onBindingRegistered(
runtimeType.toString(),
T,
);
_createdLogged = true;
}
}
void markNamed() {
if (isNamed && !_namedLogged) {
observer?.onDiagnostic(
'Binding named: ${T.toString()} name: $_name',
details: {
'type': 'Binding',
'name': T.toString(),
'nameParam': _name,
'description': 'named',
},
);
_namedLogged = true;
}
}
void markSingleton() {
if (isSingleton && !_singletonLogged) {
observer?.onDiagnostic(
'Binding singleton: ${T.toString()}${_name != null ? ' name: $_name' : ''}',
details: {
'type': 'Binding',
'name': T.toString(),
if (_name != null) 'name': _name,
'description': 'singleton mode enabled',
},
);
_singletonLogged = true;
}
}
void logAllDeferred() {
markCreated();
markNamed();
markSingleton();
}
/// RU: Метод возвращает тип экземпляра.
/// ENG: The method returns the type of the instance.
///
/// return [Type]
Type get key => _key;
/// RU: Метод возвращает имя экземпляра.
/// ENG: The method returns the name of the instance.
///
/// return [String]
String? get name => _name;
/// RU: Метод проверяет именован экземпляр или нет.
/// ENG: The method checks whether the instance is named or not.
///
/// return [bool]
bool get isNamed => _name != null;
/// RU: Метод проверяет сингелтон экземпляр или нет.
/// ENG: The method checks the singleton instance or not.
///
/// return [bool]
bool get isSingleton => _resolver?.isSingleton ?? false;
BindingResolver<T>? get resolver => _resolver;
/// RU: Добавляет имя для экземляпя [value].
/// ENG: Added name for instance [value].
///
/// return [Binding]
Binding<T> withName(String name) {
_name = name;
// Не логируем здесь, deferred log via markNamed()
return this;
}
/// RU: Инициализация экземляпяра [value].
/// ENG: Initialization instance [value].
///
/// return [Binding]
Binding<T> toInstance(Instance<T> value) {
_resolver = InstanceResolver<T>(value);
return this;
}
/// RU: Инициализация экземляпяра  через провайдер [value].
/// ENG: Initialization instance via provider [value].
///
/// return [Binding]
Binding<T> toProvide(Provider<T> value) {
_resolver = ProviderResolver<T>((_) => value.call(), withParams: false);
return this;
}
/// RU: Инициализация экземляпяра  через провайдер [value] c динамическим параметром.
/// ENG: Initialization instance via provider [value] with a dynamic param.
///
/// return [Binding]
Binding<T> toProvideWithParams(ProviderWithParams<T> value) {
_resolver = ProviderResolver<T>(value, withParams: true);
return this;
}
@Deprecated('Use toInstance instead of toInstanceAsync')
Binding<T> toInstanceAsync(Instance<T> value) {
return this.toInstance(value);
}
@Deprecated('Use toProvide instead of toProvideAsync')
Binding<T> toProvideAsync(Provider<T> value) {
return this.toProvide(value);
}
@Deprecated('Use toProvideWithParams instead of toProvideAsyncWithParams')
Binding<T> toProvideAsyncWithParams(ProviderWithParams<T> value) {
return this.toProvideWithParams(value);
}
/// RU: Инициализация экземляпяра  как сингелтон [value].
/// ENG: Initialization instance as a singelton [value].
///
/// return [Binding]
Binding<T> singleton() {
_resolver?.toSingleton();
// Не логируем здесь, deferred log via markSingleton()
return this;
}
T? resolveSync([dynamic params]) {
final res = resolver?.resolveSync(params);
if (res != null) {
observer?.onDiagnostic(
'Binding resolved instance: ${T.toString()}',
details: {
if (_name != null) 'name': _name,
'method': 'resolveSync',
'description': 'object created/resolved',
},
);
} else {
observer?.onWarning(
'resolveSync returned null: ${T.toString()}',
details: {
if (_name != null) 'name': _name,
'method': 'resolveSync',
'description': 'resolveSync returned null',
},
);
}
return res;
}
Future<T>? resolveAsync([dynamic params]) {
final future = resolver?.resolveAsync(params);
if (future != null) {
future
.then((res) => observer?.onDiagnostic(
'Future resolved for: ${T.toString()}',
details: {
if (_name != null) 'name': _name,
'method': 'resolveAsync',
'description': 'Future resolved',
},
))
.catchError((e, s) => observer?.onError(
'resolveAsync error: ${T.toString()}',
e,
s,
));
} else {
observer?.onWarning(
'resolveAsync returned null: ${T.toString()}',
details: {
if (_name != null) 'name': _name,
'method': 'resolveAsync',
'description': 'resolveAsync returned null',
},
);
}
return future;
}
}