spring-cloud-invoker-parent

介绍

spring boot 必须 3.0.0 + 版本、 jdk 17 +

一个简单轻量的rpc框架，可以不使用任何注册中心或使用注册中心两种方式。
1）支持eureka
2）支持nacos
3）支持consul
4）支持IP直连方式
5）支持redis直连方式
6）支持rabbitmq直连方式
7）支持webSocket直连方式
spring-cloud-starter-invoker序列化支持jdk、json两种方式并使用http方式，实现service接口暴露，从而实现远程调用功能。并基于spring cloud loadbalancer模块，获取注册中心“服务模块”IP地址。同时也支持项目中，没有注册中心场景下的项目。
该invoker类同于openfeign等一个远程调用工具。
我相信很多朋友也有同样的感受，在使用openfeign过程中直接调用controller会涉及到一些转换小问题，并且最终的目的想要直接调用service。但很遗憾openfeign始终保持着restful风格。如果要想service直接暴露，这样会导致设计规范冲突，并且也不便于维护。然而invoker的灵感就来自于这里，经过不断的摸索和推论最终实现了invoker rpc暴露service、远程直接使用@RemoteClient自动注入即可，能做到零侵入项目快速满足项目需求。
#### 更新说明

1、 3.0.0 开启spring boot 3.0 + 版本、jdk 17 支持

application.yml 配置

spring:
  invoker:
    connectionRequestTimeout: 15000 #请求超时
    connectTimeout: 20000   #连接超时
    readTimeout: 15000  #读取超时
    serializable: json、jdk #默认使用json方式序列化
    request:
      client: httpClient || okHttp
      #最大链接数
      maxConnections: 100 
      #最大空闲链接，单位毫秒
      timeToLive: 1000 * 30
    server:
      #全局服务端地址配置
      address: 127.0.0.1:9092
    webSocket: 
      #webSocket模式下，握手地址
      endpoint: httpInvoker
    hystrix:
      enabled: true #启动熔断降级处理，默认true
      command:
        #hystrix配置
      thread: 
        coreSize = 10;
        maximumSize = 10;
        keepAliveTimeMinutes = 1;
        maxQueueSize = -1;
        queueSizeRejectionThreshold = 5;
        allowMaximumSizeToDivergeFromCoreSize = false;
        rollingStatisticalWindowInMilliseconds = 10000;
        rollingStatisticalWindowBuckets = 10;

maven

依赖	版本	描述
spring-boot-invoker-core	3.0.0	invoker核心包
spring-boot-invoker-hystrix	3.0.0	invoker熔断
spring-boot-invoker-security	3.0.0	invoker security
spring-boot-starter-invoker	3.0.0	spring boot使用
spring-boot-starter-redis-invoker	3.0.0	spring redis使用
spring-boot-starter-amqp-invoker	3.0.0	spring rabbitmq使用
spring-boot-starter-websocket-invoker	3.0.0	spring websocket使用
spring-cloud-starter-invoker	3.0.0	spring微服务使用
spring-invoker-dependencies	3.0.0	版本依赖

pom.xml 添加如下代码

<!-- https://mvnrepository.com/artifact/com.i360day/spring-cloud-starter-invoker -->
<dependency>
    <groupId>com.i360day</groupId>
    <artifactId>spring-boot-starter-invoker</artifactId>
    <version>${project.version}</version>
</dependency>

<dependency>
    <groupId>com.i360day</groupId>
    <artifactId>spring-boot-starter-redis-invoker</artifactId>
    <version>${project.version}</version>
</dependency>

<dependency>
    <groupId>com.i360day</groupId>
    <artifactId>spring-boot-starter-amqp-invoker</artifactId>
    <version>${project.version}</version>
</dependency>

<dependency>
    <groupId>com.i360day</groupId>
    <artifactId>spring-boot-starter-websocket-invoker</artifactId>
    <version>${project.version}</version>
</dependency>

<dependency>
    <groupId>com.i360day</groupId>
    <artifactId>spring-cloud-starter-invoker</artifactId>
    <version>${project.version}</version>
</dependency>

使用说明

1、启动类添加invoker注解

@EnableRemoteDiscoveryClient//spring boot 模式 自动发现@RemoteCLient
@EnableAmqpDiscoveryClient//rabbitmq 模式 自动发现@RemoteCLient
@EnableRedisDiscoveryClient//redis 模式 自动发现@RemoteCLient
@EnableWebSocketeDiscoveryClient//webSocket 模式 自动发现@RemoteCLient
public class TestBootstrap {

    public static void main(String[] args) {
        ConfigurableApplicationContext run = SpringApplication.run(TestBootstrap.class);
    }
}

2、暴露service

@Service
public class TestService implements TestServiceFacade {
   public String test(){
	return "ok";
   }
}
注：TestServiceFacade类必须有@RemoteClient标记，否则无效

