[refractor&fix]完善rpc传参&修复失败测试

Author: Snailclimb

README-EN.md

@@ -150,9 +150,9 @@ public class NettyServerMain {
         NettyServer nettyServer = new NettyServer();
         // Register service manually
         HelloService helloService2 = new HelloServiceImpl2();
-        RpcServiceProperties rpcServiceProperties = RpcServiceProperties.builder()
+        RpcServiceProperties rpcServiceConfig = RpcServiceProperties.builder()
                 .group("test2").version("version2").build();
-        nettyServer.registerService(helloService2, rpcServiceProperties);
+        nettyServer.registerService(helloService2, rpcServiceConfig);
         nettyServer.start();
     }
 }
@@ -182,9 +182,9 @@ public class HelloController {
 
 ```java
 ClientTransport rpcRequestTransport = new SocketRpcClient();
-RpcServiceProperties rpcServiceProperties = RpcServiceProperties.builder()
+RpcServiceProperties rpcServiceConfig = RpcServiceProperties.builder()
         .group("test2").version("version2").build();
-RpcClientProxy rpcClientProxy = new RpcClientProxy(rpcRequestTransport, rpcServiceProperties);
+RpcClientProxy rpcClientProxy = new RpcClientProxy(rpcRequestTransport, rpcServiceConfig);
 HelloService helloService = rpcClientProxy.getProxy(HelloService.class);
 String hello = helloService.hello(new Hello("111", "222"));
 System.out.println(hello);

README.md

@@ -196,9 +196,9 @@ public class NettyServerMain {
         NettyServer nettyServer = new NettyServer();
         // Register service manually
         HelloService helloService2 = new HelloServiceImpl2();
-        RpcServiceProperties rpcServiceProperties = RpcServiceProperties.builder()
+        RpcServiceProperties rpcServiceConfig = RpcServiceProperties.builder()
                 .group("test2").version("version2").build();
-        nettyServer.registerService(helloService2, rpcServiceProperties);
+        nettyServer.registerService(helloService2, rpcServiceConfig);
         nettyServer.start();
     }
 }
@@ -227,9 +227,9 @@ public class HelloController {
 
 ```java
 ClientTransport rpcRequestTransport = new SocketRpcClient();
-RpcServiceProperties rpcServiceProperties = RpcServiceProperties.builder()
+RpcServiceProperties rpcServiceConfig = RpcServiceProperties.builder()
         .group("test2").version("version2").build();
-RpcClientProxy rpcClientProxy = new RpcClientProxy(rpcRequestTransport, rpcServiceProperties);
+RpcClientProxy rpcClientProxy = new RpcClientProxy(rpcRequestTransport, rpcServiceConfig);
 HelloService helloService = rpcClientProxy.getProxy(HelloService.class);
 String hello = helloService.hello(new Hello("111", "222"));
 System.out.println(hello);

config/checkstyle.xml

@@ -178,8 +178,6 @@
             <property name="basicOffset" value="4"/>
             <property name="braceAdjustment" value="0"/>
             <property name="caseIndent" value="4"/>
-            <property name="throwsIndent" value="8"/>
-            <property name="lineWrappingIndentation" value="8"/>
             <property name="arrayInitIndent" value="4"/>
         </module>
 

docs/造个轮子：自定义注解实现服务注册和消费（RPC框架）.md

@@ -111,10 +111,10 @@ public @interface RpcService {
 
 ```java
 import github.javaguide.annotation.RpcService;
-import github.javaguide.entity.RpcServiceProperties;
+import github.javaguide.config.RpcServiceConfig;
 import github.javaguide.factory.SingletonFactory;
 import github.javaguide.provider.ServiceProvider;
-import github.javaguide.provider.ServiceProviderImpl;
+import github.javaguide.provider.impl.ZkServiceProviderImpl;
 import lombok.SneakyThrows;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.BeansException;
@@ -145,10 +145,10 @@ public class SpringBeanPostProcessor implements BeanPostProcessor {
             log.info("[{}] is annotated with  [{}]", bean.getClass().getName(), RpcService.class.getCanonicalName());
             // 获取注解
             RpcService rpcService = bean.getClass().getAnnotation(RpcService.class);
-            RpcServiceProperties rpcServiceProperties = RpcServiceProperties.builder()
+            RpcServiceProperties rpcServiceConfig = RpcServiceProperties.builder()
                     .group(rpcService.group()).version(rpcService.version()).build();
             // 发布服务
-            serviceProvider.publishService(bean, rpcServiceProperties);
+            serviceProvider.publishService(bean, rpcServiceConfig);
         }
         return bean;
     }

example-client/src/main/java/github/javaguide/SocketClientMain.java

@@ -1,6 +1,6 @@
 package github.javaguide;
 
-import github.javaguide.entity.RpcServiceProperties;
+import github.javaguide.config.RpcServiceConfig;
 import github.javaguide.proxy.RpcClientProxy;
 import github.javaguide.remoting.transport.RpcRequestTransport;
 import github.javaguide.remoting.transport.socket.SocketRpcClient;
@@ -12,9 +12,8 @@
 public class SocketClientMain {
     public static void main(String[] args) {
         RpcRequestTransport rpcRequestTransport = new SocketRpcClient();
-        RpcServiceProperties rpcServiceProperties = RpcServiceProperties.builder()
-                .group("test2").version("version2").build();
-        RpcClientProxy rpcClientProxy = new RpcClientProxy(rpcRequestTransport, rpcServiceProperties);
+        RpcServiceConfig rpcServiceConfig = new RpcServiceConfig();
+        RpcClientProxy rpcClientProxy = new RpcClientProxy(rpcRequestTransport, rpcServiceConfig);
         HelloService helloService = rpcClientProxy.getProxy(HelloService.class);
         String hello = helloService.hello(new Hello("111", "222"));
         System.out.println(hello);

example-server/src/main/java/NettyServerMain.java

@@ -1,6 +1,6 @@
 import github.javaguide.HelloService;
 import github.javaguide.annotation.RpcScan;
-import github.javaguide.entity.RpcServiceProperties;
+import github.javaguide.config.RpcServiceConfig;
 import github.javaguide.remoting.transport.netty.server.NettyRpcServer;
 import github.javaguide.serviceimpl.HelloServiceImpl2;
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
@@ -19,9 +19,9 @@ public static void main(String[] args) {
         NettyRpcServer nettyRpcServer = (NettyRpcServer) applicationContext.getBean("nettyRpcServer");
         // Register service manually
         HelloService helloService2 = new HelloServiceImpl2();
-        RpcServiceProperties rpcServiceProperties = RpcServiceProperties.builder()
-                .group("test2").version("version2").build();
-        nettyRpcServer.registerService(helloService2, rpcServiceProperties);
+        RpcServiceConfig rpcServiceConfig = RpcServiceConfig.builder()
+                .group("test2").version("version2").service(helloService2).build();
+        nettyRpcServer.registerService(rpcServiceConfig);
         nettyRpcServer.start();
     }
 }

example-server/src/main/java/SocketServerMain.java

@@ -1,5 +1,5 @@
 import github.javaguide.HelloService;
-import github.javaguide.entity.RpcServiceProperties;
+import github.javaguide.config.RpcServiceConfig;
 import github.javaguide.remoting.transport.socket.SocketRpcServer;
 import github.javaguide.serviceimpl.HelloServiceImpl;
 
@@ -11,9 +11,9 @@ public class SocketServerMain {
     public static void main(String[] args) {
         HelloService helloService = new HelloServiceImpl();
         SocketRpcServer socketRpcServer = new SocketRpcServer();
-        RpcServiceProperties rpcServiceProperties = RpcServiceProperties.builder()
-                .group("test2").version("version2").build();
-        socketRpcServer.registerService(helloService, rpcServiceProperties);
+        RpcServiceConfig rpcServiceConfig = new RpcServiceConfig();
+        rpcServiceConfig.setService(helloService);
+        socketRpcServer.registerService(rpcServiceConfig);
         socketRpcServer.start();
     }
 }

rpc-framework-common/src/main/java/github/javaguide/factory/SingletonFactory.java

@@ -1,7 +1,6 @@
 package github.javaguide.factory;
 
 import java.lang.reflect.InvocationTargetException;
-import java.util.HashMap;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 

rpc-framework-common/src/main/java/github/javaguide/utils/RuntimeUtil.java

@@ -7,6 +7,7 @@
 public class RuntimeUtil {
     /**
      * 获取CPU的核心数
+     *
      * @return cpu的核心数
      */
     public static int cpus() {

rpc-framework-simple/src/main/java/github/javaguide/compress/gzip/GzipCompress.java

@@ -24,7 +24,7 @@ public byte[] compress(byte[] bytes) {
             throw new NullPointerException("bytes is null");
         }
         try (ByteArrayOutputStream out = new ByteArrayOutputStream();
-                GZIPOutputStream gzip = new GZIPOutputStream(out)) {
+             GZIPOutputStream gzip = new GZIPOutputStream(out)) {
             gzip.write(bytes);
             gzip.flush();
             gzip.finish();
@@ -40,7 +40,7 @@ public byte[] decompress(byte[] bytes) {
             throw new NullPointerException("bytes is null");
         }
         try (ByteArrayOutputStream out = new ByteArrayOutputStream();
-                GZIPInputStream gunzip = new GZIPInputStream(new ByteArrayInputStream(bytes))) {
+             GZIPInputStream gunzip = new GZIPInputStream(new ByteArrayInputStream(bytes))) {
             byte[] buffer = new byte[BUFFER_SIZE];
             int n;
             while ((n = gunzip.read(buffer)) > -1) {

rpc-framework-common/src/main/java/github/javaguide/entity/RpcServiceProperties.java renamed to rpc-framework-simple/src/main/java/github/javaguide/config/RpcServiceConfig.java

@@ -1,4 +1,4 @@
-package github.javaguide.entity;
+package github.javaguide.config;
 
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -17,18 +17,26 @@
 @Setter
 @Builder
 @ToString
-public class RpcServiceProperties {
+public class RpcServiceConfig {
     /**
      * service version
      */
-    private String version;
+    private String version = "";
     /**
      * when the interface has multiple implementation classes, distinguish by group
      */
-    private String group;
-    private String serviceName;
+    private String group = "";
 
-    public String toRpcServiceName() {
+    /**
+     * target service
+     */
+    private Object service;
+
+    public String getRpcServiceName() {
         return this.getServiceName() + this.getGroup() + this.getVersion();
     }
+
+    public String getServiceName() {
+        return this.service.getClass().getInterfaces()[0].getCanonicalName();
+    }
 }

rpc-framework-simple/src/main/java/github/javaguide/loadbalance/loadbalancer/ConsistentHashLoadBalance.java

@@ -27,17 +27,14 @@ public class ConsistentHashLoadBalance extends AbstractLoadBalance {
     protected String doSelect(List<String> serviceAddresses, RpcRequest rpcRequest) {
         int identityHashCode = System.identityHashCode(serviceAddresses);
         // build rpc service name by rpcRequest
-        String rpcServiceName = rpcRequest.toRpcProperties().toRpcServiceName();
-
+        String rpcServiceName = rpcRequest.getRpcServiceName();
         ConsistentHashSelector selector = selectors.get(rpcServiceName);
-
         // check for updates
         if (selector == null || selector.identityHashCode != identityHashCode) {
             selectors.put(rpcServiceName, new ConsistentHashSelector(serviceAddresses, 160, identityHashCode));
             selector = selectors.get(rpcServiceName);
         }
-
-        return selector.select(rpcServiceName+ Arrays.stream(rpcRequest.getParameters()));
+        return selector.select(rpcServiceName + Arrays.stream(rpcRequest.getParameters()));
     }
 
     static class ConsistentHashSelector {

rpc-framework-simple/src/main/java/github/javaguide/provider/ServiceProvider.java

@@ -1,6 +1,6 @@
 package github.javaguide.provider;
 
-import github.javaguide.entity.RpcServiceProperties;
+import github.javaguide.config.RpcServiceConfig;
 
 /**
  * store and provide service object.
@@ -11,26 +11,19 @@
 public interface ServiceProvider {
 
     /**
-     * @param service              service object
-     * @param serviceClass         the interface class implemented by the service instance object
-     * @param rpcServiceProperties service related attributes
+     * @param rpcServiceConfig rpc service related attributes
      */
-    void addService(Object service, Class<?> serviceClass, RpcServiceProperties rpcServiceProperties);
+    void addService(RpcServiceConfig rpcServiceConfig);
 
     /**
-     * @param rpcServiceProperties service related attributes
+     * @param rpcServiceName rpc service name
      * @return service object
      */
-    Object getService(RpcServiceProperties rpcServiceProperties);
+    Object getService(String rpcServiceName);
 
     /**
-     * @param service              service object
-     * @param rpcServiceProperties service related attributes
+     * @param rpcServiceConfig rpc service related attributes
      */
-    void publishService(Object service, RpcServiceProperties rpcServiceProperties);
+    void publishService(RpcServiceConfig rpcServiceConfig);
 
-    /**
-     * @param service service object
-     */
-    void publishService(Object service);
 }

rpc-framework-simple/src/main/java/github/javaguide/provider/ServiceProviderImpl.java renamed to rpc-framework-simple/src/main/java/github/javaguide/provider/impl/ZkServiceProviderImpl.java

@@ -1,9 +1,10 @@
-package github.javaguide.provider;
+package github.javaguide.provider.impl;
 
-import github.javaguide.entity.RpcServiceProperties;
+import github.javaguide.config.RpcServiceConfig;
 import github.javaguide.enums.RpcErrorMessageEnum;
 import github.javaguide.exception.RpcException;
 import github.javaguide.extension.ExtensionLoader;
+import github.javaguide.provider.ServiceProvider;
 import github.javaguide.registry.ServiceRegistry;
 import github.javaguide.remoting.transport.netty.server.NettyRpcServer;
 import lombok.extern.slf4j.Slf4j;
@@ -20,7 +21,7 @@
  * @createTime 2020年05月13日 11:23:00
  */
 @Slf4j
-public class ServiceProviderImpl implements ServiceProvider {
+public class ZkServiceProviderImpl implements ServiceProvider {
 
     /**
      * key: rpc service name(interface name + version + group)
@@ -30,47 +31,38 @@ public class ServiceProviderImpl implements ServiceProvider {
     private final Set<String> registeredService;
     private final ServiceRegistry serviceRegistry;
 
-
-    public ServiceProviderImpl() {
+    public ZkServiceProviderImpl() {
         serviceMap = new ConcurrentHashMap<>();
         registeredService = ConcurrentHashMap.newKeySet();
         serviceRegistry = ExtensionLoader.getExtensionLoader(ServiceRegistry.class).getExtension("zk");
     }
 
     @Override
-    public void addService(Object service, Class<?> serviceClass, RpcServiceProperties rpcServiceProperties) {
-        String rpcServiceName = rpcServiceProperties.toRpcServiceName();
+    public void addService(RpcServiceConfig rpcServiceConfig) {
+        String rpcServiceName = rpcServiceConfig.getRpcServiceName();
         if (registeredService.contains(rpcServiceName)) {
             return;
         }
         registeredService.add(rpcServiceName);
-        serviceMap.put(rpcServiceName, service);
-        log.info("Add service: {} and interfaces:{}", rpcServiceName, service.getClass().getInterfaces());
+        serviceMap.put(rpcServiceName, rpcServiceConfig.getService());
+        log.info("Add service: {} and interfaces:{}", rpcServiceName, rpcServiceConfig.getService().getClass().getInterfaces());
     }
 
     @Override
-    public Object getService(RpcServiceProperties rpcServiceProperties) {
-        Object service = serviceMap.get(rpcServiceProperties.toRpcServiceName());
+    public Object getService(String rpcServiceName) {
+        Object service = serviceMap.get(rpcServiceName);
         if (null == service) {
             throw new RpcException(RpcErrorMessageEnum.SERVICE_CAN_NOT_BE_FOUND);
         }
         return service;
     }
 
     @Override
-    public void publishService(Object service) {
-        this.publishService(service, RpcServiceProperties.builder().group("").version("").build());
-    }
-
-    @Override
-    public void publishService(Object service, RpcServiceProperties rpcServiceProperties) {
+    public void publishService(RpcServiceConfig rpcServiceConfig) {
         try {
             String host = InetAddress.getLocalHost().getHostAddress();
-            Class<?> serviceRelatedInterface = service.getClass().getInterfaces()[0];
-            String serviceName = serviceRelatedInterface.getCanonicalName();
-            rpcServiceProperties.setServiceName(serviceName);
-            this.addService(service, serviceRelatedInterface, rpcServiceProperties);
-            serviceRegistry.registerService(rpcServiceProperties.toRpcServiceName(), new InetSocketAddress(host, NettyRpcServer.PORT));
+            this.addService(rpcServiceConfig);
+            serviceRegistry.registerService(rpcServiceConfig.getRpcServiceName(), new InetSocketAddress(host, NettyRpcServer.PORT));
         } catch (UnknownHostException e) {
             log.error("occur exception when getHostAddress", e);
         }