| <!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-guide/go/codegen" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.10.1"><title data-rh=true>代码生成 | Apache Fory™</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true property=og:url content=https://fory.apache.org/zh-CN/docs/next/guide/go/codegen /><meta data-rh=true property=og:locale content=zh_CN /><meta data-rh=true property=og:locale:alternate content=en_US /><meta data-rh=true name=docusaurus_locale content=zh-CN /><meta data-rh=true name=docsearch:language content=zh-CN /><meta data-rh=true http-equiv=Content-Security-Policy content="frame-src 'self' https://ghbtns.com/;"/><meta data-rh=true property=og:image content=https://fory.apache.org/img/logo.png /><meta data-rh=true property=og:image:width content=1500 /><meta data-rh=true property=og:image:height content=1500 /><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true name=twitter:image content=https://fory.apache.org/img/logo.png /><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="代码生成 | Apache Fory™"/><meta data-rh=true name=description content="代码生成是 Fory Go 中的实验性特性。其 API 和行为可能会在后续版本中发生变化。标准运行时路径仍是大多数场景下稳定且推荐的做法。"/><meta data-rh=true property=og:description content="代码生成是 Fory Go 中的实验性特性。其 API 和行为可能会在后续版本中发生变化。标准运行时路径仍是大多数场景下稳定且推荐的做法。"/><link data-rh=true rel=icon href=/zh-CN/img/favicon.ico /><link data-rh=true rel=canonical href=https://fory.apache.org/zh-CN/docs/next/guide/go/codegen /><link data-rh=true rel=alternate href=https://fory.apache.org/docs/next/guide/go/codegen hreflang=en-US /><link data-rh=true rel=alternate href=https://fory.apache.org/zh-CN/docs/next/guide/go/codegen hreflang=zh-CN /><link data-rh=true rel=alternate href=https://fory.apache.org/docs/next/guide/go/codegen hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://fory.apache.org/zh-CN/docs/next/guide/go/","name":"Go","position":1},{"@type":"ListItem","item":"https://fory.apache.org/zh-CN/docs/next/guide/go/codegen","name":"代码生成","position":2}]}</script><link rel=alternate type=application/rss+xml href=/zh-CN/blog/rss.xml title="Apache Fory™ RSS Feed"><link rel=alternate type=application/atom+xml href=/zh-CN/blog/atom.xml title="Apache Fory™ Atom Feed"><script type=text/javascript>"fury.apache.org"===window.location.host&&(window.location.href="https://fory.apache.org"),function(){for(var o=window.location.pathname,a=["guide","introduction","start"],n=0;n<a.length;n++){var t=a[n],i=RegExp("^((?:/[a-z]{2}-[A-Z]{2})?/docs(?:/(?:next|[0-9]+.[0-9]+))?)/docs/"+t+"(/.*)?$"),c=o.match(i);if(c){var r=c[1]+"/"+t+(c[2]||"");window.location.replace(r+window.location.search+window.location.hash);return}}}()</script><link rel=stylesheet href=/zh-CN/assets/css/styles.3a1edaa1.css /><script src=/zh-CN/assets/js/runtime~main.49719703.js defer></script><script src=/zh-CN/assets/js/main.bc407ed5.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")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),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><div role=region aria-label=跳到主要内容><a class=skipToContent_fXgn 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=/zh-CN/><div class=navbar__logo><img src=/zh-CN/img/fory-logo-light.png alt="Fory Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"/><img src=/zh-CN/img/fory-logo-dark.png alt="Fory Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"/></div><b class="navbar__title text--truncate"></b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/zh-CN/docs/next/introduction/overview>文档</a><a class="navbar__item navbar__link" href=/zh-CN/docs/next/specification/java_serialization_spec>规范</a><a class="navbar__item navbar__link" href=/zh-CN/docs/next/community/>社区</a><a class="navbar__item navbar__link" href=/zh-CN/user>用户</a><a class="navbar__item navbar__link" href=/zh-CN/download>下载</a><a class="navbar__item navbar__link" href=/zh-CN/blog>博客</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>ASF</a><ul class=dropdown__menu><li><a href=https://www.apache.org/ target=_blank rel="noopener noreferrer" class=dropdown__link>基金会</a><li><a href=https://www.apache.org/licenses/ target=_blank rel="noopener noreferrer" class=dropdown__link>许可证</a><li><a href=https://www.apache.org/events/current-event.html target=_blank rel="noopener noreferrer" class=dropdown__link>事件</a><li><a href=https://privacy.apache.org/policies/privacy-policy-public.html target=_blank rel="noopener noreferrer" class=dropdown__link>隐私</a><li><a href=https://www.apache.org/security/ target=_blank rel="noopener noreferrer" class=dropdown__link>安全</a><li><a href=https://www.apache.org/foundation/sponsorship.html target=_blank rel="noopener noreferrer" class=dropdown__link>赞助</a><li><a href=https://www.apache.org/foundation/thanks.html target=_blank rel="noopener noreferrer" class=dropdown__link>感谢</a><li><a href=https://www.apache.org/foundation/policies/conduct.html target=_blank rel="noopener noreferrer" class=dropdown__link>行为准则</a></ul></div><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class=navbar__link aria-haspopup=true aria-expanded=false role=button href=/zh-CN/docs/next/guide/go/codegen>dev</a><ul class=dropdown__menu><li><a aria-current=page class="dropdown__link dropdown__link--active" href=/zh-CN/docs/next/guide/go/codegen>dev</a><li><a class=dropdown__link href=/zh-CN/docs/guide/go/codegen>1.3.0</a><li><a class=dropdown__link href=/zh-CN/docs/1.2.0/guide/go/codegen>1.2.0</a><li><a class=dropdown__link href=/zh-CN/docs/1.1.0/guide/go/codegen>1.1.0</a><li><a class=dropdown__link href=/zh-CN/docs/1.0.0/guide/go/codegen>1.0.0</a><li><a class=dropdown__link href=/zh-CN/docs/0.17/guide/go/codegen>0.17</a><li><a class=dropdown__link href=/zh-CN/docs/0.16/guide/go/codegen>0.16</a><li><a class=dropdown__link href=/zh-CN/docs/0.15/guide/go/codegen>0.15</a><li><a class=dropdown__link href=/zh-CN/docs/0.14/introduction/overview>0.14</a><li><a class=dropdown__link href=/zh-CN/docs/0.13/introduction/overview>0.13</a><li><a class=dropdown__link href=/zh-CN/docs/0.12/introduction/overview>0.12</a><li><a class=dropdown__link href=/zh-CN/docs/0.11/introduction/overview>0.11</a><li><a class=dropdown__link href=/zh-CN/docs/0.10/introduction/overview>0.10</a></ul></div><a href=https://github.com/apache/fory target=_blank rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><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_nlXk><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=/docs/next/guide/go/codegen target=_self rel="noopener noreferrer" class=dropdown__link lang=en-US>English</a><li><a href=/zh-CN/docs/next/guide/go/codegen target=_self rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang=zh-CN>简体中文</a></ul></div><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" 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_g3eP lightToggleIcon_pyhR"><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_g3eP darkToggleIcon_wfgR"><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_g3eP systemToggleIcon_QzmC"><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_Bca1><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled/></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class=docsWrapper_hBAB><button aria-label=回到顶部 class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type=button></button><div class=docRoot_UBD9><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class=sidebarViewport_aRkj><div class=sidebar_njMd><nav aria-label=文档侧边栏 class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><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_byQd menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=true href=/zh-CN/docs/next/introduction/overview><span title=介绍 class=categoryLinkLabel_W154>介绍</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 tabindex=0 href=/zh-CN/docs/next/introduction/overview><span title=概述 class=linkLabel_WmDU>概述</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/introduction/features><span title=特性 class=linkLabel_WmDU>特性</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/introduction/benchmark><span title=性能测试 class=linkLabel_WmDU>性能测试</span></a></ul><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_byQd menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=true href=/zh-CN/docs/next/start/install><span title=快速开始 class=categoryLinkLabel_W154>快速开始</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 tabindex=0 href=/zh-CN/docs/next/start/install><span title=安装 class=linkLabel_WmDU>安装</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/start/usage><span title=使用 class=linkLabel_WmDU>使用</span></a></ul><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_byQd menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=false href=/zh-CN/docs/next/compiler/><span title="Schema IDL 与编译器" class=categoryLinkLabel_W154>Schema IDL 与编译器</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_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role=button aria-expanded=true href=/zh-CN/docs/next/guide/java/><span title=用户指南 class=categoryLinkLabel_W154>用户指南</span></a></div><ul class=menu__list><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/zh-CN/docs/next/guide/java/><span title=Java class=categoryLinkLabel_W154>Java</span></a><button aria-label="展开侧边栏分类 'Java'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/zh-CN/docs/next/guide/python/><span title=Python class=categoryLinkLabel_W154>Python</span></a><button aria-label="展开侧边栏分类 'Python'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/zh-CN/docs/next/guide/rust/><span title=Rust class=categoryLinkLabel_W154>Rust</span></a><button aria-label="展开侧边栏分类 'Rust'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/zh-CN/docs/next/guide/cpp/><span title=C++ class=categoryLinkLabel_W154>C++</span></a><button aria-label="展开侧边栏分类 'C++'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--active" tabindex=0 href=/zh-CN/docs/next/guide/go/><span title=Go class=categoryLinkLabel_W154>Go</span></a><button aria-label="折叠侧边栏分类 'Go'" aria-expanded=true type=button class="clean-btn menu__caret"></button></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/guide/go/xlang_serialization><span title="Xlang 序列化" class=linkLabel_WmDU>Xlang 序列化</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/guide/go/native_serialization><span title="Native 序列化" class=linkLabel_WmDU>Native 序列化</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/guide/go/schema_metadata><span title="Schema 元数据" class=linkLabel_WmDU>Schema 元数据</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/guide/go/supported_types><span title=支持的类型 class=linkLabel_WmDU>支持的类型</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/guide/go/references><span title=引用 class=linkLabel_WmDU>引用</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/guide/go/schema_evolution><span title="Schema 演进" class=linkLabel_WmDU>Schema 演进</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/guide/go/configuration><span title=配置 class=linkLabel_WmDU>配置</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/guide/go/custom_serializers><span title=自定义序列化器 class=linkLabel_WmDU>自定义序列化器</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/guide/go/thread_safety><span title=线程安全 class=linkLabel_WmDU>线程安全</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/guide/go/grpc_support><span title="gRPC 支持" class=linkLabel_WmDU>gRPC 支持</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/guide/go/troubleshooting><span title=故障排查 class=linkLabel_WmDU>故障排查</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/guide/go/basic_serialization><span title=基本序列化 class=linkLabel_WmDU>基本序列化</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class=menu__link tabindex=0 href=/zh-CN/docs/next/guide/go/type_registration><span title=类型注册 class=linkLabel_WmDU>类型注册</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/zh-CN/docs/next/guide/go/codegen><span title=代码生成 class=linkLabel_WmDU>代码生成</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/zh-CN/docs/next/guide/javascript/><span title=JavaScript class=categoryLinkLabel_W154>JavaScript</span></a><button aria-label="展开侧边栏分类 'JavaScript'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/zh-CN/docs/next/guide/csharp/><span title=C# class=categoryLinkLabel_W154>C#</span></a><button aria-label="展开侧边栏分类 'C#'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/zh-CN/docs/next/guide/swift/><span title=Swift class=categoryLinkLabel_W154>Swift</span></a><button aria-label="展开侧边栏分类 'Swift'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/zh-CN/docs/next/guide/dart/><span title=Dart class=categoryLinkLabel_W154>Dart</span></a><button aria-label="展开侧边栏分类 'Dart'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/zh-CN/docs/next/guide/scala/><span title=Scala class=categoryLinkLabel_W154>Scala</span></a><button aria-label="展开侧边栏分类 'Scala'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/zh-CN/docs/next/guide/kotlin/><span title=Kotlin class=categoryLinkLabel_W154>Kotlin</span></a><button aria-label="展开侧边栏分类 'Kotlin'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex=0 href=/zh-CN/docs/next/guide/xlang/><span title=跨语言 class=categoryLinkLabel_W154>跨语言</span></a><button aria-label="展开侧边栏分类 '跨语言'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div></ul></ul></nav></div></div></aside><main class=docMainContainer_TBSr><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_VOVn"><div class="theme-doc-version-banner alert alert--warning margin-bottom--md" role=alert><div>此为 <!-- -->Apache Fory™<!-- --> <b>dev</b> 版尚未发行的文档。</div><div class=margin-top--md>最新的文档请参阅 <b><a href=/zh-CN/docs/guide/go/codegen>最新版本</a></b> (<!-- -->1.3.0<!-- -->)。</div></div><div class=docItemContainer_Djhp><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label=页面路径><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label=主页面 class=breadcrumbs__link href=/zh-CN/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_YNFT><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><a class=breadcrumbs__link href=/zh-CN/docs/next/guide/go/><span>Go</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>代码生成</span></ul></nav><span class="theme-doc-version-badge badge badge--secondary">版本：dev</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type=button class="clean-btn tocCollapsibleButton_TO0P">本页总览</button></div><div class="theme-doc-markdown markdown"><header><h1>代码生成</h1></header><div class="theme-admonition theme-admonition-warning admonition_xJq3 alert alert--warning"><div class=admonitionHeading_Gvgb><span class=admonitionIcon_Rf37><svg viewBox="0 0 16 16"><path fill-rule=evenodd d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"/></svg></span>Experimental Feature</div><div class=admonitionContent_BuS1><p>代码生成是 Fory Go 中的<strong>实验性</strong>特性。其 API 和行为可能会在后续版本中发生变化。标准运行时路径仍是大多数场景下稳定且推荐的做法。</div></div> |
| <p>Fory Go 为性能关键路径提供可选的 AOT 代码生成。它会提前生成专用序列化器，并增加编译期 shape 校验。</p> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=为什么使用代码生成>为什么使用代码生成？<a href=#为什么使用代码生成 class=hash-link aria-label=为什么使用代码生成？的直接链接 title=为什么使用代码生成？的直接链接 translate=no></a></h2> |
| <table><thead><tr><th>方面<th>标准路径<th>代码生成<tbody><tr><td>接入成本<td>零配置<td>需要 <code>go generate</code><tr><td>性能<td>已经很优秀<td>热路径上更快<tr><td>类型安全<td>运行时校验<td>编译期校验<tr><td>维护成本<td>自动完成<td>需要重新生成</table> |
| <p><strong>适合使用代码生成的场景：</strong></p> |
| <ul> |
| <li class="">需要极致性能</li> |
| <li class="">很看重编译期类型安全</li> |
| <li class="">热路径对性能非常敏感</li> |
| </ul> |
| <p><strong>适合继续使用标准路径的场景：</strong></p> |
| <ul> |
| <li class="">更偏好简单接入</li> |
| <li class="">类型经常变化</li> |
| <li class="">需要动态类型</li> |
| <li class="">不希望引入代码生成复杂度</li> |
| </ul> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=安装>安装<a href=#安装 class=hash-link aria-label=安装的直接链接 title=安装的直接链接 translate=no></a></h2> |
| <p>安装 <code>fory</code> 生成器二进制：</p> |
| <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">go </span><span class="token function" style=color:#d73a49>install</span><span class="token plain"> github.com/apache/fory/go/fory/cmd/fory@latest</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 assign-left variable" style=color:#36acaa>GO111MODULE</span><span class="token operator" style=color:#393A34>=</span><span class="token plain">on go get </span><span class="token parameter variable" style=color:#36acaa>-u</span><span class="token plain"> github.com/apache/fory/go/fory/cmd/fory</span><br/></div></code></pre></div></div> |
| <p>确保 <code>$GOBIN</code> 或 <code>$GOPATH/bin</code> 已加入 <code>PATH</code>。</p> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=基本用法>基本用法<a href=#基本用法 class=hash-link aria-label=基本用法的直接链接 title=基本用法的直接链接 translate=no></a></h2> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=步骤-1标注结构体>步骤 1：标注结构体<a href=#步骤-1标注结构体 class=hash-link aria-label="步骤 1：标注结构体的直接链接" title="步骤 1：标注结构体的直接链接" translate=no></a></h3> |
| <p>在结构体上方添加 <code>//fory:generate</code> 注释：</p> |
| <div class="language-go codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-go codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token keyword" style=color:#00009f>package</span><span class="token plain"> models</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 comment" style=color:#999988;font-style:italic>//fory:generate</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token keyword" style=color:#00009f>type</span><span class="token plain"> User </span><span class="token keyword" style=color:#00009f>struct</span><span class="token plain"> </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"> ID </span><span class="token builtin">int64</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>`json:"id"`</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> Name </span><span class="token builtin">string</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>`json:"name"`</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"></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 comment" style=color:#999988;font-style:italic>//fory:generate</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token keyword" style=color:#00009f>type</span><span class="token plain"> Order </span><span class="token keyword" style=color:#00009f>struct</span><span class="token plain"> </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"> ID </span><span class="token builtin">int64</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> Customer </span><span class="token builtin">string</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> Total </span><span class="token builtin">float64</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><br/></div></code></pre></div></div> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=步骤-2添加-go-generate-指令>步骤 2：添加 Go Generate 指令<a href=#步骤-2添加-go-generate-指令 class=hash-link aria-label="步骤 2：添加 Go Generate 指令的直接链接" title="步骤 2：添加 Go Generate 指令的直接链接" translate=no></a></h3> |
| <p>添加 <code>go:generate</code> 指令（每个文件或每个包一次即可）：</p> |
| <div class="language-go codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-go codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token comment" style=color:#999988;font-style:italic>//go:generate fory -file models.go</span><br/></div></code></pre></div></div> |
| <p>或者针对整个包：</p> |
| <div class="language-go codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-go codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token comment" style=color:#999988;font-style:italic>//go:generate fory -pkg .</span><br/></div></code></pre></div></div> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=步骤-3执行代码生成>步骤 3：执行代码生成<a href=#步骤-3执行代码生成 class=hash-link aria-label="步骤 3：执行代码生成的直接链接" title="步骤 3：执行代码生成的直接链接" translate=no></a></h3> |
| <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">go generate ./</span><span class="token punctuation" style=color:#393A34>..</span><span class="token plain">.</span><br/></div></code></pre></div></div> |
| <p>这会生成包含序列化器代码的 <code>models_fory_gen.go</code> 文件。</p> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=生成代码的结构>生成代码的结构<a href=#生成代码的结构 class=hash-link aria-label=生成代码的结构的直接链接 title=生成代码的结构的直接链接 translate=no></a></h2> |
| <p>生成器会输出以下内容：</p> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=类型快照>类型快照<a href=#类型快照 class=hash-link aria-label=类型快照的直接链接 title=类型快照的直接链接 translate=no></a></h3> |
| <p>用于检测结构体变化的编译期检查：</p> |
| <div class="language-go codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-go codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token comment" style=color:#999988;font-style:italic>// Snapshot of User's underlying type at generation time</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token keyword" style=color:#00009f>type</span><span class="token plain"> _User_expected </span><span class="token keyword" style=color:#00009f>struct</span><span class="token plain"> </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"> ID </span><span class="token builtin">int64</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> Name </span><span class="token builtin">string</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"></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 comment" style=color:#999988;font-style:italic>// Compile-time check: fails if User no longer matches</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token keyword" style=color:#00009f>var</span><span class="token plain"> </span><span class="token boolean" style=color:#36acaa>_</span><span class="token plain"> </span><span class="token operator" style=color:#393A34>=</span><span class="token plain"> </span><span class="token keyword" style=color:#00009f>func</span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">x User</span><span class="token punctuation" style=color:#393A34>)</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>_</span><span class="token plain"> </span><span class="token operator" style=color:#393A34>=</span><span class="token plain"> </span><span class="token function" style=color:#d73a49>_User_expected</span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">x</span><span class="token punctuation" style=color:#393A34>)</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>}</span><br/></div></code></pre></div></div> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=序列化器实现>序列化器实现<a href=#序列化器实现 class=hash-link aria-label=序列化器实现的直接链接 title=序列化器实现的直接链接 translate=no></a></h3> |
| <p>强类型的序列化方法：</p> |
| <div class="language-go codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-go codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token keyword" style=color:#00009f>type</span><span class="token plain"> User_ForyGenSerializer </span><span class="token keyword" style=color:#00009f>struct</span><span class="token punctuation" style=color:#393A34>{</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" style=display:inline-block></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token keyword" style=color:#00009f>func</span><span class="token plain"> </span><span class="token function" style=color:#d73a49>NewSerializerFor_User</span><span class="token punctuation" style=color:#393A34>(</span><span class="token punctuation" style=color:#393A34>)</span><span class="token plain"> fory</span><span class="token punctuation" style=color:#393A34>.</span><span class="token plain">Serializer </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 keyword" style=color:#00009f>return</span><span class="token plain"> </span><span class="token operator" style=color:#393A34>&</span><span class="token plain">User_ForyGenSerializer</span><span class="token punctuation" style=color:#393A34>{</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"></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 keyword" style=color:#00009f>func</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">User_ForyGenSerializer</span><span class="token punctuation" style=color:#393A34>)</span><span class="token plain"> </span><span class="token function" style=color:#d73a49>WriteTyped</span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">ctx </span><span class="token operator" style=color:#393A34>*</span><span class="token plain">fory</span><span class="token punctuation" style=color:#393A34>.</span><span class="token plain">WriteContext</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"> v </span><span class="token operator" style=color:#393A34>*</span><span class="token plain">User</span><span class="token punctuation" style=color:#393A34>)</span><span class="token plain"> </span><span class="token builtin">error</span><span class="token plain"> </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"> buf </span><span class="token operator" style=color:#393A34>:=</span><span class="token plain"> ctx</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>Buffer</span><span class="token punctuation" style=color:#393A34>(</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"> buf</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>WriteInt64</span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">v</span><span class="token punctuation" style=color:#393A34>.</span><span class="token plain">ID</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"> ctx</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>WriteString</span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">v</span><span class="token punctuation" style=color:#393A34>.</span><span class="token plain">Name</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 keyword" style=color:#00009f>return</span><span class="token plain"> </span><span class="token boolean" style=color:#36acaa>nil</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"></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 keyword" style=color:#00009f>func</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">User_ForyGenSerializer</span><span class="token punctuation" style=color:#393A34>)</span><span class="token plain"> </span><span class="token function" style=color:#d73a49>ReadTyped</span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">ctx </span><span class="token operator" style=color:#393A34>*</span><span class="token plain">fory</span><span class="token punctuation" style=color:#393A34>.</span><span class="token plain">ReadContext</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"> v </span><span class="token operator" style=color:#393A34>*</span><span class="token plain">User</span><span class="token punctuation" style=color:#393A34>)</span><span class="token plain"> </span><span class="token builtin">error</span><span class="token plain"> </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"> err </span><span class="token operator" style=color:#393A34>:=</span><span class="token plain"> ctx</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>Err</span><span class="token punctuation" style=color:#393A34>(</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"> buf </span><span class="token operator" style=color:#393A34>:=</span><span class="token plain"> ctx</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>Buffer</span><span class="token punctuation" style=color:#393A34>(</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"> v</span><span class="token punctuation" style=color:#393A34>.</span><span class="token plain">ID </span><span class="token operator" style=color:#393A34>=</span><span class="token plain"> buf</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>ReadInt64</span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">err</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"> v</span><span class="token punctuation" style=color:#393A34>.</span><span class="token plain">Name </span><span class="token operator" style=color:#393A34>=</span><span class="token plain"> ctx</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>ReadString</span><span class="token punctuation" style=color:#393A34>(</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 keyword" style=color:#00009f>if</span><span class="token plain"> ctx</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>HasError</span><span class="token punctuation" style=color:#393A34>(</span><span class="token punctuation" style=color:#393A34>)</span><span class="token plain"> </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 keyword" style=color:#00009f>return</span><span class="token plain"> ctx</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>TakeError</span><span class="token punctuation" style=color:#393A34>(</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"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token keyword" style=color:#00009f>return</span><span class="token plain"> </span><span class="token boolean" style=color:#36acaa>nil</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><br/></div></code></pre></div></div> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=自动注册>自动注册<a href=#自动注册 class=hash-link aria-label=自动注册的直接链接 title=自动注册的直接链接 translate=no></a></h3> |
| <p>序列化器会在 <code>init()</code> 中注册：</p> |
| <div class="language-go codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-go codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token keyword" style=color:#00009f>func</span><span class="token plain"> </span><span class="token function" style=color:#d73a49>init</span><span class="token punctuation" style=color:#393A34>(</span><span class="token punctuation" style=color:#393A34>)</span><span class="token plain"> </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"> fory</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>RegisterSerializerFactory</span><span class="token punctuation" style=color:#393A34>(</span><span class="token punctuation" style=color:#393A34>(</span><span class="token operator" style=color:#393A34>*</span><span class="token plain">User</span><span class="token punctuation" style=color:#393A34>)</span><span class="token punctuation" style=color:#393A34>(</span><span class="token boolean" style=color:#36acaa>nil</span><span class="token punctuation" style=color:#393A34>)</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"> NewSerializerFor_User</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><br/></div></code></pre></div></div> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=命令行选项>命令行选项<a href=#命令行选项 class=hash-link aria-label=命令行选项的直接链接 title=命令行选项的直接链接 translate=no></a></h2> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=按文件生成>按文件生成<a href=#按文件生成 class=hash-link aria-label=按文件生成的直接链接 title=按文件生成的直接链接 translate=no></a></h3> |
| <p>为某个文件生成：</p> |
| <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">fory </span><span class="token parameter variable" style=color:#36acaa>-file</span><span class="token plain"> models.go</span><br/></div></code></pre></div></div> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=按包生成>按包生成<a href=#按包生成 class=hash-link aria-label=按包生成的直接链接 title=按包生成的直接链接 translate=no></a></h3> |
| <p>为整个包生成：</p> |
| <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">fory </span><span class="token parameter variable" style=color:#36acaa>-pkg</span><span class="token plain"> ./models</span><br/></div></code></pre></div></div> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=显式指定类型旧用法>显式指定类型（旧用法）<a href=#显式指定类型旧用法 class=hash-link aria-label=显式指定类型（旧用法）的直接链接 title=显式指定类型（旧用法）的直接链接 translate=no></a></h3> |
| <p>显式指定类型：</p> |
| <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">fory </span><span class="token parameter variable" style=color:#36acaa>-pkg</span><span class="token plain"> ./models </span><span class="token parameter variable" style=color:#36acaa>-type</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"User,Order"</span><br/></div></code></pre></div></div> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=强制重新生成>强制重新生成<a href=#强制重新生成 class=hash-link aria-label=强制重新生成的直接链接 title=强制重新生成的直接链接 translate=no></a></h3> |
| <p>即使看起来已经是最新，也强制重新生成：</p> |
| <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">fory </span><span class="token parameter variable" style=color:#36acaa>--force</span><span class="token plain"> </span><span class="token parameter variable" style=color:#36acaa>-file</span><span class="token plain"> models.go</span><br/></div></code></pre></div></div> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=何时需要重新生成>何时需要重新生成<a href=#何时需要重新生成 class=hash-link aria-label=何时需要重新生成的直接链接 title=何时需要重新生成的直接链接 translate=no></a></h2> |
| <p>出现以下任意变化时，都应重新生成：</p> |
| <ul> |
| <li class="">字段新增、删除或重命名</li> |
| <li class="">字段类型变化</li> |
| <li class="">结构体 tag 变化</li> |
| <li class="">新增带 <code>//fory:generate</code> 的结构体</li> |
| </ul> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=自动检测>自动检测<a href=#自动检测 class=hash-link aria-label=自动检测的直接链接 title=自动检测的直接链接 translate=no></a></h3> |
| <p>Fory 内置了编译期守卫：</p> |
| <div class="language-go codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-go codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token comment" style=color:#999988;font-style:italic>// If struct changed, this fails to compile</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token keyword" style=color:#00009f>var</span><span class="token plain"> </span><span class="token boolean" style=color:#36acaa>_</span><span class="token plain"> </span><span class="token operator" style=color:#393A34>=</span><span class="token plain"> </span><span class="token keyword" style=color:#00009f>func</span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">x User</span><span class="token punctuation" style=color:#393A34>)</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>_</span><span class="token plain"> </span><span class="token operator" style=color:#393A34>=</span><span class="token plain"> </span><span class="token function" style=color:#d73a49>_User_expected</span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">x</span><span class="token punctuation" style=color:#393A34>)</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>}</span><br/></div></code></pre></div></div> |
| <p>如果忘记重新生成，构建会失败，并给出明确提示。</p> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=自动重试>自动重试<a href=#自动重试 class=hash-link aria-label=自动重试的直接链接 title=自动重试的直接链接 translate=no></a></h3> |
| <p>当通过 <code>go generate</code> 调用时，生成器会检测陈旧代码并自动重试：</p> |
| <ol> |
| <li class="">发现守卫触发的编译错误</li> |
| <li class="">删除旧的生成文件</li> |
| <li class="">重新生成最新代码</li> |
| </ol> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=支持的类型>支持的类型<a href=#支持的类型 class=hash-link aria-label=支持的类型的直接链接 title=支持的类型的直接链接 translate=no></a></h2> |
| <p>代码生成支持：</p> |
| <ul> |
| <li class="">所有原始类型（<code>bool</code>、<code>int*</code>、<code>uint*</code>、<code>float*</code>、<code>string</code>）</li> |
| <li class="">原始类型和结构体的 slice</li> |
| <li class="">键和值类型受支持的 map</li> |
| <li class="">嵌套结构体（这些结构体也必须生成）</li> |
| <li class="">指向结构体的指针</li> |
| </ul> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=嵌套结构体>嵌套结构体<a href=#嵌套结构体 class=hash-link aria-label=嵌套结构体的直接链接 title=嵌套结构体的直接链接 translate=no></a></h3> |
| <p>所有嵌套结构体也必须带有 <code>//fory:generate</code>：</p> |
| <div class="language-go codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-go codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token comment" style=color:#999988;font-style:italic>//fory:generate</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token keyword" style=color:#00009f>type</span><span class="token plain"> Address </span><span class="token keyword" style=color:#00009f>struct</span><span class="token plain"> </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"> City </span><span class="token builtin">string</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> Country </span><span class="token builtin">string</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"></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 comment" style=color:#999988;font-style:italic>//fory:generate</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token keyword" style=color:#00009f>type</span><span class="token plain"> Person </span><span class="token keyword" style=color:#00009f>struct</span><span class="token plain"> </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"> Name </span><span class="token builtin">string</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> Address Address </span><span class="token comment" style=color:#999988;font-style:italic>// Address must also be generated</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><br/></div></code></pre></div></div> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=cicd-集成>CI/CD 集成<a href=#cicd-集成 class=hash-link aria-label="CI/CD 集成的直接链接" title="CI/CD 集成的直接链接" translate=no></a></h2> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=提交生成代码>提交生成代码<a href=#提交生成代码 class=hash-link aria-label=提交生成代码的直接链接 title=提交生成代码的直接链接 translate=no></a></h3> |
| <p><strong>推荐用于库项目：</strong></p> |
| <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">go generate ./</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 function" style=color:#d73a49>git</span><span class="token plain"> </span><span class="token function" style=color:#d73a49>add</span><span class="token plain"> *_fory_gen.go</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token function" style=color:#d73a49>git</span><span class="token plain"> commit </span><span class="token parameter variable" style=color:#36acaa>-m</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"Regenerate Fory serializers"</span><br/></div></code></pre></div></div> |
| <p><strong>优点</strong>：使用者无需安装生成器即可构建；构建更可复现 |
| <strong>缺点</strong>：diff 更大；需要记得重新生成</p> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=在流水线中生成>在流水线中生成<a href=#在流水线中生成 class=hash-link aria-label=在流水线中生成的直接链接 title=在流水线中生成的直接链接 translate=no></a></h3> |
| <p><strong>推荐用于应用项目：</strong></p> |
| <div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token key atrule" style=color:#00a4db>steps</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"> </span><span class="token key atrule" style=color:#00a4db>run</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> go install github.com/apache/fory/go/fory/cmd/fory@latest</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"> </span><span class="token key atrule" style=color:#00a4db>run</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> go generate ./</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"> </span><span class="token key atrule" style=color:#00a4db>run</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> go build ./</span><span class="token punctuation" style=color:#393A34>...</span><br/></div></code></pre></div></div> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=与生成代码配合使用>与生成代码配合使用<a href=#与生成代码配合使用 class=hash-link aria-label=与生成代码配合使用的直接链接 title=与生成代码配合使用的直接链接 translate=no></a></h2> |
| <p>生成代码可以透明接入：</p> |
| <div class="language-go codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-go codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">f </span><span class="token operator" style=color:#393A34>:=</span><span class="token plain"> fory</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>New</span><span class="token punctuation" style=color:#393A34>(</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" style=display:inline-block></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>// Fory automatically uses generated serializer if available</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain">user </span><span class="token operator" style=color:#393A34>:=</span><span class="token plain"> </span><span class="token operator" style=color:#393A34>&</span><span class="token plain">User</span><span class="token punctuation" style=color:#393A34>{</span><span class="token plain">ID</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 punctuation" style=color:#393A34>,</span><span class="token plain"> Name</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"Alice"</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">data</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"> </span><span class="token boolean" style=color:#36acaa>_</span><span class="token plain"> </span><span class="token operator" style=color:#393A34>:=</span><span class="token plain"> f</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>Serialize</span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">user</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" style=display:inline-block></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token keyword" style=color:#00009f>var</span><span class="token plain"> result User</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">f</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>Deserialize</span><span class="token punctuation" style=color:#393A34>(</span><span class="token plain">data</span><span class="token punctuation" style=color:#393A34>,</span><span class="token plain"> </span><span class="token operator" style=color:#393A34>&</span><span class="token plain">result</span><span class="token punctuation" style=color:#393A34>)</span><br/></div></code></pre></div></div> |
| <p>无需修改业务代码，注册会在 <code>init()</code> 中自动完成。</p> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=混用生成与非生成方式>混用生成与非生成方式<a href=#混用生成与非生成方式 class=hash-link aria-label=混用生成与非生成方式的直接链接 title=混用生成与非生成方式的直接链接 translate=no></a></h2> |
| <p>你可以混合使用两种方式：</p> |
| <div class="language-go codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-go codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token comment" style=color:#999988;font-style:italic>//fory:generate</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token keyword" style=color:#00009f>type</span><span class="token plain"> HotPathStruct </span><span class="token keyword" style=color:#00009f>struct</span><span class="token plain"> </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 comment" style=color:#999988;font-style:italic>// Performance-critical, use codegen</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"></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 keyword" style=color:#00009f>type</span><span class="token plain"> ColdPathStruct </span><span class="token keyword" style=color:#00009f>struct</span><span class="token plain"> </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 comment" style=color:#999988;font-style:italic>// Not annotated, uses the standard runtime serializer</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><br/></div></code></pre></div></div> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=限制>限制<a href=#限制 class=hash-link aria-label=限制的直接链接 title=限制的直接链接 translate=no></a></h2> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=实验性状态>实验性状态<a href=#实验性状态 class=hash-link aria-label=实验性状态的直接链接 title=实验性状态的直接链接 translate=no></a></h3> |
| <ul> |
| <li class="">API 可能变化</li> |
| <li class="">尚未覆盖所有边界场景</li> |
| <li class="">可能仍有未发现的缺陷</li> |
| </ul> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=暂不支持>暂不支持<a href=#暂不支持 class=hash-link aria-label=暂不支持的直接链接 title=暂不支持的直接链接 translate=no></a></h3> |
| <ul> |
| <li class="">接口字段（动态类型）</li> |
| <li class="">无指针的递归类型</li> |
| <li class="">私有（未导出）字段</li> |
| <li class="">自定义序列化器</li> |
| </ul> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=标准路径回退>标准路径回退<a href=#�标准路径回退 class=hash-link aria-label=标准路径回退的直接链接 title=标准路径回退的直接链接 translate=no></a></h3> |
| <p>如果生成的序列化器不可用，Fory 会自动回退到标准序列化路径：</p> |
| <div class="language-go codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-go codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token comment" style=color:#999988;font-style:italic>// If User_ForyGenSerializer is not linked in, Fory uses the standard path</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain">f</span><span class="token punctuation" style=color:#393A34>.</span><span class="token function" style=color:#d73a49>Serialize</span><span class="token punctuation" style=color:#393A34>(</span><span class="token operator" style=color:#393A34>&</span><span class="token plain">User</span><span class="token punctuation" style=color:#393A34>{</span><span class="token punctuation" style=color:#393A34>}</span><span class="token punctuation" style=color:#393A34>)</span><br/></div></code></pre></div></div> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=故障排查>故障排查<a href=#故障排查 class=hash-link aria-label=故障排查的直接链接 title=故障排查的直接链接 translate=no></a></h2> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=fory-command-not-found><code>"fory: command not found"</code><a href=#fory-command-not-found class=hash-link aria-label=fory-command-not-found的直接链接 title=fory-command-not-found的直接链接 translate=no></a></h3> |
| <p>确保二进制已经加入 <code>PATH</code>：</p> |
| <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token builtin class-name">export</span><span class="token plain"> </span><span class="token assign-left variable environment constant" style=color:#36acaa>PATH</span><span class="token operator" style=color:#393A34>=</span><span class="token environment constant" style=color:#36acaa>$PATH</span><span class="token builtin class-name">:</span><span class="token variable" style=color:#36acaa>$(</span><span class="token variable" style=color:#36acaa>go </span><span class="token variable function" style=color:#d73a49>env</span><span class="token variable" style=color:#36acaa> GOPATH</span><span class="token variable" style=color:#36acaa>)</span><span class="token plain">/bin</span><br/></div></code></pre></div></div> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=结构体变更后出现编译错误>结构体变更后出现编译错误<a href=#结构体变更后出现编译错误 class=hash-link aria-label=结构体变更后出现编译错误的直接链接 title=结构体变更后出现编译错误的直接链接 translate=no></a></h3> |
| <p>重新生成：</p> |
| <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">go generate ./</span><span class="token punctuation" style=color:#393A34>..</span><span class="token plain">.</span><br/></div></code></pre></div></div> |
| <p>或强制重新生成：</p> |
| <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">fory </span><span class="token parameter variable" style=color:#36acaa>--force</span><span class="token plain"> </span><span class="token parameter variable" style=color:#36acaa>-file</span><span class="token plain"> yourfile.go</span><br/></div></code></pre></div></div> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=生成代码不同步>生成代码不同步<a href=#生成代码不同步 class=hash-link aria-label=生成代码不同步的直接链接 title=生成代码不同步的直接链接 translate=no></a></h3> |
| <p>编译期守卫会捕获这种情况：</p> |
| <div class="language-text codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-text codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">cannot use x (variable of type User) as type _User_expected in argument</span><br/></div></code></pre></div></div> |
| <p>运行 <code>go generate</code> 即可修复。</p> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=示例项目结构>示例项目结构<a href=#示例项目结构 class=hash-link aria-label=示例项目结构的直接链接 title=示例项目结构的直接链接 translate=no></a></h2> |
| <div class="language-text codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-text codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">myproject/</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">├── models/</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">│ ├── models.go # Struct definitions</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">│ ├── models_fory_gen.go # Generated code</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">│ └── generate.go # go:generate directive</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">├── main.go</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">└── go.mod</span><br/></div></code></pre></div></div> |
| <p><strong>models/generate.go</strong>：</p> |
| <div class="language-go codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-go codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token keyword" style=color:#00009f>package</span><span class="token plain"> models</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 comment" style=color:#999988;font-style:italic>//go:generate fory -pkg .</span><br/></div></code></pre></div></div> |
| <p><strong>models/models.go</strong>：</p> |
| <div class="language-go codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-go codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token keyword" style=color:#00009f>package</span><span class="token plain"> models</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 comment" style=color:#999988;font-style:italic>//fory:generate</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token keyword" style=color:#00009f>type</span><span class="token plain"> User </span><span class="token keyword" style=color:#00009f>struct</span><span class="token plain"> </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"> ID </span><span class="token builtin">int64</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> Name </span><span class="token builtin">string</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><br/></div></code></pre></div></div> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=faq>FAQ<a href=#faq class=hash-link aria-label=FAQ的直接链接 title=FAQ的直接链接 translate=no></a></h2> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=代码生成是必须的吗>代码生成是必须的吗？<a href=#代码生成是必须的吗 class=hash-link aria-label=代码生成是必须的吗？的直接链接 title=代码生成是必须的吗？的直接链接 translate=no></a></h3> |
| <p>不是。标准序列化路径在不使用代码生成时也能正常工作。</p> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=生成代码能跨-go-版本使用吗>生成代码能跨 Go 版本使用吗？<a href=#生成代码能跨-go-版本使用吗 class=hash-link aria-label="生成代码能跨 Go 版本使用吗？的直接链接" title="生成代码能跨 Go 版本使用吗？的直接链接" translate=no></a></h3> |
| <p>可以。生成代码就是普通 Go 代码，不依赖某个特定版本的语言特性。</p> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=可以混用生成和非生成类型吗>可以混用生成和非生成类型吗？<a href=#可以混用生成和非生成类型吗 class=hash-link aria-label=可以混用生成和非生成类型吗？的直接链接 title=可以混用生成和非生成类型吗？的直接链接 translate=no></a></h3> |
| <p>可以。只要生成的序列化器可用，Fory 会自动优先使用它。</p> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=如何更新生成代码>如何更新生成代码？<a href=#如何更新生成代码 class=hash-link aria-label=如何更新生成代码？的直接链接 title=如何更新生成代码？的直接链接 translate=no></a></h3> |
| <p>结构体变更后运行 <code>go generate ./...</code>。</p> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=应该提交生成文件吗>应该提交生成文件吗？<a href=#应该提交生成文件吗 class=hash-link aria-label=应该提交生成文件吗？的直接链接 title=应该提交生成文件吗？的直接链接 translate=no></a></h3> |
| <p>对于库项目：建议提交。对于应用项目：两种做法都可以。</p> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=相关主题>相关主题<a href=#相关主题 class=hash-link aria-label=相关主题的直接链接 title=相关主题的直接链接 translate=no></a></h2> |
| <ul> |
| <li class=""><a class="" href=/zh-CN/docs/next/guide/go/basic_serialization>基础序列化</a></li> |
| <li class=""><a class="" href=/zh-CN/docs/next/guide/go/configuration>配置</a></li> |
| <li class=""><a class="" href=/zh-CN/docs/next/guide/go/troubleshooting>故障排查</a></li> |
| </ul></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_WFHX"><a href=https://github.com/apache/fory-site/tree/main/i18n/zh-CN/docusaurus-plugin-content-docs/current/guide/go/codegen.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_Z9Sw 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_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label=文件选项卡><a class="pagination-nav__link pagination-nav__link--prev" href=/zh-CN/docs/next/guide/go/type_registration><div class=pagination-nav__sublabel>上一页</div><div class=pagination-nav__label>类型注册</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/zh-CN/docs/next/guide/javascript/><div class=pagination-nav__sublabel>下一页</div><div class=pagination-nav__label>JavaScript 序列化指南</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL 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=#安装 class="table-of-contents__link toc-highlight">安装</a><li><a href=#基本用法 class="table-of-contents__link toc-highlight">基本用法</a><ul><li><a href=#步骤-1标注结构体 class="table-of-contents__link toc-highlight">步骤 1：标注结构体</a><li><a href=#步骤-2添加-go-generate-指令 class="table-of-contents__link toc-highlight">步骤 2：添加 Go Generate 指令</a><li><a href=#步骤-3执行代码生成 class="table-of-contents__link toc-highlight">步骤 3：执行代码生成</a></ul><li><a href=#生成代码的结构 class="table-of-contents__link toc-highlight">生成代码的结构</a><ul><li><a href=#类型快照 class="table-of-contents__link toc-highlight">类型快照</a><li><a href=#序列化器实现 class="table-of-contents__link toc-highlight">序列化器实现</a><li><a href=#自动注册 class="table-of-contents__link toc-highlight">自动注册</a></ul><li><a href=#命令行选项 class="table-of-contents__link toc-highlight">命令行选项</a><ul><li><a href=#按文件生成 class="table-of-contents__link toc-highlight">按文件生成</a><li><a href=#按包生成 class="table-of-contents__link toc-highlight">按包生成</a><li><a href=#显式指定类型旧用法 class="table-of-contents__link toc-highlight">显式指定类型（旧用法）</a><li><a href=#强制重新生成 class="table-of-contents__link toc-highlight">强制重新生成</a></ul><li><a href=#何时需要重新生成 class="table-of-contents__link toc-highlight">何时需要重新生成</a><ul><li><a href=#自动检测 class="table-of-contents__link toc-highlight">自动检测</a><li><a href=#自动重试 class="table-of-contents__link toc-highlight">自动重试</a></ul><li><a href=#支持的类型 class="table-of-contents__link toc-highlight">支持的类型</a><ul><li><a href=#嵌套结构体 class="table-of-contents__link toc-highlight">嵌套结构体</a></ul><li><a href=#cicd-集成 class="table-of-contents__link toc-highlight">CI/CD 集成</a><ul><li><a href=#提交生成代码 class="table-of-contents__link toc-highlight">提交生成代码</a><li><a href=#在流水线中生成 class="table-of-contents__link toc-highlight">在流水线中生成</a></ul><li><a href=#与生成代码配合使用 class="table-of-contents__link toc-highlight">与生成代码配合使用</a><li><a href=#混用生成与非生成方式 class="table-of-contents__link toc-highlight">混用生成与非生成方式</a><li><a href=#限制 class="table-of-contents__link toc-highlight">限制</a><ul><li><a href=#实验性状态 class="table-of-contents__link toc-highlight">实验性状态</a><li><a href=#暂不支持 class="table-of-contents__link toc-highlight">暂不支持</a><li><a href=#标准路径回退 class="table-of-contents__link toc-highlight">标准路径回退</a></ul><li><a href=#故障排查 class="table-of-contents__link toc-highlight">故障排查</a><ul><li><a href=#fory-command-not-found class="table-of-contents__link toc-highlight"><code>"fory: command not found"</code></a><li><a href=#结构体变更后出现编译错误 class="table-of-contents__link toc-highlight">结构体变更后出现编译错误</a><li><a href=#生成代码不同步 class="table-of-contents__link toc-highlight">生成代码不同步</a></ul><li><a href=#示例项目结构 class="table-of-contents__link toc-highlight">示例项目结构</a><li><a href=#faq class="table-of-contents__link toc-highlight">FAQ</a><ul><li><a href=#代码生成是必须的吗 class="table-of-contents__link toc-highlight">代码生成是必须的吗？</a><li><a href=#生成代码能跨-go-版本使用吗 class="table-of-contents__link toc-highlight">生成代码能跨 Go 版本使用吗？</a><li><a href=#可以混用生成和非生成类型吗 class="table-of-contents__link toc-highlight">可以混用生成和非生成类型吗？</a><li><a href=#如何更新生成代码 class="table-of-contents__link toc-highlight">如何更新生成代码？</a><li><a href=#应该提交生成文件吗 class="table-of-contents__link toc-highlight">应该提交生成文件吗？</a></ul><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="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>社区</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://lists.apache.org/list.html?dev@fory.apache.org target=_blank rel="noopener noreferrer" class=footer__link-item>邮件列表<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a href=https://join.slack.com/t/fory-project/shared_invite/zt-1u8soj4qc-ieYEu7ciHOqA2mo47llS8A target=_blank rel="noopener noreferrer" class=footer__link-item>Slack<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a href=https://twitter.com/ApacheFory target=_blank rel="noopener noreferrer" class=footer__link-item>Twitter<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>文档</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/zh-CN/docs/start/install>安装</a><li class=footer__item><a class=footer__link-item href=/zh-CN/docs/start/usage>使用</a><li class=footer__item><a class=footer__link-item href=/zh-CN/docs/introduction/benchmark>基准测试</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>代码库</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/apache/fory target=_blank rel="noopener noreferrer" class=footer__link-item>Apache Fory™<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a href=https://github.com/apache/fory-site target=_blank rel="noopener noreferrer" class=footer__link-item>网站<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a></ul></div></div><div class="footer__bottom text--center"><div class=margin-bottom--sm><a href=https://apache.org/ rel="noopener noreferrer" class=footerLogoLink_BH7S><img src=/zh-CN/img/asf_logo.svg alt="Apache Incubator 标志" class="footer__logo themedComponent_mlkZ themedComponent--light_NVdE" width=200 /><img src=/zh-CN/img/asf_logo.svg alt="Apache Incubator 标志" class="footer__logo themedComponent_mlkZ themedComponent--dark_xIcU" width=200 /></a></div><div class=footer__copyright><div> |
| <p> 版权所有 © 2025 The Apache Software Foundation，许可证：Apache License, Version 2.0。 <br/> |
| Apache Fory、Fory、Apache、Apache Logo、Apache Fory Logo 是 Apache 软件基金会在美国和/或其他国家的注册商标或商标。 |
| </p> |
| </div></div></div></div></footer></div></body> |
