chengkun
2025-06-05 4080b5997b38ca84b3b203c7101dcadb97b76925
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
<?php
// +----------------------------------------------------------------------
// | ThinkPHP [ WE CAN DO IT JUST THINK IT ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006-2025 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: yunwuxin <448901948@qq.com>
// +----------------------------------------------------------------------
namespace think\console\command;
 
use think\console\Command;
use think\console\Input;
use think\console\input\Argument;
use think\console\input\Option;
use think\console\Output;
use think\console\Table;
use think\event\RouteLoaded;
 
class RouteList extends Command
{
    protected $sortBy = [
        'rule'   => 0,
        'route'  => 1,
        'method' => 2,
        'name'   => 3,
        'domain' => 4,
    ];
 
    protected function configure()
    {
        $this->setName('route:list')
            ->addArgument('dir', Argument::OPTIONAL, 'dir name .')
            ->addArgument('style', Argument::OPTIONAL, "the style of the table.", 'default')
            ->addOption('sort', 's', Option::VALUE_OPTIONAL, 'order by rule name.', 0)
            ->addOption('more', 'm', Option::VALUE_NONE, 'show route options.')
            ->setDescription('show route list.');
    }
 
    protected function execute(Input $input, Output $output)
    {
        $dir = $input->getArgument('dir') ?: '';
 
        $filename = $this->app->getRootPath() . 'runtime' . DIRECTORY_SEPARATOR . ($dir ? $dir . DIRECTORY_SEPARATOR : '') . 'route_list.php';
 
        if (is_file($filename)) {
            unlink($filename);
        } elseif (!is_dir(dirname($filename))) {
            mkdir(dirname($filename), 0755);
        }
 
        $content = $this->getRouteList($dir);
        file_put_contents($filename, 'Route List' . PHP_EOL . $content);
    }
 
    protected function getRouteList(?string $dir = null): string
    {
        $this->app->route->clear();
        $this->app->route->lazy(false);
 
        if ($dir) {
            $path = $this->app->getRootPath() . 'route' . DIRECTORY_SEPARATOR . $dir . DIRECTORY_SEPARATOR;
        } else {
            $path = $this->app->getRootPath() . 'route' . DIRECTORY_SEPARATOR;
        }
 
        $files = is_dir($path) ? scandir($path) : [];
 
        foreach ($files as $file) {
            if (str_contains($file, '.php')) {
                include $path . $file;
            }
        }
 
        //触发路由载入完成事件
        $this->app->event->trigger(RouteLoaded::class);
 
        $table = new Table();
 
        if ($this->input->hasOption('more')) {
            $header = ['Rule', 'Route', 'Method', 'Name', 'Domain', 'Option', 'Pattern'];
        } else {
            $header = ['Rule', 'Route', 'Method', 'Name'];
        }
 
        $table->setHeader($header);
 
        $routeList = $this->app->route->getRuleList();
        $rows      = [];
 
        foreach ($routeList as $item) {
            $item['route'] = $item['route'] instanceof \Closure ? '<Closure>' : $item['route'];
            $row           = [$item['rule'], $item['route'], $item['method'], $item['name']];
 
            if ($this->input->hasOption('more')) {
                array_push($row, $item['domain'], json_encode($item['option']), json_encode($item['pattern']));
            }
 
            $rows[] = $row;
        }
 
        if ($this->input->getOption('sort')) {
            $sort = strtolower($this->input->getOption('sort'));
 
            if (isset($this->sortBy[$sort])) {
                $sort = $this->sortBy[$sort];
            }
 
            uasort($rows, function ($a, $b) use ($sort) {
                $itemA = $a[$sort] ?? null;
                $itemB = $b[$sort] ?? null;
 
                return strcasecmp($itemA, $itemB);
            });
        }
 
        $table->setRows($rows);
 
        if ($this->input->getArgument('style')) {
            $style = $this->input->getArgument('style');
            $table->setStyle($style);
        }
 
        return $this->table($table);
    }
 
}