Simple RPC framework based on Socket+Zookeeper

github: https://github.com/shawntime/shawn-native-rpc


> If you need to implement a simple rpc framework yourself, you can refer to it and provide a little idea


#### RPC process detailed explanation




#### Implement content
* json serialization
* zookeeper implements server-side service registration and client-side service Discovery and load balancing
* Automatically scan the interface provided by the server and register it in zookeeper
* Automatically generate client dynamic proxy objects
* Socket realizes communication


#### Module description
* native-core: public package: annotations, exception definitions, Communication protocol, serialization, zookeeper client encapsulation, package scanning, configuration loading and other tool classes
* native-customer: a module that the caller needs to introduce to automatically generate client dynamic proxy objects, zk service discovery and load balancing, and communication accomplish
* native-provider: The module to be introduced by the service provider, which implements the interface client request and processing, zk's service registration
* native-interface: the interface definition for external service provision
* shawn-test-provider: the provider demo
* shawn- test-customer: caller demo


#### configuration
##### provider configuration


> configure naive-rpc.properties file
```
scanPackage=com.shawntime.rpc.api
servicePort=11001
```
* scanPackage: package scan path, automatically create the interface dynamic proxy class under the package path
* servicePort: server listening port number


> configure spring


```xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http: //www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:cache="http://www.springframework.org/schema/ cache"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans-4.1.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context-4.1.xsd
       http://www.springframework.org/schema/cache
       http://www.springframework.org/schema/cache/spring-cache-4.1.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">


    <context:component-scan base-package="com.shawntime"/>
    <context:annotation-config/>
    <aop:aspectj-autoproxy proxy-target-class="true"/>


    <!-- Configure message formatting -->
    <bean id="jsonFormatter" class="com.shawntime.rpc.core.serialize.json .JsonFormatter" />
    <bean id="jsonParse" class="com.shawntime.rpc.core.serialize.json.JsonParse" />


    <!-- Configure the service class, where sockets are used to process requests -->
    <bean id="rpcProvider" class="com.shawntime.rpc.provider.service.socket.SocketRpcProvider">
        <property name="formatter" ref="jsonFormatter" />
        <property name="parse" ref="jsonParse" / >
    </bean>


    <!-- Configure zk server cluster information for service registration-->
    <bean id=" zookeeperClient" class="com.shawntime.rpc.core.zookeeper.ZookeeperClient">
        <constructor-arg value="127.0.0.1:2181,127.0.0.1:2182,127.0.0.1:2183" />
    </bean>
</beans>
```


##### customer configuration


> configure naive-rpc .properties file
```
scanPackage=com.shawntime.rpc.api
```
* scanPackage: package scan path, automatically create interface dynamic proxy class under the package path


> configure spring


```xml
<?xml version="1.0" encoding ="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns: cache="http://www.springframework.org/schema/cache"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans-4.1.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context-4.1.xsd
       http://www.springframework.org/schema/cache
       http://www.springframework.org/schema/cache/spring-cache-4.1.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">


    <context:component-scan base-package="com.shawntime"/>
    <context:annotation-config/>
    <aop:aspectj-autoproxy proxy-target-class="true"/>


    <!-- 配置消息格式化方式 -->
    <bean id="jsonFormatter" class="com.shawntime.rpc.core.serialize.json.JsonFormatter" />
    <bean id="jsonParse" class="com.shawntime.rpc.core.serialize.json.JsonParse" />
    
    <!-- 客户端处理配置 -->
    <bean id="socketInvoke" class="com.shawntime.rpc.customer.invoke.socket.SocketInvoke" />
    
    <bean id="beanNameGenerator" class="org.springframework.context.annotation.AnnotationBeanNameGenerator" />


    <!-- 客户端动态代理注册类 -->
    <bean id="customBeanDefinitionRegistryPostProcessor"
          class="com.shawntime.rpc.customer.config.CustomBeanDefinitionRegistryPostProcessor">
        <property name="invoke" ref="socketInvoke" />
        <property name="formatter" ref="jsonFormatter" />
        <property name="parse" ref="jsonParse" />
        <property name="beanNameGenerator" ref="beanNameGenerator" />
        <property name="serviceFindManager" ref="serviceFindManager" />
    </bean>


    <!-- 服务发现和负载均衡 -->
    <bean id="serviceFindManager" class="com.shawntime.rpc.customer.ServiceFindManager">
        <property name="zookeeperClient" ref="zookeeperClient" />
    </bean>


    <!-- 配置zk服务器集群信息，作服务注册 -->
    <bean id="zookeeperClient" class="com.shawntime.rpc.core.zookeeper.ZookeeperClient">
        <constructor-arg value="127.0.0.1:2181,127.0.0.1:2182,127.0.0.1:2183" />
    </bean>
</beans>
```


### Demo
* 接口定义，用RpcService注解
```java
@RpcService
public interface IUserService {


    UserOut getUserInfo(UserIn userIn, Integer level);


    void addUserProvince(ProvinceIn in);
}
```


* 提供方


```java
package com.shawntime.test.provider;


import com.shawntime.rpc.api.IUserService;
import com.shawntime.rpc.api.contract.ProvinceIn;
import com.shawntime.rpc.api.contract.UserIn;
import com.shawntime.rpc.api.contract.UserOut;
import org.springframework.stereotype.Component;


@Component
public class UserService implements IUserService {


    public UserOut getUserInfo(UserIn userIn, Integer level) {
        UserOut userOut = new UserOut();
        if (level > 0) {
            userOut.setUserId(1);
            userOut.setAddress("安徽芜湖");
            userOut.setAge(18);
            userOut.setUserName(userIn.getUserName());
        } else {
            userOut.setUserId(2);
            userOut.setAddress("河北保定");
            userOut.setAge(19);
            userOut.setUserName(userIn.getUserName());
        }
        return userOut;
    }


    public void addUserProvince(ProvinceIn provinceIn) {
        System.out.println(provinceIn);
    }
}


```


* 调用方


```java
@Component
public class LoginService implements ILoginService {


    @Resource
    private IUserService userService;


    public boolean login(String userName, String password, Integer level) {
        UserIn userIn = new UserIn();
        userIn.setUserName(userName);
        userIn.setPassword(password);
        UserOut userInfo = userService.getUserInfo(userIn, level);
        System.out.println("userId:" + userInfo.getUserId()
                + ", age:" + userInfo.getAge()
                + ", address:" + userInfo.getAddress());
        return userInfo != null;
    }


    public int addUserProvince(ProvinceIn in) {
        userService.addUserProvince(in);
        return 1;
    }
}
```