一个基于Java Spi机制实现的远程服务调用组件

最新推荐文章于 2023-04-06 18:01:00 发布
最新推荐文章于 2023-04-06 18:01:00 发布
阅读量306 收藏
点赞数
分类专栏： 开源共享 文章标签： java xml 服务器
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/javacoo/article/details/122208895
版权

remoting

介绍

远程服务调用组件
1.远程服务调用组件是基于Java SPI(Service Provider Interface)机制实现，具有插件式，高度可扩展，集成使用简单等特点。
2.独创的XML配置格式及配套解析方法，让远程接口配置更为简单，处理更为灵活，
3.组件提供统一的远程服务调用API，解决了远程服务调用代码分散，实现各异，配置硬编码等问题。
4.同时统一抽象的调用器接口使得每个服务的具体通信方式和格式对使用者都是透明的，可通过配置不同的调用器类来支持相应的调用策略。
5.远程服务调用组件，屏蔽了具体的通信方式和数据格式转换细节，程序员只需要传入参数对象和服务ID即可。

软件架构

类关系模型

image

基于XML配置文件，配置远程接口，提供统一远程调用API，解决了远程服务调用代码分散，配置硬编码在代码中，开发效率低下的问题。与现在使用的大多数方法相比，本方法简化了远程服务调用流程，配置灵活,开发效率大大提高,具体内容如下：

  1. 独创XML配置格式：
<services>

	 <http-endpoint id="http_credits" service-addr="/v1/integral/"type="https">
	 		<host address="www.test.com" port="" appKey="30a10e21" secretKey="43351af641be41e08d398f6952d4b8c1" livemode="0" scope="INTEGRAL" />
	 </http-endpoint>

   <import service-id="add" api="add" endpoint-ref="http_credits">
     <url-param name="accesstoken">#accessToken</url-param>
     <data-param name="appid">#appKey</data-param>
     <data-param name="livemode">#livemode</data-param>
   </import>

</services>

  1. XML解析模块：系统启动时，读取XML配置文件，经过XML文件格式校验，节点完整性校验，节点数据格式合法性校验，解析等过程，最终将XML信息转换为系统内部接口服务元数据信息，保存在内存中，供下一步使用。

  2. 服务注册模块：完成XML解析之后，服务注册模块，读取接口服务元数据信息，将原数据信息转换为服务调用模块需要的接口服务信息格式，保存在内存中，供服务调用模块使用。

  3. 接口服务调用模块：提供了统一的远程服务调用接口，程序根据服务ID定位到已经注册的远程服务接口，传入请求参数，即可完成远程服务的调用，屏蔽了不同服务接口，请求方式，参数格式，协议类型等差异，让使用更为简单，开发效率更高。

  4. 服务响应处理模块：接口服务调用模块完成服务调用后，返回信息将由此模块进行统一处理，将不同接口服务响应数据格式转换为统一的接口响应格式，也可根据不同接口配置不同的响应数据处理（扩展开发），屏蔽了响应数据格式差异。

安装教程

  1. Maven工程导入方式：pom.xml 文件添加如下依赖

    <dependency>
   <groupId>com.remoting</groupId>
   <artifactId>remoting-core</artifactId>
   <version>1.0.0</version>
</dependency>

  2. jar包引入方式：导入以下包到工程

    remoting-api-1.0.0.jar
remoting-core-1.0.0.jar
remoting-tools-1.0.0.jar
使用说明

  1. 配置：以jar包引入方式，需要配置remoting.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:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
                        http://www.springframework.org/schema/beans/spring-beans-3.2.xsd  
                        http://www.springframework.org/schema/context
                        http://www.springframework.org/schema/context/spring-context-3.2.xsd">

	<!-- 远程服务调用器 -->
	<bean id="remoteServiceExecutor"
		class="com.remoting.core.http.HttpRemoteServiceExecutor">
		<!-- 构造函数：远程服务配置  -->
		<constructor-arg ref="remoteSetting" />
	</bean>
	<!-- 远程服务配置 -->
	<bean id="remoteSetting"
		class="com.remoting.api.RemoteSetting">
		<!-- 远程服务配置文件路径 -->
		<property name="configLocation" value="service-import*.xml" />
		<!-- 连接池最大并发连接数 -->
		<property name="maxTotal" value="300" />
		<!-- 单路由最大并发数 -->
		<property name="defaultMaxPerRoute" value="50" />
		<!-- 数据传输处理时间(毫秒) -->
		<property name="socketTimeout" value="4000" />
		<!-- 建立连接的timeout时间(毫秒) -->
		<property name="connectionTimeout" value="3000" />
		<!-- 从连接池中获取连接的timeout时间(毫秒) -->
		<property name="connectionRequestTimeout" value="1000" />
	</bean>
