prpc

an rpc framework

1 Architecture

2 Features

3 Quick Start

demo详情可查看prpc-example

java8及以上
依赖zookeeper

3.1 引用依赖

服务端和客户端都需要依赖prpc-spring-boot-starter

<dependency>
    <groupId>com.weaponlin.inf.prpc</groupId>
    <artifactId>prpc-spring-boot-starter</artifactId>
    <version>${latest-version}</version>
</dependency>

3.2 定义api

public interface HelloApi {
    HelloResponse hello(Long userId, HelloRequest request);
}

3.3 创建provider(服务提供方)

(1) 引用api依赖并实现

<dependency>
    <groupId>com.weaponlin.inf.prpc</groupId>
    <artifactId>api</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

public class HelloApiImpl implements HelloApi {
    public HelloResponse hello(Long userId, HelloRequest request) {
        HelloResponse res = HelloResponse.builder().greeting(RandomStringUtils.random(request.getSize(), true, true))
                .build();
        return res;
    }
}

(2) 在application.yml添加server配置

prpc:
  server:                              # 标识为服务端配置
    protocol: prpc                     # 全局配置
    registryCenter:
      naming: zookeeper
      address: 127.0.0.1:2181
    codec: protobuf
    timeout: 30000
    groups:                            # 服务分组配置
      - group: default                 # 服务分组名称
        registryCenter:                # 注册中心
          naming: zookeeper            # 命名方式，eg: zookeeper、redis(待支持)
          address: 127.0.0.1:2181      # 注册中心地址
        codec: protobuf                # 编解码，eg: protobuf、fastjson、jackson、
        protocol: prpc                 # 通信协议，eg: prpc、dubbo(待优化)、brpc(待支持)
        timeout: 30000
        basePackage: com.weaponlin.inf.prpc.api # api所在的包，多个包以逗号分割(待支持)

(3) 启动应用

@SpringBootApplication
public class ProviderApplication {
    public static void main(String[] args) {
        SpringApplication.run(ProviderApplication.class, args);
    }        
}

3.4 创建consumer(服务消费方)

(1) 引用api

<dependency>
    <groupId>com.weaponlin.inf.prpc</groupId>
    <artifactId>api</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

(2) 创建controller调用api

引用api需要标注 @ReferenceService 注解

@RestController
@RequestMapping("")
public class HelloController {

    @ReferenceService
    private HelloApi helloApi;

    @GetMapping("/hello")
    public HelloResponse hello() {
        HelloRequest req = new HelloRequest();
        req.setSize(111);
        req.setMessage("asdfasdfadsf");
        return helloApi.hello(1L, req);
    }
}

(3) 在application.yml添加client配置

prpc:
  client:                                 # 标识为客户端配置
    protocol: prpc                        # 全局配置
    registryCenter:
      naming: zookeeper
      address: 127.0.0.1:2181
    codec: protobuf
    loadBalance: roundrobin
    cluster: failfast                     # 容错机制
    groups:
      - group: default
        registryCenter:
          naming: zookeeper
          address: 127.0.0.1:2181
        codec: protobuf
        loadBalance: roundrobin           # 负载均衡
        protocol: prpc
        timeout: 30000
        basePackage: com.weaponlin.inf.prpc.api

# web 服务端口
server:
  port: 8081

(4) 启动应用

@SpringBootApplication
public class ConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConsumerApplication.class, args);
    }
}

4 TODO

一些待优化的事情记录

byWeaponLin / prpc