doc[upgrade]: upgrade doc

This commit is contained in:
sun
2023-09-04 11:51:08 +08:00
parent a53f7396ba
commit 4539fd499b
2 changed files with 25 additions and 37 deletions
+13
View File
@@ -1,6 +1,19 @@
English | [简体中文](./README_CN.md)
<a href="https://github.com/zfoo-project/zfoo"><img src="/doc/image/logo.jpg" width="30%"></a>
-----------
Attention:
-----------
- The main branch is a development version for Java 21 and GraalVM. The stable version is [zfoo-java-11-17](https://github.com/zfoo-project/zfoo/tree/zfoo-java-11-17)
- Upgrade process
- reimport not found classes
- no need to inherit IPacket anymore
- SafeRunnable has been deleted, please use ThreadUtils.safeRunnable()
- rename interfaces and annotationsStorage -> IStorage@Resource -> @Storage@ResInjection -> @StorageAutowired
- rename interfaces and annotations@EntityCachesInjection -> @EntityCacheAutowired@EntityCaches -> @EntityCache
-----------
Why is zfoo protocol ?
-----------
+12 -37
View File
@@ -1,6 +1,18 @@
简体中文 | [English](./README.md)
<a href="https://github.com/zfoo-project/zfoo"><img src="/doc/image/logo.jpg" width="30%"></a>
-----------
注意
-----------
- 主干main是当前是面向java 21和GraalVM的开发版本,稳定版本请使用 [zfoo-java-11-17](https://github.com/zfoo-project/zfoo/tree/zfoo-java-11-17)
- 升级流程
- 重新导入找不到的类
- 不需要再继承IPacket
- SafeRunnable删除了,请使用ThreadUtils.safeRunnable()
- 重命名接口和注解,Storage -> IStorage@Resource -> @Storage@ResInjection -> @StorageAutowired
- 重命名接口和注解,@EntityCachesInjection -> @EntityCacheAutowired@EntityCaches -> @EntityCache
-----------
Why is zfoo protocol ?
-----------
@@ -176,40 +188,3 @@ doc[module]: 增加了什么文档
zfoo使用 [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
![JetBrains Logo (Main) logo](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)
## 升级日志
- protocol
```
不需要再继承IPacket
```
- event
```
com.zfoo.event.model.anno.EventReceiver -> com.zfoo.event.anno.EventReceiver
```
- orm complete refactoring
```
Storage -> IStorage
@Resource -> @Storage
@ResInjection -> @StorageAutowired
```
- storage complete refactoring
- utils
```
com.zfoo.util.NetUtils -> com.zfoo.net.util.NetUtils
com.zfoo.util.ThreadUtils -> com.zfoo.protocol.util.ThreadUtils
com.zfoo.util.math.NumberUtils -> com.zfoo.protocol.util.NumberUtils
com.zfoo.util.math.RandomUtils -> com.zfoo.protocol.util.RandomUtils
com.zfoo.util.security.IdUtils -> com.zfoo.protocol.util.UuidUtils
com.zfoo.util.security.security.* -> com.zfoo.net.util.security.*
```
- SafeRunnable删除了,请使用ThreadUtils.safeRunnable