</beans>

  2. 远程服务注册配置

    <?xml version="1.0" encoding="UTF-8"?>
<services>
    <!-- 注意：accessToken,livemode,appKey,secretKey 为系统变量，以#开头使用，使用后节点的值将会被替换为系统生成的值 -->
	<http-endpoint id="http_personalizedRecommend" service-addr="/CHiQ3/launcher/" type="http">
		<!-- 服务器地址
		<host address="chiq3.chiq-cloud.com" />-->
		<!-- 测试服务器地址 -->
		<host address="chiq3.test-cloud.com" port="" />
	</http-endpoint>
	<!-- 获取子类目个性化推荐 -->
	<import service-id="together" api="together" endpoint-ref="http_personalizedRecommend" request-type="post" ></import>
	
</services>

  3. 配置参数说明

    注意：accessToken,livemode,appKey 为系统变量，以#开头使用，使用后节点的值将会被替换为系统生成的值
    对应配置文件说明：

    http-endpoint 节点
    属性
    id:服务地址节点ID,全局唯一。
    Service-addr:路径。
    Type:类型。
    Host子点：
    属性
    address：地址。
    port：端口。
    appKey：应用的唯一标示
    secretKey：安全码
    livemode：模式
    scope：作用域
    http-header 节点
    属性
    id:服务地址节点ID,全局唯一。
    charset:编码类型。
    Header子点：
    属性
    name：header键。
    Import 节点：要导入的接口
    属性
    Service-id:服务ID，全局唯一。
    Api: 即积分系统发布的接口名称。
    Endpoint-ref:服务地址配置引用ID。
    Header-ref:http请求头信息配置引用ID。
    request-type:请求方式（post,get），默认post。
    子节点
    url-param:需要添加到URL中的参数配置。
    data-param:需要添加到请求参数中的参数配置。
    注意：取值支持SpingEL表达式，需在请求参数中配置该值，如

     <!-- 积分查询 -->
	<import service-id="query" api="" endpoint-ref="http_credits" request-type="get">
		<url-param name="accesstoken">#accessToken</url-param>
		<url-param name="appid">#appKey</url-param>
		<url-param name="livemode">#livemode</url-param>
	</import>

    Key 也支持SpingEL表达式：根据配置的EL表达式找到对应的节点并添加对应的字段（要添加的节点必须存在）如

      <!-- 推送消息 -->
	<import service-id="pushMsg" api="pushMsg" endpoint-ref="http_mag">
		<data-param name="apikey">#appKey</data-param>
		<data-param name="secretkey">#secretKey</data-param>
		<data-param name="mType">THIRD</data-param>
		<data-param name="apiversion">1.0</data-param>
		<data-param name="['tag']['online']">0</data-param>
		<data-param name="['tag']['userflag']">2</data-param>
		<data-param name="['tag']['target']['condition']">AND</data-param>
	</import>

    特别说明：

    1. url-param:需要添加到URL中的参数配置。
      如上例中的：
    ```
 <url-param name="accesstoken">#accessToken</url-param>
```

​      对应积分系统发布的接口规范中，url部分：

```
 https://www.xxx.com?accesstoken=xxx
```

 其中url-name 节点中的 name属性对应的值为url中的accesstoken(注意大小写与url中保持一致)。

accessToken 则表示引用系统变量accessToken，系统自动识别，根据endpoint-ref引用配置中host配置(appKey, secretKey, scope)，以及当前import节点属性api的值，生成accessToken。

    1. data-param:需要添加到请求参数中的参数配置。
      如上例中的：

      <url-param name="appid">#appKey</url-param>
