#1871: README.txt (projectforge-common)

Этот README служит минимальным ориентировочным документом для разработчиков, изучающих модуль projectforge-common. Его содержимое намеренно краткое, поскольку этот модуль не является самостоятельным приложением — это библиотека, используемая как зависимость другими модулями ProjectForge.

Полный текст

Пожалуйста, сначала используйте projectforge-webapp для вашей разработки!

Этот модуль содержит некоторые общие классы ProjectForge.

Вам не нужен этот модуль для разработки веб-приложения ProjectForge.
Он автоматически доступен через Maven-репозиторий ProjectForge.

Назначение модуля

projectforge-common — это фундаментальный библиотечный модуль, содержащий общие служебные классы, структуры данных и сквозные функции, используемые в экосистеме ProjectForge. Он включает:

• Служебные классы: BeanHelper, ClassHelper, DateHelper, FileHelper, NumberHelper, CollectionHelper, CanonicalFileUtils
• Обработка CSV: CSVParser, CSVWriter — собственная реализация CSV (не Apache Commons CSV)
• Управление версиями: класс Version для семантического представления и сравнения версий
• Типы данных: перечисление DateFormatType, перечисление DatabaseDialect
• Diff/Patch: порт алгоритма diff-match-patch от Google
• Логирование: SLF4J, мост Log4j2-to-SLF4J, Logback
• Зависимости Apache Commons: commons-lang3, commons-beanutils, commons-collections4

Модель зависимостей

Модуль публикуется в Maven-репозиторий и используется другими модулями через объявления зависимостей Gradle. В файлах сборки Gradle (например, build.gradle.kts в других модулях) он указывается как:

implementation(project(":projectforge-common"))

Это означает, что это зависимость проекта в многомодульной сборке Gradle, и он публикуется как Maven-артефакт для внешнего использования.

Ключевое проектное решение

Указание «сначала используйте projectforge-webapp для вашей разработки» означает, что projectforge-webapp является предполагаемой точкой входа для разработчика — он предоставляет полный стек веб-приложения. Модуль projectforge-common является строительным блоком, а не отправной точкой. Такая многоуровневая архитектура разделяет задачи: общие утилиты изолированы, чтобы инструменты, скрипты и плагины могли зависеть от них без подключения полного стека веб-приложения.

Конфигурация сборки

Модуль использует плагин соглашений Gradle buildlogic.pf-module-conventions и плагин Kotlin JVM. Он объявляет API-зависимости от SLF4J, Logback, Log4j2, библиотек Apache Commons и Zip4j для работы с ZIP-архивами.