手写一个rpc远程调用服务demo 如何实现rpc调用

前言

• 因为公司业务需求，使用了K8S + istio进行服务部署和治理，没有使用常规的springclould技术栈（包括注册中心nacos和openfeign远程服务调用）。
• 所以就自己开发了一个基于AOP实现的rpc远程调用服务模块。其实现原理实现和feign类似，都是通过远程调用方法的代理对象发送HTTP请求并返回结果。
• 废话不多说，下面直接上代码

代码

• 下图是demo模块划分，common是公共模块，demo-order和demo-user是模拟两个服务调用。

• 定义一个标识为远程调用类的注解 @RpcService ，有点类似于feign的@FeignClient注解。

/**
*
* @AUTHOR ZRH
* @DATE 2021/4/10
*/
@Component
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface RpcService {

/**
* 远程服务名称
*/
String service();

/**
* 端口
*/
String port();
}

• 定义两个标识远程调用接口请求方式注解 @get和@post，相当于@PostMapping和@GetMapping。

/**
*
* @AUTHOR ZRH
* @DATE 2021/4/10
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Post {

/**
* 接口路由
*
* @return
*/
String value();
}

/**
*
* @AUTHOR ZRH
* @DATE 2021/4/10
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Get {

/**
* 接口路由
*
* @return
*/
String value();
}

• 然后定义一个AOP切面处理类 AopRpcHandler。只要远程调用接口方法上有注解@Post或者@Get，就会对方法进行代理方式请求。因为这里不需要原本远程调用方法的执行结果，所以这里直接使用@Around环绕切面，并且不需要执行原方法，所以直接使用JoinPoint 做参数接口（ProceedingJoinPoint继承自JoinPoint，里面多了两个阻塞方法proceed，用于获取原代理方法的执行结果）。
• 通过代理对象获取到原方法的参数值，参数名，接口路由地址，接口请求方式，远程服务和端口等等。使用okhttp工具类发送代理请求，然后返回响应结果。

/**
* @AUTHOR ZRH
* @DATE 2021/4/10
*/
@Slf4j
@Aspect
@Component
public class AopRpcHandler {

private final static String HTTP = "http://";

@Around(value = "@annotation(post)")
public String aopPost(JoinPoint joinPoint, Post post) {
String result = null;
String url = null;
try {
RpcService rpcService = (RpcService) joinPoint.getSignature().getDeclaringType().getAnnotation(RpcService.class);
url = HTTP + rpcService.service() + ":" + rpcService.port() + "/" + post.value();
Object[] args = joinPoint.getArgs();
result = OkHttpUtils.post(url, JSON.toJSONString(args[0]));
} catch (Throwable throwable) {
log.error("服务调用异常，url = [{}]", url);
}
return result;
}

@Around(value = "@annotation(get)")
public String aopGet(JoinPoint joinPoint, Get get) {
String result = null;
String url = null;
try {
RpcService rpcService = (RpcService) joinPoint.getSignature().getDeclaringType().getAnnotation(RpcService.class);
url = HTTP + rpcService.service() + ":" + rpcService.port() + "/" + get.value();

MethodSignature signature = (MethodSignature) joinPoint.getSignature();
Parameter[] parameters = signature.getMethod().getParameters();
if (parameters != null && parameters.length > 0) {
Object[] args = joinPoint.getArgs();
int length = parameters.length;
url += "?";
for (int i = 0; i < length; i++) {
url += parameters[i] + "=" + args[i];
if (i != length - 1) {
url += "&";
}
}
}
result = OkHttpUtils.get(url);
} catch (Throwable throwable) {
log.error("服务调用异常，url = [{}]", url);
}
return result;
}
}

• 然后在demo-user服务中如果有远程调用场景，就创建一个远程调用类。使用注解@RpcService和@Post即可。方法中的返回值和返回类型可以自定义，比如一般项目中会有统一的响应结果。

/**
* @AUTHOR ZRH
* @DATE 2021/4/10 0010 1:06
*/
@RpcService(service = "demo-order", port = "18002")
public class AopRpcDemo {

@Post("post")
public String post(String param) {
return "1";
}
}

• 在demo-user服务中使用和正常调用接口一样。

/**
* @AUTHOR ZRH
* @DATE 2021/4/10 0010 0:42
*/
@RestController
public class DemoController {

@Autowired
private AopRpcDemo aopRpcDemo;

@PostMapping("post")
public String post() {
String post = aopRpcDemo.post("zrh.post");
System.out.println("调用远程接口方法返回结= " + post);
return "ok";
}
}

• 如果就这样把demo服务启动后，访问是访问不了的。因为在aop切面处理类中对http请求的URL没有通过域名而是通过服务名称拼接的。
• 这里如果是基于注册中心和feign进行服务调用，那是没有问题，因为feign会通过服务名称到注册中心找到对应服务的地址进行请求远程接口。
• 而这里因为没有使用注册中心，所以在window上需要增加hosts文件上的地址映射关系。在C:\Windows\System32\drivers\etc目录下的hosts文件增加。并在cmd控制台中使用ipconfig /flushdns刷新DNS内容。
• @RpcService中的service写服务名而不写服务访问域名，是因为如果是多机集群部署，那么就可以使用服务名映射域名方式通过Nginx负载均衡进行转发请求。如果直接写服务访问域名就只能访问一个机子上的服务了。

• 先看一下两个服务的配置文件和demo-order的接口

• 服务启动后，访问http://localhost:18001/post，结果如下图：

• 最后的结果和我们想要的结果一致。
• 上面的demo是很简单的实现。如果读者想要在自己项目中使用此类技术栈，那需要考虑服务容错，服务发现，服务限流等等是否能兼容等。

最后

• openfeign其实是可以独立和springboot进行使用的。先引入openfeign的maven包

<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
<version>3.0.2</version>
</dependency>

• 然后在使用@FeignClient注解时，对url配置接口的访问地址，最后的执行结果和上述的结果是一样的。

/**
* @AUTHOR ZRH
* @DATE 2021/4/10 0010 1:15
*/
@FeignClient(name = "demo-user", url = "demo-user:18001")
public interface UserFeign {

@PostMapping("hello")
String hello(@RequestBody String param);
}

————————————————