<url-param name="livemode">#livemode</url-param>

      对应积分系统发布的接口规范中，正文部分相应的字段。

    像这种会根据服务器环境变化而变化，且在请求参数中的参数，可以用此节点配置，配置后，调用程序中就不需要再设置。
    其中url-name 节点中的 name属性对应的值为接口规范请求参数中的key。
    3. url-param ，data-param:
    取值支持SpingEL表达式，需在请求参数中配置该值。
    如：

    <url-param name="token]">['token']</data-param>

    Key EL表达式

    <data-param name="['tag']['online']">0</data-param>
    1. Header-ref:
      http请求头信息引用ID，如果不设置则使用组件默认值:
      即：Content-Type:application/json，编码为:UTF-8

  4. 程序调用

    package com.remoting;

import com.remoting.api.RemoteServiceExecutor;
import com.remoting.api.RemoteSetting;
import com.remoting.api.spi.executor.RemoteServiceExecutorFactory;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.HashMap;
import java.util.Map;

/**
 * Unit test for simple App.
 */
public class RemotingTest extends TestCase {
	private final Logger logger = LoggerFactory.getLogger(RemotingTest.class);
	private RemoteServiceExecutor remoteExecutor;
	protected void setUp() throws Exception {
		remoteExecutor = remoteExecutor();
	}
	private RemoteServiceExecutor remoteExecutor(){
		return RemoteServiceExecutorFactory.create();
	}
	/**
	 * 构建远程服务配置
	 * <p>说明:</p>
	 * <li></li>
	 * @author DuanYong
	 * @return
	 * @since 2017年7月31日下午4:45:39
	 */
	private RemoteSetting createRemoteSetting() {
		RemoteSetting remoteSetting = new RemoteSetting();
		remoteSetting.setConfigLocation("remoting/service-import*.xml");
		remoteSetting.setConnectionRequestTimeout(5 * 1000);
		remoteSetting.setConnectionTimeout(3 * 1000);
		remoteSetting.setDefaultMaxPerRoute(50);
		remoteSetting.setSocketTimeout(4 * 1000);
		remoteSetting.setMaxTotal(300);
		return remoteSetting;
	}
	/**
	 * Create the test case
	 *
	 * @param testName
	 *            name of the test case
	 */
	public RemotingTest(String testName) {
		super(testName);
	}

	/**
	 * @return the suite of tests being tested
	 */
	public static Test suite() {
		return new TestSuite(RemotingTest.class);
	}

	/**
	 * Rigourous Test :-)
	 */
	public void testApp() {
//		Map<String, Object> param = new HashMap<String, Object>();
//		param.put("mac", "18-99-f5-5d-71-c7");
//		param.put("sversion", "ZLM65HiS2_0.00094");
//		param.put("img_size", "300,564");
//		param.put("keyword", "tv");
//		Object resultObj = remoteExecutor.execute("together", param);
//		assertNotNull(resultObj);
		
		Map<String, Object> param = new HashMap<String, Object>();
		param.put("billUserId", "2088102971016535");
		param.put("startTime", "2019-02-18");
		param.put("endTime", "2019-02-19");
		param.put("ctoken", "u6vanf_DNIG55OWM");
		Object resultObj = remoteExecutor.execute("tradeListQuery", param);
		logger.info(resultObj.toString());
		System.out.println(resultObj.toString());
		assertNotNull(resultObj);
	}
	public void testTogether() {
		Map<String, Object> param = new HashMap<String, Object>();
		param.put("mac", "18-99-f5-5d-71-c7");
		param.put("sversion", "ZLM65HiS2_0.00094");
		param.put("img_size", "300,564");
		param.put("keyword", "tv");
		Object resultObj = remoteExecutor.execute("together", param);
		assertNotNull(resultObj);
	}

}
项目信息
路漫漫其修远兮,吾将上下而求索
码云：https://gitee.com/javacoo/remoting
QQ：164863067
作者/微信：javacoo
邮箱：xihuady@126.com
下载地址

https://gitee.com/javacoo/remoting

