Skip to content
This repository was archived by the owner on May 30, 2022. It is now read-only.

Latest commit

 

History

History

sofa-boot-samples

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
README.md
README.md
 
 
pom.xml
pom.xml
 
 

README.md

如何在 SOFABoot 环境中使用 SOFARPC

简介

该用例工程演示如何在 SOFABoot 环境中使用 SOFARPC，阅读该文档之前，建议先了解 SOFARPC 和 SOFABoot

在本地启动Zookeeper

在运行本示例工程之前，需要先在本地启动一个 Zookeeper 服务端。本工程已经提供了一个 Zookeeper 的启动类，运行该类的主函数即可: com.alipay.sofa.rpc.samples.util.LocalZookeeperServer

引入 SOFABoot 依赖

SOFABoot 提供了如健康检查，上下文隔离等基础能力，同时提供了多种中间件进行选择使用。 SOFABoot 对这些提供这些能力的依赖利用如下 pom 进行了管控，将工程的 parent 设为该 pom 。

<parent>
    <groupId>com.alipay.sofa</groupId>
    <artifactId>sofaboot-dependencies</artifactId>
    <version>2.4.5</version>
</parent>

引入 SOFARPC Starter

SOFARPC Starter 是 SOFARPC 基于 SOFABoot 实现的框架，能够将 SOFARPC 的能力以统一的编程界面和简单的操作形式提供给使用者。该依赖已被 SOFABoot 管控，用户只需要引入如下依赖：

<dependency>
     <groupId>com.alipay.sofa</groupId>
     <artifactId>rpc-sofa-boot-starter</artifactId>
 </dependency>

声明 SOFABoot 的 xsd 文件

在要使用的 XML 配置文件中将头部 xsd 文件的声明设置为如下。这样就能够使用 SOFABoot 定义的 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:sofa="http://sofastack.io/schema/sofaboot"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
            http://sofastack.io/schema/sofaboot http://sofastack.io/schema/sofaboot.xsd"
       default-autowire="byName">

使用 Zookeeper 作为注册中心

在 application.properties 中配置如下，就能够使用 Zookeeper 作为注册中心。

com.alipay.sofa.rpc.registry.address=zookeeper://127.0.0.1:2181

服务发布

在 XML 中配置如下，就能够发布一个 SOFARPC 服务。

<bean id="helloSyncServiceImpl" class="com.alipay.sofa.rpc.samples.invoke.HelloSyncServiceImpl"/>

<sofa:service ref="helloSyncServiceImpl" interface="com.alipay.sofa.rpc.samples.invoke.HelloSyncService">
    <sofa:binding.bolt/>
</sofa:service>

其中 service 元素表示发布该服务 binding 元素声明了该服务提供的调用协议。

服务引用

在 XML 中配置如下，就能够引用 SOFARPC 服务。

<sofa:reference id="helloSyncServiceReference" interface="com.alipay.sofa.rpc.samples.invoke.HelloSyncService">
    <sofa:binding.bolt/>
</sofa:reference>

其中 reference 元素表示引用该服务，binding 元素声明了该服务引用的调用的协议。如上就在 Spring 上下文中构建了一个服务的远程代理类，名字为 helloSyncServiceReference 。

服务调用

从 Spring 上下文中获取到需要的服务引用，发起远程调用。

HelloSyncService helloSyncServiceReference = (HelloSyncService) applicationContext.getBean("helloSyncServiceReference");

System.out.println(helloSyncServiceReference.saySync("sync"));

参数设置

在声明服务发布或引用的同时也可以设置需要的参数。

<sofa:reference id="helloSyncServiceReference" interface="com.alipay.sofa.rpc.samples.invoke.HelloSyncService">
    <sofa:binding.bolt>
        <sofa:global-attrs timeout="3000" address-wait-time="2000"/>
        <sofa:route target-url="127.0.0.1:22000"/>
        <sofa:method name="saySync" timeout="3000"/>
    </sofa:binding.bolt>
</sofa:reference>

如上示例， global-attrs 元素中可以设置调用超时，地址等待时间等参数； target-url 能够设置直连调用的地址； method 标签能够设置方法级别参数。

Filter配置

在 SOFABoot 环境中可以方便的进行 Filter 的配置。

1.全局生效方式。通过 rpc-global-filter 元素配置一个对所有服务都会生效的 Filter 。

<bean id="sampleFilter" class="com.alipay.sofa.rpc.samples.filter.SampleFilter"/>

<sofa:rpc-global-filter ref="com.alipay.sofa.rpc.samples.filter.SampleFilter"/>

