mirror of
https://github.com/orbien-org/orbien.git
synced 2026-09-28 16:01:46 +00:00
21 lines
33 KiB
HTML
21 lines
33 KiB
HTML
<!doctype html><html lang=zh-CN dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-integrations/springboot" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.10.2"><title data-rh=true>Spring Boot 集成 | Orbien</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:image content=https://orbien-org.github.io/orbien/img/logo.png /><meta data-rh=true name=twitter:image content=https://orbien-org.github.io/orbien/img/logo.png /><meta data-rh=true property=og:url content=https://orbien-org.github.io/orbien/docs/integrations/springboot /><meta data-rh=true property=og:locale content=zh_CN /><meta data-rh=true property=og:locale:alternate content=en /><meta data-rh=true name=docusaurus_locale content=zh-Hans /><meta data-rh=true name=docsearch:language content=zh-Hans /><meta data-rh=true name=docusaurus_version content=current /><meta data-rh=true name=docusaurus_tag content=docs-default-current /><meta data-rh=true name=docsearch:version content=current /><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current /><meta data-rh=true property=og:title content="Spring Boot 集成 | Orbien"/><meta data-rh=true name=description content="Orbien 提供可内嵌到 Spring Boot 的 Java 客户端，当前能力："/><meta data-rh=true property=og:description content="Orbien 提供可内嵌到 Spring Boot 的 Java 客户端，当前能力："/><link data-rh=true rel=icon href=/orbien/img/favicon.ico /><link data-rh=true rel=canonical href=https://orbien-org.github.io/orbien/docs/integrations/springboot /><link data-rh=true rel=alternate href=https://orbien-org.github.io/orbien/docs/integrations/springboot hreflang=zh-CN /><link data-rh=true rel=alternate href=https://orbien-org.github.io/orbien/en/docs/integrations/springboot hreflang=en /><link data-rh=true rel=alternate href=https://orbien-org.github.io/orbien/docs/integrations/springboot hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://orbien-org.github.io/orbien/docs/integrations/springboot","name":"SpringBoot集成","position":1}]}</script><link rel=stylesheet href=/orbien/assets/css/styles.ed0019d2.css /><script src=/orbien/assets/js/runtime~main.1b9facb5.js defer></script><script src=/orbien/assets/js/main.d5d69023.js defer></script></head><body><svg style="display: none;"><defs>
|
||
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme-806")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/orbien/img/logo.png /><div role=region aria-label=跳到主要内容><a class=skipToContent_FN88 href=#__docusaurus_skipToContent_fallback>跳到主要内容</a></div><nav aria-label=主导航 class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label=切换导航栏 aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/orbien/><div class=navbar__logo><img src=/orbien/img/logo.png alt=Orbien class="themedComponent_GEMc themedComponent--light_BbLV"/><img src=/orbien/img/logo.png alt=Orbien class="themedComponent_GEMc themedComponent--dark_KjWx"/></div><b class="navbar__title text--truncate">Orbien</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/orbien/docs/intro>文档</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href=# aria-haspopup=true aria-expanded=false role=button class=navbar__link><svg viewBox="0 0 24 24" width=20 height=20 aria-hidden=true class=iconLanguage_wHVZ><path fill=currentColor d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"/></svg>中文</a><ul class=dropdown__menu><li><a href=/orbien/docs/integrations/springboot target=_self rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang=zh-CN>中文</a><li><a href=/orbien/en/docs/integrations/springboot target=_self rel="noopener noreferrer" class=dropdown__link lang=en>English</a></ul></div><a href=https://github.com/orbien-org/orbien target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_noS7><use href=#theme-svg-external-link /></svg></a><div class="toggle_lFj9 colorModeToggle_tlDC"><button class="clean-btn toggleButton_kS2p toggleButtonDisabled_whbh" type=button disabled title="system mode" aria-label="切换浅色/暗黑模式（当前为system mode）"><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_GXMt lightToggleIcon_gLtc"><path fill=currentColor d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_GXMt darkToggleIcon_d7h4"><path fill=currentColor d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_GXMt systemToggleIcon_yMcU"><path fill=currentColor d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"/></svg></button></div><div class=navbarSearchContainer_qeB0></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_jh3T"><div class=docsWrapper_Nx3v><button aria-label=回到顶部 class="clean-btn theme-back-to-top-button backToTopButton_td4T" type=button></button><div class=docRoot_sSzf><aside class="theme-doc-sidebar-container docSidebarContainer_RnCF"><div class=sidebarViewport_W1f_><div class=sidebar_ZBtH><nav aria-label=文档侧边栏 class="menu thin-scrollbar menu_MXSD"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/intro><span class=linkLabel_VO99>介绍</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/download><span class=linkLabel_VO99>下载</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/quickstart><span class=linkLabel_VO99>快速开始</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/docker><span class=linkLabel_VO99>Docker 安装</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/desktop><span class=linkLabel_VO99>桌面客户端</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_oiaQ menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=false href=/orbien/docs/tunnels/tcp><span class=categoryLinkLabel_Yav_>隧道协议</span></a></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_oiaQ menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=false href=/orbien/docs/transport/protocol/tcp><span class=categoryLinkLabel_Yav_>传输与安全</span></a></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_oiaQ menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=false href=/orbien/docs/features/authentication><span class=categoryLinkLabel_Yav_>功能特性</span></a></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_oiaQ menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role=button aria-expanded=true href=/orbien/docs/integrations/springboot><span class=categoryLinkLabel_Yav_>集成</span></a></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/orbien/docs/integrations/springboot><span class=linkLabel_VO99>SpringBoot集成</span></a></ul><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/performance><span class=linkLabel_VO99>性能测试</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/license><span class=linkLabel_VO99>许可证</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/community><span class=linkLabel_VO99>社区和贡献</span></a></ul></nav></div></div></aside><main class=docMainContainer_Qokp><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_s3FD"><div class=docItemContainer_mR32><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_TgFU" aria-label=页面路径><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label=主页面 class=breadcrumbs__link href=/orbien/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_P4Jh><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><span class=breadcrumbs__link>集成</span><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>SpringBoot集成</span></ul></nav><div class="tocCollapsible_s6MJ theme-doc-toc-mobile tocMobile_OKVJ"><button type=button class="clean-btn tocCollapsibleButton_iHMI">本页总览</button></div><div class="theme-doc-markdown markdown"><header><h1>Spring Boot 集成</h1></header>
|
||
<p><strong>Orbien</strong> 提供可内嵌到 Spring Boot 的 Java 客户端，当前能力：</p>
|
||
<ul>
|
||
<li class="">隧道协议：仅 <strong>TCP</strong>、<strong>HTTP</strong></li>
|
||
<li class="">传输层：仅 <strong>TCP</strong></li>
|
||
<li class=""><strong>不支持 TCP 多路复用</strong>：<code>orbien.tcp-mux</code> 必须为 <code>false</code>，服务端也需 <code>[transport].tcpMux = false</code>（服务端默认开启多路复用，与 Java 客户端联调时需显式关闭）</li>
|
||
</ul>
|
||
<div class="theme-tabs-container tabs-container tabList_RDf5"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_L0iM tabs__item--active">Maven<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_L0iM">Gradle</ul><div class=margin-top--md><div role=tabpanel class=tabItem_npJv><div class="language-xml codeBlockContainer_NRKS theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_hhpz><pre tabindex=0 class="prism-code language-xml codeBlock_xvCs thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_nRHr><div class=token-line style=color:#393A34><span class="token tag punctuation" style=color:#393A34><</span><span class="token tag" style=color:#00009f>dependency</span><span class="token tag punctuation" style=color:#393A34>></span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token tag punctuation" style=color:#393A34><</span><span class="token tag" style=color:#00009f>groupId</span><span class="token tag punctuation" style=color:#393A34>></span><span class="token plain">io.github.lxien</span><span class="token tag punctuation" style=color:#393A34></</span><span class="token tag" style=color:#00009f>groupId</span><span class="token tag punctuation" style=color:#393A34>></span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token tag punctuation" style=color:#393A34><</span><span class="token tag" style=color:#00009f>artifactId</span><span class="token tag punctuation" style=color:#393A34>></span><span class="token plain">orbien-spring-boot-starter</span><span class="token tag punctuation" style=color:#393A34></</span><span class="token tag" style=color:#00009f>artifactId</span><span class="token tag punctuation" style=color:#393A34>></span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token tag punctuation" style=color:#393A34><</span><span class="token tag" style=color:#00009f>version</span><span class="token tag punctuation" style=color:#393A34>></span><span class="token plain">3.7.0</span><span class="token tag punctuation" style=color:#393A34></</span><span class="token tag" style=color:#00009f>version</span><span class="token tag punctuation" style=color:#393A34>></span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token tag punctuation" style=color:#393A34></</span><span class="token tag" style=color:#00009f>dependency</span><span class="token tag punctuation" style=color:#393A34>></span><br/></div></code></pre></div></div></div><div role=tabpanel class=tabItem_npJv hidden><div class="language-groovy codeBlockContainer_NRKS theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_hhpz><pre tabindex=0 class="prism-code language-groovy codeBlock_xvCs thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_nRHr><div class=token-line style=color:#393A34><span class="token plain">implementation("io.github.lxien:orbien-spring-boot-starter:3.7.0")</span><br/></div></code></pre></div></div></div></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_HmRV" id=最小配置>最小配置<a href=#最小配置 class=hash-link aria-label=最小配置的直接链接 title=最小配置的直接链接 translate=no></a></h2>
|
||
<div class="language-yaml codeBlockContainer_NRKS theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_hhpz><pre tabindex=0 class="prism-code language-yaml codeBlock_xvCs thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_nRHr><div class=token-line style=color:#393A34><span class="token comment" style=color:#999988;font-style:italic># application.yml</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token key atrule" style=color:#00a4db>orbien</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>enabled</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> </span><span class="token boolean important" style=color:#36acaa>true</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>server</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"127.0.0.1:9527"</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token comment" style=color:#999988;font-style:italic># token: YOUR_TOKEN</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>tunnel</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>protocol</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> http</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>domains</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>-</span><span class="token plain"> web.example.com</span><br/></div></code></pre></div></div>
|
||
<p>服务端需关闭多路复用：</p>
|
||
<div class="language-toml codeBlockContainer_NRKS theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_hhpz><pre tabindex=0 class="prism-code language-toml codeBlock_xvCs thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_nRHr><div class=token-line style=color:#393A34><span class="token comment" style=color:#999988;font-style:italic># orbien-server.toml</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token key property" style=color:#36acaa>listen</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>=</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"0.0.0.0:9527"</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token key property" style=color:#36acaa>httpGwPort</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>=</span><span class="token plain"> </span><span class="token number" style=color:#36acaa>80</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain" style=display:inline-block></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token punctuation" style=color:#393A34>[</span><span class="token table class-name">transport</span><span class="token punctuation" style=color:#393A34>]</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token key property" style=color:#36acaa>tcpMux</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>=</span><span class="token plain"> </span><span class="token boolean" style=color:#36acaa>false</span><br/></div></code></pre></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_HmRV" id=tcp-示例>TCP 示例<a href=#tcp-示例 class=hash-link aria-label="TCP 示例的直接链接" title="TCP 示例的直接链接" translate=no></a></h2>
|
||
<div class="language-yaml codeBlockContainer_NRKS theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_hhpz><pre tabindex=0 class="prism-code language-yaml codeBlock_xvCs thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_nRHr><div class=token-line style=color:#393A34><span class="token key atrule" style=color:#00a4db>orbien</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>enabled</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> </span><span class="token boolean important" style=color:#36acaa>true</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>server</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"127.0.0.1:9527"</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>token</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> YOUR_TOKEN</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>tunnel</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>protocol</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> tcp</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token comment" style=color:#999988;font-style:italic># local-port: 3306</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>remote-port</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> </span><span class="token number" style=color:#36acaa>9000</span><br/></div></code></pre></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_HmRV" id=完整参考>完整参考<a href=#完整参考 class=hash-link aria-label=完整参考的直接链接 title=完整参考的直接链接 translate=no></a></h2>
|
||
<div class="language-yaml codeBlockContainer_NRKS theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_hhpz><pre tabindex=0 class="prism-code language-yaml codeBlock_xvCs thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_nRHr><div class=token-line style=color:#393A34><span class="token comment" style=color:#999988;font-style:italic># application.yml</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token key atrule" style=color:#00a4db>orbien</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>enabled</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> </span><span class="token boolean important" style=color:#36acaa>true</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>server</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"127.0.0.1:9527"</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>token</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> YOUR_TOKEN</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>tcp-mux</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> </span><span class="token boolean important" style=color:#36acaa>false</span><span class="token plain"> </span><span class="token comment" style=color:#999988;font-style:italic># 必须为 false</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>pool-count</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> </span><span class="token number" style=color:#36acaa>1</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>heartbeat-interval-secs</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> </span><span class="token number" style=color:#36acaa>30</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>user</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> spring</span><span class="token punctuation" style=color:#393A34>-</span><span class="token plain">boot</span><span class="token punctuation" style=color:#393A34>-</span><span class="token plain">demo</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>tunnel</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>name</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> web</span><span class="token punctuation" style=color:#393A34>-</span><span class="token plain">demo</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>protocol</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> http</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>local-ip</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> 127.0.0.1</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token comment" style=color:#999988;font-style:italic># local-port: 8080</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token comment" style=color:#999988;font-style:italic># remote-port: 9000</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>domains</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>-</span><span class="token plain"> web.example.com</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token comment" style=color:#999988;font-style:italic># - admin</span><br/></div></code></pre></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_HmRV" id=配置项说明>配置项说明<a href=#配置项说明 class=hash-link aria-label=配置项说明的直接链接 title=配置项说明的直接链接 translate=no></a></h2>
|
||
<table><thead><tr><th>配置项<th>默认值<th>说明<tbody><tr><td><code>orbien.enabled</code><td><code>true</code><td>是否启用<tr><td><code>orbien.server</code><td><code>127.0.0.1:9527</code><td>服务端地址<tr><td><code>orbien.token</code><td>空<td>鉴权 token<tr><td><code>orbien.tcp-mux</code><td><code>false</code><td>仅允许 <code>false</code><tr><td><code>orbien.pool-count</code><td><code>1</code><td>登录时预申请的数据连接数<tr><td><code>orbien.heartbeat-interval-secs</code><td><code>30</code><td>控制面心跳间隔（秒）<tr><td><code>orbien.user</code><td>空<td>展示用用户名<tr><td><code>orbien.tunnel.name</code><td>见上文<td>隧道名<tr><td><code>orbien.tunnel.protocol</code><td><code>tcp</code><td><code>tcp</code> 或 <code>http</code><tr><td><code>orbien.tunnel.local-ip</code><td><code>127.0.0.1</code><td>本地服务 IP<tr><td><code>orbien.tunnel.local-port</code><td><code>0</code><td>本地服务端口<tr><td><code>orbien.tunnel.remote-port</code><td><code>0</code><td>服务端对外端口；<code>protocol=tcp</code> 时必填<tr><td><code>orbien.tunnel.domains</code><td><code>[]</code><td>HTTP 域名列表；<code>protocol=http</code> 时必填</table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_eZPL"><a href=https://github.com/orbien-org/orbien/tree/main/docs/docs/integrations/springboot.mdx target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit__D7p aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>编辑此页</a></div><div class="col lastUpdated_SJXM"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label=文件选项卡><a class="pagination-nav__link pagination-nav__link--prev" href=/orbien/docs/features/hot-reload><div class=pagination-nav__sublabel>上一页</div><div class=pagination-nav__label>热重载</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/orbien/docs/performance><div class=pagination-nav__sublabel>下一页</div><div class=pagination-nav__label>性能测试</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_Vz4h thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#最小配置 class="table-of-contents__link toc-highlight">最小配置</a><li><a href=#tcp-示例 class="table-of-contents__link toc-highlight">TCP 示例</a><li><a href=#完整参考 class="table-of-contents__link toc-highlight">完整参考</a><li><a href=#配置项说明 class="table-of-contents__link toc-highlight">配置项说明</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2026 Orbien. Apache-2.0.</div></div></div></footer></div></body> |