javacoo
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Apache Dubbo是一个高性能的，基于Java的开源RPC服务框架
05-24
Apache Dubbo是一个由阿里巴巴开发并开源的高性能Java RPC（Remote Procedure Call）服务框架，它旨在提高微服务架构中的服务间通信效率。Dubbo的核心特性包括服务注册与发现、负载均衡、容错机制、以及监控与管理，...
1. SPI应用场景之 DUBBO SPI
Fighting!
08-10 1517
一、DUBBO SPI使用场景 动态根据配置加载对应实现类，SPI扩展的类有非常多： 二、dubbo spi 扩展点 ①dubbo SPI基础： 根据META-INF文件下的key获取类名，再获取类的实例 对应方法为，getExtension()，举例： LoadBalance loadBalance = ExtensionLoader.getExtensionL...
Java中的SPI机制及接口多实现调用
mengo的博客
11-19 1978
1、SPI机制 SPI 全称为 (Service Provider Interface) ，是JDK内置的一种服务提供发现机制。 SPI充分体现了面向接口编程的特点。系统内置接口方法，在实际运行中用户可以自定义实现类来满足不通的实现需求。 SPI机制在JDK的DriverManager、Spring、Dubbo中得到了充分的利用，Dubbo中更是扩展了SPI机制来实现组件的可扩展性。 ...
如何跨项目使用SPI扩展点
haohao_csdn的博客
06-19 1310
    SPI-服务扩展点可以使得项目结构更加解耦，比如我司在支付方式模块中，全平台都可以使用在线支付，单由于业务场景要求，不同的业务实例会有定制化的支付方式，如非国有性质的采购人可以申请使用账期支付等。原先的技术实现是有订单模块代码中根据业务实例写死一堆的if-else业务实现，随着接入业务的增加，代码变得越来越臃肿和不可维护。为了该模块更具扩展性和易维护性，我们希望通过由订单中心提供支付方式SPI扩展接口，不同的业务线可以更灵活的配置各自的支付方式。     在一个项目中定义一个扩展接口，然后写不同的实
Java SPI机制使用及实际案例分析
一个爱分享的人
07-09 710
SPI机制
SPI机制原理和应用
weixin_41821642的博客
04-06 633
SPI全称Service Provider Interface，是Java提供的一套用来被第三方实现或者扩展的接口，它可以用来启用框架扩展和替换组件。SPI的作用就是为这些被扩展的API寻找服务实现。本质是将接口实现类的全限定名配置在文件中，并由服务加载器读取配置文件，加载实现类。这样可以在运行时，动态为接口替换实现类。通过在ClassPath路径下的META-INF/services文件夹查找文件，自动加载文件里所定义的类，进而实现可插拔，解耦。项目推荐。
dubbo spi可扩展机制源码解析
12-24
Dubbo SPI（Service Provider Interface）是阿里巴巴开源的Dubbo框架中的一个重要特性，它提供了一种动态发现服务提供者和加载实现类的机制，使得服务消费者无需关心服务提供者的具体实现，增强了系统的可扩展性和...
基于dubbo实现的rpc框架RPC
最新发布
10-18
通过定义服务接口，服务提供者实现接口并暴露服务，服务消费者通过接口引用服务，完成远程调用。同时，Dubbo的监控台能够实时展示服务调用的各类指标，便于运维和性能优化。 总结来说，基于Dubbo的RPC框架为JAVA...
JAVA_API1.6文档（中文）
04-12
javax.imageio.spi 包含用于 reader、writer、transcoder 和流的插件接口以及一个运行时注册表的 Java Image I/O API 包。 javax.imageio.stream Java Image I/O API 的一个包，用来处理从文件和流中产生的低级别 I...
java api最新7.0
10-26
javax.imageio.spi 包含用于 reader、writer、transcoder 和流的插件接口以及一个运行时注册表的 Java Image I/O API 包。 javax.imageio.stream Java Image I/O API 的一个包，用来处理从文件和流中产生的低级别 I/...
使用SPI解耦服务调用
nickDaDa的博客
08-08 362
在开发java组件时，一个功能组件往往需要支持多种规范，在客户端调用时需要根据不同情况，进行不同的服务调用。不需要外挂配置文件，通过修改jar包的META-INF/services/全路径类型的文件（内容为需要使用的服务的全路径类名）的方式来实现。使用场景：客户端添加一些service选择逻辑，配合jar包的配置文件，灵活调用组件的实现。方案一：使用配置文件，通过外部挂载一个配置文件，客户端读取配置文件，根据配置类型调用组件的服务。客户端使用组件时，需要根据自身情况调用不同协议版本的服务。...
通过SPI方式实现LPC17xx的远程升级设计
佐佐沐
07-02 8190
本方案基于NXP的LPC1768微处理器为平台，使用KEIL MDK4.70A为开发工具，通过SPI的方式实现程序的自动更新。本方案参考NXP官方的应用手册AN11257为蓝本。   程序设计： 程序由三部分组成bootloader、低区用户程序，高区用户程序。Bootloader实现程序的跳转及IAP程序的烧写。低区程序位于LPC1768的0x1000~0x2FFFF处，高区程序位于LPC
几种通讯协议的比较
taoff的专栏
12-06 3207
 一、综述本文比较了RMI，Hessian，Burlap，Httpinvoker，web service等5种通讯协议的在不同的数据结构和不同数据量时的传输性能。RMI是java语言本身提供的远程通讯协议，稳定高效，是EJB的基础。但它只能用于JAVA程序之间的通讯。Hessian和Burlap是caucho公司提供的开源协议，基于HTTP传输，服务端不用开防火墙端口。协议的规范公
