Minor edits: - Dart side adjustments following #1594. - Renamed example '3a' to just '3' and tweaked the logger message - Removed obsolete Dart block.
		
			
				
	
	
		
			278 lines
		
	
	
		
			7.1 KiB
		
	
	
	
		
			Dart
		
	
	
	
	
	
			
		
		
	
	
			278 lines
		
	
	
		
			7.1 KiB
		
	
	
	
		
			Dart
		
	
	
	
	
	
| // Examples of provider arrays
 | |
| // #docplaster
 | |
| import 'package:angular2/core.dart';
 | |
| 
 | |
| import 'app_config.dart';
 | |
| import 'heroes/hero_service_provider.dart';
 | |
| import 'heroes/hero_service.dart';
 | |
| import 'logger_service.dart';
 | |
| import 'user_service.dart';
 | |
| 
 | |
| // TODO file an issue: cannot use the following const in metadata.
 | |
| const template = '{{log}}';
 | |
| 
 | |
| @Component(
 | |
|     selector: 'provider-1',
 | |
|     template: '{{log}}',
 | |
|     // #docregion providers-1, providers-logger
 | |
|     providers: const [Logger]
 | |
|     // #enddocregion providers-1, providers-logger
 | |
| )
 | |
| class ProviderComponent1 {
 | |
|   String log;
 | |
| 
 | |
|   ProviderComponent1(Logger logger) {
 | |
|     logger.log('Hello from logger provided with Logger class');
 | |
|     log = logger.logs[0];
 | |
|   }
 | |
| }
 | |
| 
 | |
| /// Component just used to ensure that shared E2E tests pass.
 | |
| @Component(
 | |
|   selector: 'provider-3',
 | |
|   template: '{{log}}',
 | |
|   providers: 
 | |
|     // #docregion providers-3
 | |
|     const [const Provider(Logger, useClass: Logger)]
 | |
|     // #enddocregion providers-3
 | |
| )
 | |
| class ProviderComponent3 {
 | |
|   String log;
 | |
| 
 | |
|   ProviderComponent3(Logger logger) {
 | |
|     logger.log('Hello from logger provided with useClass:Logger');
 | |
|     log = logger.logs[0];
 | |
|   }
 | |
| }
 | |
| 
 | |
| @Injectable()
 | |
| class BetterLogger extends Logger {}
 | |
| 
 | |
| @Component(
 | |
|     selector: 'provider-4',
 | |
|     template: '{{log}}',
 | |
|     providers:
 | |
|       // #docregion providers-4
 | |
|       const [const Provider(Logger, useClass: BetterLogger)]
 | |
|       // #enddocregion providers-4
 | |
| )
 | |
| class ProviderComponent4 {
 | |
|   String log;
 | |
| 
 | |
|   ProviderComponent4(Logger logger) {
 | |
|     logger.log('Hello from logger provided with useClass:BetterLogger');
 | |
|     log = logger.logs[0];
 | |
|   }
 | |
| }
 | |
| 
 | |
| // #docregion EvenBetterLogger
 | |
| @Injectable()
 | |
| class EvenBetterLogger extends Logger {
 | |
|   final UserService _userService;
 | |
| 
 | |
|   EvenBetterLogger(this._userService);
 | |
| 
 | |
|   @override void log(String message) {
 | |
|     var name = _userService.user.name;
 | |
|     super.log('Message to $name: $message');
 | |
|   }
 | |
| }
 | |
| // #enddocregion EvenBetterLogger
 | |
| 
 | |
| @Component(
 | |
|     selector: 'provider-5',
 | |
|     template: '{{log}}',
 | |
|     providers:
 | |
|       // #docregion providers-5
 | |
|       const [UserService, const Provider(Logger, useClass: EvenBetterLogger)]
 | |
|       // #enddocregion providers-5
 | |
| )
 | |
