JOYRPC 项目使用教程

JOYRPC 项目使用教程

1. 项目目录结构及介绍

JOYRPC 项目的目录结构如下：

joyrpc/
├── docs/
│   └── cndocs/
├── joyrpc-all/
├── joyrpc-api/
├── joyrpc-core/
├── joyrpc-example/
├── joyrpc-extension/
├── joyrpc-plugin/
├── joyrpc-spring/
├── joyrpc-springboot/
├── joyrpc-test/
├── license_config/
├── .gitignore
├── LICENSE
├── NOTICE
├── README.md
├── README_third_party.md
├── RELEASE.md
└── pom.xml

目录介绍

• docs/: 项目文档目录，包含中文文档 cndocs/。
• joyrpc-all/: 包含所有模块的打包文件。
• joyrpc-api/: 定义了项目的 API 接口。
• joyrpc-core/: 项目的核心实现代码。
• joyrpc-example/: 提供了项目的使用示例。
• joyrpc-extension/: 扩展模块，包含一些额外的功能实现。
• joyrpc-plugin/: 插件模块，包含各种插件的实现。
• joyrpc-spring/: 与 Spring 框架集成的模块。
• joyrpc-springboot/: 与 Spring Boot 框架集成的模块。
• joyrpc-test/: 项目的测试代码。
• license_config/: 许可证配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• NOTICE: 项目通知文件。
• README.md: 项目主 README 文件。
• README_third_party.md: 第三方依赖的 README 文件。
• RELEASE.md: 发布说明文件。
• pom.xml: Maven 项目配置文件。

2. 项目启动文件介绍

JOYRPC 项目的启动文件主要位于 joyrpc-example/ 目录下，提供了多种启动示例。以下是一个典型的启动示例：

public static void main(String[] args) throws Exception {
    DemoService demoService = new DemoServiceImpl();
    ProviderConfig<DemoService> providerConfig = new ProviderConfig<>();
    providerConfig.setServerConfig(new ServerConfig());
    providerConfig.setInterfaceClazz(DemoService.class.getName());
    providerConfig.setRef(demoService);
    providerConfig.setAlias("joyrpc-demo");
    providerConfig.setRegistry(new RegistryConfig("broadcast"));
    providerConfig.exportAndOpen().whenComplete((v, t) -> {
        if (t != null) {
            logger.error(t.getMessage(), t);
            System.exit(1);
        }
    });
    System.in.read();
}

启动文件说明

• DemoService: 服务接口。
• DemoServiceImpl: 服务接口的实现类。
• ProviderConfig: 服务提供者的配置类，用于配置服务接口、服务实现、注册中心等信息。
• ServerConfig: 服务端配置类，用于配置服务端的端口等信息。
• RegistryConfig: 注册中心配置类，用于配置注册中心的类型和地址。
• exportAndOpen(): 启动服务端的方法，异步执行。

3. 项目配置文件介绍

JOYRPC 项目的配置文件主要通过代码进行配置，但也支持通过外部配置文件进行配置。以下是一些常见的配置项：

服务端配置

ServerConfig serverConfig = new ServerConfig();
serverConfig.setPort(8080); // 设置服务端口
serverConfig.setHost("localhost"); // 设置服务地址

注册中心配置

RegistryConfig registryConfig = new RegistryConfig("broadcast");
registryConfig.setAddress("localhost:2181"); // 设置注册中心地址

服务提供者配置

ProviderConfig<DemoService> providerConfig = new ProviderConfig<>();
providerConfig.setServerConfig(serverConfig);
providerConfig.setInterfaceClazz(DemoService.class.getName());
providerConfig.setRef(demoService);
providerConfig.setAlias("joyrpc-demo");
providerConfig.setRegistry(registryConfig);

服务消费者配置

ConsumerConfig<DemoService> consumerConfig = new ConsumerConfig<>();
consumerConfig.setInterfaceClazz(DemoService.class.getName());
consumerConfig.setAlias("joyrpc-demo");
consumerConfig.setRegistry(registryConfig);

通过以上配置，可以灵活地启动和管理 JOYRPC 服务。