Google Git
Sign in
apache / servicecomb-java-chassis / 66b99e8f080e134ee3800ba1b1d1f654ea182a6f
commit66b99e8f080e134ee3800ba1b1d1f654ea182a6f[log] [tgz]
authorliubao68 <bismy@qq.com>Wed Apr 24 14:10:20 2024 +0800
committerGitHub <noreply@github.com>Wed Apr 24 14:10:20 2024 +0800
treec1bf39875dceb7c70a6940999ffee02e93ca95dd
parent4f27591e3fe78f68dd964a16ab636f588a5cdce4 [diff]
update read me using api first example (#4306)
2 files changed
tree: c1bf39875dceb7c70a6940999ffee02e93ca95dd
  1. .github/
  2. ci/
  3. clients/
  4. common/
  5. core/
  6. coverage-reports/
  7. demo/
  8. dependencies/
  9. distribution/
  10. dynamic-config/
  11. edge/
  12. etc/
  13. foundations/
  14. governance/
  15. handlers/
  16. huawei-cloud/
  17. metrics/
  18. parents/
  19. providers/
  20. samples/
  21. service-registry/
  22. solutions/
  23. spring-boot/
  24. swagger/
  25. tracing/
  26. transports/
  27. .gitignore
  28. doap_ServiceComb_Java-Chassis.rdf
  29. LICENSE
  30. NOTICE
  31. pom.xml
  32. README.md
  33. README_ZH.md
README.md

Java Chassis 中文 Maven Central License

Apache ServiceComb Java Chassis is a Software Development Kit (SDK) for rapid development of microservices in Java, providing service registration, service discovery, dynamic routing, and service management features.

releases

Release TrainLatest VersionCompiled JDK VersionTested JDK VersionOpen APINotes
Java Chassis 33.1.0OpenJDK 17OpenJDK 173.0.xDepends on Spring Boot 3
Java Chassis 22.8.16OpenJDK 8OpenJDK 8, 11, 172.0.xDepends on Spring 5
Java Chassis 11.3.11OpenJDK 8OpenJDK 82.0.xEnd of Support

NOTICE: Since Open API 3.0.x is not compatible with 2.0.x, Java Chassis 2 and Java Chassis 1 can not work together with Java Chassis 3. All related consumers, providers and edge service need use Java Chassis 3 when upgrading.

NOTICE: Java Chassis 1 reached its end of support now after it's first release from 2018.

Quick Start

  • Define API
@RequestMapping(path = "/provider")
public interface ProviderService {
  @GetMapping("/sayHello")
  String sayHello(@RequestParam("name") String name);
}
  • Provider service
@RestSchema(schemaId = "ProviderController", schemaInterface = ProviderService.class)
public class ProviderController implements ProviderService {
  @Override
  public String sayHello(String name) {
    return "Hello " + name;
  }
}
  • Consumer service
@Configuration
public class ProviderServiceConfiguration {
  @Bean
  public ProviderService providerService() {
    return Invoker.createProxy("provider", "ProviderController", ProviderService.class);
  }
}

Invoke Provider service with RPC

@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);
  }
}

Try out this example here .

Documentation

Project documentation is available on the ServiceComb Java Chassis Developer Guide.

Building

You don’t need to build from source to use Java Chassis (binaries in apache nexus ), but if you want to try out the latest and greatest, Java Chassis can be easily built with the maven. You also need JDK 17.

  mvn clean install

The first build may take a longer than expected as Maven downloads all the dependencies.

Automated Testing

To build the docker image and run the integration tests with docker, you can use maven docker profile

  mvn clean install -Pdocker -Pit

If you are using docker machine, please use the following command

  mvn clean install -Pdocker -Pit -Pdocker-machine

Contact

Bugs: issues

mailing list: subscribe dev

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

License

Licensed under an Apache 2.0 license.