Skip to content

Latest commit

 

History

History
65 lines (54 loc) · 2.71 KB

README.md

File metadata and controls

65 lines (54 loc) · 2.71 KB

MyRpcProtocol

This repository build a remote procedure call framework, which contains several highlights:

  1. Use SPI (Service Provider Interface) to enhance the scalability.
  2. Implement several internet transport methods, including Socket and Netty.
  3. Implement several serialize methods, including Protostuff and jackson.
  4. Use Zookeeper as the register center.
  5. Implementation of the heartbeat mechanism to ensure stable connections.
  6. Customized message protocol, avoid packet concatenation and half packet happen, see RpcMessageDecoder/RpcMessageEncoder.
  7. Implement consistent hashing algorithm for zookeeper load balancing.

Prerequisites

  1. Java 1.8 and Docker
  2. Pull Zookeeper from docker hub. 
    docker pull zookeeper:3.5.8
  3. This repository is developed using Intellij IDEA, not tested with other IDEs.
  4. This repository is coded with Lombok annotations, users need to install Lombok plugin to successfully compile.
  5. Add src/main/resources into your IDE's classpath.

Demonstration

  1. Users can edit configs in path src/main/resources/ or add services in src/main/resources/META-INF/extensions.
  2. Start Zookeeper service, default port: 2181. 
    docker run -d --name zookeeper -p 2181:2181 zookeeper:3.5.8
  3. Users can run the test codes in path src/test/java.
  • Compile and run socketTest.ServerMain first.
  • Compile and run socketTest.ClientMain afterwords.
  • If it runs properly you can see the result in the output。

How to use the project in your code

Server-Side (Service Provider)

  THE_SERVICE_YOU_WANT_TO_PROVIDE targetRpcService = TargetRpcService.builder()
          .group("THE_GROUP_OF_THE_SERVICE_YOU_WANT_TO_PROVIDE")
          .version("THE_VERSION_OF_THE_SERVICE_YOU_WANT_TO_PROVIDE")
          .service(THE_OBJECT_OF_THE_SERVICE_YOU_WANT_TO_PROVIDE)
          .build();
  SocketRpcServer socketRpcServer = new SocketRpcServer();
  socketRpcServer.registerService(targetRpcService);
  socketRpcServer.start();

Client-Side (Service User)

  RpcRequestTransport rpcRequestTransport = new SocketRpcClient();
  TargetRpcService targetRpcService = TargetRpcService.builder()
          .group("THE_GROUP_OF_THE_SERVICE_YOU_WANT_TO_IMPLEMENT")
          .version("THE_VERSION_OF_THE_SERVICE_YOU_WANT_TO_IMPLEMENT")
          .build();
  
  RpcClientProxy rpcClientProxy = new RpcClientProxy(rpcRequestTransport, targetRpcService);
  THE_SERVICE_YOU_WANT_TO_IMPLEMENT service = rpcClientProxy.getProxy(ClassTransferTest.class);
  service.doSth();

Credit