blob: 67c02990021f55ab6114f69c7a88846be9de4949 [file] [log] [blame]
<!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="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
<title>理解服务契约 - Java Chassis 3 开发指南</title>
<link rel="stylesheet" href="../assets/stylesheets/main.6543a935.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--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<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="false">
<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">
<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>
</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>
</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/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="../security/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>
</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="../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="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_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="../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_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="../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_20" >
<label class="md-nav__link" for="__nav_20" id="__nav_20_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_20_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_20">
<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">
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="_1">理解服务契约</h1>
<p>servicecomb 的核心设计理念是 <code>以契约为中心</code>,契约是微服务系统运行和治理的基础。 可以将契约理解为基
于 OpenAPI 规范的微服务接口描述。java chassis 提供了两种方式定义契约:<code>code first</code>
<code>contract first</code></p>
<ul>
<li>code first</li>
</ul>
<p>开发者首先通过 JAVA 代码定义接口信息,servicecomb 会根据代码定义,生成以 yaml 文件描述的 OpenAPI
文档。 servicecomb 支持使用 <code>JAX-RS</code>, <code>Spring MVC</code> 等 REST Annotation 描述接口信息,还可以通过
swagger API 补充其他接口信息。 在使用 <code>RPC</code> 方式定义接口的时候, 系统会按照默认的规则生成接口描述,
也可以使用这些标签修饰接口信息,让契约信息更加容易阅读和理解。</p>
<ul>
<li>contract first</li>
</ul>
<p>开发者先通过契约编辑器书写 yaml 格式的接口描述,然后通过代码生成工具,生成项目代码。这种方式通常
需要定义一套标准的软件工程规范,并提供相关的工具支持。这种方式更加容易实现接口规范管理,实现测试自动化
等软件工程流程。</p>
<p>由于 <code>contract first</code> 实践起来,需要配套的管理过程和工具体系支持,这里不详细描述,
本章节简单描述如何书写契约。后续的章节会描述使用 <code>code first</code> 的开发细节。</p>
<h1 id="contract-first">contract first 开发步骤简要描述</h1>
<p>ServiceComb 使用 yaml 文件格式定义服务契约,推荐使用<a href="http://editor.swagger.io/#/">Swagger Editor</a>工具来编写契约,
可检查语法格式及自动生成API文档。详细的契约文件格式请参考<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md">OpenAPI官方文档</a></p>
<p>契约文件放置在 <code>resources/microservices</code> 或者 <code>resources/application</code> 目录下,目录结构如下所示。</p>
<pre><code class="language-yaml">resources
- microservices
- serviceName #微服务名
- schemaId.yaml #schema接口的契约
- applications
- appId #应用ID
- serviceName #微服务名
- schemaId.yaml #schema接口的契约
</code></pre>
<p>ServiceComb的Swagger契约文件应当使用UTF-8字符集保存。如果当用户使用其他字符集保存契约文件,且文
件中包含中文字符时,可能会导致未知错误。</p>
<h2 id="_2">示例代码</h2>
<p><code>resources/microservices</code>目录和<code>resources/application</code> 目录下的schemaId.yaml文件内容示例如下。</p>
<pre><code class="language-yaml">swagger: '2.0'
info:
title: hello
version: 1.0.0
x-java-interface: org.apache.servicecomb.samples.common.schema.Hello
basePath: /springmvchello
produces:
- application/json
paths:
/sayhi:
post:
operationId: sayHi
parameters:
- name: name
in: query
required: true
type: string
responses:
200:
description: 正确返回
schema:
type: string
default:
description: 默认返回
schema:
type: string
/sayhello:
post:
operationId: sayHello
parameters:
- name: person
in: body
required: true
schema:
$ref: &quot;#/definitions/Person&quot;
responses:
200:
description: 正确返回
schema:
type: string
default:
description: 默认返回
schema:
type: string
definitions:
Person:
type: &quot;object&quot;
properties:
name:
type: &quot;string&quot;
description: &quot;person name&quot;
xml:
name: &quot;Person&quot;
</code></pre>
<p>ServiceComb中的契约,basePath不需要包含web container的web root,以及servlet的url pattern。
因为ServiceComb支持部署解耦,既可以脱离servlet container独立部署,也可使用war的方式部署
到servlet container中,还可以使用embedded servlet container的方式运行。
部署方式修改导致的实际url变更,ServiceComb consumer业务代码并不需要感知,框架会自动适配。 </p>
<p>说明:</p>
<ul>
<li>info.x-java-interface需要标明具体的接口路径,根据项目实际情况而定。该信息主要是为了和老版本兼容,
新版本可以不需要指定。</li>
<li>SchemaId中可以包含"."字符,但不推荐这样命名。这是由于ServiceComb使用的配置文件是yaml格式的,
"."符号用于分割配置项名称,如果SchemaId中也包含了"."可能会导致一些支持契约级别的配置无法正确被识别。</li>
<li>OperationId的命名中不可包含"."字符。</li>
</ul>
</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.081f42fc.min.js"></script>
</body>
</html>