Flying-snail RPC framework

Introduction

Flying-snail is an RPC(Remote procedure call) framework based on Java.

Features

• Flying-snail could work through traditional socket(BIO) or Netty(NIO, default).
• Following serialization method are supported: Json, Kryo, Hessian(default), Protostuff.
• Support service register center: Nacos(default) and Zookeeper.
• Load balance for service provide.
• No need to worry about TCP adhesive package.

Usage

1 Define the service interface

public interface AddService {
    // define your own service
    public Integer add(Integer a, Integer b);
}

2 Implement service in server-end

// add this goddamn notation
@RPCService
public class AddServiceImpl implements AddService {
    @Override
    public Integer add(Integer a, Integer b) {
        return a + b;
    }
}

3 Run RPC service in server-end

# select your register center and make sure they're running on the port your configured here
snail.zookeeper.address=127.0.0.1:12444
snail.nacos.address=127.0.0.1:12345

// add this notation
@RPCServiceScan
public class NettyTestServer {
    public static void main(String[] args) {
        // Use Netty as transport framework
        NettyServer nettyServer = new NettyServer.Builder()
                .port(9001)
                // Ensure zookeeper or nacos is running
                .serviceRegistry(new ZkServiceRegistry())
                .build();
        nettyServer.scanService();
        // start the service
        nettyServer.start();
    }
}

4 Invoke remote procedure call

public class NettyTestClient {
    public static void main(String[] args) {
        // start client
        NettyClient nettyClient = new NettyClient.Builder()
                .serviceDiscovery(new ZkServiceDiscovery())
                .serializer(SerializerCode.HESSIAN.getCode())
                .build();

        RPCClientProxy clientProxy = new RPCClientProxy(nettyClient);
        AddService addProxy = clientProxy.getProxy(AddService.class);
        // now we can invoke this stupid function remotely
        Integer res = addProxy.add(23, 12);
    }
}

5 Using in Spring

//---------- server ---------
// define a RPC server bean
@RPCScan()
public class SpringContextTestServer {

    @Bean("rpcServer")
    public RPCServer setRPCServer() {
        return new NettyServer.Builder()
                .port(9001)
                // .serviceRegistry(new ZkServiceRegistry())
                .build();
    }

    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SpringContextTestServer.class);
        RPCServer rpcServer = (RPCServer) context.getBean("rpcServer");
        rpcServer.start();
    }
}




//---------- client ---------
// define your RPC client bean
@Component
public class MyClient {
    
    @Bean("rpcClient")
    RPCClient setRpcClient() {
        return new NettyClient.Builder()
                // .serviceDiscovery(new ZkServiceDiscovery())
                .serializer(SerializerCode.PROTOSTUFF.getCode())
                .build();
    }
}

// remote service controller
@Component
@Slf4j
public class MyController {

    @RPCReference
    private HelloService helloService;

    @RPCReference
    private AddService addService;

    @Autowired
    private RPCClient rpcClient;

    public void helloTest() {
        helloService.hello(new HelloObj(11, "WDNMD"));
    }

    public void addTest() {
        log.info("Add 测试...");
        Integer res = addService.add(12, 13);
        log.info("测试结果: {}", res);
    }
}

// invoke remote call
@ComponentScan(basePackages = {"com.catas"})
public class SpringContextTestClient {

    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SpringContextTestClient.class);
        MyController myController = (MyController) context.getBean("myController");

        myController.helloTest();

        myController.addTest();
    }
}