SOFA 提供一套机制去存放各种组件的编程 API,并提供一套统一的方法,让您可以获取到这些 API。组件编程 API 的存放与获取均通过 SOFA 的 ClientFactory 类进行,通过这个 ClientFactory 类,可以获取到对应组件的编程 API。
SOFA 提供两种方式获取 ClientFactory
:
使用 SOFA 组件编程相关的 API,请确保使用的模块里面已经添加了如下的依赖:
<dependency>
<groupId>com.alipay.sofa</groupId>
<artifactId>rpc-enterprise-sofa-boot-starter</artifactId>
</dependency>
获取 ClientFactory
实现 ClientFactoryAware 接口
第一种获取 ClientFactory
的方式是实现 ClientFactoryAware
接口,代码示例如下:
public class ClientFactoryBean implements ClientFactoryAware{
private ClientFactory clientFactory;
@Override
public void setClientFactory(ClientFactory clientFactory){
this.clientFactory = clientFactory;
}
public ClientFactory getClientFactory(){
return clientFactory;
}
}
然后,将上面的 ClientFactoryBean
配置成一个 Spring Bean。
<bean id="clientFactoryBean" class="com.alipay.test.ClientFactoryBean"/>
这样,ClientFactoryBean
就可以获取到 clientFactory
对象来使用了。
使用 @SofaClientFactory 注解
第二种获取 ClientFactory
的方式是使用 @SofaClientFactory
注解,代码示例如下:
public class ClientAnnotatedBean{
@SofaClientFactory
private ClientFactory clientFactory;
public ClientFactory getClientFactory(){
return clientFactory;
}
}
只要在 ClientFactory
字段上加上 @SofaClientFactory
的注解,然后将 ClientAnnotatedBean
配置成一个 Spring Bean 即可。
<bean id="clientAnnotatedBean" class="com.alipay.test.ClientAnnotatedBean"/>
这样,SOFA 框架就会自动将 ClientFactory
的实例注入到被 @SofaClientFactory
注解的字段上了。
不过,这样只是获取到 ClientFactory
这个对象。如果要获取特定的客户端,如 ServiceFactory
,还需要调用 ClientFactory
的 getClient
方法。SOFA 对 @SofaClientFactory
的注解进行了增强,可以直接通过 @SofaClientFactory
来获取具体的 Client,代码示例如下:
public class ClientAnnotatedBean{
@SofaClientFactory
private ServiceClient serviceClient;
public ServiceClient getServiceClient(){
return serviceClient;
}
}
当 @SofaClientFactory
直接使用在具体的 Client 对象上时,此注解可以直接将对应的 Client 对象注入到被注解的字段上。在上述例子中,@SofaClientFactory
是直接注解在类型为 ServiceClient
的字段上,SOFA 框架会直接将 ServiceClient
对象注入到这个字段上。只要是在 ClientFactory
中存在的对象,都可以通过此种方式来获得。
编程 API 示例
服务的发布与订阅不仅可以通过在 XML 中配置 Spring Bean 的方式在应用启动期静态加载,也可以采用编程 API 的方式在应用运行期动态执行,用法如下。
BOLT 服务发布
ServiceClient serviceClient = clientFactory.getClient(ServiceClient.class);
ServiceParam serviceParam = new ServiceParam();
serviceParam.setInstance(sampleService);
serviceParam.setInterfaceType(SampleService.class);
serviceParam.setUniqueId(uniqueId);
TrBindingParam trBinding = new TrBindingParam();
// 对应 global-attrs 标签
trBinding.setClientTimeout(5000);
serviceParam.addBindingParam(trBinding);
serviceClient.service(serviceParam);
BOLT 服务引用
ReferenceClient referenceClient = clientFactory.getClient(ReferenceClient.class);
ReferenceParam<SampleService> referenceParam = new ReferenceParam<SampleService>();
referenceParam.setInterfaceType(SampleService.class);
referenceParam.setUniqueId(uniqueId);
TrBindingParam trBinding = new TrBindingParam();
// 对应 global-attrs 标签
trBinding.setClientTimeout(8000);
// 对应 method 标签
TrBindingMethodInfo trMethodInfo = new TrBindingMethodInfo();
trMethodInfo.setName("helloMethod");
trMethodInfo.setType("callback");
// 对象必须实现 com.alipay.sofa.rpc.api.callback.SofaResponseCallback 接口
trMethodInfo.setCallbackHandler(callbackHandler);
trBinding.addMethodInfo(trMethodInfo);
referenceParam.setBindingParam(trBinding);
SampleService proxy = referenceClient.reference(referenceParam);
通过动态客户端创建 SOFA Reference 返回的对象是一个非常重的对象,在使用的时候不要频繁创建,自行做好缓存,否则可能存在内存溢出的风险。 因为编程 API 的类不能轻易变化,类名为了兼容以前的用法,保持 TR 写法,但实际其中走的是 BOLT 协议。
在文档使用中是否遇到以下问题
更多建议
匿名提交