commit	65f719598126b6d5c01db2ea46c2fc7234b10ed5	[log] [tgz]
author	胡锋 <fengmi99@gmail.com>	Sun Nov 17 01:19:07 2019 +0800
committer	GitHub <noreply@github.com>	Sun Nov 17 01:19:07 2019 +0800
tree	5b9a8a2de76362573b34b9192f6e4ed9e621e3cf
parent	dce88629965ad84e5f15bb6d463398338a167575 [diff]
parent	2ac8091de299abbeaf133152eefd89eed873b551 [diff]

tree: 5b9a8a2de76362573b34b9192f6e4ed9e621e3cf

README.md

Apache Dubbo-js

Dubbo-js, using Node.js to embrace the Dubbo ecosystem. See this Demo to find how intelligent this project is.

Features

Various transport protocols (Hessian, JSON-RPC etc.) supports
Tracing (Runtime information, Call Stack)
Multiple registry centers (Zookeeper, Nacos, Redis) supports or connecting to services directly
Extensibility, inspired from Koa Middleware
Builtin reconnection strategy
Typescript type definitions
Tools to automatically translate Java interfaces to Typescript type definitions
Dubbox supports

Architecture

Getting Started

yarn add dubbo2.js

Usage

Below code snippet shows how to work with the typescript type definitions which automatically translated from Java interfaces.

// ===================== service.ts ==================
// generated by interpret tools
import {BasicTypeProvider} from './providers/com/alibaba/dubbo/demo/BasicTypeProvider';
import {DemoProvider} from './providers/com/alibaba/dubbo/demo/DemoProvider';
import {ErrorProvider} from './providers/com/alibaba/dubbo/demo/ErrorProvider';

export default {
  BasicTypeProvider,
  DemoProvider,
  ErrorProvider,
};

// =============== dubbo.ts ========================
import {Dubbo} from 'dubbo2.js';
import service from './service';

// create dubbo object
const dubbo = new Dubbo<typeof service>({
  application: {name: 'node-dubbo'},
  // zookeeper address
  register: 'localhost:2181',
  service,
});

// main method
(async () => {
  let {res, err} = await dubbo.service.DemoProvider.sayHello('node');
  // print {err: null, res:'hello node from dubbo service'}
  ({res, err} = await dubbo.service.DemoProvider.echo());
  // print {err: null, res: 'pang'}
  ({res, err} = await dubbo.service.DemoProvider.getUserInfo());
  // print {status: 'ok', info: { id: '1', name: 'test' }, err: null}
})();

The automatically translated typescript type definitions are not necessary, below code snippet demonstrates how to use dubbo-js without them.

// create the service to be injected
import {Dubbo} from 'dubbo2.js';

const demoProvider = dubbo =>
  dubbo.proxyService({
    dubboInterface: 'com.alibaba.dubbo.demo.DemoProvider',
    version: '1.0.0',
    methods: {
      sayHello(name) {
        return [java.String(name)];
      },

      echo() {},

      test() {},

      getUserInfo() {
        return [
          java.combine('com.alibaba.dubbo.demo.UserRequest', {
            id: 1,
            name: 'nodejs',
            email: 'node@qianmi.com',
          }),
        ];
      },
    },
  });

// integrate the service in demoProvider with dubbo object constructor
const service = {
  demoProvider,
};

const dubbo = new Dubbo<typeof service>({
  // ....other parameters
  service,
});

For contributors

If you‘d like to contribute, it’s a good start to follow below commands to get a locally runnable project.

# start zookeeper cluster
docker-compose up

# start java
cd java/dubbo-demo
mvn clean install
cd java/dubbo-demo/dubbo-demo-provider
mvn clean package
java -jar target/dubbo-demo-provider-2.6.3-jar-with-dependencies.jar

# build
make

# start node
cd example/hello-koa
npm run debug:start

# test /hello
curl http://localhost:3000/hello

Next steps

Guides

Reporting bugs

Please follow the template for reporting any issues.

Knowledge Sharing

2019-meetup by hufeng

Thanks

Dubbo-js will not work without:

Many thanks to their authors fengmk2 and dead-horse.

License

Apache Dubbo is under the Apache 2.0 license. See the LICENSE file for details.