我基於Spring-Cloud-Gateway做響應式的API網關開發工作也有1年多的時間了，做了很多擴展性的工作， 可以說對Spring-Cloud-Gateway的設計思想和源碼細節有不錯的瞭解了，但是我個人其實不太喜歡Spring-Cloud-Gateway， 或者說是因爲不太喜歡Spring-Boot和Spring-Framework，因爲我覺的它太重了，誠然，它很好用（寫業務），提供了很多開箱即用的功能， 可以很大的提高業務團隊寫業務的效率，但是一想到它往我的內存裏塞了那麼多我可能根本就不需要的東西， 構建出來的包那麼大，啓動的那麼慢，我就有點不舒服。另外，我個人喜歡對代碼的執行有更好的掌控感，能不用框架解決的問題就不用框架。 所以，最終，我決定吸收Spring-Cloud-Gateway的部分思想自己寫一個響應式API網關。 目的倒不是做一個多麼成功的項目，主要是做一個筆記，和自己所學的沉澱。
API網關類型的項目，確實是適合用響應式的庫來開發，這個可以看Spring-Cloud-Gateway和Spring-WebFlux的文檔上相關的說明。 Spring-Cloud-Gateway其實就是建立在Spring自己推出的響應式Web框架Spring-WebFlux之上， 而Spring-WebFlux底層的Http服務實現是一個叫reactor-netty, 這個項目其實也是Spring的團隊出的，它其實就是結合了2個項目[netty]和[project-reactor]，前者是衆所周知的高性能網絡庫， 後者是Spring推出的響應式庫，二者結合起來，就是“高性能的響應式網絡庫”。
flowchart TD id1[Spring-Cloud-Gateway] id2[Spring-Boot] id3[Spring-WebFlux] id4[reactor-netty] id5[netty] id6[project-reactor] id7[reactive-streams] style id5 fill:#f9f,stroke:#333,stroke-width:2px style id7 fill:#f9f,stroke:#333,stroke-width:2px id1 --> id2 id1 --> id3 id3 --> id4 id4 --> id5 id4 --> id6 id6 --> id7
flowchart TD id[reactor-gateway] id4[reactor-netty] id5[netty] id6[project-reactor] id7[reactive-streams] style id5 fill:#f9f,stroke:#333,stroke-width:2px style id7 fill:#f9f,stroke:#333,stroke-width:2px style id fill:#7CCD7C,stroke:#333,stroke-width:2px id --> id4 id4 --> id5 id4 --> id6 id6 --> id7
Talk is cheap, show me the code!
Talk is cheap, show me the code!
一個開源協議文件，開源協議用Apache License V2
mkdir reactor-gateway cd reactor-gateway git init touch .gitignore touch README.md touch LICENSE
# IDEA ignore .idea *.iml *.ipr *.iws # vs code ingore .vscode *.suo *.njsproj **/bin/main/ # vim ingore *.swp *.swo # eclipse ingore .project .settings .classpath # Mac OS ingore .DS_Store # gradle project ingore .gradle build qa/format/java-format.xml qa/format/java.importorder
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
git add . git commit -m '初始化空項目'
此係列博文後面還會出現很多貼大段代碼的地方，會比較影響閱讀體驗，網頁要是能摺疊代碼就看起來體驗會好點。其實這是我特意如此的，因爲我想讀者自己跟着動手，而不是隻動眼。我自己的想法是做一個“菜單”，而不是直接端出一盤做好的菜。“菜單”是一個可以重複的過程，而不是單單隻有結果。好比你去看kafka的源碼，直接丟給你幾十萬行的代碼，你根本把握不住它的核心思想，但是如果kafka的作者，把他從0到1做kafka的過程展示給你，你肯定把kafka學的更好。如果你想要看githug的代碼，也是有的，感興趣可以瞅瞅：https://github.com/tmzk1005/reactor-gateway， https://github.com/tmzk1005/fornax， 後者是插件化比較弱的版本，前者是正在弄的插件化的重構版，還處於比較初始的階段，不過，不妨礙理解設計思想。