1 Star 1 Fork 2

HuiSir / koa-ts-micro-service-cli

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
Apache-2.0

koa-ts-micro-service-cli

Node 微服务轻量级脚手架

NodeJS在I/O密集型应用中所表现的突出能力使得越来越多的开发者青睐。如今越来越多的应用涉及到的都是I/O方面的业务,故而NodeJS在性能和学习成本方面展现了很大优势。在微服务架构的席卷下,甚至好多大型应用会采用“NodeJS+其他开发语言”这种多语言开发模式进行开发。所以“NodeJS微服务开发”是很有必要的。

框架选型

先前了解到node有一微服务框架名为seneca,于是尝试一番,由于其插件和本身的维护都比较旧,用法也很麻烦。最终由于其日志功能、数据库支持、与PM2的搭配、与redis的搭配等方面都不尽如人意,固放弃。

遂了解到有一款较为完善的微服务框架Moleculer,看了官方文档感觉很复杂,学习成本较高,于是想要按自己的理解写一个轻量级的较为简单的脚手架。

微服务的核心是:主服务和各个微服务之间的通信问题,涉及到发布订阅功能。在Moleculer框架指导下,了解到有很多插件能够解决,比如:TCPNATSRedisMQTTAMQPKafka等,通过查阅,TCP方案可以直接使用Node内置net模块的tcp功能进行封装,而Redis是在服务中必用的缓存模块,其自带的发布订阅功能的API也很简单。所以这两种方案都能用。Redis可以直接使用ioredis模块,无需封装。

了解到,如果使用redis方案的话,若所有微服务均在同一台服务器,那么只使用一个redis服务,那么不易实现多端口的微服务方案,且若在不同服务器的话,如果某个微服务没有使用redis缓存功能,那么只使用redis的发布订阅功能就显得很浪费。所以这里果断采用TCP方案,自己封装一个发布订阅模式。

主要依赖\技术栈

  • TypeScript:使用TS方便函数和参数的类型检测
  • Koa2:一种以AOP(面向切面编程)的web开发框架,主要思路为洋葱模型和中间件架构。这款框架自己较为熟悉,用于主服务。
  • tcp-micro-service:个人开发的一款用于微服务的TCP发布订阅通信工具,GIT地址
  • PM2:强大的Nodejs应用部署器(先前自己项目使用pkg模块进行打包后再进行部署,在linux下需要使用nohub命令,在win下需要生成nohub.vbs脚本进行执行,而在微服务框架下,打包多个应用后各自运行不便于集中管理,所以还是直接使用pm2)

架构

名称 技术模式/框架 说明
网关/负载均衡 Nginx 对前后端的沟通进行统一的管理
配置中心 service-config服务(内置) 所有服务的配置统一管理,各服务会定期pull各自相应的配置参数到缓存中(配置中心初步使用yaml文件进行配置,各服务也暂用yaml文件进行缓存,后期可更改为数据库和redis)
传输器 tcp-micro-service 多个微服务节点之间进行沟通,采用发布订阅模式
注册中心/中央消息转发器 service-register服务(内置) 对所有微服务配置进行管理,服务必须注册登记才能使用,主服务接口请求时候进行client,只在第一次请求时client
微服务 net/tcp 创建各种单一职责和接口分离模块(插件),各微服务可分布式部署到不同服务器

内置服务/功能

功能 服务/框架 端口
数据库 Mysql
数据模型/实体
缓存库 Redis(这里使用redis而不用其他库,因为redis便于后期管理)
日志 log4js,配合PM2插件输出到文件

配置文件

yaml配置文件阅读方便,支持多种类型(字符串、数值、布尔值、null、时间戳、数组),可注释,故而用途广泛,比json和ini等好太多。
Nodejs读写yaml需要用到yaml库。

import YAML from 'yaml'
// 读取
const file = fs.readFileSync('./config.yaml', 'utf8')
const yamlStr = YAML.parse(file)
console.log(yamlStr)
// 写入
const options = {a:1, b:2}
fs.writeFileSync('config.yaml', YAML.stringify(options))

启动

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.

About

nodejs 微服务轻量级脚手架 expand collapse
Apache-2.0
Cancel

Releases

No release

Contributors

All

Activities

Load More
can not load any more
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
NodeJS
1
https://gitee.com/huisir001/koa-ts-micro-service-cli.git
git@gitee.com:huisir001/koa-ts-micro-service-cli.git
huisir001
koa-ts-micro-service-cli
koa-ts-micro-service-cli
master

Search