| class ProviderComponent5 {
 | |
|   String log;
 | |
| 
 | |
|   ProviderComponent5(Logger logger) {
 | |
|     logger.log('Hello from EvenBetterlogger');
 | |
|     log = logger.logs[0];
 | |
|   }
 | |
| }
 | |
| 
 | |
| @Injectable()
 | |
| class NewLogger extends Logger implements OldLogger {}
 | |
| 
 | |
| class OldLogger extends Logger {
 | |
|   @override
 | |
|   void log(String message) {
 | |
|     throw new Exception('Should not call the old logger!');
 | |
|   }
 | |
| }
 | |
| 
 | |
| @Component(
 | |
|     selector: 'provider-6a',
 | |
|     template: '{{log}}',
 | |
|     providers:
 | |
|       // #docregion providers-6a
 | |
|       const [NewLogger,
 | |
|         // Not aliased! Creates two instances of `NewLogger`
 | |
|         const Provider(OldLogger, useClass: NewLogger)]
 | |
|       // #enddocregion providers-6a
 | |
| )
 | |
| class ProviderComponent6a {
 | |
|   String log;
 | |
| 
 | |
|   ProviderComponent6a(NewLogger newLogger, OldLogger oldLogger) {
 | |
|     if (newLogger == oldLogger) {
 | |
|       throw new Exception('expected the two loggers to be different instances');
 | |
|     }
 | |
|     oldLogger.log('Hello OldLogger (but we want NewLogger)');
 | |
|     // The newLogger wasn't called so no logs[]
 | |
|     // display the logs of the oldLogger.
 | |
|     log = newLogger.logs.isEmpty ? oldLogger.logs[0] : newLogger.logs[0];
 | |
|   }
 | |
| }
 | |
| 
 | |
| @Component(
 | |
|     selector: 'provider-6b',
 | |
|     template: '{{log}}',
 | |
|     providers:
 | |
|       // #docregion providers-6b
 | |
|       const [NewLogger,
 | |
|         // Alias OldLogger with reference to NewLogger
 | |
|         const Provider(OldLogger, useExisting: NewLogger)]
 | |
|       // #enddocregion providers-6b
 | |
| )
 | |
| class ProviderComponent6b {
 | |
|   String log;
 | |
| 
 | |
|   ProviderComponent6b(NewLogger newLogger, OldLogger oldLogger) {
 | |
|     if (newLogger != oldLogger) {
 | |
|       throw new Exception('expected the two loggers to be the same instance');
 | |
|     }
 | |
|     oldLogger.log('Hello from NewLogger (via aliased OldLogger)');
 | |
|     log = newLogger.logs[0];
 | |
|   }
 | |
| }
 | |
| 
 | |
| // #docregion silent-logger
 | |
| // #docregion const-class
 | |
| class SilentLogger implements Logger {
 | |
|   @override
 | |
|   final List<String> logs = const ['Silent logger says "Shhhhh!". Provided via "useValue"'];
 | |
| 
 | |
|   const SilentLogger();
 | |
| 
 | |
|   @override
 | |
|   void log(String message) { }
 | |
| }
 | |
| // #enddocregion const-class
 | |
| // #docregion const-object
 | |
| 
 | |
| const silentLogger = const SilentLogger();
 | |
| // #enddocregion const-object
 | |
| // #enddocregion silent-logger
 | |
| 
 | |
| @Component(
 | |
|   selector: 'provider-7',
 | |
|   template: '{{log}}',
 | |
|   providers:
 | |
|     // #docregion providers-7
 | |
|     const [const Provider(Logger, useValue: silentLogger)]
 | |
|     // #enddocregion providers-7
 | |
| )
 | |
| class ProviderComponent7 {
 | |
|   String log;
 | |
| 
 | |
|   ProviderComponent7(Logger logger) {
 | |
|     logger.log('Hello from logger provided with useValue');
 | |
|     log = logger.logs[0];
 | |
|   }
 | |
| }
 | |
| 
 | |
