介绍文档 | 部署文档 | 初始化文档

Подготовка работы

JDK >= 17 (рекомендуется версия 17)
MySQL >= 8.0 (рекомендуется версия 8.0)
Maven >= 3.0
Redis >= 3.2 (рекомендуется версия 7.0)

Другие (необязательные):

Облачное хранилище Alibaba Cloud OSS, облачное хранилище Tencent COS, а также облачные хранилища Qiniu и MinIo.

Запуск системы

• Импортируйте скачанный проект в idea.
• Создайте базу данных novel в базе данных и выполните сценарии SQL в папке sql.
• Запустите NovelApplication.java в модуле admin (перед запуском рекомендуется выполнить maven install для всего проекта).
• Дождитесь запуска системы без каких-либо исключений в консоли, что будет означать успешный запуск.

Необходимые настройки

1. Корневой каталог файлов проекта, если вы используете систему Windows, настройте соответствующим образом.
2. Измените информацию о базе данных.
3. Измените информацию redis.
4. Измените конфигурацию информации о ресурсах хранения file-storage.
5. Если вы используете объектное хранилище, вам необходимо изменить соответствующую конфигурацию.

MySQL:

Отредактируйте application-dev.yml в каталоге resources модуля admin:

spring:
  datasource:
    druid:
      # URL подключения к базе данных
      url: 
      # Имя пользователя базы данных
      username: 
      # Пароль базы данных
      password: 

Redis:

Отредактируйте application-dev.yml в каталоге resources модуля admin:

spring:
  redis:
    # Адрес redis
    host: 
    # Пароль redis
    password: 
    # Порт redis
    port: 

Конфигурация хранилища файлов file-storage:

Отредактируйте application-dev.yml в каталоге resources модуля admin:

spring:
# Документ конфигурации хранилища файлов: https://spring-file-storage.xuyanwu.cn/
  file-storage: # Конфигурация хранилища файлов
    enable: true # Включить хранилище файлов
    cache-enable: false # Включить кэш
    default-platform: local-plus-1 # По умолчанию используется платформа хранения
    local-plus:
      - platform: local-plus-1 # Идентификатор платформы хранения
        enable-storage: true  # Включить хранение
        enable-access: false
        storage-path: E:\image\ # Путь хранения

Развёртывание системы

1. Настройте вышеуказанные параметры.
2. В корневом каталоге проекта выполните команду mvn clean package -Dmaven.test.skip=true, дождитесь завершения компиляции.
3. Поместите пакет jar из папки docker на сервер для запуска.

Развертывание через контейнер Docker

1. Следуйте инструкциям в документе для завершения компиляции программы.
2. Скопируйте файлы builddocker.sh, Dockerfile и скомпилированный пакет jar в папку docker сервера.
3. Выполните:

# Добавить права на выполнение
sudo chmod 777 builddocker.sh
# Запустить скрипт
./builddocker.sh

Описание шифрования параметров конфигурации

1. Добавьте информацию о конфигурации jasypt.encryptor.password в файл конфигурации. (Этот пароль используется для шифрования и дешифрования конфигураций, поэтому его следует хранить в безопасности.)
2. Запустите тестовый метод AdminApplicationTests.java в модуле admin, замените строку root на свойство конфигурации, которое вы хотите зашифровать.
3. После получения зашифрованного свойства конфигурации настройте его в соответствующем месте конфигурации и заключите его в ENC(), например: ENC(XW2daxuaTftQ+F2iYPQu0g==), где содержимое в скобках — это информация о конфигурации.
4. После настройки параметров конфигурации удалите параметр конфигурации jasypt.encryptor.password.
5. При запуске в среде добавьте информацию об окружении jasypt.Encryptor.Password=VLu3H58dxYAsv3TIGOueaXIXBbhbT2, где пароль совпадает с паролем, используемым при шифровании.

Настройка файлового сервера

Если вы не используете файловый сервер, установите file-storage.enable в значение false или не настраивайте его, остальные параметры настраивать не нужно, по умолчанию файлы хранятся на сервере, на котором работает программа.

Примечание: установка file-storage.enable в значение false или отсутствие настройки не влияет на инициализацию объектного хранилища, проект всё ещё может использовать функции объектного хранилища. Поэтому, даже если вы внедрили объектное хранилище, необходимо настроить информацию об объектном хранилище.

Для настройки файлового модуля требуется добавить зависимость:

<!-- Файловый модуль -->
<dependency>
    <groupId>com.novel</groupId>
    <artifactId>resources</artifactId>
</dependency>

Если выбрано объектное хранилище и т. д., пожалуйста, обратитесь к file-storage для конкретной конфигурации.

Развёртывание через Jenkins

Опущено.

Часто задаваемые вопросы

1. Если вы используете Mac, измените путь к файлу application-dev.yml профиля.
2. Если при использовании Linux появляется сообщение о том, что таблица не существует, настройте чувствительность к регистру в /etc/my.cnf, добавив lower_case_table_names=1, и перезапустите службу MySQL.
3. Если появится сообщение о недостаточных текущих разрешениях и невозможности записи в файл, проверьте, можно ли читать и записывать в каталог профиля или есть ли доступ к этому каталогу.