3、添加接口与熔断，并指向模块调用注册中心地址进行远程访问 3.1）有注册中心下使用，如果没有项目名（contextPath）则为空或不填写

方式一：
@RemoteClient(name = "cx-test",fallback = TestServiceFacadeHystrix.class, contextPath = "/projectName")
public interface TestServiceFacade {
   public String test();
}

public class TestServiceFacadeHystrix implements TestServiceFacade{
   public String test(){
	return "ok";
   }
}
方式二：
#客服端调用
@RemoteClient(fallback = TestServiceFacadeHystrix.class, contextPath = "/projectName")
public interface TestServiceFacade extends TestServiceModule {
   public String test();
}
#降级回调
public class TestServiceFacadeHystrix implements TestServiceFacade{
   public String test(){
	return "ok";
   }
}
#模块独立，供子类继承
@RemoteModule(name = "cx-test", address = "127.0.0.1:9092")
public interface TestServiceModule {
}

方式三：
@RemoteClient(name = "cx-test", FallbackFactory = TestServiceFacadeHystrix.class, contextPath = "/projectName")
public interface TestServiceFacade {
   public String test();
}

@Component
public class SpringInvokerSampleServiceHystrix implements FallbackFactory {
    @Override
    public Object create(Throwable var1) {
        return new SpringInvokerSampleServiceFacade() {
            @Override
            public String test() {
                return null;
            }
        };
    }
}

方式四：
@RemoteClient(FallbackFactory = TestServiceFacadeHystrix.class, contextPath = "/projectName")
public interface TestServiceFacade extends TestServiceModule{
   public String test();
}

@Component
public class SpringInvokerSampleServiceHystrix implements FallbackFactory {
    @Override
    public Object create(Throwable var1) {
        return new SpringInvokerSampleServiceFacade() {
            @Override
            public String test() {
                return null;
            }
        };
    }
}
#模块独立，供子类继承
@RemoteModule(name = "cx-test", address = "127.0.0.1:9092")
public interface TestServiceModule {
}

新增remoteModule注解后也可以这样写，获取当前请求的地址配置

@RemoteModule(name = "cx-test", contextPath = "/projectName")
public interface TestModuleFacade {
   public String test();
}

@RemoteClient(fallback = TestServiceFacadeHystrix.class)
public interface TestServiceFacade extends TestModuleFacade{
   public String test();
}

3.2） 非注册中心下使用，如果没有项目名（contextPath）则为空或不填写

@RemoteClient(address = "127.0.0.1:8080",fallback = TestServiceFacadeHystrix.class, contextPath = "/projectName")
public interface TestServiceFacade {
   public String test();
}

public class TestServiceFacadeHystrix implements TestServiceFacade{
   public String test(){
	return "ok";
   }
}

新增remoteModule注解后也可以这样写，获取当前请求的地址配置

@RemoteModule(name = "cx-test", address = "127.0.0.1:8080", contextPath = "/projectName")
public interface TestModuleFacade {
   public String test();
}

@RemoteClient(fallback = TestServiceFacadeHystrix.class)
public interface TestServiceFacade extends TestModuleFacade{
   public String test();
}

4、客服端使用接口

@RestController
@RequestMapping("/test")
public class ChatController {

    @Autowired
    private TestServiceFacade testServiceFacade;


    @RequestMapping("/test")
    public String test(){
        return testServiceFacade.test();
    }
}

5、security oauth2 服务调用验证

忽略远程service
@IgnoreRemoteService
public class TestService{
    ...
}
加入请求头
@Component
public class RequestInterceptor implements HttpInvokerRequestInterceptor {
	@Override
	public void apply(RequestTemplate requestTemplate) {
		Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
		if ((authentication instanceof AbstractAuthenticationToken)) {
			AbstractAuthenticationToken aat = (AbstractAuthenticationToken)authentication;
			if ((aat.getDetails() instanceof OAuth2AuthenticationDetails)) {
				OAuth2AuthenticationDetails details = (OAuth2AuthenticationDetails)aat.getDetails();
                requestTemplate.addHeaders("Authorization", new String(String.format("%s %s", new Object[] { details.getTokenType(), details.getTokenValue() })));
			}
		}
	}
}

小猪快跑023 / spring-starter-invoker-rpc

spring-cloud-invoker-parent

介绍

spring boot 必须 3.0.0 + 版本、 jdk 17 +

application.yml 配置

maven

使用说明

参与贡献

简介

发行版

贡献者

近期动态

小猪快跑023 / spring-starter-invoker-rpc .gitee-modal { width: 500px !important; }

spring-cloud-invoker-parent

介绍

spring boot 必须 3.0.0 + 版本、 jdk 17 +

application.yml 配置

maven

使用说明

参与贡献

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

小猪快跑023 / spring-starter-invoker-rpc