blob: 5521e0a903eae7e86e64ee008f0bd391ad5370b6 [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="prev" href="open-service.html">
<link rel="next" href="zuul.html">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.19">
<title>使用 Edge Service 做网关 - 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="#edge-service" 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">
使用 Edge Service 做网关
</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="../build-provider/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="../build-provider/basics.html" class="md-nav__link">
<span class="md-ellipsis">
基础概念
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/http-mapping.html" class="md-nav__link">
<span class="md-ellipsis">
HTTP参数映射参考
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/jaxrs.html" class="md-nav__link">
<span class="md-ellipsis">
用JAX-RS开发微服务
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/springmvc.html" class="md-nav__link">
<span class="md-ellipsis">
用SpringMVC开发微服务
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/transparent-rpc.html" class="md-nav__link">
<span class="md-ellipsis">
用透明RPC开发微服务
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/use-interface.html" class="md-nav__link">
<span class="md-ellipsis">
只发布interface的方法为服务接口
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/reactive.html" class="md-nav__link">
<span class="md-ellipsis">
异步处理
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/context-param.html" class="md-nav__link">
<span class="md-ellipsis">
使用 Context 参数
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/multi-code.html" class="md-nav__link">
<span class="md-ellipsis">
多个返回值和错误码
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/swagger-annotation.html" class="md-nav__link">
<span class="md-ellipsis">
使用Swagger注解
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/interface-constraints.html" class="md-nav__link">
<span class="md-ellipsis">
接口定义和数据类型
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/listen-address-and-publish-address.html" class="md-nav__link">
<span class="md-ellipsis">
服务监听地址和发布地址
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/thread-pool.html" class="md-nav__link">
<span class="md-ellipsis">
线程池
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/event-listener.html" class="md-nav__link">
<span class="md-ellipsis">
服务启动事件
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/parameter-validator.html" class="md-nav__link">
<span class="md-ellipsis">
参数效验
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/bootup.html" class="md-nav__link">
<span class="md-ellipsis">
程序启动逻辑
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/ipv6-configuration.html" class="md-nav__link">
<span class="md-ellipsis">
IPV6配置和使用
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/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--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_15" checked>
<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="true">
<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="open-service.html" class="md-nav__link">
<span class="md-ellipsis">
介绍
</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">
使用 Edge Service 做网关
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="by-servicecomb-sdk.html" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
使用 Edge Service 做网关
</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="#edge-service_1" class="md-nav__link">
<span class="md-ellipsis">
开发 Edge Service 服务
</span>
</a>
</li>
<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="#header" class="md-nav__link">
<span class="md-ellipsis">
定制公共转发 Header
</span>
</a>
</li>
<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="#_3" class="md-nav__link">
<span class="md-ellipsis">
部署示例
</span>
</a>
</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="#demo" class="md-nav__link">
<span class="md-ellipsis">
DEMO功能说明
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="zuul.html" class="md-nav__link">
<span class="md-ellipsis">
使用 `zuul` 和 `spring cloud gateway` 做网关
</span>
</a>
</li>
<li class="md-nav__item">
<a href="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="#edge-service_1" class="md-nav__link">
<span class="md-ellipsis">
开发 Edge Service 服务
</span>
</a>
</li>
<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="#header" class="md-nav__link">
<span class="md-ellipsis">
定制公共转发 Header
</span>
</a>
</li>
<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="#_3" class="md-nav__link">
<span class="md-ellipsis">
部署示例
</span>
</a>
</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="#demo" class="md-nav__link">
<span class="md-ellipsis">
DEMO功能说明
</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="edge-service">使用 Edge Service 做网关</h1>
<p>Edge Service 是ServiceComb 提供的JAVA网关服务开发框架。Edge Service作为整个微服务系统对外的接口,向最终用户提供服务,接入REST请求,转发给内部微服务,Edge Service支持REST请求和Highway请求的转发。Edge Service以开发框架的形式提供,开发者可以非常简单的搭建一个Edge Service服务,通过简单的配置就可以定义路由转发规则。同时Edge Service支持强大的扩展能力,服务映射、请求解析、加密解密、鉴权等逻辑都可以通过扩展实现。</p>
<p>Edge Service 本身也是一个微服务,需遵守所有微服务开发的规则。其本身可以部署为多实例,前端使用负载均衡装置进行负载分发;也可以部署为主备,直接接入用户请求。开发者可以根据Edge Service承载的逻辑和业务访问量、组网情况来规划。</p>
<h2 id="edge-service_1">开发 Edge Service 服务</h2>
<p>开发 Edge Service 和开发一个普通的微服务步骤差不多,开发者可以从导入<a href="https://github.com/apache/servicecomb-samples/tree/master/basic/gateway">ServiceComb Edge Service Samples</a>入手。从头搭建项目包含如下几个步骤:</p>
<ul>
<li>配置依赖关系</li>
</ul>
<p>在项目中加入edge-core的依赖,就可以启动Edge Service的功能。</p>
<pre><code> &lt;dependency&gt;
&lt;groupId&gt;org.apache.servicecomb&lt;/groupId&gt;
&lt;artifactId&gt;java-chassis-spring-boot-starter-standalone&lt;/artifactId&gt;
&lt;/dependency&gt;
&lt;dependency&gt;
&lt;groupId&gt;org.apache.servicecomb&lt;/groupId&gt;
&lt;artifactId&gt;edge-core&lt;/artifactId&gt;
&lt;/dependency&gt;
</code></pre>
<ul>
<li>定义启动类</li>
</ul>
<p>和开发普通微服务一样,可以通过 <code>@EnableServiceComb</code> 的方式将服务拉起来。</p>
<pre><code>@SpringBootApplication
@EnableServiceComb
public class GatewayApplication {
public static void main(String[] args) throws Exception {
try {
new SpringApplicationBuilder().web(WebApplicationType.NONE).sources(GatewayApplication.class).run(args);
} catch (Exception e) {
e.printStackTrace();
}
}
}
</code></pre>
<ul>
<li>增加配置文件 microservice.yaml</li>
</ul>
<p>Edge Service本身也是一个微服务,遵循微服务查找的规则,自己也会进行注册。注意 <code>application</code> 与需要转发的微服务相同。在下面的配置中,指定了Edge Service监听的地址,处理链等信息。其中auth处理链是DEMO项目中自定义的处理链,用于实现认证。同时auth服务本身,不经过这个处理链,相当于不鉴权。</p>
<pre><code>servicecomb:
service:
application: edge
name: edge
version: 0.0.1
registry:
address: http://127.0.0.1:30100
rest:
address: 127.0.0.1:18080
handler:
chain:
Consumer:
default: auth,loadbalance
service:
auth: loadbalance
</code></pre>
<h2 id="_1">工作流程</h2>
<p>Edge Service的工作流程如下,蓝色背景部分在Eventloop线程中执行,黄色背景部分:
* 如果工作于reactive模式,则直接在Eventloop线程执行
* 如果工作于线程池模式,则在线程池的线程中执行
<img alt="" src="../assets/workFlow.png" /></p>
<h2 id="header">定制公共转发 Header</h2>
<p>Edge Service 在转发请求的时候, 会默认过滤掉 <code>公共请求头</code> 。 也就是除了 <strong>Provider</strong> 端显示 声明需要的 <code>HEADER</code> 外, 其他的 header 在转发的时候都会丢失。用户可以通过配置相关参数保留 公共请求头。</p>
<pre><code class="language-yaml">servicecomb:
edge:
filter:
addHeader:
# 开启 公共请求头保留功能。默认 false
enabled: true
# 要保留的公共请求头,以逗号隔开
allowedHeaders: external_1,external_2
</code></pre>
<p>如果对接了配置中心, 可以在配置中心动态修改 配置 <code>servicecomb.edge.filter.addHeader.enabled</code><code>servicecomb.edge.filter.addHeader.allowedHeaders</code> , 配置动态生效。</p>
<h2 id="_2">定制路由规则</h2>
<p>使用Edge Service的核心工作是配置路由规则。场景不同,规则也不同。
路由规则由一系列AbstractEdgeDispatcher组成。Edge Service提供了几个常见的Dispatcher,通过配置即可启用,如果这些Dispatcher不满足业务场景需要,还可以自定义。</p>
<ul>
<li>使用 DefaultEdgeDispatcher</li>
</ul>
<p>DefaultEdgeDispatcher是一个非常简单、容易管理的Dispatcher,使用这个Dispatcher,用户不用动态管理转发规则,应用于实际的业务场景非常方便,这个也是推荐的一种管理机制。它包含如下几个配置项:</p>
<pre><code>servicecomb:
http:
dispatcher:
edge:
default:
enabled: true
prefix: rest
withVersion: true
prefixSegmentCount: 1
</code></pre>
<p>常见的这些配置项的示例及含义如下:</p>
<ul>
<li>[prefix=rest;withVersion=true;prefixSegmentCount=1]微服务xService提供的URL为: /xService/v1/abc,通过Edge访问的地址为/rest/xService/v1/abc,请求只转发到[1.0.0-2.0.0)版本的微服务实例。</li>
<li>[prefix=rest;withVersion=true;prefixSegmentCount=2]微服务xService提供的URL为: /v1/abc,通过Edge访问的地址为/rest/xService/v1/abc,请求只转发到[1.0.0-2.0.0)版本的微服务实例。</li>
<li>[prefix=rest;withVersion=true;prefixSegmentCount=3]微服务xService提供的URL为: /abc,通过Edge访问的地址为/rest/xService/v1/abc,请求只转发到[1.0.0-2.0.0)版本的微服务实例。</li>
<li>[prefix=rest;withVersion=false;prefixSegmentCount=1]微服务xService提供的URL为: /xService/v1/abc,通过Edge访问的地址为/rest/xService/v1/abc,请求可能转发到任意微服务实例。</li>
<li>[prefix=rest;withVersion=false;prefixSegmentCount=2]微服务xService提供的URL为: /v1/abc,通过Edge访问的地址为/rest/xService/v1/abc,,请求可能转发到任意微服务实例。</li>
<li>[prefix=rest;withVersion=false;prefixSegmentCount=2]微服务xService提供的URL为: /abc,通过Edge访问的地址为/rest/xService/abc,,请求可能转发到任意微服务实例。</li>
</ul>
<p>withVersion配置项提供了客户端灰度规则,可以让客户端指定访问的服务端版本。Edge Service还包含根据接口兼容性自动路由的功能,请求会转发到包含了该接口的实例。假设某微服务,兼容规划为所有高版本必须兼容低版本,部署了以下版本实例:</p>
<ul>
<li>
<p>1.0.0,提供了operation1</p>
</li>
<li>
<p>1.1.0,提供了operation1、operation2</p>
</li>
</ul>
<p>Edge Service在转发operation1时,会自动使用1.0.0+的规则来过滤实例</p>
<p>Edge Service在转发operation2时,会自动使用1.1.0+的规则来过滤实例</p>
<p>以上过程用户不必做任何干预,全自动完成,以避免将新版本的operation转发到旧版本的实例中去。</p>
<ul>
<li>使用 URLMappedEdgeDispatcher</li>
</ul>
<p>URLMappedEdgeDispatcher 允许用户配置URL和微服务的映射关系。使用它可以非常灵活的定义哪些URL转发到哪些微服务。它包含如下几个配置项:</p>
<pre><code class="language-yaml">servicecomb:
http:
dispatcher:
edge:
url:
enabled: true
## 默认值,一般不需要配置
pattern: &quot;/(.*)&quot;
mappings:
businessV1:
prefixSegmentCount: 1
path: &quot;/url/business/v1/.*&quot;
microserviceName: business
versionRule: 1.0.0-2.0.0
businessV2:
prefixSegmentCount: 1
path: &quot;/url/business/v2/.*&quot;
microserviceName: business
versionRule: 2.0.0-3.0.0
</code></pre>
<p><code>businessV1</code> 配置项表示的含义是将请求路径为 <code>/url/business/v1/.*</code> 的请求,转发到<code>business</code> 这个微服务,并且只转发到版本号为1.0.0-2.0.0的实例(不含2.0.0)。转发的时候URL为 <code>/business/v1/.*</code> 。path使用的是JDK的正则表达式,可以查看Pattern类的说明。prefixSegmentCount表示前缀的URL Segment数量,前缀不包含在转发的URL路径中。有三种形式的versionRule可以指定。2.0.0-3.0.0表示版本范围,含2.0.0,但不含3.0.0;2.0.0+表示大于2.0.0的版本,含2.0.0;2.0.0表示只转发到2.0.0版本。2,2.0等价于2.0.0。</p>
<p>从上面的配置可以看出,URLMappedEdgeDispatcher也支持客户端灰度。当然配置项会比DefaultEdgeDispatcher多。URLMappedEdgeDispatcher支持通过配置中心动态的修改配置,调整路由规则。</p>
<ul>
<li>使用 CommonHttpEdgeDispatcher</li>
</ul>
<p>CommonHttpEdgeDispatcher 能够将请求转发到监听 HTTP 或者 HTTP 2 协议的 Provider, 对于 Provider 的开发框架没有限制,也不
要求 Provider 注册契约信息。 </p>
<pre><code class="language-yaml">servicecomb:
http:
dispatcher:
edge:
http:
enabled: true
## 默认值,一般不需要配置
pattern: &quot;/(.*)&quot;
mappings:
businessV2:
prefixSegmentCount: 1
path: &quot;/http/business/v2/.*&quot;
microserviceName: business
versionRule: 2.0.0
</code></pre>
<p>CommonHttpEdgeDispatcher 配置项的含义和 URLMappedEdgeDispatcher 类似。</p>
<ul>
<li>自定义 Dispatcher</li>
</ul>
<p>自定义Dispatcher包含两个步骤:</p>
<ol>
<li>实现AbstractEdgeDispatcher</li>
<li>通过SPI发布:增加文件META-INF/services/org.apache.servicecomb.transport.rest.vertx.VertxHttpDispatcher,并写入实现类</li>
</ol>
<p>详细的代码细节可以参考下面的章节"DEMO功能说明"。开发者也可以参考DefaultEdgeDispatcher等代码来定义自己的Dispatcher。</p>
<ul>
<li>进行认证鉴权和其他业务处理</li>
</ul>
<p>通过Edge Servie工作流程可以看出,可以通过多种方式来扩展Edge Service的功能,包括Dispatcher、HttpServerFilter、Handler、HttpClientFilter等。比较常用和简单的是通过Handler来扩展。DEMO里面展示了如何通过Handler扩展来实现鉴权。详细的代码细节可以参考下面的章节"DEMO功能说明"。</p>
<h2 id="_3">部署示例</h2>
<p><img alt="" src="../assets/deployment.png" /></p>
<h2 id="_4">工作模式</h2>
<ul>
<li>reactive (默认)</li>
</ul>
<p>Edge Service默认工作于高性能的reactive模式,此模式要求工作于Edge Service转发流程中的业务代码不能有任何的阻塞操作,包括不限于:</p>
<ul>
<li>
<p>远程同步调用,比如同步查询数据库、同步调用微服务,或是同步查询远程缓存等等</p>
</li>
<li>
<p>任何的sleep调用</p>
</li>
<li>
<p>任何的wait调用</p>
</li>
<li>
<p>超大的循环</p>
</li>
</ul>
<p>Edge Service的底层是基于netty的vertx,以上约束即是netty的reactive模式约束。</p>
<p><img alt="" src="../assets/reactive.png" /></p>
<ul>
<li>线程池</li>
</ul>
<p>如果业务模型无法满足reactive要求,则需要使用线程池模式。</p>
<p>此时需要在Edge Service的microservice.yaml中配置:</p>
<pre><code>servicecomb:
executors:
default: servicecomb.executor.groupThreadPool
</code></pre>
<p>这里的servicecomb.executor.groupThreadPool是ServiceComb内置的默认线程池对应的spring bean的beanId;业务可以定制自己的线程池,并声明为一个bean,其beanId也可以配置到这里。</p>
<p><img alt="" src="../assets/threadPool.png" /></p>
<h2 id="demo">DEMO功能说明</h2>
<p>DEMO 源码请参考 <a href="https://github.com/apache/servicecomb-java-chassis/tree/master/demo/demo-edge">edge service demo</a></p>
<ul>
<li>注册Dispatcher</li>
</ul>
<p>实现接口org.apache.servicecomb.transport.rest.vertx.VertxHttpDispatcher,或从
org.apache.servicecomb.edge.core.AbstractEdgeDispatcher继承,实现自己的dispatcher功能。</p>
<p>实现类通过java标准的SPI机制注册到系统中去。</p>
<p>Dispatcher需要实现2个方法:</p>
<ul>
<li>getOrder</li>
</ul>
<p>Dispatcher需要向vertx注入路由规则,路由规则之间是有优先级顺序关系的。</p>
<p>系统中所有的Dispatcher按照getOrder的返回值按从小到大的方式排序,按顺序初始化。</p>
<p>如果2个Dispatcher的getOrder返回值相同,则2者的顺序不可预知。</p>
<ul>
<li>init</li>
</ul>
<p>init方法入参为vertx框架中的io.vertx.ext.web.Router,需要通过该对象实现路由规则的定制。</p>
<p>可以指定满足要求的url,是否需要处理cookie、是否需要处理body、使用哪个自定义方法处理收到的请求等等</p>
<p>更多路由规则细节请参考vertx官方文档:<a href="http://vertx.io/docs/vertx-web/java/#_routing_by_exact_path">vertx路由机制</a></p>
<p><em>提示:</em></p>
<p><em>多个Dispatcher可以设置路由规则,覆盖到相同的url。</em></p>
<p><em>假设Dispatcher A和B都可以处理同一个url,并且A优先级更高,则:</em></p>
<ul>
<li>
<p><em>如果A处理完,既没应答,也没有调用RoutingContext.next(),则属于bug,本次请求挂死了</em></p>
</li>
<li>
<p><em>如果A处理完,然后调用了RoutingContext.next(),则会将请求转移给B处理</em></p>
</li>
<li>
<p>转发请求</p>
</li>
</ul>
<p>注册路由时,指定了使用哪个方法来处理请求(下面使用onRequest来指代该方法),在onRequest中实现转发逻辑。</p>
<p>方法原型为:</p>
<pre><code>void onRequest(RoutingContext context)
</code></pre>
<p>系统封装了org.apache.servicecomb.edge.core.EdgeInvocation来实现转发功能,至少需要准备以下参数:</p>
<ul>
<li>
<p>microserviceName,业务自行制定规则,可以在url传入,或是根据url查找等等</p>
</li>
<li>
<p>context,即onRequest的入参</p>
</li>
<li>
<p>path,转发目标的url</p>
</li>
<li>
<p>httpServerFilters,Dispatcher父类已经初始化好的成员变量</p>
</li>
</ul>
<pre><code> EdgeInvocation edgeInvocation = new EdgeInvocation();
edgeInvocation.init(microserviceName, context, path, httpServerFilters);
edgeInvocation.edgeInvoke();
</code></pre>
<p>edgeInvoke调用内部,会作为ServiceComb标准consumer去转发调用。</p>
<p>作为标准consumer,意味着ServiceComb所有标准的治理能力在这里都是生效的。</p>
<ul>
<li>设置兼容规则</li>
</ul>
<p>不同的业务可能有不同的兼容规划,servicecomb默认的兼容规则,要求所有新版本兼容旧版本。如果满足这个要求,则不必做任何特殊的设置。</p>
<p>还有一种典型的规划:</p>
<ul>
<li>
<p>1.0.0-2.0.0内部兼容,url为/microserviceName/v1/….的形式</p>
</li>
<li>
<p>2.0.0-3.0.0内部兼容,url为/microserviceName/v2/….的形式</p>
</li>
</ul>
<p>……</p>
<p>各大版本之间不兼容</p>
<p>此时,开发人员需要针对EdgeInvocation设置兼容规则:</p>
<pre><code>private CompatiblePathVersionMapper versionMapper = new CompatiblePathVersionMapper();
……
edgeInvocation.setVersionRule(versionMapper.getOrCreate(pathVersion).getVersionRule());
</code></pre>
<p>versionMapper的作用是将v1或是v2这样的串,转为1.0.0-2.0.0或2.0.0-3.0.0这样的兼容规则。</p>
<ul>
<li>鉴权</li>
</ul>
<p>Edge Service是系统的边界,对于很多请求需要执行鉴权逻辑。</p>
<p>基于标准的ServiceComb机制,可以通过handler来实现这个功能。</p>
<p>最简单的示意代码如下:</p>
<pre><code>public class AuthHandler implements Handler {
private static Logger LOGGER = LoggerFactory.getLogger(AuthHandler.class);
private static Auth auth;
static {
auth = Invoker.createProxy(&quot;auth&quot;, &quot;auth&quot;, Auth.class);
}
@Override
public void init(MicroserviceMeta microserviceMeta, InvocationType invocationType) {
}
@Override
public void handle(Invocation invocation, AsyncResponse asyncResp) throws Exception {
if (invocation.getHandlerContext().get(EdgeConst.ENCRYPT_CONTEXT) != null) {
invocation.next(asyncResp);
return;
}
auth.auth(&quot;&quot;).whenComplete((succ, e) -&gt; doHandle(invocation, asyncResp, succ, e));
}
</code></pre>
<p>Auth表示是鉴权微服务提供的接口,Invoker.createProxy("auth", "auth", Auth.class)是透明RPC开发模式中consumer的底层api,与@ReferenceRpc是等效,只不过不需要依赖spring bean机制。</p>
<p>Auth接口完全由业务定义,这里只是一个示例。</p>
<p>Handler开发完成后,配置到edge service的microservice.yaml中:</p>
<pre><code>servicecomb:
handler:
chain:
Consumer:
default: auth,……
service:
auth: ……
</code></pre>
<p>这个例子,表示转发请求给所有的微服务都必须经过鉴权,但是调用鉴权微服务时不需要鉴权。</p>
<p><strong><em>特别注意:</em></strong> edge service 的定制逻辑,包括 Dispatcher, Handler, HttpServerFilter 等,均在
事件派发线程 event-loop 中执行, 任何定制逻辑必须不能够存在阻塞逻辑,否则会导致 edge service 出现死锁。
比如上面鉴权的逻辑,必须使用异步接口,而不能够参考 provider 开发的逻辑那样,使用同步接口。 建议业务使用
定制逻辑的时候,对 edge service 进行并发测试,死锁问题会在并发数大于 event-loop 线程数量的情况下出现。
(event-loop线程数量默认是CPU核数的两倍, 可以通过 jstack 命令查看线程。)</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>