mirror of
https://github.com/tiennm99/zfoo.git
synced 2026-05-20 01:26:23 +00:00
godotg
171 lines
6.6 KiB
Markdown
171 lines
6.6 KiB
Markdown
English | [简体中文](./README_CN.md)
|
||
<a href="https://github.com/zfoo-project/zfoo"><img src="/doc/image/logo.jpg" width="30%"></a>
|
||
|
||
## Ⅰ. Introduction of zfoo🚩
|
||
|
||
- **Extremely fast, asynchronous, actor design, lock free, universal RPC framework, native GraalVM support**
|
||
- **Decentralized serialization [zfoo protocol](protocol/README.md)**, supports C++ C# Go Java Javascript TypeScript Lua GDScript Python
|
||
- **High scalability**, Single server deployment, microservice deployment, cluster deployment, gateway deployment
|
||
- **Can be used as a game server framework or website server framework.**
|
||
|
||
Perfect work development process, complete online solution
|
||
|
||
- Spring projects, distributed projects, container projects, **hot update code without
|
||
downtime** [hotswap](hotswap/src/test/java/com/zfoo/hotswap/ApplicationTest.java)
|
||
- Excel json csv configuration is automatically mapped and parsed, **Online hotswap
|
||
configuration** [storage](storage/src/test/java/com/zfoo/storage/ApplicationTest.java)
|
||
- Automapping framework for MongoDB [orm](orm/README.md)
|
||
- Event bus [event](event/src/test/java/com/zfoo/event/ApplicationTest.java)
|
||
- Time task scheduling [scheduler](scheduler/README.md)
|
||
- **Cpu, memory, hard disk, network monitoring built into the program** no code and extra tools
|
||
required [monitor](monitor/src/test/java/com/zfoo/monitor/ApplicationTest.java)
|
||
|
||
## Ⅱ. Who uses this project
|
||
|
||
|
||
- Projects with extremely high-performance requirements, such as website and game server frameworks, single server, global server, live chat, IM system, real-time push
|
||
- Projects such as saving, development, deployment, operation and maintenance costs
|
||
- As a backend infrastructure for **Godot, Unity, Cocos，Webgl, H5**, Network protocol supports tcp udp websocket http
|
||
- [Keep it Simple and Stupid](https://baike.baidu.com/item/KISS原则/3242383), simple configuration, lightweight code
|
||
|
||
## Ⅲ. Maven dependency✨
|
||
|
||
|
||
- Environment requirement **JDK 17+**, support **OpenJDK**, **Oracle JDK** and **native GraalVM**
|
||
|
||
```
|
||
<dependency>
|
||
<groupId>com.zfoo</groupId>
|
||
<artifactId>boot</artifactId>
|
||
<version>3.3.1</version>
|
||
</dependency>
|
||
```
|
||
|
||
- If you don't want to depend on all zfoo modules, you only need to choose to depend on one of them
|
||
|
||
```
|
||
<dependency>
|
||
<groupId>com.zfoo</groupId>
|
||
<artifactId>protocol</artifactId>
|
||
<version>3.3.1</version>
|
||
</dependency>
|
||
```
|
||
|
||
## Ⅳ. Tutorials
|
||
|
||
|
||
- [zfoo sdk of csharp and lua for unity and godot](https://github.com/zfoo-project/zfoo-sdk-csharp-lua-unity-godot)
|
||
- [zfoo sdk typescript javascript cocos web h5](https://github.com/zfoo-project/zfoo-sdk-typescript-javascript-cocos-web-h5)
|
||
- [zfoo sdk gdscript for godot](https://github.com/zfoo-project/zfoo-sdk-gdscript-godot)
|
||
- [tank-game-server](https://github.com/zfoo-project/tank-game-server) Online game《The Fight of Tanks》, novice friendly,
|
||
difficulty 2 stars
|
||
- [godot-bird](https://github.com/zfoo-project/godot-bird) bird and bird，powered by godot
|
||
- [FAQ](./doc/FAQ.md)，There are standard demo display and instructions in the test folder of each project directory,
|
||
which can be run directly
|
||
|
||
## Ⅴ. Usage⭐
|
||
|
||
|
||
#### 1. [protocol](protocol/README.md) ultimate performance serialization and deserialization
|
||
|
||
```
|
||
// zfoo protocol registration, can only be initialized once
|
||
ProtocolManager.initProtocol(Set.of(ComplexObject.class, ObjectA.class, ObjectB.class));
|
||
|
||
// serialization
|
||
ProtocolManager.write(byteBuf, complexObject);
|
||
|
||
// deserialization
|
||
var packet = ProtocolManager.read(byteBuf);
|
||
```
|
||
|
||
#### 2. [net](net/README.md) ultimate performance RPC framework, supports tcp udp websocket http
|
||
|
||
```
|
||
// Service provider, only need to add an annotation to the method, the interface will be automatically registered
|
||
@PacketReceiver
|
||
public void atUserInfoAsk(Session session, UserInfoAsk ask) {
|
||
}
|
||
|
||
// Consumers, synchronously requesting remote service, will block the current thread
|
||
var userInfoAsk = UserInfoAsk.valueOf(userId);
|
||
var answer = NetContext.getCosumer().syncAsk(userInfoAsk, UserInfoAnswer.class, userId).packet();
|
||
|
||
// Consumers, asynchronously requesting remote service, and will still execute logic in the current thread after the asynchronous
|
||
NetContext.getCosumer()
|
||
.asyncAsk(userInfoAsk, UserInfoAnswer.class, userId)
|
||
.whenComplete(sm -> {
|
||
// do something
|
||
);
|
||
```
|
||
|
||
#### 3. [hotswap](hotswap/src/test/java/com/zfoo/hotswap/ApplicationTest.java) hot update code, no need to stop the server, no additional configuration, just one line of code to start hot update
|
||
|
||
```
|
||
// Pass in the class file that needs to be updated
|
||
HotSwapUtils.hotswapClass(bytes);
|
||
```
|
||
|
||
#### 4. [orm](orm/README.md) automatic mapping framework based on mongodb, The secondary cache is designed using [caffeine](https://github.com/ben-manes/caffeine) to fully release the database pressure
|
||
|
||
```
|
||
// You don't need to write sql and any configuration yourself, define a table in the database directly through annotation definitions
|
||
@EntityCache
|
||
public class UserEntity implements IEntity<Long> {
|
||
@Id
|
||
private long id;
|
||
private String name;
|
||
}
|
||
|
||
// update database data
|
||
entityCaches.update(userEntity);
|
||
```
|
||
|
||
#### 5. [event](event/src/test/java/com/zfoo/event/ApplicationTest.java) use the observer design pattern, decouples different modules and improves the quality of the code
|
||
|
||
```
|
||
// To receive an event, you only need to add an annotation to the method and the method will be automatically listen for the event
|
||
@EventReceiver
|
||
public void onMyNoticeEvent(MyNoticeEvent event) {
|
||
// do something
|
||
}
|
||
|
||
// fire an event
|
||
EventBus.post(MyNoticeEvent.valueOf("My event"));
|
||
```
|
||
|
||
#### 6. [scheduler](scheduler/README.md) scheduling Framework Based on Cron Expression
|
||
|
||
````
|
||
@Scheduler(cron = "0/1 * * * * ?")
|
||
public void cronSchedulerPerSecond() {
|
||
// do something
|
||
}
|
||
````
|
||
|
||
#### 7. [storage](storage/src/test/java/com/zfoo/storage/ApplicationTest.java) Excel to class automatic mapping framework, you only need to define a class corresponding to Excel, and directly parse Excel
|
||
|
||
```
|
||
@Storage
|
||
public class StudentResource {
|
||
@Id
|
||
private int id;
|
||
@Index
|
||
private String name;
|
||
private int age;
|
||
}
|
||
```
|
||
|
||
## Ⅵ. Commit specification👏
|
||
|
||
- People who like this project are welcome to maintain this project together, and pay attention to the following
|
||
specifications when submitting code
|
||
- The code formats use the default formatting of IntelliJ Idea
|
||
- [conventional-changelog-metahub](https://github.com/pvdlg/conventional-changelog-metahub#commit-types)
|
||
|
||
## Ⅶ. License
|
||
|
||
zfoo use [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
||
|
||
|