NettyRPC 开源项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00876/article/details/141704928

NettyRPC 开源项目教程

NettyRPC Yet another RPC framework based on Netty 项目地址: https://gitcode.com/gh_mirrors/nett/NettyRPC

1. 项目介绍

NettyRPC 是一个基于 Netty 的 RPC（远程过程调用）框架。它旨在提供一个简单、高性能的 RPC 解决方案，适用于需要快速开发和部署分布式系统的场景。NettyRPC 具有以下特点：

简单易用：代码库小巧，API 设计简洁，易于学习和使用。
高性能：完全非阻塞的异步调用，支持同步、异步和单向调用。
高可用性：支持负载均衡和故障转移，确保系统的高可用性。
服务发现：支持使用 Zookeeper 作为服务注册中心，实现动态服务发现。

2. 项目快速启动

2.1 环境准备

确保你已经安装了以下工具和环境：

Java 8 或更高版本
Maven 3.x
Zookeeper（可选，用于服务发现）

2.2 下载项目

git clone https://github.com/dawnbreaks/NettyRPC.git
cd NettyRPC

2.3 编译项目

mvn clean install

2.4 定义接口

首先，定义一个接口，该接口将作为远程服务的接口。

public interface IHelloWordObj {
    String hello(String msg);
    String test(Integer i, String s, Long l);
    void notifySomeThing(Integer i, String s, Long l);
}

2.5 实现接口

实现上述定义的接口。

public class HelloWorldObj implements IHelloWordObj {
    @Override
    public String hello(String msg) {
        return msg;
    }

    @Override
    public String test(Integer i, String s, Long l) {
        return i + s + l;
    }

    @Override
    public void notifySomeThing(Integer i, String s, Long l) {
        System.out.println("notifySomeThing|i=" + i + "|s=" + s + "|l=" + l);
    }
}

2.6 配置文件

更新配置文件 config.properties，配置服务器和客户端参数。

server.port=9090
server.backlog=1000
server.async=false
server.asyncThreadPoolSize=4
server.ioThreadNum=4
server.enableServiceDiscovery=true
server.objects=com.lubin.rpc.example.obj.HelloWorldObj

client.syncCallTimeOutMillis=300
client.connectTimeoutMillis=300
client.reconnIntervalMillis=1000
client.asyncThreadPoolSize=1
client.ioThreadNum=1
client.objects=[{name=com.lubin.rpc.example.obj.IHelloWordObj, servers="127.0.0.1:9090 127.0.0.1:9091"}]

2.7 启动服务器

启动 RPC 服务器。

import com.lubin.rpc.server.RPCServer;

public class ServerMain {
    public static void main(String[] args) {
        RPCServer server = new RPCServer();
        server.start();
    }
}

2.8 客户端调用

创建客户端代理并调用远程服务。

import com.lubin.rpc.client.RPCClient;

public class ClientMain {
    public static void main(String[] args) {
        IHelloWordObj client = RPCClient.proxyBuilder(IHelloWordObj.class)
                                        .withServerNode("127.0.0.1", 9090)
                                        .build();
        String result = client.hello("hello world");
        System.out.println(result);
    }
}

3. 应用案例和最佳实践

3.1 高可用性部署

为了实现高可用性，可以在多个服务器上部署 NettyRPC 服务，并配置负载均衡和故障转移。

ArrayList<InetSocketAddress> serverNodeList = new ArrayList<>();
serverNodeList.add(new InetSocketAddress("127.0.0.1", 9090));
serverNodeList.add(new InetSocketAddress("127.0.0.1", 9091));

IHelloWordObj client = RPCClient.proxyBuilder(IHelloWordObj.class)
                                .withServerNodes(serverNodeList)
                                .build();
System.out.println("test server list:" + client.hello("test server list11"));

3.2 服务发现

使用 Zookeeper 作为服务注册中心，实现动态服务发现。

IHelloWordObj client = RPCClient.proxyBuilder(IHelloWordObj.class)
                                .enableRegistry()
                                .build();
System.out.println("test server list:" + client.hello("test server list11"));