| |
| <!DOCTYPE HTML> |
| <html lang="" > |
| <head> |
| <meta charset="UTF-8"> |
| <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> |
| <title>10 编码约定 · GitBook</title> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge" /> |
| <meta name="description" content=""> |
| <meta name="generator" content="GitBook 3.2.2"> |
| |
| |
| |
| |
| <link rel="stylesheet" href="gitbook/style.css"> |
| |
| |
| |
| |
| <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css"> |
| |
| |
| |
| <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css"> |
| |
| |
| |
| <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <meta name="HandheldFriendly" content="true"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> |
| <meta name="apple-mobile-web-app-capable" content="yes"> |
| <meta name="apple-mobile-web-app-status-bar-style" content="black"> |
| <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png"> |
| <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon"> |
| |
| |
| <link rel="next" href="检查列表.html" /> |
| |
| |
| <link rel="prev" href="坏味道.html" /> |
| |
| |
| </head> |
| <body> |
| |
| <div class="book"> |
| <div class="book-summary"> |
| |
| |
| <div id="book-search-input" role="search"> |
| <input type="text" placeholder="Type to search" /> |
| </div> |
| |
| |
| <nav role="navigation"> |
| |
| |
| |
| <ul class="summary"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="chapter " data-level="1.1" data-path="./"> |
| |
| <a href="./"> |
| |
| |
| Introduction |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.2" data-path="contribution.html"> |
| |
| <a href="contribution.html"> |
| |
| |
| 1 contribution |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.3" data-path="版本管理.html"> |
| |
| <a href="版本管理.html"> |
| |
| |
| 2 版本管理 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.4" data-path="源码构建.html"> |
| |
| <a href="源码构建.html"> |
| |
| |
| 3 源码构建 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.5" data-path="框架设计.html"> |
| |
| <a href="框架设计.html"> |
| |
| |
| 4 框架设计 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.6" data-path="扩展点加载.html"> |
| |
| <a href="扩展点加载.html"> |
| |
| |
| 5 扩展点加载 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7" data-path="SPI参考手册/introduction.html"> |
| |
| <a href="SPI参考手册/introduction.html"> |
| |
| |
| 6 SPI参考手册 |
| |
| </a> |
| |
| |
| |
| <ul class="articles"> |
| |
| |
| <li class="chapter " data-level="1.7.1" data-path="SPI参考手册/协议扩展.html"> |
| |
| <a href="SPI参考手册/协议扩展.html"> |
| |
| |
| 6.1 协议扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.2" data-path="SPI参考手册/调用拦截扩展.html"> |
| |
| <a href="SPI参考手册/调用拦截扩展.html"> |
| |
| |
| 6.2 调用拦截扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.3" data-path="SPI参考手册/引用监听扩展.html"> |
| |
| <a href="SPI参考手册/引用监听扩展.html"> |
| |
| |
| 6.3 引用监听扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.4" data-path="SPI参考手册/暴露监听扩展.html"> |
| |
| <a href="SPI参考手册/暴露监听扩展.html"> |
| |
| |
| 6.4 暴露监听扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.5" data-path="SPI参考手册/集群扩展.html"> |
| |
| <a href="SPI参考手册/集群扩展.html"> |
| |
| |
| 6.5 集群扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.6" data-path="SPI参考手册/路由扩展.html"> |
| |
| <a href="SPI参考手册/路由扩展.html"> |
| |
| |
| 6.6 路由扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.7" data-path="SPI参考手册/负载均衡扩展.html"> |
| |
| <a href="SPI参考手册/负载均衡扩展.html"> |
| |
| |
| 6.7 负载均衡扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.8" data-path="SPI参考手册/合并结果扩展.html"> |
| |
| <a href="SPI参考手册/合并结果扩展.html"> |
| |
| |
| 6.8 合并结果扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.9" data-path="SPI参考手册/注册中心扩展.html"> |
| |
| <a href="SPI参考手册/注册中心扩展.html"> |
| |
| |
| 6.9 注册中心扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.10" data-path="SPI参考手册/监控中心扩展.html"> |
| |
| <a href="SPI参考手册/监控中心扩展.html"> |
| |
| |
| 6.10 监控中心扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.11" data-path="SPI参考手册/扩展点加载扩展.html"> |
| |
| <a href="SPI参考手册/扩展点加载扩展.html"> |
| |
| |
| 6.11 扩展点加载扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.12" data-path="SPI参考手册/动态代理扩展.html"> |
| |
| <a href="SPI参考手册/动态代理扩展.html"> |
| |
| |
| 6.12 动态代理扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.13" data-path="SPI参考手册/编译器扩展.html"> |
| |
| <a href="SPI参考手册/编译器扩展.html"> |
| |
| |
| 6.13 编译器扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.14" data-path="SPI参考手册/消息派发扩展.html"> |
| |
| <a href="SPI参考手册/消息派发扩展.html"> |
| |
| |
| 6.14 消息派发扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.15" data-path="SPI参考手册/线程池扩展.html"> |
| |
| <a href="SPI参考手册/线程池扩展.html"> |
| |
| |
| 6.15 线程池扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.16" data-path="SPI参考手册/序列化扩展.html"> |
| |
| <a href="SPI参考手册/序列化扩展.html"> |
| |
| |
| 6.16 序列化扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.17" data-path="SPI参考手册/网络传输扩展.html"> |
| |
| <a href="SPI参考手册/网络传输扩展.html"> |
| |
| |
| 6.17 网络传输扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.18" data-path="SPI参考手册/信息交换扩展.html"> |
| |
| <a href="SPI参考手册/信息交换扩展.html"> |
| |
| |
| 6.18 信息交换扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.19" data-path="SPI参考手册/组网扩展.html"> |
| |
| <a href="SPI参考手册/组网扩展.html"> |
| |
| |
| 6.19 组网扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.20" data-path="SPI参考手册/Telnet命令扩展.html"> |
| |
| <a href="SPI参考手册/Telnet命令扩展.html"> |
| |
| |
| 6.20 Telnet命令扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.21" data-path="SPI参考手册/状态检查扩展.html"> |
| |
| <a href="SPI参考手册/状态检查扩展.html"> |
| |
| |
| 6.21 状态检查扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.22" data-path="SPI参考手册/容器扩展.html"> |
| |
| <a href="SPI参考手册/容器扩展.html"> |
| |
| |
| 6.22 容器扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.23" data-path="SPI参考手册/页面扩展.html"> |
| |
| <a href="SPI参考手册/页面扩展.html"> |
| |
| |
| 6.23 页面扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.24" data-path="SPI参考手册/缓存扩展.html"> |
| |
| <a href="SPI参考手册/缓存扩展.html"> |
| |
| |
| 6.24 缓存扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.25" data-path="SPI参考手册/验证扩展.html"> |
| |
| <a href="SPI参考手册/验证扩展.html"> |
| |
| |
| 6.25 验证扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7.26" data-path="SPI参考手册/日志适配扩展.html"> |
| |
| <a href="SPI参考手册/日志适配扩展.html"> |
| |
| |
| 6.26 日志适配扩展 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| |
| </ul> |
| |
| </li> |
| |
| <li class="chapter " data-level="1.8" data-path="技术兼容性测试.html"> |
| |
| <a href="技术兼容性测试.html"> |
| |
| |
| 7 技术兼容性测试 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.9" data-path="公共契约.html"> |
| |
| <a href="公共契约.html"> |
| |
| |
| 8 公共契约 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.10" data-path="坏味道.html"> |
| |
| <a href="坏味道.html"> |
| |
| |
| 9 坏味道 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter active" data-level="1.11" data-path="编码约定.html"> |
| |
| <a href="编码约定.html"> |
| |
| |
| 10 编码约定 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.12" data-path="检查列表.html"> |
| |
| <a href="检查列表.html"> |
| |
| |
| 11 检查列表 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.13" data-path="设计原则.html"> |
| |
| <a href="设计原则.html"> |
| |
| |
| 12 设计原则 |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| |
| |
| |
| <li class="divider"></li> |
| |
| <li> |
| <a href="https://www.gitbook.com" target="blank" class="gitbook-link"> |
| Published with GitBook |
| </a> |
| </li> |
| </ul> |
| |
| |
| </nav> |
| |
| |
| </div> |
| |
| <div class="book-body"> |
| |
| <div class="body-inner"> |
| |
| |
| |
| <div class="book-header" role="navigation"> |
| |
| |
| <!-- Title --> |
| <h1> |
| <i class="fa fa-circle-o-notch fa-spin"></i> |
| <a href="." >10 编码约定</a> |
| </h1> |
| </div> |
| |
| |
| |
| |
| <div class="page-wrapper" tabindex="-1" role="main"> |
| <div class="page-inner"> |
| |
| <div id="book-search-results"> |
| <div class="search-noresults"> |
| |
| <section class="normal markdown-section"> |
| |
| <p>Dubbo 的源代码和 JavaDoc 遵循以下的规范：</p> |
| <ul> |
| <li><a href="http://www.oracle.com/technetwork/java/codeconvtoc-136057.html" target="_blank">Code Conventions for the Java Programming Language</a></li> |
| <li><a href="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html" target="_blank">How to Write Doc Comments for the Javadoc Tool</a></li> |
| </ul> |
| <p>异常和日志：</p> |
| <ul> |
| <li>尽可能携带完整的上下文信息，比如出错原因，出错的机器地址，调用对方的地址，连的注册中心地址，使用Dubbo的版本等。</li> |
| <li>尽量将直接原因写在最前面，所有上下文信息，在原因后用键值对显示。</li> |
| <li>抛出异常的地方不用打印日志，由最终处理异常者决定打印日志的级别，吃掉异常必需打印日志。</li> |
| <li>打印ERROR日志表示需要报警，打印WARN日志表示可以自动恢复，打印INFO表示正常信息或完全不影响运行。</li> |
| <li>建议应用方在监控中心配置ERROR日志实时报警，WARN日志每周汇总发送通知。</li> |
| <li>RpcException是Dubbo对外的唯一异常类型，所有内部异常，如果要抛出给用户，必须转为RpcException。</li> |
| <li>RpcException不能有子类型，所有类型信息用ErrorCode标识，以便保持兼容。</li> |
| </ul> |
| <p>配置和URL：</p> |
| <ul> |
| <li>配置对象属性首字母小写，多个单词用驼峰命名(Java约定)。</li> |
| <li>配置属性全部用小写，多个单词用"-"号分隔(Spring约定)。</li> |
| <li>URL参数全部用小写，多个单词用"."号分隔(Dubbo约定)。</li> |
| <li>尽可能用URL传参，不要自定义Map或其它上下文格式，配置信息也转成URL格式使用。</li> |
| <li>尽量减少URL嵌套，保持URL的简洁性。</li> |
| </ul> |
| <p>单元和集成测试：</p> |
| <ul> |
| <li>单元测试统一用JUnit和EasyMock，集成测试用TestNG，数据库测试用DBUnit。</li> |
| <li>保持单元测试用例的运行速度，不要将性能和大的集成用例放在单元测试中。</li> |
| <li>保持单元测试的每个用例都用try...finally或tearDown释放资源。</li> |
| <li>减少while循环等待结果的测试用例，对定时器和网络的测试，用以将定时器中的逻辑抽为方法测试。</li> |
| <li>对于容错行为的测试，比如failsafe的测试，统一用LogUtil断言日志输出。</li> |
| </ul> |
| <p>扩展点基类与AOP：</p> |
| <ul> |
| <li>AOP类都命名为XxxWrapper，基类都命名为AbstractXxx。</li> |
| <li>扩展点之间的组合将关系由AOP完成，ExtensionLoader只负载加载扩展点，包括AOP扩展。</li> |
| <li>尽量采用IoC注入扩展点之间的依赖，不要直接依赖ExtensionLoader的工厂方法。</li> |
| <li>尽量采用AOP实现扩展点的通用行为，而不要用基类，比如负载均衡之前的isAvailable检查，它是独立于负载均衡之外的，不需要检查的是URL参数关闭。</li> |
| <li>对多种相似类型的抽象，用基类实现，比如RMI,Hessian等第三方协议都已生成了接口代理，只需将将接口代理转成Invoker即可完成桥接，它们可以用公共基类实现此逻辑。</li> |
| <li>基类也是SPI的一部分，每个扩展点都应该有方便使用的基类支持。</li> |
| </ul> |
| <p>模块与分包：</p> |
| <ul> |
| <li>基于复用度分包，总是一起使用的放在同一包下，将接口和基类分成独立模块，大的实现也使用独立模块。</li> |
| <li>所有接口都放在模块的根包下，基类放在support子包下，不同实现用放在以扩展点名字命名的子包下。</li> |
| <li>尽量保持子包依赖父包，而不要反向。</li> |
| </ul> |
| |
| |
| </section> |
| |
| </div> |
| <div class="search-results"> |
| <div class="has-results"> |
| |
| <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> |
| <ul class="search-results-list"></ul> |
| |
| </div> |
| <div class="no-results"> |
| |
| <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> |
| |
| </div> |
| </div> |
| </div> |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| |
| |
| <a href="坏味道.html" class="navigation navigation-prev " aria-label="Previous page: 9 坏味道"> |
| <i class="fa fa-angle-left"></i> |
| </a> |
| |
| |
| <a href="检查列表.html" class="navigation navigation-next " aria-label="Next page: 11 检查列表"> |
| <i class="fa fa-angle-right"></i> |
| </a> |
| |
| |
| |
| </div> |
| |
| <script> |
| var gitbook = gitbook || []; |
| gitbook.push(function() { |
| gitbook.page.hasChanged({"page":{"title":"10 编码约定","level":"1.11","depth":1,"next":{"title":"11 检查列表","level":"1.12","depth":1,"path":"检查列表.md","ref":"./检查列表.md","articles":[]},"previous":{"title":"9 坏味道","level":"1.10","depth":1,"path":"坏味道.md","ref":"./坏味道.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":[],"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"编码约定.md","mtime":"2017-08-02T06:13:38.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-08-02T07:44:46.950Z"},"basePath":".","book":{"language":""}}); |
| }); |
| </script> |
| </div> |
| |
| |
| <script src="gitbook/gitbook.js"></script> |
| <script src="gitbook/theme.js"></script> |
| |
| |
| <script src="gitbook/gitbook-plugin-search/search-engine.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-search/search.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script> |
| |
| |
| |
| </body> |
| </html> |
| |
