2019 09 01 手写RPC框架第一章《自定义配置xml》
作者：小傅哥
博客：https://bugstack.cn - 原创系列专题
沉淀、分享、成长，让自己和他人都能有所收获！
本案例通过三个章节来实现一共简单的rpc框架，用于深入学习rpc框架是如何通信的，当前章节主要介绍如何自定义xml文件并进行解析。想解析自定义的xml首先定义自己的xsd文件，并且实现spring的NamespaceHandlerSupport、BeanDefinitionParser，两个方法进行处理。
远程过程调用协议 RPC（Remote Procedure Call）—远程过程调用，它是一种通过网络从远程计算机程序上请求服务，而不需要了解底层网络技术的协议。RPC协议假定某些传输协议的存在，如TCP或UDP，为通信程序之间携带信息数据。在OSI网络通信模型中，RPC跨越了传输层和应用层。RPC使得开发包括网络分布式多程序在内的应用程序更加容易。 RPC采用客户机/服务器模式。请求程序就是一个客户机，而服务提供程序就是一个服务器。首先，客户机调用进程发送一个有进程参数的调用信息到服务进程，然后等待应答信息。在服务器端，进程保持睡眠状态直到调用信息到达为止。当一个调用信息到达，服务器获得进程参数，计算结果，发送答复信息，然后等待下一个调用信息，最后，客户端调用进程接收答复信息，获得进程结果，然后调用执行继续进行。
Dubbo是 [1] 阿里巴巴公司开源的一个高性能优秀的服务框架，使得应用可通过高性能的 RPC 实现服务的输出和输入功能，可以和 [2] Spring框架无缝集成。 Dubbo是一款高性能、轻量级的开源Java RPC框架，它提供了三大核心能力：面向接口的远程方法调用，智能容错和负载均衡，以及服务自动注册和发现。
- jdk 1.8.0
- IntelliJ IDEA Community Edition 2018.3.1 x64
itstack-demo-rpc-01
└── src
└── main
│ ├── java
│ │ └── org.itstack.demo.rpc.config
│ │ ├── spring
│ │ │ ├── bean
│ │ │ │ ├── ConsumerBean.java
│ │ │ │ ├── ProviderBean.java
│ │ │ │ └── ServerBean.java
│ │ │ ├── MyBeanDefinitionParser.java
│ │ │ └── MyNamespaceHandler.java
│ │ ├── ConsumerConfig.java
│ │ ├── ProviderConfig.java
│ │ └── ProviderConfig.java
│ └── resource
│ └── META-INF
│ ├── rpc.xsd
│ ├── spring.handlers
│ └── spring.schemas
└── test
├── java
│ └── org.itstack.demo.test
│ ├── service
│ │ ├── impl
│ │ │ └── HelloServiceImpl.java
│ │ └── HelloService.java
│ └── ApiTest.java
└── resource
├── itstack-rpc-consumer.xml
├── itstack-rpc-provider.xml
└── log4j.xml
ProviderConfig.java
public class ProviderConfig {
private String nozzle; //接口
private String ref; //映射
private String alias; //别名
//发布
protected void doExport() {
System.out.format("生产者信息=> [接口：%s] [映射：%s] [别名：%s] \r\n", nozzle, ref, alias);
}
public String getNozzle() {
return nozzle;
}
public void setNozzle(String nozzle) {
this.nozzle = nozzle;
}
public String getRef() {
return ref;
}
public void setRef(String ref) {
this.ref = ref;
}
public String getAlias() {
return alias;
}
public void setAlias(String alias) {
this.alias = alias;
}
}ProviderBean.java
public class ProviderBean extends ProviderConfig implements ApplicationContextAware {
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
//发布生产者
doExport();
}
}MyBeanDefinitionParser.java
public class MyBeanDefinitionParser implements BeanDefinitionParser {
private final Class<?> beanClass;
MyBeanDefinitionParser(Class<?> beanClass) {
this.beanClass = beanClass;
}
@Override
public BeanDefinition parse(Element element, ParserContext parserContext) {
RootBeanDefinition beanDefinition = new RootBeanDefinition();
beanDefinition.setBeanClass(beanClass);
beanDefinition.setLazyInit(false);
String beanName = element.getAttribute("id");
parserContext.getRegistry().registerBeanDefinition(beanName, beanDefinition);
for (Method method : beanClass.getMethods()) {
if (!isProperty(method, beanClass)) continue;
String name = method.getName();
String methodName = name.substring(3, 4).toLowerCase() + name.substring(4);
String value = element.getAttribute(methodName);
beanDefinition.getPropertyValues().addPropertyValue(methodName, value);
}
return beanDefinition;
}
private boolean isProperty(Method method, Class beanClass) {
String methodName = method.getName();
boolean flag = methodName.length() > 3 && methodName.startsWith("set") && Modifier.isPublic(method.getModifiers()) && method.getParameterTypes().length == 1;
Method getter = null;
if (!flag) return false;
Class<?> type = method.getParameterTypes()[0];
try {
getter = beanClass.getMethod("get" + methodName.substring(3));
} catch (NoSuchMethodException ignore) {
}
if (null == getter) {
try {
getter = beanClass.getMethod("is" + methodName.substring(3));
} catch (NoSuchMethodException ignore) {
}
}
flag = getter != null && Modifier.isPublic(getter.getModifiers()) && type.equals(getter.getReturnType());
return flag;
}
}MyNamespaceHandler.java
public class MyNamespaceHandler extends NamespaceHandlerSupport {
@Override
public void init() {
registerBeanDefinitionParser("consumer", new MyBeanDefinitionParser(ConsumerBean.class));
registerBeanDefinitionParser("provider", new MyBeanDefinitionParser(ProviderBean.class));
registerBeanDefinitionParser("server", new MyBeanDefinitionParser(ServerBean.class));
}
}rpc.xsd
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns="http://rpc.itstack.org/schema/rpc"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:beans="http://www.springframework.org/schema/beans"
targetNamespace="http://rpc.itstack.org/schema/rpc"
elementFormDefault="qualified" attributeFormDefault="unqualified">
<xsd:import namespace="http://www.springframework.org/schema/beans"/>
<!-- org.itstack.demo.rpc.config.ServerConfig -->
<xsd:element name="server">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="beans:identifiedType">
<xsd:attribute name="host" type="xsd:string">
<xsd:annotation>
<xsd:documentation><![CDATA[ 栈台地点 ]]></xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="port" type="xsd:string">
<xsd:annotation>
<xsd:documentation><![CDATA[ 栈台岸口 ]]></xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
<!-- org.itstack.demo.rpc.config.ConsumerConfig -->
<xsd:element name="consumer">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="beans:identifiedType">
<xsd:attribute name="nozzle" type="xsd:string">
<xsd:annotation>
<xsd:documentation><![CDATA[ 接口名称 ]]></xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="alias" type="xsd:string">
<xsd:annotation>
<xsd:documentation><![CDATA[ 服务别名分组信息 ]]></xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
<!-- org.itstack.demo.rpc.config.ProviderConfig -->
<xsd:element name="provider">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="beans:identifiedType">
<xsd:attribute name="nozzle" type="xsd:string">
<xsd:annotation>
<xsd:documentation><![CDATA[ 接口名称 ]]></xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="ref" type="xsd:string">
<xsd:annotation>
<xsd:documentation><![CDATA[ 接口实现类 ]]></xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="alias" type="xsd:string">
<xsd:annotation>
<xsd:documentation><![CDATA[ 服务别名分组信息 ]]></xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
</xsd:schema>spring.handlers
http\://rpc.itstack.org/schema/rpc=org.itstack.demo.rpc.config.spring.MyNamespaceHandler
spring.schemas
http\://rpc.itstack.org/schema/rpc/rpc.xsd=META-INF/rpc.xsd
itstack-rpc-consumer.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:rpc="http://rpc.itstack.org/schema/rpc"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://rpc.itstack.org/schema/rpc http://rpc.itstack.org/schema/rpc/rpc.xsd">
<!-- redis配置，保存链接 -->
<rpc:server id="consumer_itstack" host="127.0.0.1" port="6379"/>
<rpc:consumer id="consumer_helloService" nozzle="org.itstack.demo.test.service.HelloService" alias="itStackRpc"/>
</beans>itstack-rpc-provider.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:rpc="http://rpc.itstack.org/schema/rpc"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://rpc.itstack.org/schema/rpc http://rpc.itstack.org/schema/rpc/rpc.xsd">
<rpc:provider id="provider_helloService" nozzle="org.itstack.demo.test.service.HelloService"
ref="helloService" alias="itStackRpc" />
</beans>ApiTest.java
package org.itstack.demo.test;
import org.springframework.context.support.ClassPathXmlApplicationContext;
/**
* http://www.itstack.org
* create by fuzhengwei on 2019/5/4
* 本章节主要介绍如何读取自定义配置xml文件字段信息
*/
public class ApiTest {
public static void main(String[] args) {
String[] configs = {"itstack-rpc-consumer.xml", "itstack-rpc-provider.xml"};
new ClassPathXmlApplicationContext(configs);
}
}2019-05-07 19:44:24,805 main INFO [org.springframework.context.support.ClassPathXmlApplicationContext:prepareRefresh:510] - Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@299a06ac: startup date [Tue May 07 19:44:24 CST 2019]; root of context hierarchy
2019-05-07 19:44:24,872 main INFO [org.springframework.beans.factory.xml.XmlBeanDefinitionReader:loadBeanDefinitions:315] - Loading XML bean definitions from class path resource [itstack-rpc-consumer.xml]
2019-05-07 19:44:24,972 main INFO [org.springframework.beans.factory.xml.XmlBeanDefinitionReader:loadBeanDefinitions:315] - Loading XML bean definitions from class path resource [itstack-rpc-provider.xml]
2019-05-07 19:44:25,008 main INFO [org.springframework.beans.factory.support.DefaultListableBeanFactory:preInstantiateSingletons:577] - Pre-instantiating singletons in org.springframework.beans.factory.support.DefaultListableBeanFactory@192b07fd: defining beans [consumer_itstack,consumer_helloService,provider_helloService]; root of factory hierarchy
服务端信息=> [注册中心地址：127.0.0.1] [注册中心端口：6379]
生产者信息=> [接口：org.itstack.demo.test.service.HelloService] [映射：helloService] [别名：itStackRpc] 微信搜索「bugstack虫洞栈」公众号，关注后回复「rpc案例源码」获取本文源码&更多原创专题案例！
🌏 知识星球：码农会锁
实战项目：「DDD+RPC分布式抽奖系统」、专属小册、问题解答、简历指导、架构图稿、视频课程
🐲 头条
-
💥
🎁 Lottery 抽奖系统- 基于领域驱动设计的四层架构的互联网分布式开发实践 -
小傅哥的《重学 Java 设计模式》- 全书彩印、重绘类图、添加内容 -
⭐小傅哥的《Java 面经手册》- 全书5章29节，417页11.5万字，完稿&发版 -
小傅哥的《手撸 Spring》- 通过带着读者手写简化版 Spring 框架，了解 Spring 核心原理 -
🌈小傅哥的《SpringBoot 中间件设计和开发》- 小册16个中间件开发30个代码库
⛳ 目录
公众号：
💋 精选
🐾 友链
建立本开源项目的初衷是基于个人学习与工作中对 Java 相关技术栈的总结记录，在这里也希望能帮助一些在学习 Java 过程中遇到问题的小伙伴，如果您需要转载本仓库的一些文章到自己的博客，请按照以下格式注明出处，谢谢合作。
作者：小傅哥
链接：https://bugstack.cn
来源：bugstack虫洞栈2021年10月24日，小傅哥 的文章全部开源到代码库 CodeGuide 中，与同好同行，一起进步，共同维护。
这里我提供 3 种方式：
-
提出
Issue：在 Issue 中指出你觉得需要改进/完善的地方(能够独立解决的话，可以在提出 Issue 后再提交PR)。 -
处理
Issue: 帮忙处理一些待处理的Issue。 -
提交
PR： 对于错别字/笔误这类问题可以直接提交PR，无需提交Issue确认。
详细参考：CodeGuide 贡献指南 - 非常感谢你的支持，这里会留下你的足迹
- 加群交流 本群的宗旨是给大家提供一个良好的技术学习交流平台，所以杜绝一切广告！由于微信群人满 100 之后无法加入，请扫描下方二维码先添加作者 “小傅哥” 微信(fustack)，备注：加群。
微信：fustack
- 公众号(bugstack虫洞栈) - 沉淀、分享、成长，专注于原创专题案例，以最易学习编程的方式分享知识，让自己和他人都能有所收获。
公众号：bugstack虫洞栈
感谢以下人员对本仓库做出的贡献或者对小傅哥的赞赏，当然不仅仅只有这些贡献者，这里就不一一列举了。如果你希望被添加到这个名单中，并且提交过 Issue 或者 PR，请与我联系。