content/references/java-chassis/zh_CN/build-provider/interface-constraints.html - servicecomb-website - Git at Google


 <!doctype html>
 <html lang="en" class="no-js">
   <head>

       <meta charset="utf-8">
       <meta name="viewport" content="width=device-width,initial-scale=1">


         <link rel="prev" href="swagger-annotation.html">


         <link rel="next" href="listen-address-and-publish-address.html">


       <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.19">


         <title>接口定义和数据类型 - Java Chassis 3 开发指南</title>


       <link rel="stylesheet" href="../assets/stylesheets/main.66ac8b77.min.css">


         <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
         <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
         <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>


     <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>


   </head>


     <body dir="ltr">


     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
     <label class="md-overlay" for="__drawer"></label>
     <div data-md-component="skip">


         <a href="#_1" class="md-skip">
           Skip to content
         </a>

     </div>
     <div data-md-component="announce">

     </div>


 <header class="md-header md-header--shadow" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
     <a href="../index.html" title="Java Chassis 3 开发指南" class="md-header__button md-logo" aria-label="Java Chassis 3 开发指南" data-md-component="logo">


   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

     </a>
     <label class="md-header__button md-icon" for="__drawer">

       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
     </label>
     <div class="md-header__title" data-md-component="header-title">
       <div class="md-header__ellipsis">
         <div class="md-header__topic">
           <span class="md-ellipsis">
             Java Chassis 3 开发指南
           </span>
         </div>
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">

               接口定义和数据类型

           </span>
         </div>
       </div>
     </div>


       <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>


       <label class="md-header__button md-icon" for="__search">

         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
       </label>
       <div class="md-search" data-md-component="search" role="dialog">
   <label class="md-search__overlay" for="__search"></label>
   <div class="md-search__inner" role="search">
     <form class="md-search__form" name="search">
       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
       <label class="md-search__icon md-icon" for="__search">

         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>

         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
       </label>
       <nav class="md-search__options" aria-label="Search">

         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">

           <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
         </button>
       </nav>

     </form>
     <div class="md-search__output">
       <div class="md-search__scrollwrap" data-md-scrollfix>
         <div class="md-search-result" data-md-component="search-result">
           <div class="md-search-result__meta">
             Initializing search
           </div>
           <ol class="md-search-result__list" role="presentation"></ol>
         </div>
       </div>
     </div>
   </div>
 </div>


   </nav>

 </header>

     <div class="md-container" data-md-component="container">


       <main class="md-main" data-md-component="main">
         <div class="md-main__inner md-grid">


               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
                 <div class="md-sidebar__scrollwrap">
                   <div class="md-sidebar__inner">


 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
     <a href="../index.html" title="Java Chassis 3 开发指南" class="md-nav__button md-logo" aria-label="Java Chassis 3 开发指南" data-md-component="logo">


   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

     </a>
     Java Chassis 3 开发指南
   </label>

   <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../index.html" class="md-nav__link">


   <span class="md-ellipsis">
     概述
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../start/design.html" class="md-nav__link">


   <span class="md-ellipsis">
     Java Chassis设计参考
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../introduce3.x.x.html" class="md-nav__link">


   <span class="md-ellipsis">
     Java Chassis 3版本介绍
   </span>


       </a>
     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >


           <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">


   <span class="md-ellipsis">
     快速入门
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             快速入门
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../start/development-environment.html" class="md-nav__link">


   <span class="md-ellipsis">
     安装本地开发环境
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../start/first-sample.html" class="md-nav__link">


   <span class="md-ellipsis">
     开发第一个微服务应用
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../featured-topics/application-bmi.html" class="md-nav__link">


   <span class="md-ellipsis">
     BMI应用-使用服务治理
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../featured-topics/application-porter.html" class="md-nav__link">


   <span class="md-ellipsis">
     PORTER应用-典型开发场景
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item">
       <a href="definition/service-definition.html" class="md-nav__link">


   <span class="md-ellipsis">
     微服务定义
   </span>


       </a>
     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >


           <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">


   <span class="md-ellipsis">
     Spring Boot集成Java Chassis
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_6">
             <span class="md-nav__icon md-icon"></span>
             Spring Boot集成Java Chassis
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../spring-boot/introduction.html" class="md-nav__link">


   <span class="md-ellipsis">
     Spring Boot集成Java Chassis介绍
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../spring-boot/diff-spring-mvc.html" class="md-nav__link">


   <span class="md-ellipsis">
     与Spring Web MVC开发习惯的差异
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--active md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" checked>


           <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">


   <span class="md-ellipsis">
     开发服务提供者
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="true">
           <label class="md-nav__title" for="__nav_7">
             <span class="md-nav__icon md-icon"></span>
             开发服务提供者
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="basics.html" class="md-nav__link">


   <span class="md-ellipsis">
     基础概念
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="http-mapping.html" class="md-nav__link">


   <span class="md-ellipsis">
     HTTP参数映射参考
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="jaxrs.html" class="md-nav__link">


   <span class="md-ellipsis">
     用JAX-RS开发微服务
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="springmvc.html" class="md-nav__link">


   <span class="md-ellipsis">
     用SpringMVC开发微服务
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="transparent-rpc.html" class="md-nav__link">


   <span class="md-ellipsis">
     用透明RPC开发微服务
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="use-interface.html" class="md-nav__link">


   <span class="md-ellipsis">
     只发布interface的方法为服务接口
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="reactive.html" class="md-nav__link">


   <span class="md-ellipsis">
     异步处理
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="context-param.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用 Context 参数
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="multi-code.html" class="md-nav__link">


   <span class="md-ellipsis">
     多个返回值和错误码
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="swagger-annotation.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用Swagger注解
   </span>


       </a>
     </li>


     <li class="md-nav__item md-nav__item--active">

       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">


         <label class="md-nav__link md-nav__link--active" for="__toc">


   <span class="md-ellipsis">
     接口定义和数据类型
   </span>


           <span class="md-nav__icon md-icon"></span>
         </label>

       <a href="interface-constraints.html" class="md-nav__link md-nav__link--active">


   <span class="md-ellipsis">
     接口定义和数据类型
   </span>


       </a>


 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">


     <label class="md-nav__title" for="__toc">
       <span class="md-nav__icon md-icon"></span>
       Table of contents
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

         <li class="md-nav__item">
   <a href="#_2" class="md-nav__link">
     <span class="md-ellipsis">
       接口定义的最佳实践和类型约束
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#code-first" class="md-nav__link">
     <span class="md-ellipsis">
       从 code first 角度理解夸平台数据类型的约束
     </span>
   </a>

     <nav class="md-nav" aria-label="从 code first 角度理解夸平台数据类型的约束">
       <ul class="md-nav__list">

           <li class="md-nav__item">
   <a href="#_3" class="md-nav__link">
     <span class="md-ellipsis">
       关于数据结构和接口变更
     </span>
   </a>

 </li>

       </ul>
     </nav>

 </li>

         <li class="md-nav__item">
   <a href="#_4" class="md-nav__link">
     <span class="md-ellipsis">
       协议上的差异
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#_5" class="md-nav__link">
     <span class="md-ellipsis">
       泛型支持
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#_6" class="md-nav__link">
     <span class="md-ellipsis">
       其他常见问题
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#rest" class="md-nav__link">
     <span class="md-ellipsis">
       REST 通信类型扩展
     </span>
   </a>

 </li>

     </ul>

 </nav>

     </li>


     <li class="md-nav__item">
       <a href="listen-address-and-publish-address.html" class="md-nav__link">


   <span class="md-ellipsis">
     服务监听地址和发布地址
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="thread-pool.html" class="md-nav__link">


   <span class="md-ellipsis">
     线程池
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="event-listener.html" class="md-nav__link">


   <span class="md-ellipsis">
     服务启动事件
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="parameter-validator.html" class="md-nav__link">


   <span class="md-ellipsis">
     参数效验
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="bootup.html" class="md-nav__link">


   <span class="md-ellipsis">
     程序启动逻辑
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="ipv6-configuration.html" class="md-nav__link">


   <span class="md-ellipsis">
     IPV6配置和使用
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="access-log-configuration.html" class="md-nav__link">


   <span class="md-ellipsis">
     Access Log配置
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >


           <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">


   <span class="md-ellipsis">
     开发服务消费者
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_8">
             <span class="md-nav__icon md-icon"></span>
             开发服务消费者
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../build-consumer/basics.html" class="md-nav__link">


   <span class="md-ellipsis">
     基础概念
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../build-consumer/using-resttemplate.html" class="md-nav__link">


   <span class="md-ellipsis">
     Restful风格 - 使用 RestOperations
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../build-consumer/develop-consumer-using-rpc.html" class="md-nav__link">


   <span class="md-ellipsis">
     RPC风格
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../build-consumer/invoker.html" class="md-nav__link">


   <span class="md-ellipsis">
     泛化调用
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../build-consumer/3rd-party-service-invoke.html" class="md-nav__link">


   <span class="md-ellipsis">
     调用第三方REST服务
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >


           <label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">


   <span class="md-ellipsis">
     定制请求处理流程
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_9">
             <span class="md-nav__icon md-icon"></span>
             定制请求处理流程
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../references-handlers/intruduction.html" class="md-nav__link">


   <span class="md-ellipsis">
     处理链介绍
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >


           <label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">


   <span class="md-ellipsis">
     通用功能开发
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_10">
             <span class="md-nav__icon md-icon"></span>
             通用功能开发
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../general-development/metrics.html" class="md-nav__link">


   <span class="md-ellipsis">
     应用性能监控
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/microservice-invocation-chain.html" class="md-nav__link">


   <span class="md-ellipsis">
     微服务调用链
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/customized-tracing.html" class="md-nav__link">


   <span class="md-ellipsis">
     自定义调用链打点
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/local-develop-test.html" class="md-nav__link">


   <span class="md-ellipsis">
     本地开发和测试
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/upload-download.html" class="md-nav__link">


   <span class="md-ellipsis">
     文件上传下载
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/reactive.html" class="md-nav__link">


   <span class="md-ellipsis">
     Reactive
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/dnsconfig.html" class="md-nav__link">


   <span class="md-ellipsis">
     DNS自定义配置
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/proxy.html" class="md-nav__link">


   <span class="md-ellipsis">
     代理设置
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/report-framework-version.html" class="md-nav__link">


   <span class="md-ellipsis">
     框架上报版本号
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/cross-app-invocation.html" class="md-nav__link">


   <span class="md-ellipsis">
     跨应用调用
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/secret-field.html" class="md-nav__link">


   <span class="md-ellipsis">
     定制序列化和反序列化方法
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/context.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用Context传递控制消息
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/produceprocess.html" class="md-nav__link">


   <span class="md-ellipsis">
     返回值序列化扩展
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/CORS.html" class="md-nav__link">


   <span class="md-ellipsis">
     跨域资源共享(CORS)
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/AlarmEvent.html" class="md-nav__link">


   <span class="md-ellipsis">
     获取熔断与实例隔离告警事件信息
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/shutdown.html" class="md-nav__link">


   <span class="md-ellipsis">
     优雅停机
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/error-handling.html" class="md-nav__link">


   <span class="md-ellipsis">
     异常处理
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/multienvironment.html" class="md-nav__link">


   <span class="md-ellipsis">
     微服务实例间多环境隔离
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/thread-model.html" class="md-nav__link">


   <span class="md-ellipsis">
     线程模型
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../general-development/config-logs.html" class="md-nav__link">


   <span class="md-ellipsis">
     配置日志
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" >


           <label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="0">


   <span class="md-ellipsis">
     多样化的通信协议功能
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_11">
             <span class="md-nav__icon md-icon"></span>
             多样化的通信协议功能
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../transports/introduction.html" class="md-nav__link">


   <span class="md-ellipsis">
     多协议介绍
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../transports/rest-over-vertx.html" class="md-nav__link">


   <span class="md-ellipsis">
     REST over HTTP(Vert.x)
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../transports/http2.html" class="md-nav__link">


   <span class="md-ellipsis">
     REST over HTTP2(Vert.x)
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../transports/rest-over-servlet-embedded.html" class="md-nav__link">


   <span class="md-ellipsis">
     REST over Servlet(Spring Boot Embedded)
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../transports/rest-over-servlet.html" class="md-nav__link">


   <span class="md-ellipsis">
     REST over Servlet(WAR)
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../transports/highway-rpc.html" class="md-nav__link">


   <span class="md-ellipsis">
     Highway
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_12" >


           <label class="md-nav__link" for="__nav_12" id="__nav_12_label" tabindex="0">


   <span class="md-ellipsis">
     多样化的服务注册与发现功能
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_12_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_12">
             <span class="md-nav__icon md-icon"></span>
             多样化的服务注册与发现功能
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../registry/introduction.html" class="md-nav__link">


   <span class="md-ellipsis">
     注册发现介绍
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../registry/service-center.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用Service Center
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../registry/nacos.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用Nacos
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../registry/zookeeper.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用ZooKeeper
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../registry/local-registry.html" class="md-nav__link">


   <span class="md-ellipsis">
     本地注册发现
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../registry/distributed.html" class="md-nav__link">


   <span class="md-ellipsis">
     去中心化注册发现
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_13" >


           <label class="md-nav__link" for="__nav_13" id="__nav_13_label" tabindex="0">


   <span class="md-ellipsis">
     多样化的配置管理功能
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_13_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_13">
             <span class="md-nav__icon md-icon"></span>
             多样化的配置管理功能
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../config/general-config.html" class="md-nav__link">


   <span class="md-ellipsis">
     服务配置介绍
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../config/read-config.html" class="md-nav__link">


   <span class="md-ellipsis">
     在程序中读取配置信息
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../config/kie.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用Kie
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../config/nacos.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用Nacos
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../config/zookeeper.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用Zookeeper
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../config/apollo.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用Apollo
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../config/cse1.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用CSE1.0配置中心
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_14" >


           <label class="md-nav__link" for="__nav_14" id="__nav_14_label" tabindex="0">


   <span class="md-ellipsis">
     服务治理功能参考
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_14_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_14">
             <span class="md-nav__icon md-icon"></span>
             服务治理功能参考
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../references-handlers/rule-governance.html" class="md-nav__link">


   <span class="md-ellipsis">
     流量特征治理
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../references-handlers/governance-best-practise.html" class="md-nav__link">


   <span class="md-ellipsis">
     流量特征治理最佳实践
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../references-handlers/loadbalance.html" class="md-nav__link">


   <span class="md-ellipsis">
     负载均衡
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../references-handlers/ratelimit.html" class="md-nav__link">


   <span class="md-ellipsis">
     限流
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../references-handlers/router.html" class="md-nav__link">


   <span class="md-ellipsis">
     灰度发布
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../references-handlers/fault-injection.html" class="md-nav__link">


   <span class="md-ellipsis">
     故障注入
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../references-handlers/fail-retry.html" class="md-nav__link">


   <span class="md-ellipsis">
     快速失败和重试
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_15" >


           <label class="md-nav__link" for="__nav_15" id="__nav_15_label" tabindex="0">


   <span class="md-ellipsis">
     网关功能参考
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_15_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_15">
             <span class="md-nav__icon md-icon"></span>
             网关功能参考
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../edge/open-service.html" class="md-nav__link">


   <span class="md-ellipsis">
     介绍
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../edge/by-servicecomb-sdk.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用 Edge Service 做网关
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../edge/zuul.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用 `zuul` 和 `spring cloud gateway` 做网关
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../edge/nginx.html" class="md-nav__link">


   <span class="md-ellipsis">
     nginx 网关简单介绍
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_16" >


           <label class="md-nav__link" for="__nav_16" id="__nav_16_label" tabindex="0">


   <span class="md-ellipsis">
     安全特性参考
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_16_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_16">
             <span class="md-nav__icon md-icon"></span>
             安全特性参考
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../references-handlers/publickey.html" class="md-nav__link">


   <span class="md-ellipsis">
     公钥认证
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../security/tls.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用TLS通信
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../security/shi-yong-rsa-ren-zheng.html" class="md-nav__link">


   <span class="md-ellipsis">
     使用RSA认证
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_17" >


           <label class="md-nav__link" for="__nav_17" id="__nav_17_label" tabindex="0">


   <span class="md-ellipsis">
     专题文章
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_17_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_17">
             <span class="md-nav__icon md-icon"></span>
             专题文章
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../featured-topics/features.html" class="md-nav__link">


   <span class="md-ellipsis">
     特性介绍
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../featured-topics/secrets.html" class="md-nav__link">


   <span class="md-ellipsis">
     技术解密
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../featured-topics/upgrading.html" class="md-nav__link">


   <span class="md-ellipsis">
     升级指导
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../featured-topics/compatibility.html" class="md-nav__link">


   <span class="md-ellipsis">
     兼容问题和兼容性策略
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../featured-topics/performance.html" class="md-nav__link">


   <span class="md-ellipsis">
     性能问题分析和调优
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_18" >


           <label class="md-nav__link" for="__nav_18" id="__nav_18_label" tabindex="0">


   <span class="md-ellipsis">
     常用配置项参考
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_18_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_18">
             <span class="md-nav__icon md-icon"></span>
             常用配置项参考
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../config-reference/rest-transport-client.html" class="md-nav__link">


   <span class="md-ellipsis">
     REST Transport Client 配置项
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


     <li class="md-nav__item md-nav__item--nested">


         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_19" >


           <label class="md-nav__link" for="__nav_19" id="__nav_19_label" tabindex="0">


   <span class="md-ellipsis">
     常见问题
   </span>


             <span class="md-nav__icon md-icon"></span>
           </label>

         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_19_label" aria-expanded="false">
           <label class="md-nav__title" for="__nav_19">
             <span class="md-nav__icon md-icon"></span>
             常见问题
           </label>
           <ul class="md-nav__list" data-md-scrollfix>


     <li class="md-nav__item">
       <a href="../question-and-answer/faq.html" class="md-nav__link">


   <span class="md-ellipsis">
     FAQ
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../question-and-answer/question_answer.html" class="md-nav__link">


   <span class="md-ellipsis">
     Q & A
   </span>


       </a>
     </li>


     <li class="md-nav__item">
       <a href="../question-and-answer/interface-compatibility.html" class="md-nav__link">


   <span class="md-ellipsis">
     微服务接口兼容常见问题
   </span>


       </a>
     </li>


           </ul>
         </nav>

     </li>


   </ul>
 </nav>
                   </div>
                 </div>
               </div>


               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
                 <div class="md-sidebar__scrollwrap">
                   <div class="md-sidebar__inner">


 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">


     <label class="md-nav__title" for="__toc">
       <span class="md-nav__icon md-icon"></span>
       Table of contents
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

         <li class="md-nav__item">
   <a href="#_2" class="md-nav__link">
     <span class="md-ellipsis">
       接口定义的最佳实践和类型约束
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#code-first" class="md-nav__link">
     <span class="md-ellipsis">
       从 code first 角度理解夸平台数据类型的约束
     </span>
   </a>

     <nav class="md-nav" aria-label="从 code first 角度理解夸平台数据类型的约束">
       <ul class="md-nav__list">

           <li class="md-nav__item">
   <a href="#_3" class="md-nav__link">
     <span class="md-ellipsis">
       关于数据结构和接口变更
     </span>
   </a>

 </li>

       </ul>
     </nav>

 </li>

         <li class="md-nav__item">
   <a href="#_4" class="md-nav__link">
     <span class="md-ellipsis">
       协议上的差异
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#_5" class="md-nav__link">
     <span class="md-ellipsis">
       泛型支持
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#_6" class="md-nav__link">
     <span class="md-ellipsis">
       其他常见问题
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#rest" class="md-nav__link">
     <span class="md-ellipsis">
       REST 通信类型扩展
     </span>
   </a>

 </li>

     </ul>

 </nav>
                   </div>
                 </div>
               </div>


             <div class="md-content" data-md-component="content">
               <article class="md-content__inner md-typeset">


 <h1 id="_1">接口定义和数据类型</h1>
 <p>不论采用 <code>JAX-RS</code>、<code>Spring MVC</code>，还是采用 <code>透明RPC</code> 开发，都涉及接口的返回值和参数。java-chassis
 采用的是一种平台无关的数据序列化方式，当 <code>Transport</code> 为 <code>REST</code> 的时候，序列化方式为 <code>json</code>，当
 <code>Transport</code> 为 <code>Highway</code> 的时候，序列化方式为 <code>protobuffer</code>。 平台无关的数据序列化方式有个基本
 特征：作为 <code>Consumer</code>， 从序列化的数据中，无法获取任何和 <code>Consuemr</code> 开发语言有关的类型信息。 平台无关
 特性给接口定义的数据类型提供了更严格的要求，符合这些要求的接口定义，一方面运行更加高效，另外一方面更加方便的
 动态调整 <code>Transport</code>， 而无需对代码做出修改。 </p>
 <p>对于 <code>REST</code>， 虽然 <code>json</code> 本身不包含特定平台的类型信息，但是 <code>JAVA</code> 可以通过在反序列化的时候，指定目标
 类型，所以对于 <code>REST</code>， 可以更加灵活的使用不同的类型。 </p>
 <p>本章节主要介绍为了实现最大的夸平台和高性能，开发者定义接口的最佳实践。同时介绍在使用 <code>REST</code> 的情况下，如何
 更加灵活的支持不同的类型。 </p>
 <h2 id="_2">接口定义的最佳实践和类型约束</h2>
 <p>java-chassis 的所有接口定义，都可以生成符合 <code>OpenAPI</code> 的 <code>swagger</code> 接口描述，当使用 <code>Highway</code> 协议时，
 <code>swagger</code> 文件还会在内部被转换为等价的 <code>proto</code> 文件。 接口定义的最佳实践需要满足 <code>OpenAPI</code> 和 <code>proto</code>的
 数据类型要求。 </p>
 <ul>
 <li><code>OpenAPI</code> 定义了如下一些基本类型：</li>
 </ul>
 <p>下面列举一些常见的类型说明，详细参考 <a href="https://swagger.io/docs/specification/data-models/data-types/">OpenAPI文档</a>。</p>
 <table>
 <thead>
 <tr>
 <th style="text-align: left;">type</th>
 <th style="text-align: left;">format</th>
 <th style="text-align: left;">java</th>
 <th style="text-align: left;">说明</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td style="text-align: left;">string</td>
 <td style="text-align: left;">-</td>
 <td style="text-align: left;">String</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">string</td>
 <td style="text-align: left;">date</td>
 <td style="text-align: left;">java.util.Date, java.time.LocalDate</td>
 <td style="text-align: left;">推荐使用 LocalDate</td>
 </tr>
 <tr>
 <td style="text-align: left;">string</td>
 <td style="text-align: left;">date-time</td>
 <td style="text-align: left;">java.util.Date, java.time.LocalDateTime</td>
 <td style="text-align: left;">推荐使用 LocalDateTime</td>
 </tr>
 <tr>
 <td style="text-align: left;">number</td>
 <td style="text-align: left;">-</td>
 <td style="text-align: left;">double</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">number</td>
 <td style="text-align: left;">float</td>
 <td style="text-align: left;">float</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">number</td>
 <td style="text-align: left;">double</td>
 <td style="text-align: left;">double</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">integer</td>
 <td style="text-align: left;">-</td>
 <td style="text-align: left;">integer</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">integer</td>
 <td style="text-align: left;">int32</td>
 <td style="text-align: left;">int</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">integer</td>
 <td style="text-align: left;">int64</td>
 <td style="text-align: left;">long</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">boolean</td>
 <td style="text-align: left;">-</td>
 <td style="text-align: left;">boolean</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">array</td>
 <td style="text-align: left;"></td>
 <td style="text-align: left;">ArrayList</td>
 <td style="text-align: left;">必须指定类型</td>
 </tr>
 <tr>
 <td style="text-align: left;">object</td>
 <td style="text-align: left;"></td>
 <td style="text-align: left;"></td>
 <td style="text-align: left;">由上面的属性构成的对象类型。包括字典（HashMap），字典的 key 必须为 string</td>
 </tr>
 </tbody>
 </table>
 <table>
 <thead>
 <tr>
 <th style="text-align: left;">参数类型</th>
 <th style="text-align: left;">通信协议</th>
 <th style="text-align: left;">编码方式</th>
 <th style="text-align: left;">是否支持</th>
 <th style="text-align: left;">备注</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td style="text-align: left;">Query</td>
 <td style="text-align: left;">HTTP/HTTP2</td>
 <td style="text-align: left;">TEXT</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;">支持string, number, boolean, array</td>
 </tr>
 <tr>
 <td style="text-align: left;">Path</td>
 <td style="text-align: left;">HTTP/HTTP2</td>
 <td style="text-align: left;">TEXT</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;">支持string, number, boolean</td>
 </tr>
 <tr>
 <td style="text-align: left;">Header</td>
 <td style="text-align: left;">HTTP/HTTP2</td>
 <td style="text-align: left;">TEXT</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;">支持string, number, boolean</td>
 </tr>
 <tr>
 <td style="text-align: left;">Cookie</td>
 <td style="text-align: left;">HTTP/HTTP2</td>
 <td style="text-align: left;">TEXT</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;">支持string, number, boolean</td>
 </tr>
 <tr>
 <td style="text-align: left;">Body</td>
 <td style="text-align: left;">HTTP/HTTP2</td>
 <td style="text-align: left;">application/x-www-form-urlencoded</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;">支持string, number, boolean</td>
 </tr>
 <tr>
 <td style="text-align: left;">Body</td>
 <td style="text-align: left;">HTTP/HTTP2</td>
 <td style="text-align: left;">multipart/form-data</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;">支持string, number, boolean</td>
 </tr>
 <tr>
 <td style="text-align: left;">Body</td>
 <td style="text-align: left;">HTTP/HTTP2</td>
 <td style="text-align: left;">application/json</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">Body</td>
 <td style="text-align: left;">HTTP/HTTP2</td>
 <td style="text-align: left;">application/protobuf</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">Query</td>
 <td style="text-align: left;">HIGHWAY</td>
 <td style="text-align: left;">TEXT</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;">支持string, number, boolean, array</td>
 </tr>
 <tr>
 <td style="text-align: left;">Path</td>
 <td style="text-align: left;">HIGHWAY</td>
 <td style="text-align: left;">TEXT</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;">支持string, number, boolean</td>
 </tr>
 <tr>
 <td style="text-align: left;">Header</td>
 <td style="text-align: left;">HIGHWAY</td>
 <td style="text-align: left;">TEXT</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;">支持string, number, boolean</td>
 </tr>
 <tr>
 <td style="text-align: left;">Cookie</td>
 <td style="text-align: left;">HIGHWAY</td>
 <td style="text-align: left;">TEXT</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;">支持string, number, boolean</td>
 </tr>
 <tr>
 <td style="text-align: left;">Body</td>
 <td style="text-align: left;">HIGHWAY</td>
 <td style="text-align: left;">application/x-www-form-urlencoded</td>
 <td style="text-align: left;">否</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">Body</td>
 <td style="text-align: left;">HIGHWAY</td>
 <td style="text-align: left;">multipart/form-data</td>
 <td style="text-align: left;">否</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">Body</td>
 <td style="text-align: left;">HIGHWAY</td>
 <td style="text-align: left;">application/json</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">Body</td>
 <td style="text-align: left;">HIGHWAY</td>
 <td style="text-align: left;">application/protobuf</td>
 <td style="text-align: left;">是</td>
 <td style="text-align: left;"></td>
 </tr>
 </tbody>
 </table>
 <ul>
 <li><code>proto</code> 定义了如下一些基本类型：</li>
 </ul>
 <p>下面列举一些常见的类型说明，详细参考 <a href="https://docs.microsoft.com/en-us/dotnet/architecture/grpc-for-wcf-developers/protobuf-data-types">Proto Buffer类型说明</a>。</p>
 <table>
 <thead>
 <tr>
 <th style="text-align: left;">type</th>
 <th style="text-align: left;">java</th>
 <th style="text-align: left;">说明</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td style="text-align: left;">double</td>
 <td style="text-align: left;">double</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">float</td>
 <td style="text-align: left;">float</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">int32</td>
 <td style="text-align: left;">int</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">int64</td>
 <td style="text-align: left;">long</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">uint32</td>
 <td style="text-align: left;">int</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">uint64</td>
 <td style="text-align: left;">long</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">sint32</td>
 <td style="text-align: left;">int</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">sint64</td>
 <td style="text-align: left;">long</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">fixed32</td>
 <td style="text-align: left;">int</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">fixed64</td>
 <td style="text-align: left;">long</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">sfixed32</td>
 <td style="text-align: left;">int</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">sfixed64</td>
 <td style="text-align: left;">long</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">bool</td>
 <td style="text-align: left;">boolean</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">string</td>
 <td style="text-align: left;">String</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">bytes</td>
 <td style="text-align: left;">ByteString</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td style="text-align: left;">map</td>
 <td style="text-align: left;"></td>
 <td style="text-align: left;">字典类型</td>
 </tr>
 </tbody>
 </table>
 <p><code>OpenAPI</code> 的 <code>date</code> format 在 <code>proto</code> 里面采用 <code>long</code> 表示。 java-chassis 的开发实践分为 <code>code first</code>
 和 <code>contrast first</code> 两种模式， 如果采用 <code>contrast first</code> 模式，先写 <code>swagger</code>， 然后通过 <code>swagger</code> 生成
 代码， 这种方式生成的数据类型都是符合最佳实践的。 如果采用 <code>code first</code>， 要考虑哪些类型是最佳实践，可以从思考定义
 的 JAVA 类型，对应的 <code>swagger</code> 是什么样子的。 当然这样思考，对于不熟悉 <code>swagger</code> 或者 <code>proto</code> 的开发者
 还是显得复杂。 下面从 <code>code first</code> 的角度描述使用哪些类型是最佳实践。 </p>
 <h2 id="code-first">从 <code>code first</code> 角度理解夸平台数据类型的约束</h2>
 <p>开发者不能在接口定义的时候使用如下类型：</p>
 <ul>
 <li>
 <p>抽象的数据结构: java.lang.Object, net.sf.json.JsonObject 等。 使用这些类型 java-chassis 启动
   不会报错，功能也是正常的。但不是最佳实践，也会对性能有一定影响。 </p>
 </li>
 <li>
 <p>接口或者抽象类</p>
 <pre><code>```java
 public interface IPerson {//...}
 public abstract class AbstractPerson  {//...}
 ```
 </code></pre>
 </li>
 <li>
 <p>上述类型的集合类型或者没有指定具体类型的集合，比如：<code>List&lt;IPerson&gt;, Map&lt;String, PersonHolder&lt;?&gt;&gt;, List, Map</code>等。 <code>List&lt;String&gt;, List&lt;Person&gt;</code> 这些具体类型是支持的。</p>
 </li>
 <li>
 <p>包含上述类型作为属性的类型</p>
 <pre><code>```java
 public class GroupOfPerson {IPerson master //...}
 ```
 </code></pre>
 </li>
 </ul>
 <p>不用担心记不住这些约束，程序会在启动的时候检查不支持的类型，并给与错误提示。</p>
 <p>总之，数据结构需要能够使用简单的数据类型进行描述，一目了然就是最好的。这个在不同的语言，不同的协议里面都支持的很
 好，长期来看，可以大大减少开发者联调沟通和后期重构的成本。</p>
 <h3 id="_3">关于数据结构和接口变更</h3>
 <p>接口名称、参数类型、参数顺序、返回值类型变更都属于接口变更。ServiceComb启动的时候，会根据版本号检测接口变化，
 接口变化要求修改版本号。ServiceComb识别接口是否变化是通过代码生成的契约内容，有些不规范的接口定义可能导致在
 代码没有变化的情况下，生成的契约不同。比如：</p>
 <pre><code>public void get(Person p)
 class Person {
   private String value;
   private boolean isOk;
   public String getName() {return value}
   public boolean isOk() {return isOK}
 }
 </code></pre>
 <p>这个接口通过access method定义了"name"和"ok"两个属性，和实际的字段"value"和"isOk"不同。这种情况可能导
 致每次启动生成的契约不一样。需要将代码调整为符合JAVA Bean规范的定义。</p>
 <pre><code>public void get(Person p)
 class Person {
   private String name;
   private boolean ok;
   public String getName() {return name}
   public boolean isOk() {return ok}
 }
 </code></pre>
 <p>或者通过JSON标注，显示的指明字段顺序。比如：</p>
 <pre><code>public void get(Person p)
 @JsonPropertyOrder({&quot;name&quot;, &quot;ok&quot;})
 class Person {
   private String value;
   private boolean isOk;
   public String getName() {return value}
   public boolean isOk() {return isOK}
 }
 </code></pre>
 <p>考虑到接口变更的影响，建议在进行对外接口定义的时候，尽可能不要使用第三方软件提供的类作为接口参数，而是使
 用自定义的POJO类。一方面升级三方件的时候，可能感知不到接口变化；另外一方面，如果出现问题，无法通过
 修改第三方代码进行规避。比如：java.lang.Timestamp, org.joda.time.JodaTime等。</p>
 <h2 id="_4">协议上的差异</h2>
 <p>尽管 ServiceComb-Java-Chassis 实现了不同协议之间开发方式的透明，受限于底层协议的限制，不同的协议存在少量差异。</p>
 <ul>
 <li>
 <p>map，key只支持 string</p>
 </li>
 <li>
 <p>highway (protobuf限制)  </p>
 <ol>
 <li>不支持在网络上传递null，包括Collection、array中的元素，map的value  </li>
 <li>长度为0的数组、list，不会在网络上传递，接收端解码出来就是默认值</li>
 </ol>
 </li>
 <li>
 <p>springmvc  </p>
 <ol>
 <li>不支持 Date 作为 path、query 参数。 因为springmvc 直接将 Date 做 toString 放在path、query中，与
    swagger的标准不匹配。</li>
 </ol>
 </li>
 </ul>
 <h2 id="_5">泛型支持</h2>
 <p>ServiceComb-Java-Chassis 支持REST传输方式下的泛型请求参数和返回值。例如使用一个泛型的数据类型:</p>
 <pre><code class="language-java">public class Generic&lt;T&gt;{
   public T value;
 }
 </code></pre>
 <p>其中的泛型属性T可以是一个实体类、java.util.Date、枚举，也可以嵌套泛型数据类型。</p>
 <p>当用户使用隐式契约功能自动生成微服务契约时，需要在provider接口方法的返回消息中明确指定泛型类型，以保
 证 ServiceComb-Java-Chassis 生成的契约中包含足够的接口信息。例如，当provider端接口方法代码为</p>
 <pre><code class="language-java">public Holder&lt;List&lt;Person&gt;&gt; getHolderListArea() {
   Holder&lt;List&lt;Person&gt;&gt; response = new Holder&lt;&gt;();
   // ommited
   return response;
 }
 </code></pre>
 <p>时， ServiceComb-Java-Chassis 能够识别出泛型返回对象的确切信息，以保证consumer端接收到的应答消息能够被
 正确地反序列化。而如果provider端接口方法的代码为</p>
 <pre><code class="language-java">public Holder getHolderListArea() {
   Holder&lt;List&lt;Person&gt;&gt; response = new Holder&lt;&gt;();
   // ommited
   return response;
 }
 </code></pre>
 <p>时，由于契约中缺少List元素的类型信息，就会出现consumer端无法正确反序列化应答的情况，比如consumer接收
 到的参数类型可能会变为<code>Holder&lt;List&lt;Map&lt;String,String&gt;&gt;&gt;</code>，<code>Person</code>对象退化为Map类型。</p>
 <blockquote>
 <p><strong><em>说明:</em></strong> <br />
 虽然 ServiceComb-Java-Chassis 支持REST泛型参数，但是我们更加推荐用户使用实体类作为参数，以获得
 更加明确的接口语义。</p>
 </blockquote>
 <h2 id="_6">其他常见问题</h2>
 <ul>
 <li>使用 RestTemplate 传递 raw json</li>
 </ul>
 <p>假设服务端定义了接口</p>
 <pre><code>Person test(Person input)
 </code></pre>
 <p>用户期望使用RestTemplate自行拼接json字符串，然后进行传递:</p>
 <pre><code>      String personStr = JsonUtils.writeValueAsString(input);
       result = template.postForObject(cseUrlPrefix + &quot;sayhello&quot;, personStr, Person.class);
 </code></pre>
 <p>ServiceComb不推荐开发者这样使用，里面的处理逻辑存在大量歧义。如果必须使用，需要满足几个约束：Person
 必须包含带String类型的构造函数；provider/consumer都必须存在这个Person类型。</p>
 <h2 id="rest"><code>REST</code> 通信类型扩展</h2>
 <p>默认情况下， 如果在接口中使用 <code>interface</code> 或者 <code>abstract class</code> 作为参数或者返回值， java-chassis
 启动会报告错误。 java-chassis 提供了类型扩展机制， 使得程序中可以支持各种类型。 </p>
 <p>***注意: *** 使用扩展机制的接口，只能够在 <code>REST</code> 通信模式下使用。</p>
 <p>以支持 <code>spring-data</code> 的 <code>Page</code> 接口作为返回值为例， 首先需要通过 <code>SPI</code> 的机制实现 <code>jackson</code> 的类型扩展：</p>
 <pre><code class="language-java">public class SpringDataModule extends SimpleModule implements SPIOrder {
   private static final long serialVersionUID = 1L;

   @JsonDeserialize(as = PageImpl.class)
   @JsonPropertyOrder(alphabetic = true)
   public static class PageMixin&lt;T&gt; {
     @JsonCreator
     public PageMixin(@JsonProperty(value = &quot;content&quot;) List&lt;T&gt; content,
         @JsonProperty(&quot;pageable&quot;) Pageable pageable,
         @JsonProperty(&quot;total&quot;) long total) {
     }
   }

   @JsonDeserialize(as = PageRequest.class)
   @JsonPropertyOrder(alphabetic = true)
   public static class PageableMixin {
     @JsonCreator
     public PageableMixin(@JsonProperty(value = &quot;pageNumber&quot;) int page,
         @JsonProperty(&quot;pageSize&quot;) int size, @JsonProperty(value = &quot;sort&quot;) Sort sort) {
     }
   }

   @JsonPropertyOrder(alphabetic = true)
   @JsonDeserialize(as = Sort.class)
   public static class SortMixin {
     // Notice:
     // spring data model changed from version to version
     // for the tested version, sort is not consistency in serialization and deserialization
     @JsonCreator
     public SortMixin(String... properties) {
     }
   }

   public SpringDataModule() {
     super(&quot;springData&quot;);

     setMixInAnnotation(Page.class, PageMixin.class);
     setMixInAnnotation(Pageable.class, PageableMixin.class);
     setMixInAnnotation(Sort.class, SortMixin.class);

     setMixInAnnotation(PageImpl.class, PageMixin.class);
     setMixInAnnotation(PageRequest.class, PageableMixin.class);
   }

   @Override
   public Object getTypeId() {
     return getModuleName();
   }

   @Override
   public int getOrder() {
     return Short.MAX_VALUE;
   }
 }
 </code></pre>
 <p>再实现 <code>SPI</code> 告诉 java-chassis 跳过类型检查：</p>
 <pre><code class="language-java">public class SpringDataConcreteTypeRegister implements ConcreteTypeRegister {
   @Override
   public void register(Set&lt;Type&gt; types) {
     types.add(Page.class);
     types.add(Pageable.class);
   }
 }
 </code></pre>
 <p>经过这两个步骤（步骤中没描述开发SPI 需要增加 services 文件的内容）， 就能够实现任意类型的支持。 需要注意，这些扩展，必须
 同时包含在 <code>Consumer</code>, <code>Provider</code>, <code>edge service</code> 中，因为这种处理方式是依赖于平台类型的非夸平台特性。 </p>
 <p>上述例子的详细代码可以参考 java-chassis 的源代码， generator-spring-data 模块。 </p>


               </article>
             </div>


 <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
         </div>

       </main>

         <footer class="md-footer">

   <div class="md-footer-meta md-typeset">
     <div class="md-footer-meta__inner md-grid">
       <div class="md-copyright">


     Made with
     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
       Material for MkDocs
     </a>

 </div>

     </div>
   </div>
 </footer>

     </div>
     <div class="md-dialog" data-md-component="dialog">
       <div class="md-dialog__inner md-typeset"></div>
     </div>


     <script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


       <script src="../assets/javascripts/bundle.dd8806f2.min.js"></script>


   </body>
 </html>