jt-framework

Сервер для протокола Jt-808.

Для информации о проблемах обновления до последней версии, см. руководство по обновлению с версии 2.0.x до 2.1.x.

Рекомендованный небольшой инструмент для декодирования и кодирования приватных протоколов

Небольшой инструмент для декодирования и кодирования приватных протоколов, не зависящий от конкретного протокола.

• Github: https://github.com/hylexus/xtream-codec
• Gitee: https://gitee.com/hylexus/xtream-codec

Совместимость

Поддерживает spring-boot-2.x и spring-boot-3.x .

Дополнительная информация о совместимости версий доступна здесь: начало работы -- совместимость.JDK версия и ограничения версии Spring Boot для starter следующие:| Модуль | JDK | Spring Boot | Описание | |---------------------------------------------|-------|-------------------|---------------------------------------------| | jt-808-server-spring-boot-starter-boot2 | 8+ | [2.2.x, 2.7.18] | Starter для Spring Boot 2.x | | jt-808-server-spring-boot-starter | 17+ | [3.0.0, ...] | Starter для Spring Boot 3.x | | jt-1078-server-spring-boot-starter-boot2 | 8+ | [2.2.x, 2.7.18] | Starter для Spring Boot 2.x, beta версия | | jt-1078-server-spring-boot-starter | 17+ | [3.0.0, ...] | Starter для Spring Boot 3.x, beta версия | | jt-dashboard-client-spring-boot-starter | 17+ | [3.0.0, ...] | Поддерживает только JDK 17+/Spring Boot 3.x, beta версия | | jt-dashboard-server-spring-boot-starter | 17+ | [3.0.0, ...] | Поддерживает только JDK 17+/Spring Boot 3.x, beta версия |

Модули

