https://github.com/sunquakes/jsonrpc4j
A java client and server over http or tcp implementation of JSON-RPC 2.0. Support consul & nacos.
https://github.com/sunquakes/jsonrpc4j
client consul http java jsonrpc jsonrpc2 nacos netty rpc server springboot tcp
Last synced: 18 days ago
JSON representation
A java client and server over http or tcp implementation of JSON-RPC 2.0. Support consul & nacos.
- Host: GitHub
- URL: https://github.com/sunquakes/jsonrpc4j
- Owner: sunquakes
- License: mit
- Created: 2022-02-11T14:13:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-19T05:44:27.000Z (over 1 year ago)
- Last Synced: 2024-11-15T06:52:29.754Z (over 1 year ago)
- Topics: client, consul, http, java, jsonrpc, jsonrpc2, nacos, netty, rpc, server, springboot, tcp
- Language: Java
- Homepage: https://www.moonquakes.io/guide/java.html
- Size: 524 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
English | [π¨π³δΈζ](README_ZH.md)
# jsonrpc4j
## Installing
- Add maven source to the pom.xml
```xml
releases
Releases
https://oss.sonatype.org/content/repositories/releases/
snapshots
Snapshots
https://oss.sonatype.org/content/repositories/snapshots/
```
- Add dependency to the pom.xml
```xml
com.sunquakes
jsonrpc4j
3.0.0-SNAPSHOT
```
## Getting started
### step1. Configuring base packages with @JsonRpcScan to scan service and client class
- method 1. Used with the @Configuration
```java
@Configuration
@JsonRpcScan({"com.sunquakes"})
public class JsonRpcConfig {
}
```
- method 2. Used in the Application class
```java
@SpringBootApplication
@JsonRpcScan({"com.sunquakes.jsonrpc4j.spring.boot"})
public class JsonRpcApplication {
public static void main(String[] args) {
SpringApplication.run(JsonRpcApplication.class, args);
}
}
```
### step2. Configuring server
- Add configuration items to application.properties
```properties
# The protocol of the server, Value can be tcp or http.
jsonrpc.server.protocol=tcp
# The port of the server listening.
jsonrpc.server.port=3200
# If the protocol is http, the next two property can be ignore.
# Symbol for the end of data receive once.
jsonrpc.server.package-eof=\r\n
# Buffer size of the server receive data.
jsonrpc.server.package-max-length=2097152
```
### step3. Create service interface and class
- Create a new interface file named IJsonRpcService with @JsonRpcService, value is the name of the service
```java
@JsonRpcService(value = "JsonRpc")
public interface IJsonRpcService {
int add(int a, int b);
}
```
- Create a new class file name JsonRpcServiceImpl to implements interface IJsonRpcService
```java
public class JsonRpcServiceImpl implements IJsonRpcService {
@Override
public Integer add(int a, int b) {
return a + b;
}
}
```
### step4. Configuring client
- Add configuration items to application.properties
```properties
# Symbol for the end of data request once.
jsonrpc.client.package-eof=\r\n
```
### step5. Create client interface
- Create a new interface file named IJsonRpcClient with @JsonRpcClient, protocol can be tcp or http or https and should
be same as item(jsonrpc.server.protocol) of step2, value must be same as the value of step3.
```java
@JsonRpcClient(value = "JsonRpc", protocol = JsonRpcProtocol.TCP, url = "localhost:3200")
public interface IJsonRpcClient {
int add(int a, int b);
}
```
### step6. Use the client request the server
```java
public class JsonRpcTest {
@Autowired
private IJsonRpcClient jsonRpcClient;
public int add() {
// data sent: {"id":"691bbf41-e992-4f45-9c0d-1eeb0b088698","jsonrpc":"2.0","method":"json_rpc/add","params":{"a":3,"b":4}}
// data received: {"id":"691bbf41-e992-4f45-9c0d-1eeb0b088698","jsonrpc":"2.0","result":7}
return jsonRpcClient.add(1, 2); // the result is 3
}
}
```
## More Feature
### Service Discovery
- Consul
```properties
# The service hostname, not required, if the default node ip is used, it can be ignored.
jsonrpc.discovery.hostname=192.168.39.1
# The consul address
# instanceId: If there are the same service has same service name and port in difference nodes, the parameter is required.
# check: true is enable health check. The default value is false
# checkInterval: If the check parameter is true, the parameter valid. The default value is 60s
jsonrpc.discovery.url=http://127.0.0.1:8500?instanceId=2&check=true&checkInterval=5s
# The consul driver
jsonrpc.discovery.driver-name=com.sunquakes.jsonrpc4j.discovery.Consul
```
- Nacos
```properties
# The service hostname, not required, if the default node ip is used, it can be ignored.
jsonrpc.discovery.hostname=192.168.39.1
# The nacos address
# Support [Open API Guide](https://nacos.io/en-us/docs/open-api.html) Register instance chapter Request Parameters.
jsonrpc.discovery.url=http://127.0.0.1:8849?namespaceId=XXXXXX&...
# The nacos driver
jsonrpc.discovery.driver-name=com.sunquakes.jsonrpc4j.discovery.Nacos
```
## Test
```shell
mvn test
```