build[release]: first zfoo 3.1.4 release for java 17

zfoo-project · Sep 21, 2023 · eeefb69 · eeefb69
1 parent ae91bb7
commit eeefb69
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -47,6 +47,8 @@ Perfect work development process, complete online solution
 Ⅳ. Maven dependency✨
 ------------
 
+**JDK 17+**，**OpenJDK** or **Oracle JDK** 
+
 ```
 <dependency>
     <groupId>com.zfoo</groupId>
@@ -59,16 +61,7 @@ Perfect work development process, complete online solution
 Ⅴ. Install and use⭐
 ------------
 
-#### 1. Environmental Requirements and Installation
-
-**17**，**OpenJDK** or **Oracle JDK** ，maven install to local repository
-
-```
-If you do not have JDK installed, the quick installation method is to download directly 
-from Project Structure, Platform Settings, SDKs in the upper right corner of Idea
-```
-
-#### 2. [protocol](protocol/README.md) very fast serialization and deserialization
+#### 1. [protocol](protocol/README.md) ultimate performance serialization and deserialization
 
 ```
 // zfoo protocol registration, can only be initialized once
@@ -81,7 +74,7 @@ ProtocolManager.write(byteBuf, complexObject);
 var packet = ProtocolManager.read(byteBuf);
 ```
 
-#### 3. [net](net/README.md) very fast RPC framework, supports tcp udp websocket http
+#### 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
@@ -101,14 +94,14 @@ NetContext.getCosumer()
                     );
 ```
 
-#### 4. [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
+#### 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);
 ```
 
-#### 5. [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
+#### 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
@@ -123,7 +116,7 @@ public class UserEntity implements IEntity<Long> {
 entityCaches.update(userEntity);
 ```
 
