blob: b022fa24a96070b3235aa344d2e45204e267f13d [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="shutdown.html">
<link rel="next" href="multienvironment.html">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.19">
<title>异常处理 - Java Chassis 3 开发指南</title>
<link rel="stylesheet" href="../assets/stylesheets/main.66ac8b77.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#_1" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../index.html" title="Java Chassis 3 开发指南" class="md-header__button md-logo" aria-label="Java Chassis 3 开发指南" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Java Chassis 3 开发指南
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
异常处理
</span>
</div>
</div>
</div>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../index.html" title="Java Chassis 3 开发指南" class="md-nav__button md-logo" aria-label="Java Chassis 3 开发指南" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
Java Chassis 3 开发指南
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../index.html" class="md-nav__link">
<span class="md-ellipsis">
概述
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../start/design.html" class="md-nav__link">
<span class="md-ellipsis">
Java Chassis设计参考
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../introduce3.x.x.html" class="md-nav__link">
<span class="md-ellipsis">
Java Chassis 3版本介绍
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
快速入门
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
快速入门
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../start/development-environment.html" class="md-nav__link">
<span class="md-ellipsis">
安装本地开发环境
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../start/first-sample.html" class="md-nav__link">
<span class="md-ellipsis">
开发第一个微服务应用
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../featured-topics/application-bmi.html" class="md-nav__link">
<span class="md-ellipsis">
BMI应用-使用服务治理
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../featured-topics/application-porter.html" class="md-nav__link">
<span class="md-ellipsis">
PORTER应用-典型开发场景
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../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--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" checked>
<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="true">
<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="metrics.html" class="md-nav__link">
<span class="md-ellipsis">
应用性能监控
</span>
</a>
</li>
<li class="md-nav__item">
<a href="microservice-invocation-chain.html" class="md-nav__link">
<span class="md-ellipsis">
微服务调用链
</span>
</a>
</li>
<li class="md-nav__item">
<a href="customized-tracing.html" class="md-nav__link">
<span class="md-ellipsis">
自定义调用链打点
</span>
</a>
</li>
<li class="md-nav__item">
<a href="local-develop-test.html" class="md-nav__link">
<span class="md-ellipsis">
本地开发和测试
</span>
</a>
</li>
<li class="md-nav__item">
<a href="upload-download.html" class="md-nav__link">
<span class="md-ellipsis">
文件上传下载
</span>
</a>
</li>
<li class="md-nav__item">
<a href="reactive.html" class="md-nav__link">
<span class="md-ellipsis">
Reactive
</span>
</a>
</li>
<li class="md-nav__item">
<a href="dnsconfig.html" class="md-nav__link">
<span class="md-ellipsis">
DNS自定义配置
</span>
</a>
</li>
<li class="md-nav__item">
<a href="proxy.html" class="md-nav__link">
<span class="md-ellipsis">
代理设置
</span>
</a>
</li>
<li class="md-nav__item">
<a href="report-framework-version.html" class="md-nav__link">
<span class="md-ellipsis">
框架上报版本号
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cross-app-invocation.html" class="md-nav__link">
<span class="md-ellipsis">
跨应用调用
</span>
</a>
</li>
<li class="md-nav__item">
<a href="secret-field.html" class="md-nav__link">
<span class="md-ellipsis">
定制序列化和反序列化方法
</span>
</a>
</li>
<li class="md-nav__item">
<a href="context.html" class="md-nav__link">
<span class="md-ellipsis">
使用Context传递控制消息
</span>
</a>
</li>
<li class="md-nav__item">
<a href="produceprocess.html" class="md-nav__link">
<span class="md-ellipsis">
返回值序列化扩展
</span>
</a>
</li>
<li class="md-nav__item">
<a href="CORS.html" class="md-nav__link">
<span class="md-ellipsis">
跨域资源共享(CORS)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="AlarmEvent.html" class="md-nav__link">
<span class="md-ellipsis">
获取熔断与实例隔离告警事件信息
</span>
</a>
</li>
<li class="md-nav__item">
<a href="shutdown.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">
异常处理
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="error-handling.html" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
异常处理
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#_2" class="md-nav__link">
<span class="md-ellipsis">
异常分类及客户端如何判断异常类型
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#_3" class="md-nav__link">
<span class="md-ellipsis">
异常拦截器
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="multienvironment.html" class="md-nav__link">
<span class="md-ellipsis">
微服务实例间多环境隔离
</span>
</a>
</li>
<li class="md-nav__item">
<a href="thread-model.html" class="md-nav__link">
<span class="md-ellipsis">
线程模型
</span>
</a>
</li>
<li class="md-nav__item">
<a href="config-logs.html" class="md-nav__link">
<span class="md-ellipsis">
配置日志
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" >
<label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="0">
<span class="md-ellipsis">
多样化的通信协议功能
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_11">
<span class="md-nav__icon md-icon"></span>
多样化的通信协议功能
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../transports/introduction.html" class="md-nav__link">
<span class="md-ellipsis">
多协议介绍
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../transports/rest-over-vertx.html" class="md-nav__link">
<span class="md-ellipsis">
REST over HTTP(Vert.x)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../transports/http2.html" class="md-nav__link">
<span class="md-ellipsis">
REST over HTTP2(Vert.x)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../transports/rest-over-servlet-embedded.html" class="md-nav__link">
<span class="md-ellipsis">
REST over Servlet(Spring Boot Embedded)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../transports/rest-over-servlet.html" class="md-nav__link">
<span class="md-ellipsis">
REST over Servlet(WAR)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../transports/highway-rpc.html" class="md-nav__link">
<span class="md-ellipsis">
Highway
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_12" >
<label class="md-nav__link" for="__nav_12" id="__nav_12_label" tabindex="0">
<span class="md-ellipsis">
多样化的服务注册与发现功能
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_12_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_12">
<span class="md-nav__icon md-icon"></span>
多样化的服务注册与发现功能
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../registry/introduction.html" class="md-nav__link">
<span class="md-ellipsis">
注册发现介绍
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../registry/service-center.html" class="md-nav__link">
<span class="md-ellipsis">
使用Service Center
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../registry/nacos.html" class="md-nav__link">
<span class="md-ellipsis">
使用Nacos
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../registry/zookeeper.html" class="md-nav__link">
<span class="md-ellipsis">
使用ZooKeeper
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../registry/local-registry.html" class="md-nav__link">
<span class="md-ellipsis">
本地注册发现
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../registry/distributed.html" class="md-nav__link">
<span class="md-ellipsis">
去中心化注册发现
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_13" >
<label class="md-nav__link" for="__nav_13" id="__nav_13_label" tabindex="0">
<span class="md-ellipsis">
多样化的配置管理功能
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_13_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_13">
<span class="md-nav__icon md-icon"></span>
多样化的配置管理功能
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../config/general-config.html" class="md-nav__link">
<span class="md-ellipsis">
服务配置介绍
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../config/read-config.html" class="md-nav__link">
<span class="md-ellipsis">
在程序中读取配置信息
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../config/kie.html" class="md-nav__link">
<span class="md-ellipsis">
使用Kie
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../config/nacos.html" class="md-nav__link">
<span class="md-ellipsis">
使用Nacos
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../config/zookeeper.html" class="md-nav__link">
<span class="md-ellipsis">
使用Zookeeper
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../config/apollo.html" class="md-nav__link">
<span class="md-ellipsis">
使用Apollo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../config/cse1.html" class="md-nav__link">
<span class="md-ellipsis">
使用CSE1.0配置中心
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_14" >
<label class="md-nav__link" for="__nav_14" id="__nav_14_label" tabindex="0">
<span class="md-ellipsis">
服务治理功能参考
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_14_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_14">
<span class="md-nav__icon md-icon"></span>
服务治理功能参考
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../references-handlers/rule-governance.html" class="md-nav__link">
<span class="md-ellipsis">
流量特征治理
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../references-handlers/governance-best-practise.html" class="md-nav__link">
<span class="md-ellipsis">
流量特征治理最佳实践
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../references-handlers/loadbalance.html" class="md-nav__link">
<span class="md-ellipsis">
负载均衡
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../references-handlers/ratelimit.html" class="md-nav__link">
<span class="md-ellipsis">
限流
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../references-handlers/router.html" class="md-nav__link">
<span class="md-ellipsis">
灰度发布
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../references-handlers/fault-injection.html" class="md-nav__link">
<span class="md-ellipsis">
故障注入
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../references-handlers/fail-retry.html" class="md-nav__link">
<span class="md-ellipsis">
快速失败和重试
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_15" >
<label class="md-nav__link" for="__nav_15" id="__nav_15_label" tabindex="0">
<span class="md-ellipsis">
网关功能参考
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_15_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_15">
<span class="md-nav__icon md-icon"></span>
网关功能参考
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../edge/open-service.html" class="md-nav__link">
<span class="md-ellipsis">
介绍
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../edge/by-servicecomb-sdk.html" class="md-nav__link">
<span class="md-ellipsis">
使用 Edge Service 做网关
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../edge/zuul.html" class="md-nav__link">
<span class="md-ellipsis">
使用 `zuul` 和 `spring cloud gateway` 做网关
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../edge/nginx.html" class="md-nav__link">
<span class="md-ellipsis">
nginx 网关简单介绍
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_16" >
<label class="md-nav__link" for="__nav_16" id="__nav_16_label" tabindex="0">
<span class="md-ellipsis">
安全特性参考
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_16_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_16">
<span class="md-nav__icon md-icon"></span>
安全特性参考
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../references-handlers/publickey.html" class="md-nav__link">
<span class="md-ellipsis">
公钥认证
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../security/tls.html" class="md-nav__link">
<span class="md-ellipsis">
使用TLS通信
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../security/shi-yong-rsa-ren-zheng.html" class="md-nav__link">
<span class="md-ellipsis">
使用RSA认证
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_17" >
<label class="md-nav__link" for="__nav_17" id="__nav_17_label" tabindex="0">
<span class="md-ellipsis">
专题文章
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_17_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_17">
<span class="md-nav__icon md-icon"></span>
专题文章
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../featured-topics/features.html" class="md-nav__link">
<span class="md-ellipsis">
特性介绍
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../featured-topics/secrets.html" class="md-nav__link">
<span class="md-ellipsis">
技术解密
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../featured-topics/upgrading.html" class="md-nav__link">
<span class="md-ellipsis">
升级指导
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../featured-topics/compatibility.html" class="md-nav__link">
<span class="md-ellipsis">
兼容问题和兼容性策略
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../featured-topics/performance.html" class="md-nav__link">
<span class="md-ellipsis">
性能问题分析和调优
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_18" >
<label class="md-nav__link" for="__nav_18" id="__nav_18_label" tabindex="0">
<span class="md-ellipsis">
常用配置项参考
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_18_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_18">
<span class="md-nav__icon md-icon"></span>
常用配置项参考
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../config-reference/rest-transport-client.html" class="md-nav__link">
<span class="md-ellipsis">
REST Transport Client 配置项
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_19" >
<label class="md-nav__link" for="__nav_19" id="__nav_19_label" tabindex="0">
<span class="md-ellipsis">
常见问题
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_19_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_19">
<span class="md-nav__icon md-icon"></span>
常见问题
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../question-and-answer/faq.html" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../question-and-answer/question_answer.html" class="md-nav__link">
<span class="md-ellipsis">
Q & A
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../question-and-answer/interface-compatibility.html" class="md-nav__link">
<span class="md-ellipsis">
微服务接口兼容常见问题
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#_2" class="md-nav__link">
<span class="md-ellipsis">
异常分类及客户端如何判断异常类型
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#_3" class="md-nav__link">
<span class="md-ellipsis">
异常拦截器
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="_1">异常处理</h1>
<h2 id="_2">异常分类及客户端如何判断异常类型</h2>
<ul>
<li>业务异常:这类异常由业务接口定义。用户在获取到服务swagger定义的时候,就能够从定义中看到这类异常对
应的错误码,以及返回值类型。 下面的例子展现了业务定义异常。<pre><code>@Path("/errorCode")
@POST
@ApiResponses({
@ApiResponse(code = 200, response = MultiResponse200.class, message = ""),
@ApiResponse(code = 400, response = MultiResponse400.class, message = ""),
@ApiResponse(code = 500, response = MultiResponse500.class, message = "")})
public MultiResponse200 errorCode(MultiRequest request) {
if (request.getCode() == 400) {
MultiResponse400 r = new MultiResponse400();
r.setCode(400);
r.setMessage("bad request");
throw new InvocationException(javax.ws.rs.core.Response.Status.BAD_REQUEST, r);
} else if (request.getCode() == 500) {
MultiResponse500 r = new MultiResponse500();
r.setCode(500);
r.setMessage("internal error");
throw new InvocationException(javax.ws.rs.core.Response.Status.INTERNAL_SERVER_ERROR, r);
} else {
MultiResponse200 r = new MultiResponse200();
r.setCode(200);
r.setMessage("success result");
return r;
}
}
</code></pre>
</li>
</ul>
<p><strong><em>注意</em></strong>: 对于 2xx 错误码,可以返回具体的业务 model, 对于其他的错误码,
必须抛出 InvocationException。 </p>
<p>客户端代码可以按照如下方式处理异常。异常的类型是确定的,可以通过cast获取到异常类型。</p>
<pre><code> MultiRequest request = new MultiRequest();
request.setCode(200);
ResponseEntity&lt;MultiResponse200&gt; result = template
.postForEntity(SERVER + "/MultiErrorCodeService/errorCode", request, MultiResponse200.class);
TestMgr.check(result.getStatusCode(), 200);
TestMgr.check(result.getBody().getMessage(), "success result");
request.setCode(400);
MultiResponse400 t400 = null;
try {
template.postForEntity(SERVER + "/MultiErrorCodeService/errorCode", request, MultiResponse400.class);
} catch (InvocationException e) {
t400 = (MultiResponse400) e.getErrorData();
}
TestMgr.check(t400.getCode(), 400);
TestMgr.check(t400.getMessage(), "bad request");
request.setCode(500);
MultiResponse500 t500 = null;
try {
template.postForEntity(SERVER + "/MultiErrorCodeService/errorCode", request, MultiResponse400.class);
} catch (InvocationException e) {
t500 = (MultiResponse500) e.getErrorData();
}
TestMgr.check(t500.getCode(), 500);
TestMgr.check(t500.getMessage(), "internal error");
</code></pre>
<ul>
<li>控制异常:这类异常通常是框架处理流程上的异常。比如流控Handler抛出TOO_MANY_REQUESTS_STATUS异常。<pre><code>public class ConsumerQpsFlowControlHandler implements Handler {
... ...
if (qpsController.isLimitNewRequest()) {
// return http status 429
CommonExceptionData errorData = new CommonExceptionData("rejected by qps flowcontrol");
asyncResp.consumerFail(
new InvocationException(QpsConst.TOO_MANY_REQUESTS_STATUS, errorData));
return;
}
invocation.next(asyncResp);
}
}
</code></pre>
</li>
</ul>
<p>控制异常在接口定义里面没有声明。客户端在做异常处理的时候,不知道异常类型。可以采用弱类型的方式处理异常:</p>
<pre><code> JsonObject requestJson = new JsonObject();
requestJson.put("code", 400);
requestJson.put("message", "test message");
try {
template
.postForEntity(SERVER + "/MultiErrorCodeService/noClientErrorCode", requestJson, Object.class);
} catch (InvocationException e) {
TestMgr.check(e.getStatusCode(), 400);
mapResult = RestObjectMapperFactory.getRestObjectMapper().convertValue(e.getErrorData(), Map.class);
TestMgr.check(mapResult.get("message"), "test message");
TestMgr.check(mapResult.get("code"), 400);
TestMgr.check(mapResult.get("t400"), 400);
}
</code></pre>
<p>上面的代码假设不知道异常类型,通过API将异常类型转换为Map类型,然后从Map里面读取异常类型。
ServiceComb自己抛出的异常类型中,一般控制异常的类型也是固定的,为CommonExceptionData。</p>
<ul>
<li>未知异常:这类异常发生的情况不确定。比如业务代码实现的时候,抛出NullPointerException等未捕获异常、底层
的网络连接超时异常等。这类异常会由ServiceComb封装成590或者490错误返回。比如:<pre><code>CommonExceptionData errorData = new CommonExceptionData(cause.getMessage());
asyncResp.producerFail(new InvocationException(590, errorData)
</code></pre>
</li>
</ul>
<p>或者</p>
<pre><code> asyncResp.consumerFail(new InvocationException(490, errorData)
</code></pre>
<p>未知异常消息的类型固定为CommonExceptionData类型。</p>
<h2 id="_3">异常拦截器</h2>
<p>有时候,业务需要将所有的未知异常、控制异常进行捕获,转换为对用户友好的消息。或者对控制异常进行捕获,将
消息体转换为自定义的JSON格式。这里面有几个参考点。</p>
<ul>
<li>
<p>通过 <code>ExceptionToProducerResponseConverter</code> 拦截异常</p>
<p><code>ExceptionToProducerResponseConverter</code>能够拦截业务异常以及业务实现里面抛出的未知异常。但是不能拦截
Handler,HttpServerFilter 等抛出的异常。更加确切的是 <code>ProducerOperationHandler</code> 捕获的异常都会被
<code>ExceptionToProducerResponseConverter</code> 处理。 <code>ExceptionToProducerResponseConverter</code> 包含如下
几个接口:</p>
<ul>
<li><code>getExceptionClass()</code> 实现类所处理的异常类型。如果该方法返回<code>null</code>,则说明此实现类为默认converter。</li>
<li><code>Response convert(SwaggerInvocation swaggerInvocation, T e)</code> 处理异常逻辑,该方法返回的<code>Response</code>决定了ServiceComb将会返回何种状态码、何种response body的应答。</li>
<li><code>getOrder()</code> 实现类的优先级,该方法返回的值越小,优先级越高,如果不覆写该方法的话,则返回默认优先级<code>0</code>。对于处理同一异常类型的converter(或默认converter),只有优先级最高的生效。</li>
</ul>
</li>
</ul>
<p>在为异常选择converter时,会从异常本身的类型开始匹配,如果找不到对应的converter则逐级向上查找父类型的converter。当匹配到<code>Throwable</code>仍未找到converter时,将使用默认converter处理异常。</p>
<pre><code> public class CustomExceptionToProducerResponseConverter implements ExceptionToProducerResponseConverter&lt;IllegalStateException&gt; {
@Override
public Class&lt;IllegalStateException&gt; getExceptionClass() {
// 返回IllegalStateException表示该converter处理IllegalStateException类型的异常
return IllegalStateException.class;
}
@Override
public int getOrder() {
// 返回的order值越小,优先级越高
return 100;
}
@Override
public Response convert(SwaggerInvocation swaggerInvocation, IllegalStateException e) {
// 这里是处理异常的逻辑
IllegalStateErrorData data = new IllegalStateErrorData();
data.setId(500);
data.setMessage(e.getMessage());
data.setState(e.getMessage());
InvocationException state = new InvocationException(Status.INTERNAL_SERVER_ERROR, data);
return Response.failResp(state);
}
}
</code></pre>
<p><strong><em>说明</em></strong> : 2.0.2 之前的版本部分业务异常无法通过 ExceptionToProducerResponseConverter 捕获,
系统做了自动处理,不经过 ExceptionToProducerResponseConverter。 2.0.2 版本规范化了处理流程。 </p>
<ul>
<li>控制消息消息体序列化</li>
</ul>
<p>控制消息消息体序列化的目的是简化消费者的异常处理逻辑,不用使用弱类型,而是使用确切类型。可以采用注册全局的错误码类型。
业务需要通过SPI实现org.apache.servicecomb.swagger.invocation.response.ResponseMetaMapper接口。
接口的核心内容是为每个错误码指定序列化类型:</p>
<pre><code> private final static Map&lt;Integer, ResponseMeta&gt; CODES = new HashMap&lt;&gt;(1);
static {
ResponseMeta meta = new ResponseMeta();
meta.setJavaType(SimpleType.constructUnsafe(IllegalStateErrorData.class));
CODES.put(500, meta);
}
@Override
public Map&lt;Integer, ResponseMeta&gt; getMapper() {
return CODES;
}
</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>