自定义实现一个RPC框架（二）
开心就好
05-29 5897
文章目录自定义实现一个RPC框架（二）：地址：https://gitee.com/liyunfengfengfeng/rpcspispi基础扩展DubboSpiJavaSpiProtocolHttpProtocolDubboProtocolspi配置文件 自定义实现一个RPC框架（二）： 地址：https://gitee.com/liyunfengfengfeng/rpc spi 在扩展类的 jar 包内 [1]，放置扩展点配置文件 META-INF/dubbo/接口全 限定名，内容为：配置名=扩展实现类全
几种远程调用接口协议简单比较
二师兄
09-20 5834
协议 dubbo rmi hessian http webservice 连接个数 单连接 多连接  多连接  多连接  多连接  连接方式 长连接 短连接 短连接 短连接 短连接 传输协议 TCP TCP HTTP HTTP HTTP
5.RPC框架的简单实现（SPI机制-ProtocolFactory）
真相不难
09-11 930
dubbo框架中广泛使用了SPI的思想，很多dubbo源码解析的相关资料也是把基于SPI机制的dubbo内核实现作为了解dubbo源码的第一讲，dubbo源码中的ExtensionFactory、Protocol、Complier等大多数接口类都是基于SPI思想的。ldubbo这个自己实现的rpc框架也加入SPI的简单实现
【RPC】远程接口调用实例
热门推荐
crainnogao的博客
04-12 1万+
实例之前可以先了解一个东西--HttpInvoker。HTTPInvoker使用原理Spring HTTP Invoker：使用HTTP协议，允许穿透防火墙，使用JAVA系列化方式，但仅限于Spring应用之间使用，即调用者与被调用者都必须是使用Spring框架的应用。服务器端：基于现在的多模块项目开发，我新建了一个client模块，这个模块专门为客户端提供rpc的远程调用接口。/** * @d...
[ Java ] 到底什么是 SPI ？
削尖螺丝刀的钉文
05-15 366
昨天在和我的小伙伴探讨Druid源码的时候，他提出了一个问题，问题是这样描述的：DruidDataSource#getConnection中的 init 执行 DruidDriver.getInstance 的时候是如何把其他驱动注册的，也就是下面这里： public void init() throws SQLException { if (inited) { return; } ...
Dubbo 源码分析详解：架构、核心机制、远程调用流程解析
Dubbo 是一个高性能、基于 Java 的开源 RPC 框架，提供了分布式应用系统的服务治理解决方案。本文将对 Dubbo 的源代码进行深入分析，涵盖了 Dubbo 的架构、核心机制、Extension 机制、代理、远程调用流程、过程分析...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

javacoo

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值