Spring Boot 集成

Orbien 提供可内嵌到 Spring Boot 的 Java 客户端，当前能力：

• 隧道协议：仅 TCP、HTTP
• 传输层：仅 TCP
• 不支持 TCP 多路复用：orbien.tcp-mux 必须为 false，服务端也需 [transport].tcpMux = false（服务端默认开启多路复用，与 Java 客户端联调时需显式关闭）

Maven

<dependency>
    <groupId>io.github.lxien</groupId>
    <artifactId>orbien-spring-boot-starter</artifactId>
    <version>3.6.1</version>
</dependency>

Gradle

implementation("io.github.lxien:orbien-spring-boot-starter:3.6.1")

最小配置

# application.yml
orbien:
  enabled: true
  server: "127.0.0.1:9527"
  # token: YOUR_TOKEN
  tunnel:
    protocol: http
    domains:
      - web.example.com

服务端需关闭多路复用：

# orbien-server.toml
listen = "0.0.0.0:9527"
httpGwPort = 80

[transport]
tcpMux = false

TCP 示例

orbien:
  enabled: true
  server: "127.0.0.1:9527"
  token: YOUR_TOKEN
  tunnel:
    protocol: tcp
    # local-port: 3306
    remote-port: 9000

完整参考

# application.yml
orbien:
  enabled: true
  server: "127.0.0.1:9527"
  token: YOUR_TOKEN
  tcp-mux: false # 必须为 false
  pool-count: 1
  heartbeat-interval-secs: 30
  user: spring-boot-demo
  tunnel:
    name: web-demo
    protocol: http
    local-ip: 127.0.0.1
    # local-port: 8080
    # remote-port: 9000
    domains:
      - web.example.com
      # - admin

配置项说明

配置项	默认值	说明
orbien.enabled	true	是否启用
orbien.server	127.0.0.1:9527	服务端地址
orbien.token	空	鉴权 token
orbien.tcp-mux	false	仅允许 false
orbien.pool-count	1	登录时预申请的数据连接数
orbien.heartbeat-interval-secs	30	控制面心跳间隔（秒）
orbien.user	空	展示用用户名
orbien.tunnel.name	见上文	隧道名
orbien.tunnel.protocol	tcp	tcp 或 http
orbien.tunnel.local-ip	127.0.0.1	本地服务 IP
orbien.tunnel.local-port	0	本地服务端口
orbien.tunnel.remote-port	0	服务端对外端口；protocol=tcp 时必填
orbien.tunnel.domains	[]	HTTP 域名列表；protocol=http 时必填