2.服务生效方式。只对指定的服务生效。

<bean id="sampleFilter" class="com.alipay.sofa.rpc.samples.filter.SampleFilter"/>

<sofa:service ref="filterService" interface="com.alipay.sofa.rpc.samples.filter.FilterService">
    <sofa:binding.bolt>
        <sofa:global-attrs filter="sampleFilter"/>
    </sofa:binding.bolt>
</sofa:service>

泛化调用

在 SOFABoot 环境中可以如下声明一个泛化调用的引用。

<sofa:reference id="sampleGenericServiceReference" interface="com.alipay.sofa.rpc.api.GenericService">
    <sofa:binding.bolt>
        <sofa:global-attrs generic-interface="com.alipay.sofa.rpc.samples.generic.SampleGenericService"/>
    </sofa:binding.bolt>
</sofa:reference>

然后利用该代理在代码中进行泛化调用。

GenericService sampleGenericServiceReference = (GenericService) applicationContext.getBean("sampleGenericServiceReference");

GenericObject genericObject = new GenericObject("com.alipay.sofa.rpc.samples.generic.SampleGenericParamModel");
genericObject.putField("name", "Bible");

GenericObject result = (GenericObject) sampleGenericServiceReference.$genericInvoke("sayGeneric",
            new String[] { "com.alipay.sofa.rpc.samples.generic.SampleGenericParamModel" },
            new Object[] { genericObject });

System.out.println(result.getType());
System.out.println(result.getField("name"));
System.out.println(result.getField("value"));

自定义线程池

在 SOFABoot 环境中可以如下为一个服务设置一个自定义线程池。

<bean id="customerThreadPool" class="com.alipay.sofa.rpc.server.UserThreadPool" init-method="init">
    <property name="corePoolSize" value="10"/>
    <property name="maximumPoolSize" value="10"/>
    <property name="queueSize" value="5"/>
    <property name="threadPoolName" value="customerThreadPool_name"/>
</bean>

<bean id="threadPoolServiceImpl" class="com.alipay.sofa.rpc.samples.threadpool.ThreadPoolServiceImpl"/>

<sofa:service ref="threadPoolServiceImpl" interface="com.alipay.sofa.rpc.samples.threadpool.ThreadPoolService">
    <sofa:binding.bolt>
        <sofa:global-attrs thread-pool-ref="customerThreadPool"/>
    </sofa:binding.bolt>
</sofa:service>

直连调用

在 SOFABoot 环境中可以如下进行直连调用。利用 target-url 属性调用指定的协议， ip 和端口。

<sofa:reference id="directServiceReference" interface="com.alipay.sofa.rpc.samples.direct.DirectService">
    <sofa:binding.bolt>
        <sofa:route target-url="bolt://127.0.0.1:12200"/>
    </sofa:binding.bolt>
</sofa:reference>

负载均衡

在 SOFABoot 环境中可以如下选择负载均衡的方式，利用 loadBalancer 属性指定调用时候使用的负载均衡策略。目前支持 random ， localPref ， roundRobin ， consistentHash ， weightRoundRobin 。

<sofa:reference id="loadBalancerServiceReference" interface="com.alipay.sofa.rpc.samples.loadBalancer.LoadBalancerService">
    <sofa:binding.bolt>
        <sofa:global-attrs loadBalancer="random"/>
    </sofa:binding.bolt>
</sofa:reference>

调用重试

调用的重试次数，即在第一次调用失败后重试的最大次数，如果重试成功则不再继续重试。在 SOFABoot 环境中可以如下设置调用次数，利用 retries 属性指定重试次数。

<sofa:reference id="retriesServiceReferenceBolt" interface="com.alipay.sofa.rpc.samples.retries.RetriesService">
    <sofa:binding.bolt>
        <sofa:global-attrs retries="2"/>
    </sofa:binding.bolt>
</sofa:reference>

lazy 连接

lazy连接，即客户端在第一次调用时才和所要调用的远程地址建立连接。默认情况下是在注册中心推送地址到客户端时就立即建立好连接，这个过程通常是在第一次调用之前进行的。在 SOFABoot 环境中可以如下设置 lazy 连接方式，将 lazy 属性设为 true 。

<sofa:reference id="lazyServiceReferenceBolt" interface="com.alipay.sofa.rpc.samples.lazy.LazyService">
    <sofa:binding.bolt>
        <sofa:global-attrs lazy="true"/>
    </sofa:binding.bolt>
</sofa:reference>