По умолчанию в этом проекте используются следующие версии JDK и Spring Boot:| Модуль | JDK | CompileLevel | .class | spring-boot | Описание | |------------------------------------------|-----|--------------|-------------|-------------|-----------------------------------------------| | jt-core | 17 | JDK-8 | 52 (JDK-8) | -- | | | jt-808-server-spring-boot-starter | 17 | JDK-17 | 61 (JDK-17) | 3.3.0 | | | jt-808-server-spring-boot-starter-boot2 | 17 | JDK-8 | 52 (JDK-8) | 2.7.18 | | | jt-808-server-spring-boot-autoconfigure | 17 | JDK-8 | 52 (JDK-8) | 2.7.18 | | | jt-808-server-support | 17 | JDK-8 | 52 (JDK-8) | -- | | | jt-1078-server-spring-boot-starter | 17 | JDK-17 | 61 (JDK-17) | 3.3.0 | | | jt-1078-server-spring-boot-starter-boot2 | 17 | JDK-8 | 52 (JDK-8) | 2.7.18 | | | jt-1078-server-spring-boot-autoconfigure | 17 | JDK-8 | 52 (JDK-8) | 2.7.18 | | | jt-1078-server-support | 17 | JDK-8 | 52 (JDK-8) | -- | | | dashboard/** | 17 | JDK-17 | 61 (JDK-17) | 3.3.0 | модуль dashboard временно поддерживает только spring-boot-3.x/jdk17 |- Описание модулей```sh . ├── build-script # скрипты сборки и конфигурация checkstyle для gradle ├── docs # документация (vue-press) ├── jt-1078-server-spring-boot-autoconfigure # (jdk8+) ├── jt-1078-server-spring-boot-starter # автоматическая конфигурация для spring-boot-v3 (jdk17+) ├── jt-1078-server-spring-boot-starter-boot2 # автоматическая конфигурация для spring-boot-v2 (jdk8+) ├── jt-1078-server-support # реализация jt-1078 (jdk8+) ├── jt-808-server-spring-boot-autoconfigure # (jdk8+) ├── jt-808-server-spring-boot-starter # автоматическая конфигурация для spring-boot-v3 (jdk17+) ├── jt-808-server-spring-boot-starter-boot2 # автоматическая конфигурация для spring-boot-v2 (jdk8+) ├── jt-808-server-support # реализация jt-808 (jdk8+) ├── jt-core # некоторые общие классы (jdk8+) ├── dashboard # модуль dashboard «временно» не поддерживает spring-boot-2.x │ ├── jt-dashboard-client # клиент dashboard (jdk17+) │ ├── jt-dashboard-client-spring-boot-starter # автоматическая конфигурация для spring-boot-v3 для клиента dashboard (jdk17+) │ ├── jt-dashboard-common # общие зависимости для dashboard (jdk17+) │ ├── jt-dashboard-server # сервер dashboard (jdk17+) │ ├── jt-dashboard-server-spring-boot-starter # автоматическая конфигурация для spring-boot-v3 для сервера dashboard (jdk17+) │ └── jt-dashboard-server-ui-vue3 # интерфейс dashboard на основе VUE3 ├── demos # (jdk17+) │ ├── jt-demo-1078-server-webflux-boot3 │ ├── jt-demo-808-server-webflux-boot3 │ ├── jt-demo-dashboard-webflux-boot3 │ └── jt-demo-dashboard-webmvc-boot3 └── samples ├── jt-1078-server-sample-webflux-boot3 # пример для JT/T 1078 (spring-boot-3.x; Webflux) (jdk17+) ├── jt-1078-server-sample-webmvc-boot3 # пример для JT/T 1078 (Spring Boot 3.x; Spring MVC) (JDK 17+) ├── jt-808-server-sample-annotation # пример с использованием аннотаций (Spring Boot 2.x) (JDK 8+) ├── jt-808-server-sample-bare # пример с минимальной конфигурацией (Spring Boot 2.x) (JDK 8+) ├── jt-808-server-sample-bare-boot3 # пример с минимальной конфигурацией (Spring Boot 3.x) (JDK 17+) ├── jt-808-server-sample-customized # пример с пользовательской конфигурацией (Spring Boot 2.x) (JDK 8+)

       ├── jt-808-server-sample-debug          # Проект для отладки во время разработки, проигнорируйте
       └── jt-sample-common                    # Общие зависимости для проектов samples (JDK 8+)```## Документация

- Документация доступна по ссылке: [https://hylexus.github.io/jt-framework/](https://hylexus.github.io/jt-framework/)

## Быстрый старт

Дополнительная информация доступна по ссылке [начало -- быстрый старт](https://hylexus.github.io/jt-framework/v2/jt-808/guide/quick-start/quick-start.html).

### 1. Создание проекта

Создайте пустой проект на основе `spring-boot`.

### 2. Добавление зависимостей

- **spring-boot-3.x**
   - `jt-808-server-spring-boot-starter-2.3.0-rc.3.jar`
- **spring-boot-2.x**
   - `jt-808-server-spring-boot-starter-boot2-2.3.0-rc.3.jar`

Добавьте зависимости для работы с протоколом `808`:

- gradle

```groovy
implementation group: 'io.github.hylexus.jt', name: 'jt-808-server-spring-boot-starter-boot2', version: "2.3.0-rc.3"

• maven

<dependency>
    <groupId>io.github.hylexus.jt</groupId>
    <artifactId>jt-808-server-spring-boot-starter-boot2</artifactId>
    <version>2.3.0-rc.3</version>
</dependency>

3. Настройка

• application.yml

jt808:
  built-components:
    component-statistics:
      enabled: true
    request-handlers:
      enabled: true
logging:
  level.root: info
  level.io.github.hylexus: info
  level.jt-808.request.decoder: debug
  level.jt-808.response.encoder: debug

Возможности

• Разработка с использованием аннотаций
• Поддержка сервера приложений по ГОСТу
• Поддержка отправки сообщений
• Поддержка разделения сообщений
• Поддержка нескольких версий
• Поддержка шифрования и расшифровки сообщений

Примеры Maven

Примеры проектов на базе Maven

• GitHub: https://github.com/hylexus/jt-framework-samples-maven
• Gitee: https://gitee.com/hylexus/jt-framework-samples-maven

Сборка из исходного кодаДополнительная информация о сборке из исходного кода доступна по ссылке начало -- сборка из исходного кода.

• MacOS/Linux/Unix-подобная система

./gradlew clean build

• Windows

.\gradlew.bat clean build

Отчет о проблемах

• GitHub создайте Issue
• QQ группа общения: 1072477383

Сообщество

Поддержка проекта

Развитие проекта зависит от вашей поддержки, помогите автору выпить пиво🍺!