-#### 6. [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
+#### 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
@@ -136,7 +129,7 @@ public void onMyNoticeEvent(MyNoticeEvent event) {
 EventBus.post(MyNoticeEvent.valueOf("My event"));
 ```
 
-#### 7. [scheduler](scheduler/README.md) scheduling Framework Based on Cron Expression
+#### 6. [scheduler](scheduler/README.md) scheduling Framework Based on Cron Expression
 
 ````
 @Scheduler(cron = "0/1 * * * * ?")
@@ -145,7 +138,7 @@ public void cronSchedulerPerSecond() {
 }
 ````
 
-#### 8. [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
+#### 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

diff --git a/README_CN.md b/README_CN.md
@@ -49,6 +49,8 @@
 Ⅳ. Maven依赖✨
 ------------
 
+**JDK 17+**，**OpenJDK** or **Oracle JDK**
+
 ```
 <dependency>
     <groupId>com.zfoo</groupId>
@@ -60,15 +62,7 @@
 Ⅴ. 安装和使用⭐
 ------------
 
-#### 1. 环境要求和安装
-
-**JDK 17**，可以在 **OpenJDK** 和 **Oracle JDK** 无缝切换，下载完本项目，maven install到本地仓库即可使用
-
-```
-如果你没有安装JDK，快速的安装方法是在Idea的右上角Project Structure，Platform Settings，SDKs中直接下载
-```
-
-#### 2. [protocol](protocol/README.md) 目前性能最好的Java序列化和反序列化库
+#### 1. [protocol](protocol/README.md) 极致性能的Java序列化和反序列化库
 
 ```
 // zfoo协议注册，只能初始化一次
@@ -82,7 +76,7 @@ ProtocolManager.write(byteBuf, complexObject);
 var packet = ProtocolManager.read(byteBuf);
 ```
 
-#### 3. [net](net/README.md) 目前速度极快的RPC框架，支持 tcp udp websocket http
+#### 2. [net](net/README.md) 极致性能的RPC框架，支持 tcp udp websocket http
 
 ```
 // 服务提供者，只需要在方法上加个注解，则自动注册接口
@@ -102,14 +96,14 @@ NetContext.getCosumer()
                     );
 ```
 
-#### 4. [hotswap](hotswap/src/test/java/com/zfoo/hotswap/ApplicationTest.java) 热更新代码，不需要停止服务器，不需要额外的任何配置，一行代码开启热更新
+#### 3. [hotswap](hotswap/src/test/java/com/zfoo/hotswap/ApplicationTest.java) 热更新代码，不需要停止服务器，不需要额外的任何配置，一行代码开启热更新
 
 ```
 // 传入需要更新的class文件
 HotSwapUtils.hotswapClass(bytes);
 ```
 
-#### 5. [orm](orm/README.md) 基于mongodb的自动映射框架，使用 [caffeine](https://github.com/ben-manes/caffeine) 设计了二级缓存，充分释放数据库压力
+#### 4. [orm](orm/README.md) 基于mongodb的自动映射框架，使用 [caffeine](https://github.com/ben-manes/caffeine) 设计了二级缓存，充分释放数据库压力
 
 ```
 // 无需自己写sql和任何配置，直接通过注解定义在数据库中定义一张表
@@ -124,7 +118,7 @@ public class UserEntity implements IEntity<Long> {
 entityCaches.update(userEntity);
 ```
 
-#### 6. [event](event/src/test/java/com/zfoo/event/ApplicationTest.java) 事件总线解耦不同模块，提高代码的质量，核心思想是观察者设计模式
+#### 5. [event](event/src/test/java/com/zfoo/event/ApplicationTest.java) 事件总线解耦不同模块，提高代码的质量，核心思想是观察者设计模式
 
 ```
 // 接收一个事件，只需要在需要接收事件的方法上加一个注解就会自动监听这个事件
@@ -137,7 +131,7 @@ public void onMyNoticeEvent(MyNoticeEvent event) {
 EventBus.post(MyNoticeEvent.valueOf("我的事件"));
 ```
 
-#### 7. [scheduler](scheduler/README.md) 基于cron表达式的定时任务调度框架
+#### 6. [scheduler](scheduler/README.md) 基于cron表达式的定时任务调度框架
 
 ````
 @Scheduler(cron = "0/1 * * * * ?")
@@ -146,7 +140,7 @@ public void cronSchedulerPerSecond() {
 }
 ````
 
-#### 8. [storage](storage/src/test/java/com/zfoo/storage/ApplicationTest.java) Excel类自动映射框架，只需要定义一个和Excel对应的类，直接解析Excel
+#### 7. [storage](storage/src/test/java/com/zfoo/storage/ApplicationTest.java) Excel类自动映射框架，只需要定义一个和Excel对应的类，直接解析Excel
 
 ```
 @Storage

diff --git a/protocol/README.md b/protocol/README.md
@@ -3,8 +3,7 @@ English | [简体中文](./README_CN.md)
 ### Ⅰ. Introduction
 
 - [zfoo protocol](https://github.com/zfoo-project/zfoo/blob/main/protocol/README.md)
-  Fast framework for binary serialization and deserialization in Java, and has the fewest
-  serialization bytes
+  Ultimate performance binary serialization and deserialization in Java, and has the fewest serialization bytes
 - The protocol is currently natively supported **C++ Java Javascript C# Go Lua GDScript Python**，It's easy to do cross-platform
 - The protocol can customize the private protocol format to make your protocol more secure, and supports adding fields
   and being compatible with previous and subsequent protocols

diff --git a/protocol/README_CN.md b/protocol/README_CN.md
@@ -3,7 +3,7 @@
 ### Ⅰ. 简介
 
 - [zfoo protocol](https://github.com/zfoo-project/zfoo/blob/main/protocol/README.md)
-  是目前的Java二进制序列化和反序列化速度极快的框架，并且为序列化字节最少的框架
+  是极致性能的Java二进制序列化和反序列化的框架，并且为序列化字节最少的框架
 - 协议目前原生支持 **C++ Java Javascript C# Go Lua GDScript Python**，可以轻易实现跨平台
 - 协议可以自定义私有协议格式，让你的协议更加安全，支持增加字段和兼容前后版本协议
 - 兼容protobuf，支持生成protobuf协议文件，提供从pojo到proto的生成方式