X-RPC 框架

项目介绍

架构设计

整体架构

调用流程

核心功能

1. 多种通信协议支持

2. 灵活的序列化机制

3. 服务注册与发现

4. 负载均衡

5. 容错机制

6. SPI 扩展机制

快速开始

环境要求

1. 添加依赖

<dependency>
 <groupId>com.x</groupId>
 <artifactId>x-rpc-core</artifactId>
 <version>1.0-SNAPSHOT</version>
</dependency>

2. 定义服务接口

package com.x.example.common.service;
import com.x.example.common.model.User;
public interface UserService {
 /**
 * 获取用户
 */
 User getUser(User user);
 
 default short getNumber(){
 return 1;
 }
}

3. 实现服务接口

package com.x.example.provider;
import com.x.example.common.model.User;
import com.x.example.common.service.UserService;
public class UserServiceImpl implements UserService {
 public User getUser(User user) {
 System.out.println("用户名:" + user.getName());
 return user;
 }
 
 @Override
 public short getNumber() {
 System.out.println("调用getNumber方法");
 return 1;
 }
}

4. 启动服务提供者

package com.x.example.provider;
import com.x.example.common.service.UserService;
import com.x.rpc.model.ServiceRegisterInfo;
import com.x.rpc.bootstrap.ProviderBootstrap;
import java.util.ArrayList;
import java.util.List;
public class EasyProviderExample {
 public static void main(String[] args) {
 // 要注册的服务
 List<ServiceRegisterInfo<?>> serviceRegisterInfoList = new ArrayList<>();
 ServiceRegisterInfo<UserService> userServiceRegisterInfo = new ServiceRegisterInfo<>(UserService.class.getName(), UserServiceImpl.class);
 serviceRegisterInfoList.add(userServiceRegisterInfo);
 // 初始化
 ProviderBootstrap.init(serviceRegisterInfoList);
 }
}

5. 服务消费者调用

package com.x.example.consumer;
import com.x.example.common.model.User;
import com.x.example.common.service.UserService;
import com.x.rpc.proxy.ServiceProxyFactory;
public class EasyConsumerExample {
 public static void main(String[] args) {
 // 获取服务代理对象
 UserService userService = ServiceProxyFactory.getProxy(UserService.class);
 // 创建请求参数
 User user = new User();
 user.setName("lingpfeng");
 // 调用远程服务
 User newUser = userService.getUser(user);
 if (newUser != null) {
 System.out.println("新用户名:" + newUser.getName());
 } else {
 System.out.println("获取用户失败");
 }
 // 调用另一个方法
 long number = userService.getNumber();
 System.out.println("number:" + number);
 }
}

配置选项

# RPC 框架配置
rpc:
 # 服务器主机名
 serverHost: localhost
 # 服务器端口号
 serverPort: 8080
 # 注册中心配置
 registry:
 # 注册中心类型(local, zookeeper, etcd)
 registry: local
 # 注册中心地址
 address: localhost:2181
 # 序列化器类型(JDK, JSON, Hessian, Kryo)
 serializer: Hessian
 # 负载均衡器类型(random, roundRobin, consistentHash)
 loadBalancer: random
 # 容错策略(failFast, failSafe, failOver, failBack)
 tolerantStrategy: failFast
 # 重试策略(no, fixedInterval)
 retryStrategy: fixedInterval
 # 重试次数
 retryTimes: 3
 # 重试间隔(毫秒)
 retryInterval: 1000

扩展机制

项目结构

my-rpc/
├── x-rpc-core/ # 核心实现模块
├── yu-rpc-easy/ # 简化版实现
├── example-common/ # 示例公共模块
├── example-consumer/ # 消费者示例
├── example-provider/ # 提供者示例
├── example-springboot-consumer/ # Spring Boot消费者示例
└── example-springboot-provider/ # Spring Boot提供者示例

Spring Boot集成

核心注解

集成原理

服务提供者示例

// 1. 在启动类上添加@EnableRpc注解
@SpringBootApplication
@EnableRpc
public class ProviderApplication {
 public static void main(String[] args) {
 SpringApplication.run(ProviderApplication.class, args);
 }
}
// 2. 在服务实现类上添加@RpcService注解
@RpcService(interfaceClass = UserService.class)
public class UserServiceImpl implements UserService {
 @Override
 public User getUser(User user) {
 System.out.println("用户名:" + user.getName());
 return user;
 }
 
 @Override
 public short getNumber() {
 System.out.println("调用getNumber方法");
 return 1;
 }
}

服务消费者示例

// 1. 在启动类上添加@EnableRpc注解
@SpringBootApplication
@EnableRpc(needServer = false) // 消费者一般不需要启动服务器
public class ConsumerApplication {
 public static void main(String[] args) {
 SpringApplication.run(ConsumerApplication.class, args);
 }
}
// 2. 在需要使用远程服务的类中注入服务
@RestController
public class UserController {
 // 使用@RpcReference注解注入远程服务
 @RpcReference(interfaceClass = UserService.class)
 private UserService userService;
 
 @GetMapping("/user")
 public User getUser(String name) {
 User user = new User();
 user.setName(name);
 // 调用远程服务
 return userService.getUser(user);
 }
}

配置选项

# RPC配置
rpc:
 # 服务器主机名
 serverHost: localhost
 # 服务器端口号
 serverPort: 8080
 # 注册中心配置
 registry:
 # 注册中心类型(local, zookeeper, etcd)
 registry: zookeeper
 # 注册中心地址
 address: localhost:2181
 # 序列化器类型
 serializer: Hessian
 # 负载均衡器类型
 loadBalancer: roundRobin
 # 容错策略
 tolerantStrategy: failFast
 # 重试策略
 retryStrategy: fixedInterval
 # 重试次数
 retryTimes: 3
 # 重试间隔(毫秒)
 retryInterval: 1000

最近更新

性能优化

贡献指南

许可证

联系方式