# kylin-rpc

**Repository Path**: wangjkui/kylin-rpc

## Basic Information

- **Project Name**: kylin-rpc
- **Description**: 麒麟rpc远程调用框架，基于netty，zookeeper实现的远程调用框架
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-02-04
- **Last Updated**: 2022-09-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: rpc, Netty, 远程调用, zookeeper

## README

# kylin-rpc

#### 介绍
麒麟rpc远程调用框架
1.  参考 xxl-rpc

#### 软件架构
软件架构说明
1.  使用netty 4.1.48.Final
2.  spring boot 2.6.2
3.  支持zookeeper注册中心
4.  支持jdk、hessian、fastjson2序列化反序列化
5.  支持Random、Round、LRU、LFU算法调用服务提供者
6.  支持 sync、future、callback、one调用方式




#### 安装教程

1.  xxxx
2.  xxxx
3.  xxxx

#### 使用说明
##### 服务提供者
1. 引入pom
    ~~~
    <dependency>
        <groupId>com.wjk.kylin</groupId>
        <artifactId>kylin-rpc-core</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </dependency>
    ~~~
2. 配置
    ~~~   
    kylin:
      rpc:
        provider:
          enable: true
          serializer: fastjson
          registry:
            type : zookeeper
            address: 192.168.33.10:2181
    ~~~     
3. 对外提供接口的实现类加注解。例：
    ~~~
    public interface DemoService {
       Long hello(String id);
    }
    ~~~
    ~~~
    @Service
    @RpcService
    public class DemoServiceImpl implements DemoService {
        @Override
        public Long hello(String id) {
            return System.currentTimeMillis();
        }
    }  
    ~~~
##### 服务消费者
1. 引入pom
    ~~~
    <dependency>
        <groupId>com.wjk.kylin</groupId>
        <artifactId>kylin-rpc-core</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </dependency>
    ~~~
2. 配置
    ~~~   
    kylin:
      rpc:
        consumer:
          enable: true
          serializer: fastjson
          registry:
            type : zookeeper
            address: 192.168.33.10:2181
    ~~~     
3. 注解服务提供者接口。例：
    ~~~
    @RpcReference
    private DemoService demoService;
    ~~~
    ~~~
    @Service
    public class IndexServiceImpl implements IndexService {
        @RpcReference
        private DemoService demoService;
    
        @Override
        public Long index(String name) {
            Long hello = demoService.hello(name);
            return hello;
        }
    }
    ~~~

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)