Repository navigation
Expand file tree
/
Copy pathApplicationBuilder.php
More file actions
357 lines (349 loc) · 19 KB
/
Copy pathApplicationBuilder.php
File metadata and controls
357 lines (349 loc) · 19 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
<?php
declare(strict_types=1);
namespace Loom;
/**
* 应用的组合根,对应 ASP.NET Core 的 WebApplicationBuilder。构造时读取环境文件和 config/,并登记框架默认服务;
* 应用在 build() 之前通过 $services 追加或覆盖登记。
*
* build() 时扫描 addModule() 登记的模块:带 Singleton / Scoped / Component(可选 Bind)注解的类按生命周期 tryAdd 补登记(应用已登记的标识不覆盖),
* 控制器路由进入路由表,Command 注解类进入命令表,Timer 类交给 TimerRunner。
*
* @example $builder = Application::createBuilder(__DIR__); $builder->addModule(\App\AppModule::class); $builder->services->addSingleton(Clock::class); $app = $builder->build();
*/
final class ApplicationBuilder
{
public readonly ServiceCollection $services;
public readonly Config $configuration;
public readonly \Loom\MonitoringBuilder $monitoring;
public readonly \Loom\Filesystem\FilesystemBuilder $filesystems;
public readonly \Loom\Events\EventsBuilder $events;
public readonly \Loom\CacheBuilder $cache;
public readonly \Loom\Logging\DiaryBuilder $diary;
public readonly \Loom\QueueBuilder $queue;
public readonly \Loom\Mail\MailBuilder $mail;
private \Loom\Events\EventsRegistration $eventsRegistration;
private bool $built = false;
/** @var list<\Closure> */
private array $onStopHandlers = [];
/** @var list<string> */
private array $modules = [];
/**
* @param string $root 项目根目录。
* @param ?string $environmentFile 先加载的 .env 文件;null 表示不加载。
*/
public function __construct(string $root, ?string $environmentFile = null)
{
if ($environmentFile !== null) {
Environment::load($environmentFile);
}
$this->configuration = new Config($root);
$this->configuration->load();
$this->services = new ServiceCollection();
$services = $this->services;
$services->addInstance(Config::class, $this->configuration);
$services->addSingleton(Options::class);
$services->addSingleton(Network::class);
$services->addSingleton(Process::class);
$services->addSingleton(StopSignal::class);
$services->addSingleton(Host::class);
$services->addSingleton(HttpServer::class);
$services->addSingleton(TcpServer::class);
$services->addSingleton(GrpcServer::class);
$diaryRegistration = new \Loom\Logging\DiaryRegistration();
$services->addInstance(\Loom\Logging\DiaryRegistration::class, $diaryRegistration);
$this->diary = new \Loom\Logging\DiaryBuilder($diaryRegistration);
$queueRegistration = new \Loom\QueueRegistration();
$services->addInstance(\Loom\QueueRegistration::class, $queueRegistration);
$this->queue = new \Loom\QueueBuilder($queueRegistration);
$mailRegistration = new \Loom\Mail\MailRegistration();
$services->addInstance(\Loom\Mail\MailRegistration::class, $mailRegistration);
$this->mail = new \Loom\Mail\MailBuilder($mailRegistration);
$services->tryAddScoped(\Loom\Queue::class);
$services->tryAddScoped(\Loom\Events\EventListenJob::class);
$services->configure(HttpServerOptions::class, 'http');
$services->tryAddSingleton(\Loom\Logging\DiaryOptions::class, static function (ServiceResolver $resolver): \Loom\Logging\DiaryOptions {
$bound = $resolver->get(Options::class)->bindOptional(\Loom\Logging\DiaryOptions::class, 'diary');
if (!($bound instanceof \Loom\Logging\DiaryOptions)) {
throw new \LogicException('DiaryOptions binding must return DiaryOptions');
}
return $bound;
});
$services->tryAddSingleton(\Loom\Logging\JournalWriter::class, static function (ServiceResolver $resolver): \Loom\Logging\JournalWriter {
$options = $resolver->get(\Loom\Logging\DiaryOptions::class);
return \Loom\Logging\DiaryComposer::createWriter(
$options,
$resolver->get(\Loom\Logging\DiaryRegistration::class),
$resolver->get(Config::class),
);
});
$services->tryAddSingleton(\Loom\Logging\JournalFormatter::class, static function (ServiceResolver $resolver): \Loom\Logging\JournalFormatter {
$options = $resolver->get(\Loom\Logging\DiaryOptions::class);
return \Loom\Logging\DiaryComposer::formatter(
$options->formatter,
$options,
$resolver->get(\Loom\Logging\DiaryRegistration::class),
$resolver->get(Config::class),
[],
);
});
$services->tryAddSingleton(\Loom\Logging\Diary::class, static function (ServiceResolver $resolver): \Loom\Logging\Diary {
$options = $resolver->get(\Loom\Logging\DiaryOptions::class);
$sink = \Loom\Logging\DiaryComposer::createSink(
$options,
$resolver->get(\Loom\Logging\DiaryRegistration::class),
$resolver->get(Config::class),
);
return new \Loom\Logging\Diary($sink, null, $options->level);
});
$services->tryAddSingleton(\Loom\RedisOptions::class, static function (ServiceResolver $resolver): \Loom\RedisOptions {
$bound = $resolver->get(Options::class)->bindOptional(\Loom\RedisOptions::class, 'redis');
if (!($bound instanceof \Loom\RedisOptions)) {
throw new \LogicException('RedisOptions binding must return RedisOptions');
}
return $bound;
});
$services->tryAddSingleton(\Loom\QueueOptions::class, static function (ServiceResolver $resolver): \Loom\QueueOptions {
$bound = $resolver->get(Options::class)->bindOptional(\Loom\QueueOptions::class, 'queue');
if (!($bound instanceof \Loom\QueueOptions)) {
throw new \LogicException('QueueOptions binding must return QueueOptions');
}
return $bound;
});
$services->tryAddSingleton(\Loom\QueueBackend::class, static function (ServiceResolver $resolver): \Loom\QueueBackend {
$options = $resolver->get(\Loom\QueueOptions::class);
$profile = $options->connectionProfile($options->default);
$factory = $resolver->get(\Loom\QueueRegistration::class)->factory($profile['driver']);
if ($factory !== null) {
$instance = $factory($resolver);
if (!$instance instanceof \Loom\QueueBackend) {
throw new \LogicException('Queue driver factory must return QueueBackend');
}
return $instance;
}
if ($profile['driver'] !== 'redis') {
throw new \LogicException('Unsupported queue driver: ' . $profile['driver']);
}
return new \Loom\RedisQueue(
$resolver->get(Config::class),
(string)($profile['connection'] ?? ''),
(string)($profile['name'] ?? ''),
);
});
$services->tryAddSingleton(\Loom\RedisQueue::class, static function (ServiceResolver $resolver): \Loom\RedisQueue {
$backend = $resolver->get(\Loom\QueueBackend::class);
if (!$backend instanceof \Loom\RedisQueue) {
throw new \LogicException('RedisQueue is only registered when the queue driver is redis');
}
return $backend;
});
$services->tryAddSingleton(\Loom\Mail\MailOptions::class, static function (ServiceResolver $resolver): \Loom\Mail\MailOptions {
$bound = $resolver->get(Options::class)->bindOptional(\Loom\Mail\MailOptions::class, 'mail');
if (!($bound instanceof \Loom\Mail\MailOptions)) {
throw new \LogicException('MailOptions binding must return MailOptions');
}
return $bound;
});
$services->tryAddSingleton(\Loom\Mail\Mailer::class);
$services->addHostedService(TimerHostedService::class);
$services->addScoped(Database::class);
$services->addScoped(RequestContext::class);
$services->tryAddSingleton(\Loom\WebSocket\Hub::class);
$services->tryAddScoped(\Loom\WebSocket\HandlerDispatcher::class);
$services->tryAddScoped(\Loom\WebSocket::class);
$services->addScoped(\Loom\Monitoring\CorrelationId::class);
$services->tryAddScoped(\Loom\Monitoring\Monitoring::class, \Loom\Monitoring\LoggingMonitoring::class);
$monitoringRegistration = new \Loom\Monitoring\MonitoringRegistration();
$services->addInstance(\Loom\Monitoring\MonitoringRegistration::class, $monitoringRegistration);
$this->monitoring = new \Loom\MonitoringBuilder($services, $monitoringRegistration);
$filesystemRegistration = new \Loom\Filesystem\FilesystemRegistration();
$services->addInstance(\Loom\Filesystem\FilesystemRegistration::class, $filesystemRegistration);
$this->filesystems = new \Loom\Filesystem\FilesystemBuilder($filesystemRegistration);
$this->eventsRegistration = new \Loom\Events\EventsRegistration();
$services->addInstance(\Loom\Events\EventsRegistration::class, $this->eventsRegistration);
$this->events = new \Loom\Events\EventsBuilder($this->eventsRegistration);
$services->tryAddSingleton(\Loom\Filesystem\FilesystemOptions::class, static function (ServiceResolver $resolver): \Loom\Filesystem\FilesystemOptions {
$bound = $resolver->get(Options::class)->bindOptional(\Loom\Filesystem\FilesystemOptions::class, 'filesystems');
if (!($bound instanceof \Loom\Filesystem\FilesystemOptions)) {
throw new \LogicException('FilesystemOptions binding must return FilesystemOptions');
}
return $bound;
});
$services->tryAddSingleton(\Loom\Filesystem\Filesystem::class, static function (ServiceResolver $resolver): \Loom\Filesystem\Filesystem {
return new \Loom\Filesystem\Filesystem(
$resolver->get(Config::class),
$resolver->get(\Loom\Filesystem\FilesystemOptions::class),
$resolver->get(\Loom\Filesystem\FilesystemRegistration::class),
);
});
$cacheRegistration = new \Loom\CacheRegistration();
$services->addInstance(\Loom\CacheRegistration::class, $cacheRegistration);
$this->cache = new \Loom\CacheBuilder($services, $cacheRegistration);
$services->tryAddSingleton(\Loom\CacheOptions::class, static function (ServiceResolver $resolver): \Loom\CacheOptions {
$bound = $resolver->get(Options::class)->bindOptional(\Loom\CacheOptions::class, 'cache');
if (!($bound instanceof \Loom\CacheOptions)) {
throw new \LogicException('CacheOptions binding must return CacheOptions');
}
return $bound;
});
$services->tryAddSingleton(\Loom\Cache::class, static function (ServiceResolver $resolver): \Loom\Cache {
return new \Loom\Cache(
$resolver->get(\Loom\CacheOptions::class),
$resolver->get(\Loom\CacheRegistration::class),
);
});
$services->tryAddSingleton(\Loom\Monitoring\MonitoringOptions::class, static function (ServiceResolver $resolver): \Loom\Monitoring\MonitoringOptions {
$bound = $resolver->get(Options::class)->bindOptional(\Loom\Monitoring\MonitoringOptions::class, 'monitoring');
if (!($bound instanceof \Loom\Monitoring\MonitoringOptions)) {
throw new \LogicException('MonitoringOptions binding must return MonitoringOptions');
}
$bound->finalize();
return $bound;
});
$services->tryAddSingleton(\Loom\Monitoring\DatabaseMonitoringStore::class);
$services->tryAddSingleton(\Loom\Monitoring\MonitoringRepository::class);
$services->tryAddTransient(\Loom\Monitoring\MonitoringDashboard::class);
}
/**
* 登记长驻进程收到停止信号时要执行的回调。可在 build() 之前调用;未登记则直接退出。
*
* @example $builder->onStop(static function (): void { fwrite(STDERR, "bye\n"); });
*/
public function onStop(callable $handler): self
{
$this->onStopHandlers[] = $handler(...);
return $this;
}
/**
* 登记一个带 Module 注解的启动模块类。重复登记同一类会去重。必须在 build() 之前调用。
*
* @example $builder->addModule(\App\AppModule::class);
*/
public function addModule(string $class): self
{
if ($this->built) {
throw new \LogicException('Modules cannot be added after the application has been built');
}
foreach ($this->modules as $entry) {
if ($entry === $class) {
return $this;
}
}
$this->modules[] = $class;
return $this;
}
/**
* 扫描模块、补齐模块服务,生成根容器和 Application。只能调用一次。
*/
public function build(): Application
{
if ($this->built) {
throw new \LogicException('The application has already been built');
}
$this->built = true;
$services = $this->services;
$registration = $this->monitoring->registration();
if (!$registration->monitoringReplaced() && count($services->descriptors(\Loom\Monitoring\Monitoring::class)) <= 1) {
$services->addScoped(\Loom\Monitoring\Monitoring::class, static function (ServiceResolver $resolver): \Loom\Monitoring\Monitoring {
$options = $resolver->get(\Loom\Monitoring\MonitoringOptions::class);
$configured = new \Loom\Monitoring\ConfigurableMonitoring(
$options,
$resolver->get(\Loom\Monitoring\MonitoringRegistration::class),
$resolver->get(\Loom\Logging\Diary::class),
$resolver->get(\Loom\Monitoring\DatabaseMonitoringStore::class),
);
$configured->bindScope($resolver->get(ServiceScope::class));
return $configured;
});
}
$discovery = ModuleDiscovery::configured($this->configuration, $this->modules);
foreach ($discovery->eventListeners() as $event => $listeners) {
foreach ($listeners as $row) {
$class = $row[0];
$method = $row[1];
$queued = $row[2] ?? false;
if ($queued) {
$this->eventsRegistration->discoverQueued($event, $class, $method);
} else {
$this->eventsRegistration->discover($event, $class, $method);
}
}
}
$listenerMap = $this->eventsRegistration->listeners();
self::assertQueueableEventListeners($listenerMap);
$services->tryAddScoped(\Loom\Events\EventDispatcher::class, static function (ServiceResolver $resolver) use ($listenerMap): \Loom\Events\EventDispatcher {
return new \Loom\Events\EventDispatcher($listenerMap, $resolver, $resolver->get(\Loom\Queue::class));
});
$builtinJobs = ['loom.event.listen' => [\Loom\Events\EventListenJob::class, 'handle']];
$services->addSingleton(JobDispatcher::class, static function (ServiceResolver $resolver) use ($builtinJobs): JobDispatcher {
return new JobDispatcher($resolver->get(ModuleDiscovery::class), $builtinJobs);
});
foreach ($discovery->services() as $id => $class) {
$services->tryAdd(new ServiceDescriptor($id, ServiceLifetime::from($discovery->serviceLifetime($id)), $class));
}
$router = $discovery->router();
$monitoringOptions = (new Options($this->configuration))->bindOptional(\Loom\Monitoring\MonitoringOptions::class, 'monitoring');
if ($monitoringOptions instanceof \Loom\Monitoring\MonitoringOptions) {
$monitoringOptions->finalize();
\Loom\Monitoring\MonitoringDashboard::register($router, $monitoringOptions->dashboard->path, $monitoringOptions);
}
$kernel = new HttpKernel($router);
$console = new Console\Console();
$grpc = new Grpc\Dispatcher($this->configuration);
$services->addInstance(ModuleDiscovery::class, $discovery);
$services->addInstance(Router::class, $router);
$services->addInstance(HttpKernel::class, $kernel);
$services->addInstance(Console\Console::class, $console);
$services->addInstance(Grpc\Dispatcher::class, $grpc);
$timers = $discovery->timers();
$services->tryAddSingleton(TimerRunner::class, static function (ServiceResolver $resolver) use ($timers): TimerRunner {
$runner = new TimerRunner($resolver->get(ServiceProvider::class));
foreach ($timers as $class) {
$runner->register($class);
}
return $runner;
});
$console->add(Console\Commands\DoctorCommand::class);
$console->add(Console\Commands\ServeCommand::class);
$console->add(Console\Commands\TcpServeCommand::class);
$console->add(Console\Commands\GrpcServeCommand::class);
$console->add(Console\Commands\MigrateUpCommand::class);
$console->add(Console\Commands\MigrateDownCommand::class);
$console->add(Console\Commands\MigrateStatusCommand::class);
$console->add(Console\Commands\QueueWorkCommand::class);
$console->add(Console\Commands\ScheduleListCommand::class);
$console->add(Console\Commands\ScheduleRunCommand::class);
$console->add(Console\Commands\ScheduleListenCommand::class);
$console->add(Console\Commands\ScheduleWorkCommand::class);
$console->add(Console\Commands\JobCommand::class);
$console->add(Console\Commands\MonitoringPruneCommand::class);
Console\Commands\ScaffoldCommands::register($console);
foreach ($discovery->commands() as $class) {
$console->add($class);
}
$provider = $services->build();
\Loom\Redis::bindOptions($provider->get(\Loom\RedisOptions::class));
$provider->get(\Loom\Logging\Diary::class);
$stopSignal = $provider->get(StopSignal::class);
foreach ($this->onStopHandlers as $handler) {
$stopSignal->onStop($handler);
}
return new Application($provider, $this->configuration, $router, $kernel, $console, $grpc);
}
/**
* @param array<string, list<array{type: string, listener: string|callable, method?: string, queued?: bool}>> $listenerMap
*/
private static function assertQueueableEventListeners(array $listenerMap): void
{
foreach ($listenerMap as $event => $entries) {
foreach ($entries as $entry) {
if (!($entry['queued'] ?? false)) {
continue;
}
$reflection = new \ReflectionClass($event);
if (!$reflection->implementsInterface(\Loom\Events\QueueableEvent::class)) {
throw new \LogicException('Queued event listeners require QueueableEvent: ' . $event);
}
}
}
}
}