| @Component(
 | |
|   selector: 'provider-8',
 | |
|   template: '{{log}}',
 | |
|   providers: const [heroServiceProvider, Logger, UserService])
 | |
| class ProviderComponent8 {
 | |
|   // #docregion provider-8-ctor
 | |
|   ProviderComponent8(HeroService heroService);
 | |
|   // #enddocregion provider-8-ctor
 | |
| 
 | |
|   // must be true else this component would have blown up at runtime
 | |
|   var log = 'Hero service injected successfully via heroServiceProvider';
 | |
| }
 | |
| 
 | |
| @Component(
 | |
|   selector: 'provider-9',
 | |
|   template: '{{log}}',
 | |
|   // #docregion providers-9
 | |
|   providers: const [
 | |
|     const Provider(APP_CONFIG, useValue: heroDiConfig)]
 | |
|   // #enddocregion providers-9
 | |
| )
 | |
| class ProviderComponent9 implements OnInit {
 | |
|   Map _config;
 | |
|   String log;
 | |
| 
 | |
|   // #docregion provider-9-ctor
 | |
|   ProviderComponent9(@Inject(APP_CONFIG) this._config);
 | |
|   // #enddocregion provider-9-ctor
 | |
| 
 | |
|   @override
 | |
|   void ngOnInit() {
 | |
|     log = 'APP_CONFIG Application title is ${_config['title']}';
 | |
|   }
 | |
| }
 | |
| 
 | |
| // Sample providers 1 to 7 illustrate a required logger dependency.
 | |
| // Optional logger, can be null.
 | |
| @Component(selector: 'provider-10', template: '{{log}}')
 | |
| class ProviderComponent10 implements OnInit {
 | |
|   final Logger _logger;
 | |
|   String log;
 | |
| 
 | |
|   /*
 | |
|   // #docregion provider-10-ctor
 | |
|   HeroService(@Optional() this._logger) {
 | |
|   // #enddocregion provider-10-ctor
 | |
|    */
 | |
|   ProviderComponent10(@Optional() this._logger) {
 | |
|     const someMessage = 'Hello from the injected logger';
 | |
|     // #docregion provider-10-ctor
 | |
|     if (_logger != null)
 | |
|       _logger.log(someMessage);
 | |
|   }
 | |
|   // #enddocregion provider-10-ctor
 | |
| 
 | |
|   @override
 | |
|   void ngOnInit() {
 | |
|     log = _logger == null ? 'Optional logger was not available' : _logger.logs[0];
 | |
|   }
 | |
| }
 | |
| 
 | |
| @Component(
 | |
|     selector: 'my-providers',
 | |
|     template: '''
 | |
|       <h2>Provider variations</h2>
 | |
|       <div id="p1"><provider-1></provider-1></div>
 | |
|       <div id="p3"><provider-3></provider-3></div>
 | |
|       <div id="p4"><provider-4></provider-4></div>
 | |
|       <div id="p5"><provider-5></provider-5></div>
 | |
|       <div id="p6a"><provider-6a></provider-6a></div>
 | |
|       <div id="p6b"><provider-6b></provider-6b></div>
 | |
|       <div id="p7"><provider-7></provider-7></div>
 | |
|       <div id="p8"><provider-8></provider-8></div>
 | |
|       <div id="p9"><provider-9></provider-9></div>
 | |
|       <div id="p10"><provider-10></provider-10></div>''',
 | |
|     directives: const [
 | |
|       ProviderComponent1,
 | |
|       ProviderComponent3,
 | |
|       ProviderComponent4,
 | |
|       ProviderComponent5,
 | |
|       ProviderComponent6a,
 | |
|       ProviderComponent6b,
 | |
|       ProviderComponent7,
 | |
|       ProviderComponent8,
 | |
|       ProviderComponent9,
 | |
|       ProviderComponent10
 | |
|     ])
 | |
| class ProvidersComponent {}
 |