Lumen Xadmin

Lumen — это фреймворк для разработки API. Xadmin — интерфейс для управления серверной частью. Вместе они представляют собой базовую платформу для быстрой разработки.

Установка

1. Загрузите фреймворк Lumen на свой рабочий каталог:

   git clone https://gitee.com/scarecrowpqs/lumen_xadmin.git

2. Перейдите в проект и установите расширения:

   cd lumen_xadmin
   composer install --ignore-platform-reqs

3. Создайте файл конфигурации .env, скопировав файл .env.example.

4. Настройте переменные в файле .env:

   • APP_KEY — ваш собственный ключ;
   • IS_CHECK_SIGN — если вам нужно отключить проверку подписи, установите значение false. Если вы хотите использовать подпись, измените значение своего ключа;
   • APP_SOCKET_KEY — ваш собственный солевой ключ;
   • DB_CONNECTION — тип базы данных (например, mysql);
   • DB_HOST — адрес сервера базы данных;
   • DB_PORT — порт сервера базы данных;
   • DB_DATABASE — имя базы данных;
   • DB_USERNAME — имя пользователя базы данных;
   • DB_PASSWORD — пароль пользователя базы данных.

5. Импортируйте файл sc_lumen_auth.sql в вашу базу данных. В этом файле содержатся основные таблицы данных, а также измените конфигурацию базы данных в файле .env.

6. Установите соединение с базой данных и завершите установку.

Доступ

• API запрос: http://host/
• Страница администратора: http://host/admin/login.html

Архитектура разработки Lumen

Общая структура

1. Определены общие функции, константы, классы поставщиков услуг и инструменты:

   • Определён каталог общих констант: app/Common/Const.
     • ApiConst.php — файл глобальных констант.
   • Определён каталог общих функций: app/Common/Function.
     • ScarecrowFunction.php — файл общих функций.
   • Определены каталоги классов поставщиков услуг и инструментов: app/Common/ScarecrowProvider.
     • ScarecrowAuthProvider.php — класс поставщика услуг авторизации.
     • ScarecrowDoLogProvider.php — класс инструментов для обработки журналов операций.

2. Определены поставщики услуг и фасады:

   • Поставщик услуг авторизации: app/Providers/ScarecrowAuthServiceProvider.
   • Фасад авторизации: app/Facades/ScarecrowAuth.

3. Определено промежуточное ПО (маршрутизаторы и глобальные):

   • Маршрутизатор аутентификации API: app/Http/Middleware/ApiTokenCheckMiddleware. Используется для проверки подлинности API, определения прав доступа к маршрутам API и автоматического обновления срока действия и количества обращений API.
   • Проверяющее промежуточное ПО: app/Http/Middleware/CheckApiSignMiddleware. Используется для проверки подписи API. Конфигурация находится в файле .env.
     • IS_CHECK_SIGN: true.
     • APP_SOCKET_KEY: KEY.
   • Промежуточное ПО для разрешения междоменного доступа: app/Http/Middleware/AllowCrossOriginMiddleware. Разрешает доступ к API из разных источников. Конфигурация находится в файле .env.
     • IS_ALLOW_ORIGIN: true.
   • Исключительное промежуточное ПО: app/Http/Middleware/HandleExceptionMiddleware. Форматирует вывод исключений, чтобы он соответствовал формату ответа API. Конфигурация находится в файле .env.
     • IS_FORMAT_EXCEPTION: true.

Основные встроенные модули

• Управление пользователями, логином и сроком действия API: app/Http/Controllers/AuthManage/LoginController. Адрес маршрута: routes/auth.php. Документация: doc/*_login_doc.md.
• Управление меню: app/Http/Controllers/AuthManage/MenuController. Адрес маршрута: routes/auth.php. Документация: doc/back_menu_doc.md.
• Управление правами доступа: app/Http/Controllers/AuthManage/AuthController. Адрес маршрута: routes/auth.php. Документация: doc/back_auth_doc.md.

Другие особенности

• Конфигурация .env:
  • ACTION_LOG_WRITE_TYPE — определяет тип хранилища журнала операций. Возможные значения: file или mysql.
• Глобальные функции:
  • ApiReturn — функция, используемая для унифицированного возврата формата API.
  • ModelReturn — функция, используемая для унифицированного возврата модели.
  • HandleLog — функция, возвращающая класс обработки глобального журнала. Вызов метода addLog для добавления глобального журнала.
  • DieDump — глобальный метод вывода точек останова.
• Расширение установки:
  1. Используйте composer require для установки расширений.
  2. Поместите пакет расширения непосредственно в каталог Extend и выполните команду composer dumpautoload. Фреймворк автоматически загрузит расширение.
• Пользовательские файлы конфигурации:
  1. Создайте каталог config в корне проекта.
  2. Напишите собственный файл конфигурации, который возвращает массив в качестве содержимого конфигурации. Имя файла используется в качестве ключа конфигурации. Например, файл systemframe.php.
  3. Зарегистрируйте этот файл конфигурации в bootstrap/app.php с помощью команды $app->configure('systemframe').

Команды модульного тестирования

Выполните следующую команду для запуска модульных тестов:

php phpunit --configuration phpunit.xml --verbose --group Menu

Здесь:

• --configuration — загружает файл конфигурации для тестирования.
• --verbose — выводит подробную информацию о тестах.
• --group — указывает группу тестов (объявляется в тестовом классе с использованием @group).