https://github.com/vinks/nest-consul-loadbalance
A Nest framework (node.js) module for getting service from consul and sending http request by loadbalance.
https://github.com/vinks/nest-consul-loadbalance
Last synced: 21 days ago
JSON representation
A Nest framework (node.js) module for getting service from consul and sending http request by loadbalance.
- Host: GitHub
- URL: https://github.com/vinks/nest-consul-loadbalance
- Owner: vinks
- Created: 2019-01-25T12:27:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-11T08:56:07.000Z (over 7 years ago)
- Last Synced: 2025-02-28T11:51:50.673Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 73.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Description
A component of [nestcloud](http://github.com/nest-cloud/nestcloud). NestCloud is a nest framework micro-service solution.
[中文文档](https://nestcloud.org/solutions/fu-zai-jun-heng)
This is a software load balancers primary for rest calls.
## Installation
```bash
$ npm i --save nest-consul consul nest-consul-loadbalance
```
## Quick Start
#### Import Module
```typescript
import { Module } from '@nestjs/common';
import { ConsulModule } from 'nest-consul';
import { LoadbalanceModule } from 'nest-consul-loadbalance';
@Module({
imports: [
ConsulModule.register({
host: '127.0.0.1',
port: 8500
}),
LoadbalanceModule.register({
rules: [
{service: 'test-service', ruleCls: 'RandomRule'},
{service: 'user-service', ruleCls: '../rules/CustomRule'}
]
})
],
})
export class ApplicationModule {}
```
If you use [nest-boot](https://github.com/miaowing/nest-boot) module.
```typescript
import { Module } from '@nestjs/common';
import { ConsulModule, CONSUL_ADAPTER } from 'nest-consul';
import { LoadbalanceModule } from 'nest-consul-loadbalance';
import { BootModule, BOOT_ADAPTER } from 'nest-boot';
@Module({
imports: [
ConsulModule.register({adapter: BOOT_ADAPTER}),
BootModule.register(__dirname, 'bootstrap.yml'),
LoadbalanceModule.register({adapter: BOOT_ADAPTER})
],
})
export class ApplicationModule {}
```
##### Nest-boot config file
```yaml
consul:
host: localhost
port: 8500
loadbalance:
rules:
- {service: 'test-service', ruleCls: 'RandomRule'}
- {service: 'user-service', ruleCls: '../rules/CustomRule'}
```
#### Usage
```typescript
import { Component } from '@nestjs/common';
import { InjectLoadbalancee, Loadbalance } from 'nest-consul-loadbalance';
@Component()
export class TestService {
constructor(@InjectLoadbalancee() private readonly lb: Loadbalance) {}
async chooseOneNode() {
const node = this.lb.choose('user-service');
}
}
```
### Custom Loadbalance Rule
```typescript
import { Rule, Loadbalancer } from 'nest-consul-loadbalance';
export class CustomRule implements Rule {
private loadbalancer: Loadbalancer;
init(loadbalancer: Loadbalancer) {
this.loadbalancer = loadbalancer;
}
choose() {
const servers = this.loadbalancer.servers;
return servers[0];
}
}
```
## API
### class LoadbalanceModule
#### static register\(options\): DynamicModule
Import nest consul loadbalance module.
| field | type | description |
| :--- | :--- | :--- |
| options.adapter | string | if you are using nest-boot module, please set BOOT_ADAPTER |
| options.ruleCls | string \| class | lb rule，support：RandomRule, RoundRobinRule, WeightedResponseTimeRule or custom lb rule, use relative path |
| options.rules | RuleOption | one service use one rule, eg：\[{service: '', ruleCls: ''}\] |
### class Loadbalance
#### choose\(service: string\): Server
Choose a node that running the specific service.
| field | type | description |
| :--- | :--- | :--- |
| service | string | the service name |
#### chooseLoadbalancer\(service: string\): Loadbalancer
Get loadbalancer.
| field | type | description |
| :--- | :--- | :--- |
| service | string | the service name |
## Stay in touch
- Author - [Miaowing](https://github.com/miaowing)
## License
Nest is [MIT licensed](LICENSE).