polaris-java icon indicating copy to clipboard operation
polaris-java copied to clipboard

Lightweight Java SDK used as Proxyless Service Governance

polaris-java

Build Status Maven Central

See the 中文文档 for Chinese readme.

polaris-java is the Java language SDK for polarismesh, support SDK API for application to use polaris

How to build

polaris-java uses Maven for most build-related activities, and JDK 1.8 or later versions are supported. You should be able to get off the ground quite quickly by cloning the project you are interested in and typing:

mvn clean install

How to Use

Add maven dependency

Modify pom.xml in application root, add dependencyManagement for polaris-java:

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.tencent.polaris</groupId>
            <artifactId>polaris-dependencies</artifactId>
            <version>1.7.3</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

add the module in dependencies.

Examples

A polaris-examples module is included in our project for you to get started with polaris-java quickly. It contains an example, and you can refer to the readme file in the example project for a quick walkthrough.

QuickStart Example

Discovery Example

Router Example

CircuitBreaker Example

RateLimit Example

Configuration Example