Skip to content

Repository files navigation

xtream-codec

xtream-codec logo

Ask DeepWiki
licenseJDKMaven Central
Gradle BuildGitHub last commit
GitHub commit activityGitHub commit activityGitHub commit activityGitHub commit activity

Tips / 提示

2026.1 版的 idea 中打开项目可能会报错

AI 生成的代码都会有标记,比如 @author opencode (AI)

ProjectNaming / 项目命名

项目名来源: xtream-codec == xtream + codec

  • xtream == Extensible + Stream(发音特点合成)
    • Extensible: 可扩展
    • Stream: 非阻塞 的流式编程(projectreactor)
  • codec == Coder + Decoder

Intro / 介绍

该项目是一个基于 projectreactor 的、和具体协议无关的、异步的、非阻塞的、TCP/UDP 服务端实现。

同时提供了基于 xtream-codec-server-reactiveJT/T 808 协议JT/T 1078 协议 的服务端实现:

JT/T 808 QuickStart

# 支持 amd64 和 arm64 两种架构
docker run -it --rm -p 8888:8888 registry.cn-hangzhou.aliyuncs.com/xtream-codec/jt-808-server-quick-start-with-dashboard:latest

启动后访问: http://localhost:8888/dashboard-ui/

首页编解码调试
jt-808-docker-quickstart.pngjt-808-dashboard-debug.png

Roadmap / 版本路线图

通过 GitHub Milestones 管理未来的版本计划

欢迎在 Issue 中讨论设计,或认领 help wanted 任务参与开发

Compatibility / 兼容性

参考 : https://start.spring.io/actuator/info

非 spring 项目可以不用理会这个兼容性

但依然建议使用 spring-boot-dependencies 这个 BOM 来管理 N 多依赖的兼容性问题

xtream-versionspring-boot-dependenciesspring-cloud-dependencies
0.1.x3.5.6 +2025.0.0
0.0.x3.2.x +2023.0.3

Modules / 项目模块

.
├── build-script ## 构建脚本
├── docs ## 文档
├── ext ## 扩展模块
│ └── jt ## JT/T 扩展
│ ├── jt-808-server-dashboard-spring-boot-starter-reactive ## JT/T 808 扩展 - Dashboard - Server
│ ├── jt-808-server-dashboard-ui ## JT/T 808 扩展 - Dashboard - UI
│ └── jt-808-server-spring-boot-starter-reactive ## JT/T 808 扩展
├── quick-start ## quick-start 示例
│ └── jt ## JT/T 示例
│ ├── jt-808-attachment-server-quick-start-blocking ## JT/T 808 附件服务器服务端示例(不带 dashboard)
│ ├── jt-808-attachment-server-quick-start-nonblocking ## JT/T 808 附件服务器服务端示例(不带 dashboard)
│ ├── jt-808-server-quick-start ## JT/T 808 服务端示例(不带 dashboard)
│ ├── jt-808-server-quick-start-with-dashboard ## JT/T 808 服务端示例(带 dashboard)
│ ├── jt-808-server-quick-start-with-storage-blocking ## JT/T 808 服务端[阻塞版-SpringMvc]示例(带 存储:clickhouse,mysql,postgres,minio)
│ └── jt-808-server-quick-start-with-storage-nonblocking ## JT/T 808 服务端[非阻塞版-WebFlux]示例(带 存储:clickhouse,mysql,postgres,minio)
├── debug ## 调试专用(不用理会)
│ ├── jt ## JT/T 示例(不用理会)
│ │ └── jt-808-server-spring-boot-starter-reactive-debug ## JT/T 808 服务端调试(不用理会)
│ ├── xtream-codec-core-debug ## xtream-codec-core 模块调试(不用理会)
│ ├── xtream-codec-server-reactive-debug-tcp ## xtream-codec-server-reactive TCP 调试(不用理会)
│ └── xtream-codec-server-reactive-debug-udp ## xtream-codec-server-reactive UDP 调试(不用理会)
├── xtream-codec-core ## xtream-codec-core 核心编解码模块
└── xtream-codec-server-reactive ## 异步非阻塞的 TCP/UDP 服务端实现

Docs / 文档

QuickStart / 快速入门

License / 开源协议

xtream-codec 使用 Apache License, Version 2.0 开源许可证。 详情见 LICENSE 文件。

第三方依赖的许可证信息:

  • 请参考生成的 .jar 文件中的 META-INF/NOTICE.txt 文件 。
  • 或者, 执行 ./gradlew clean generateLicenseReport 之后查看生成的 build/reports/dependency-license/THIRD-PARTY-NOTICES.txt 文件。

Funding / 打赏

项目的发展离不开你的支持,请作者喝一杯🍺吧!

有钱的捧个钱场 没钱的捧个人场

References / 参考资料 / 致谢

TODO / 待办

About

私有协议编解码、jt-808、部标、国标

Topics

Resources

Stars

111 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages