Apache ServiceComb Java Chassis 技术文档

1. 安装指南

1.1 环境要求

• JDK版本: 根据项目版本选择合适的JDK版本。例如，Java Chassis 3需要OpenJDK 17，Java Chassis 2支持OpenJDK 8、11和17。
• Maven: 需要预先安装Maven用于构建项目。
• Docker: 如果需要运行测试用例，需要预先安装Docker。

1.2 安装步骤

1. 下载项目: 从GitHub仓库下载项目源码。
2. 构建项目: 使用Maven进行构建。

   mvn clean install
   

3. 运行测试用例: 如果需要运行测试用例，使用以下命令。

   mvn clean install -Pdocker -Pit
   

   如果使用docker machine，使用以下命令。

   mvn clean install -Pdocker -Pit -Pdocker-machine
   

2. 项目的使用说明

2.1 快速开始

1. 定义服务契约: 使用@RequestMapping注解定义服务契约。

   @RequestMapping(path = "/provider")
   public interface ProviderService {
     @GetMapping("/sayHello")
     String sayHello(@RequestParam("name") String name);
   }
   

2. 定义提供者: 使用@RestSchema注解定义提供者。

   @RestSchema(schemaId = "ProviderController", schemaInterface = ProviderService.class)
   public class ProviderController implements ProviderService {
     @Override
     public String sayHello(String name) {
       return "Hello " + name;
     }
   }
   

3. 定义消费者: 使用@Configuration注解定义消费者。

   @Configuration
   public class ProviderServiceConfiguration {
     @Bean
     public ProviderService providerService() {
       return Invoker.createProxy("provider", "ProviderController", ProviderService.class);
     }
   }
   

4. 使用RPC方式访问提供者: 使用@RestSchema注解定义消费者控制器。

   @RestSchema(schemaId = "ConsumerController", schemaInterface = ConsumerService.class)
   public class ConsumerController implements ConsumerService {
     private ProviderService providerService;
   
     @Autowired
     public void setProviderService(ProviderService providerService) {
       this.providerService = providerService;
     }
   
     @Override
     public String sayHello(String name) {
       return providerService.sayHello(name);
     }
   }
   

3. 项目API使用文档

3.1 服务契约定义

• @RequestMapping: 用于定义服务契约的路径。
• @GetMapping: 用于定义GET请求的映射。
• @RequestParam: 用于定义请求参数。

3.2 提供者定义

• @RestSchema: 用于定义提供者的模式ID和接口。
• @Override: 用于重写接口方法。

3.3 消费者定义

• @Configuration: 用于定义配置类。
• @Bean: 用于定义Bean。
• Invoker.createProxy: 用于创建服务代理。

3.4 消费者控制器定义

• @RestSchema: 用于定义消费者控制器的模式ID和接口。
• @Autowired: 用于自动装配Bean。

4. 项目安装方式

4.1 通过Maven仓库安装

1. 在pom.xml中添加依赖。

   <dependency>
     <groupId>org.apache.servicecomb</groupId>
     <artifactId>java-chassis-core</artifactId>
     <version>3.2.2</version>
   </dependency>
   

2. 使用Maven进行构建。

   mvn clean install
   

4.2 源码安装

1. 下载项目源码。
2. 使用Maven进行构建。

   mvn clean install
   

通过以上步骤，您可以顺利安装并使用Apache ServiceComb Java Chassis进行微服务开发。