content/references/java-chassis/zh_CN/build-provider/springmvc.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="jaxrs.html">


         <link rel="next" href="transparent-rpc.html">


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


         <title>用SpringMVC开发微服务 - 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="#spring-mvc" 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">

               用SpringMVC开发微服务

           </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 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">
     用SpringMVC开发微服务
   </span>


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

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


   <span class="md-ellipsis">
     用SpringMVC开发微服务
   </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="#_1" class="md-nav__link">
     <span class="md-ellipsis">
       开发步骤
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#servicecomb-spring-mvc" class="md-nav__link">
     <span class="md-ellipsis">
       ServiceComb支持的 Spring MVC 注解说明
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#http-header" class="md-nav__link">
     <span class="md-ellipsis">
       在响应中包含 HTTP header
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#string-body" class="md-nav__link">
     <span class="md-ellipsis">
       指定 String 类型 body 编码方式
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#querypojo" class="md-nav__link">
     <span class="md-ellipsis">
       Query参数聚合为POJO对象
     </span>
   </a>

     <nav class="md-nav" aria-label="Query参数聚合为POJO对象">
       <ul class="md-nav__list">

           <li class="md-nav__item">
   <a href="#_2" class="md-nav__link">
     <span class="md-ellipsis">
       代码示例
     </span>
   </a>

     <nav class="md-nav" aria-label="代码示例">
       <ul class="md-nav__list">

           <li class="md-nav__item">
   <a href="#provider" class="md-nav__link">
     <span class="md-ellipsis">
       Provider端开发服务
     </span>
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#consumer" class="md-nav__link">
     <span class="md-ellipsis">
       Consumer端调用服务
     </span>
   </a>

 </li>

       </ul>
     </nav>

 </li>

       </ul>
     </nav>

 </li>

     </ul>

 </nav>

     </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">
       <a href="interface-constraints.html" class="md-nav__link">


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


       </a>
     </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="#_1" class="md-nav__link">
     <span class="md-ellipsis">
       开发步骤
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#servicecomb-spring-mvc" class="md-nav__link">
     <span class="md-ellipsis">
       ServiceComb支持的 Spring MVC 注解说明
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#http-header" class="md-nav__link">
     <span class="md-ellipsis">
       在响应中包含 HTTP header
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#string-body" class="md-nav__link">
     <span class="md-ellipsis">
       指定 String 类型 body 编码方式
     </span>
   </a>

 </li>

         <li class="md-nav__item">
   <a href="#querypojo" class="md-nav__link">
     <span class="md-ellipsis">
       Query参数聚合为POJO对象
     </span>
   </a>

     <nav class="md-nav" aria-label="Query参数聚合为POJO对象">
       <ul class="md-nav__list">

           <li class="md-nav__item">
   <a href="#_2" class="md-nav__link">
     <span class="md-ellipsis">
       代码示例
     </span>
   </a>

     <nav class="md-nav" aria-label="代码示例">
       <ul class="md-nav__list">

           <li class="md-nav__item">
   <a href="#provider" class="md-nav__link">
     <span class="md-ellipsis">
       Provider端开发服务
     </span>
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#consumer" class="md-nav__link">
     <span class="md-ellipsis">
       Consumer端调用服务
     </span>
   </a>

 </li>

       </ul>
     </nav>

 </li>

       </ul>
     </nav>

 </li>

     </ul>

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


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


 <h1 id="spring-mvc">用 Spring MVC 开发微服务</h1>
 <p>Spring MVC 是 spring-web 项目定义的一套注解，开发者可以使用这套注解定义 REST 接口。 servicecomb 也
 支持使用这套标签定义 REST 接口。需要注意的是，servicecomb 只是使用这些注解，而注解的实现是项目自行开发的，
 实现的功能集合是 Spring MVC 注解的子集。可以阅读文章后面的内容了解具体的标签集合和使用约束。</p>
 <p><a href="https://github.com/apache/servicecomb-samples/tree/master/java-chassis-samples/springmvc-sample">SpringMVC Sample</a> 提供了一些基础的代码示例，可以下载使用。</p>
 <h2 id="_1">开发步骤</h2>
 <p>下面简单介绍使用 Spring MVC 开发 REST 服务的一些简单步骤。</p>
 <ul>
 <li>定义服务接口（可选）</li>
 </ul>
 <p>定义接口是一个好习惯， 它不是必须的。</p>
 <pre><code>    ```java
     public interface Hello {
         String sayHi(String name);
         String sayHello(Person person);
     }
     ```
 </code></pre>
 <ul>
 <li>实现服务接口</li>
 </ul>
 <p>在服务的实现类上打上注解 <code>@RestSchema</code>，指定 <code>schemaId</code>。 注意 <code>schemaId</code> 需要保证微服务范围内唯一。</p>
 <pre><code>    ```java
     @RestSchema(schemaId = "springmvcHello")
     @RequestMapping(path = "/springmvchello", produces = MediaType.APPLICATION_JSON)
     public class SpringmvcHelloImpl implements Hello {
         @Override
         @RequestMapping(path = "/sayhi", method = RequestMethod.POST)
         public String sayHi(@RequestParam(name = "name") String name) {
             return "Hello " + name;
         }

         @Override
         @RequestMapping(path = "/sayhello", method = RequestMethod.POST)
         public String sayHello(@RequestBody Person person) {
             return "Hello person " + person.getName();
         }
     }
     ```
 </code></pre>
 <h2 id="servicecomb-spring-mvc">ServiceComb支持的 Spring MVC 注解说明</h2>
 <p>servicecomb 支持使用 Spring MVC 提供的注解 <code>org.springframework.web.bind.annotation</code> 来声
 明REST接口，但是两者是独立的实现，而且有不一样的设计目标。servicecomb 的目标是提供跨语言、支持多通信协议的
 框架，因此去掉了Spring MVC中一些对跨语言支持不是很好的特性，也不支持特定运行框架强相关的特性，比
 如直接访问Servlet协议定义的<code>HttpServletRequest</code>。servicecomb 没有实现<code>@Controller</code>相关功
 能, 只实现了<code>@RestController</code>，即通过MVC模式进行页面渲染等功能都是不支持的。</p>
 <p>下面是一些具体差异。</p>
 <ul>
 <li>常用标签支持</li>
 </ul>
 <p>下面是CSE对于Spring MVC常用标签的支持情况。</p>
 <p><strong><em>表1-1 Spring MVC注解情况说明</em></strong></p>
 <table>
 <thead>
 <tr>
 <th>标签名称</th>
 <th style="text-align: center;">是否支持</th>
 <th style="text-align: left;">说明</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>RequestMapping</td>
 <td style="text-align: center;">是</td>
 <td style="text-align: left;">不允许制定多个Path，一个接口只允许一个Path，必须显示的声明 method 属性，只能定义唯一一个 method</td>
 </tr>
 <tr>
 <td>GetMapping</td>
 <td style="text-align: center;">是</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td>PutMapping</td>
 <td style="text-align: center;">是</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td>PostMapping</td>
 <td style="text-align: center;">是</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td>DeleteMapping</td>
 <td style="text-align: center;">是</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td>PatchMapping</td>
 <td style="text-align: center;">是</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td>RequestParam</td>
 <td style="text-align: center;">是</td>
 <td style="text-align: left;">注意含义与Spring MVC不同。Java Chassis 表示 query 参数。</td>
 </tr>
 <tr>
 <td>CookieValue</td>
 <td style="text-align: center;">是</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td>PathVariable</td>
 <td style="text-align: center;">是</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td>RequestHeader</td>
 <td style="text-align: center;">是</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td>RequestBody</td>
 <td style="text-align: center;">是</td>
 <td style="text-align: left;">目前支持application/json，plain/text</td>
 </tr>
 <tr>
 <td>RequestPart</td>
 <td style="text-align: center;">是</td>
 <td style="text-align: left;">用于文件上传的场景，对应的标签还有Part、MultipartFile</td>
 </tr>
 <tr>
 <td>ResponseBody</td>
 <td style="text-align: center;">否</td>
 <td style="text-align: left;">返回值缺省都是在body返回</td>
 </tr>
 <tr>
 <td>ResponseStatus</td>
 <td style="text-align: center;">否</td>
 <td style="text-align: left;">可以通过ApiResponse指定返回的错误码</td>
 </tr>
 <tr>
 <td>RequestAttribute</td>
 <td style="text-align: center;">是</td>
 <td style="text-align: left;">注意含义与Spring MVC不同。Java Chassis 表示 form 参数。</td>
 </tr>
 <tr>
 <td>SessionAttribute</td>
 <td style="text-align: center;">否</td>
 <td style="text-align: left;">Servlet协议相关的标签</td>
 </tr>
 <tr>
 <td>MatrixVariable</td>
 <td style="text-align: center;">否</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td>ModelAttribute</td>
 <td style="text-align: center;">否</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td>ControllerAdvice</td>
 <td style="text-align: center;">否</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td>CrossOrigin</td>
 <td style="text-align: center;">否</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td>ExceptionHandler</td>
 <td style="text-align: center;">否</td>
 <td style="text-align: left;"></td>
 </tr>
 <tr>
 <td>InitBinder</td>
 <td style="text-align: center;">否</td>
 <td style="text-align: left;"></td>
 </tr>
 </tbody>
 </table>
 <ul>
 <li>服务声明方式</li>
 </ul>
 <p>Spring MVC使用<code>@RestController</code>声明服务，而ServiceComb使用<code>@RestSchema</code>声明服务，并且需
   要显式地使用<code>@RequestMapping</code>声明服务路径，以区分该服务是采用Spring MVC的标签还是使用JAX RS的标签。</p>
 <pre><code>    ```
     @RestSchema(schemaId = "springmvcHello")
     @RequestMapping(path = "/springmvchello", produces = MediaType.APPLICATION_JSON)
     public class SpringmvcHelloImpl implements Hello {
       ......
     }
     ```
 </code></pre>
 <p>servicecomb 也支持 <code>@RestController</code> 声明，等价于 <code>@RestSchma(schemaId="服务的class名称")</code>，这个
   功能可以简化用户将老的应用改造为 servicecomb 。 建议用户使用<code>@RestSchema</code>显式声明schemaId，在管理
   接口基本的配置项的时候，更加直观。</p>
 <p><strong>注意</strong>：如果不希望Java-Chassis扫描<code>@RestController</code>注解作为REST接口类处理，需要增加配置
   <code>servicecomb.provider.rest.scanRestController=false</code> 以关闭此功能。</p>
 <ul>
 <li>数据类型支持</li>
 </ul>
 <p>Spring 技术实现的 Spring MVC，可以在服务定义中使用多种数据类型，只要这种数据类型能够被json序列化和
   反序列化。比如：</p>
 <pre><code>    ```
     // 抽象类型
     public void postData(@RequestBody Object data)
     // 接口定义
     public void postData(@RequestBody IPerson interfaceData)
     // 没指定类型的泛型
     public void postData(@RequestBody Map rawData)
     ```
 </code></pre>
 <p>Spring 技术早期都是基于 JSP/Servlet 协议标准的，还可以使用相关的 context 参数，比如：</p>
 <pre><code>    ```
     // 具体协议相关的类型
     public void postData(HttpServletRequest rquest, HttpServletResponse response)
     ```
 </code></pre>
 <p>servicecomb 对于数据类型存在一定的限制，不允许使用接口、抽象类等数据类型定义参数，虽然 servicecomb
   支持使用 Object 这个特殊的类型来处理类型无法确定的情况，但是建议尽可能少使用，使用 Object 作为类型，
   运行时的类型不确定，可能给客户端代码的书写带来一定麻烦。</p>
 <p>servicecomb 也支持一些 context 参数， 参考<a href="context-param.html">使用 Context 参数</a> 。但是由于 servicecomb 默认的运行环境并不是 JSP/Servlet 协议
   环境，因此不能直接使用 <code>HttpServletRequest</code> 和 <code>HttpServletResponse</code>。 </p>
 <p>ServiceComb在数据类型的支持方面的更多说明，请参考： <a href="interface-constraints.html">接口定义和数据类型</a></p>
 <ul>
 <li>其他</li>
 </ul>
 <p>更多开发过程中碰到的问题，可以参考<a href="https://bbs.huaweicloud.com/blogs/8b8d8584e70d11e8bd5a7ca23e93a891">案例</a>。开发过程中存在疑问，也可以在这里进行提问。</p>
 <h2 id="http-header">在响应中包含  HTTP header</h2>
 <p>可以有多种方式在响应中包含 HTTP header， 下面代码展示了使用 ResponseEntity 包含 HTTP header。 需要注意
 使用 @ResponseHeaders 声明返回的 header 信息。 包含了 @ResponseHeaders 以后， 接口生成的契约中，也可以
 看到对应的 header 参数。</p>
 <pre><code class="language-java">  @ResponseHeaders({@ResponseHeader(name = &quot;h1&quot;, response = String.class),
       @ResponseHeader(name = &quot;h2&quot;, response = String.class)})
   @RequestMapping(path = &quot;/responseEntity&quot;, method = RequestMethod.POST)
   public ResponseEntity&lt;Date&gt; responseEntity(InvocationContext c1,
         @RequestAttribute(&quot;date&quot;) Date date) {
     HttpHeaders headers = new HttpHeaders();
     headers.add(&quot;h1&quot;, &quot;h1v &quot; + c1.getContext().get(Const.SRC_MICROSERVICE));

     InvocationContext c2 = ContextUtils.getInvocationContext();
     headers.add(&quot;h2&quot;, &quot;h2v &quot; + c2.getContext().get(Const.SRC_MICROSERVICE));

     return new ResponseEntity&lt;&gt;(date, headers, HttpStatus.ACCEPTED);
   }
 </code></pre>
 <p>也可以使用 Response 对象返回 HTTP header，示例代码如下：</p>
 <pre><code class="language-java">  @ApiResponse(code = 202, response = User.class, message = &quot;&quot;)
   @ResponseHeaders({@ResponseHeader(name = &quot;h1&quot;, response = String.class),
       @ResponseHeader(name = &quot;h2&quot;, response = String.class)})
   @RequestMapping(path = &quot;/cseResponse&quot;, method = RequestMethod.GET)
   public Response cseResponse(InvocationContext c1) {
     Response response = Response.createSuccess(Status.ACCEPTED, new User());
     Headers headers = response.getHeaders();
     headers.addHeader(&quot;h1&quot;, &quot;h1v &quot; + c1.getContext().get(Const.SRC_MICROSERVICE));

     InvocationContext c2 = ContextUtils.getInvocationContext();
     headers.addHeader(&quot;h2&quot;, &quot;h2v &quot; + c2.getContext().get(Const.SRC_MICROSERVICE));

     return response;
   }
 </code></pre>
 <p>这个示例代码还通过 @ApiResponse 指定了返回 202 错误码及其类型， 这个响应值会在契约体现。</p>
 <p><strong><em>注意</em></strong>: HIGHWAY 协议不支持指定返回错误码和类型。需要同时使用 HIGHWAY 和 REST 访问的接口，
 请勿使用。  </p>
 <h2 id="string-body">指定 String 类型 body 编码方式</h2>
 <p>使用 REST 通信的服务， 一般采用 json 进行编解码。 String 类型的数据， 编码为 json 的时候，存在
 双引号。 比如 <code>abc</code> 编码以后为 <code>"abc"</code> 。 但是 Spring 自身的实现， 将 String 类型的数据，编码
 为不带双引号。 为了保持 Spring 原始实现的方式兼容， servicecomb 提供了 <code>RawJsonRequestBody</code> 接收
 不带双引号的参数。 </p>
 <pre><code class="language-java">  @ResponseBody
   public String testRawJsonAnnotation(@RawJsonRequestBody String jsonInput) {
     return jsonInput;
   }
 </code></pre>
 <p>或者使用 MediaType.TEXT_PLAIN_VALUE, 不使用 MediaType.APPLICATION_JSON_VALUE</p>
 <pre><code class="language-java">  @RequestMapping(path = &quot;/textPlain&quot;, method = RequestMethod.POST,
       consumes = MediaType.TEXT_PLAIN_VALUE)
   public String textPlain(@RequestBody String body) {
     return body;
   }
 </code></pre>
 <p>如果响应不期望带双引号，可以使用 <code>produces = MediaType.TEXT_PLAIN_VALUE</code></p>
 <pre><code class="language-java"> @RequestMapping(path = &quot;/sayhi/compressed/{name}/v2&quot;,
     method = RequestMethod.GET, produces = MediaType.TEXT_PLAIN_VALUE)
   public String sayHiForCompressed(@PathVariable(name = &quot;name&quot;) String name) {
      return name;
   }
 </code></pre>
 <h2 id="querypojo">Query参数聚合为POJO对象</h2>
 <p>SpringBoot支持将Java业务接口中的多个query参数聚合为一个POJO类，SpringBoot原生用法示例如下：</p>
 <pre><code class="language-java">@RequestMapping(&quot;/hello&quot;)
 public class HelloService {
   @RequestMapping(value = &quot;/sayHello&quot;, method = RequestMethod.GET)
   public String sayHello(Person person) {
     System.out.println(&quot;sayHello is called, person = [&quot; + person + &quot;]&quot;);
     return &quot;Hello, your name is &quot; + person.getName() + &quot;, and age is &quot; + person.getAge();
   }
 }
 </code></pre>
 <p>其中，作为参数的<code>Person</code>类是一个标准的JavaBean，包含属性<code>name</code>和<code>age</code>。当服务接收到的请求时，SpringBoot会将query参数<code>name</code>和<code>age</code>聚合为Person对象传入业务接口。</p>
 <p>ServiceComb的SpringMVC开发模式现在也支持类似的用法，该用法的要求如下：</p>
 <ol>
 <li>POJO参数上不能有Spring的参数注解，否则ServiceComb不会将其作为聚合的query参数对象处理。</li>
 <li>仅支持聚合query参数</li>
 <li>POJO参数类中的属性名与query参数名需要保持一致</li>
 <li>POJO参数中不支持复杂的属性，如其他POJO对象、List等。用户可以在这些复杂类型打上<code>@JsonIgnore</code>注解来让ServiceComb忽略这些复杂属性。</li>
 <li>consumer端不支持query参数聚合为POJO对象，调用服务时依然要按照契约发送请求。即provider端被聚合的POJO参数在契约中会被展开成一系列的query参数，consumer端需要在provider接口方法中依次定义这些query参数（RPC开发模式），或在发送请求时填入这些query参数（RestTemplate开发模式）。</li>
 </ol>
 <h3 id="_2">代码示例</h3>
 <h4 id="provider">Provider端开发服务</h4>
 <ul>
 <li>Provider端业务接口代码：</li>
 </ul>
 <pre><code class="language-java">  @RestSchema(schemaId = &quot;helloService&quot;)
   @RequestMapping(&quot;/hello&quot;)
   public class HelloService {
     @RequestMapping(value = &quot;/sayHello&quot;, method = RequestMethod.GET)
     public String sayHello(Person person) {
       System.out.println(&quot;sayHello is called, person = [&quot; + person + &quot;]&quot;);
       return &quot;Hello, your name is &quot; + person.getName() + &quot;, and age is &quot; + person.getAge();
     }
   }
 </code></pre>
 <ul>
 <li>POJO参数对象定义：</li>
 </ul>
 <pre><code class="language-java">  public class Person {
     private String name;
     private int age;
     @JsonIgnore  // 复杂属性需要标记@JsonIgnore，否则启动时会报错
     private List&lt;Person&gt; children;
   }
 </code></pre>
 <ul>
 <li>接口契约：</li>
 </ul>
 <pre><code class="language-yaml"># 忽略契约的其他部分
 basePath: &quot;/hello&quot;
 paths:
   /sayHello:
     get:
       operationId: &quot;sayHello&quot;
       parameters:
         # Person类的name属性和age属性作为契约中的query参数
       - name: &quot;name&quot;
         in: &quot;query&quot;
         required: false
         type: &quot;string&quot;
       - name: &quot;age&quot;
         in: &quot;query&quot;
         required: false
         type: &quot;integer&quot;
         format: &quot;int32&quot;
       responses:
         200:
           description: &quot;response of 200&quot;
           schema:
             type: &quot;string&quot;
 </code></pre>
 <h4 id="consumer">Consumer端调用服务</h4>
 <p>consumer端RPC开发模式：</p>
 <ul>
 <li>Provider接口定义</li>
 </ul>
 <pre><code class="language-java">public interface HelloServiceIntf {
   String sayHello(String name, int age);
 }
 </code></pre>
 <ul>
 <li>调用代码</li>
 </ul>
 <pre><code class="language-java">String result = helloService.sayHello(&quot;Bob&quot;, 22); // result的值为&quot;Hello, your name is Bob, and age is 22&quot;
 </code></pre>
 <ul>
 <li>consumer端RestTemplate开发模式：</li>
 </ul>
 <pre><code class="language-java">String result = restTemplate.getForObject(
   &quot;cse://provider-service/hello/sayHello?name=Bob&amp;age=22&quot;,
   String.class); // 调用效果与RPC方式相同
 </code></pre>


               </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>