Разработка пользовательских плагинов

Хотя я уже предоставил наиболее часто используемые middleware, они могут не удовлетворять всем случаям разработки пользователей. В большинстве случаев пользователям требуется создание своих собственных плагинов.

Настройка окружения

1. Клонировать репозиторий

git clone https://gitee.com/sanri/sanri-tools-maven.git

2. Установить внешние JAR-файлы

Скопируйте содержимое файла tools-name/src/main/resources/install.txt в консоль и выполните его.
Скопируйте содержимое файла tools-fastdfs/src/main/resources/install.txt в консоль и выполните его.

3. Попробуйте запустить и проверьте успешность запуска, затем запустите первый интерфейс версии номера в tools-console.http
4. Скачайте последнюю версию фронтенда скачать здесь
5. Распакуйте фронтенд и поместите его в папку public вашего профиля пользователя
6. Запустите backend, перейдите по адресу http://localhost:8084/public/index.html

Настройка окружения фронтенда (разделение front-end и back-end)

1. Клонировать репозиторий

git clone https://gitee.com/sanri/sanritoolsvue.git

2. Установить зависимости

npm install 

3. Запустить проект

npm run dev 

4. Адрес для доступа http://localhost:9527

Если соединение не удалось, проверьте, является ли адресом localhost адресом сервера. Проверьте файл .env.development и установите значение VUE_APP_BASE_API как текущий IP-адрес машины или просто http://localhost:8084## Разработка модулей

Создайте новый модуль с названием tools-*, путь к пакету com.sanri.tools.modules.название_модуля, затем вы можете начать разработку своего модуля, предоставляя свои услуги.

Добавьте модуль в tools-console/pom.xml, чтобы завершить разработку нового модуля.

Если вам нужно скомпилировать проект, необходимо добавить директорию в sanritools.jar. Конкретные шаги можно найти в конфигурации сборщика spring-boot-maven-plugin. Если вы используете внешние библиотеки, вам потребуется пересобрать зависимость sanritoolslib.

# Создание зависимости sanritoolslib

# 1. Прокомментируйте зависимость tools-console в /pom.xml

# 2. Выполните команду 
mvn dependency:copy-dependencies -DoutputDirectory=d:/test/sanritoolslib -DincludeScope=runtime 

Использование предоставленных платформой возможностей

Создание подключения

Если ваш модуль требует создания нового подключения, вам следует создать файл в каталоге classpath с именем connect.название_модуля.template.формат_конфигурации.

Использование возможностей tools-core

Для использования возможностей из tools-core вам необходимо импортировать этот модуль. Он предоставляет такие возможности, как генерация случайных чисел, сервис хранения файлов, загрузчики классов и многое другое.

Получение класс-лодера по имени

class Test {
    @Autowired
    private ClassloaderService classloaderService;

    ClassLoader classLoader = classloaderService.getClassloader(classloaderName);
}
```**Получение сериализатора по имени**
```java
import com.sanri.tools.modules.serializer.service.Serializer;

class Test {
    @Autowired
    private SerializerChoseService serializerChoseService;

    Serializer serializer = serializerChoseService.choseSerializer(serializerParam.getHashKey());
}

Получение информации о соединении, созданном пользователем, по имени Здесь получаем данные в виде строковых данных, которые пользователь должен преобразовать в нужную структуру данных.

class Test {
    @Autowired
    private ConnectService connectService;

    String database = connectService.loadContent("database", connName);
}

Регистрация плагинов Если вы хотите показывать свой плагин на главной странице, вам потребуется предоставить файл конфигурации tools-[модуль]-plugin.properties в classpath.

Предоставление информации о меню Для предоставления информации о меню перед фронтендом требуется наличие файла конфигурации tools-[модуль].menus.conf в classpath.

Отладка интерфейсов

Инструмент использует более удобные модульные тесты, отправляющие HTTP запросы для отладки. Все модульные тесты находятся в файлах requests/[модуль].http.

Если добавлены права доступа, то запрос следует отправлять следующим образом:

1. Сначала выполните запрос авторизации, который находится первым в списке запросов в файле tools-security.http.
2. Добавьте информацию о токене в заголовок запроса: Authorization: {{Authorization}}

Управление правами доступа

Добавьте файл конфигурации прав доступа authority.conf в директорию resources.Формат конфигурации см. в разделе "Конфигурационные примеры" в tools-security.

Внимание при сборке и развёртывании

В плагине spring-boot-maven-plugin, расположенном в секции build, необходимо указать ваш модуль для включения его в артефакт сборки, а также обновить папку lib новыми JAR-библиотеками.

Сборка проекта

Выполните команду mvn clean package в каталоге sanri-tools-maven.

Собранный артефакт можно найти в каталоге sanri-tools-maven/tools-console/target.

Техническая помощь

Обратитесь к sanri

Подача вклада

Если разработанный функционал имеет универсальное значение, приветствуем его подачу как модуль для совместного совершенствования.