Zfoo

https://github.com/zfoo-project/zfoo
Admin
💡Extremely fast enterprise server framework, can be used in RPC, game server, web server.
Tokens:13,233
Snippets:109
Trust Score:6.4
License:Apache-2.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Verify Git Installation

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Confirms that Git has been installed correctly by checking its version in the Git Bash terminal. A successful output indicates that Git is ready for use.

```Shell
git --version
```

--------------------------------

### Install Node.js Dependencies

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Installs all the necessary Node.js modules specified in the package.json file. This command is typically run in the root directory of a Node.js project.

```Shell
npm install
```

--------------------------------

### Run ZooKeeper

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Starts the ZooKeeper server by executing the zkServer.sh script. This command requires the JAVA_HOME environment variable to be set correctly.

```Shell
zkServer.sh start
```

--------------------------------

### Java TCP Server Example

Source: https://github.com/zfoo-project/zfoo/blob/main/net/README_CN.md

Demonstrates how to set up a single TCP server using zfoo net. This is a foundational example for basic server-client communication within the framework.

```java
```java
// src/test/java/com/zfoo/net/core/tcp/server/TcpServerTest.java
// (Code snippet not provided in the input text, but path indicates content)
```
```

--------------------------------

### Verify Node.js and npm Installation

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Checks if Node.js and its package manager, npm, are installed successfully by displaying their respective versions. These tools are essential for modern JavaScript development.

```Shell
npm --version
node --version
```

--------------------------------

### Install Yarn Package Manager

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Installs the Yarn package manager globally using npm. Yarn is an alternative to npm for managing JavaScript dependencies.

```Shell
npm install -g yarn
```

--------------------------------

### Java Gateway Load Balancing Example

Source: https://github.com/zfoo-project/zfoo/blob/main/net/README_CN.md

Illustrates the implementation of a gateway with load balancing capabilities using zfoo net. This example shows how to distribute incoming requests across multiple server instances.

```java
```java
// src/test/java/com/zfoo/net/core/gateway/GatewayTest.java
// (Code snippet not provided in the input text, but path indicates content)
```
```

--------------------------------

### Configure IntelliJ IDEA Custom Properties

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Allows customization of IntelliJ IDEA's behavior by setting specific properties in the 'idea.properties' file. Examples include disabling the console buffer or increasing the maximum file size for IntelliSense.

```Properties
# idea.cycle.buffer.size=disabled
idea.max.intellisense.filesize=50000
```

--------------------------------

### Java Microservices RPC Example

Source: https://github.com/zfoo-project/zfoo/blob/main/net/README_CN.md

Provides an example of implementing microservices using zfoo net. This demonstrates how to structure applications into independent, scalable services and manage inter-service communication.

```java
```java
// src/test/java/com/zfoo/net/core/provider/ProviderTest.java
// (Code snippet not provided in the input text, but path indicates content)
```
```

--------------------------------

### Configure MongoDB Environment Variable

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Adds the MongoDB 'bin' directory to the system's PATH environment variable, allowing MongoDB commands like 'mongosh' to be executed from any directory in the command prompt.

```Shell
set Path=C:\Program Files\MongoDB\Server\4.2\bin;%Path%
```

--------------------------------

### IntelliJ IDEA Copyright Profile

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Sets up a copyright profile in IntelliJ IDEA that includes the full Apache 2.0 license text. This profile can be applied to project files to automatically add the specified copyright information.

```Text
Copyright (C) 2020 The zfoo Authors
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.
```

--------------------------------

### Configure Java Environment Variables

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Sets up the JAVA_HOME environment variable and adds the JDK's bin directory to the system's Path. This is crucial for the Java Development Kit to be recognized by the system and various tools. Verification is done by checking the Java version in the command prompt.

```Shell
set JAVA_HOME=D:\Java\JDK
set Path=%JAVA_HOME%\bin;%Path%
java -version
```

--------------------------------

### Configure npm Proxy

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Sets an HTTP proxy for npm, which is necessary when npm needs to download packages from a registry through a proxy server. This is common in environments with network restrictions.

```Shell
npm config set proxy http://127.0.0.1:10809
```

--------------------------------

### Configure Maven Proxy Settings

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Provides Maven with proxy settings to enable it to download dependencies through a proxy server. This typically involves modifying the 'settings.xml' file or passing system properties during the Maven command execution.

```Shell
mvn clean install -U -DproxySet=true -DproxyHost=127.0.0.1 -DproxyPort=10809
```

--------------------------------

### IntelliJ IDEA Copyright Header Template

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Defines a standard Java file header template in IntelliJ IDEA, including author information and a placeholder for the Apache 2.0 license. This helps in maintaining consistent copyright notices across project files.

```Java
/**
 * @author jaysunxiao
 */
```

--------------------------------

### Maven Dependency for zfoo Boot

Source: https://github.com/zfoo-project/zfoo/blob/main/README.md

This snippet shows how to include the zfoo boot module in your Maven project. Ensure you have JDK 17+ installed. This dependency provides the core functionalities of the zfoo framework.

```xml
<dependency>
    <groupId>com.zfoo</groupId>
    <artifactId>boot</artifactId>
    <version>4.1.0</version>
</dependency>
```

--------------------------------

### Configure IntelliJ IDEA File Encodings

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Sets the global, project, and properties file encodings to UTF-8 within IntelliJ IDEA. It also configures the handling of BOM for UTF-8 files, recommending 'No Bom' for consistency.

```JSON
{
  "globalEncoding": "UTF-8",
  "projectEncoding": "UTF-8",
  "propertiesEncoding": "UTF-8",
  "bomForUtf8": "No Bom"
}
```

--------------------------------

### Configure Translate Plugin Shortcuts

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Sets custom keyboard shortcuts for the 'Translate' plugin in IntelliJ IDEA. These shortcuts are used to quickly open the translation dialog and trigger translations.

```JSON
{
  "translatePluginShortcuts": {
    "showDialog": "ctrl+shift+x",
    "translate": "ctrl+x"
  }
}
```

--------------------------------

### MongoDB Database Backup and Restore

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/mongodb/mongodb.md

Illustrates how to perform database backups using mongodump and restore them using mongorestore. Examples include specifying URIs, authentication, collection filtering, query conditions, and options like --drop for restore.

```bash
mongodump --uri mongodb://localhost:27017/robot --username=root --password=123456 --authenticationDatabase=admin -o /home
```

```bash
mongodump --uri mongodb://localhost:27017/robot -u "root" -p "123456" --authenticationDatabase=admin -c user -q "{name:'joe'}" -o /home
```

```bash
# 使用/home路径下的BSON和JSON文件恢复数据库test，--drop参数表示如果已经存在test数据库则删除原数据库，去掉--drop则与原数据库合并
mongorestore --uri mongodb://localhost:27017/robot -u "root" -p "123456" --authenticationDatabase=admin /home/test --drop
```

--------------------------------

### Configure Git HTTP Proxy

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Sets up a global HTTP and HTTPS proxy for Git, which can resolve issues with slow code downloads or connectivity problems. This is often used when behind a corporate network or using specific VPN configurations.

```Shell
git config --global http.proxy http://127.0.0.1:10809
git config --global https.proxy https://127.0.0.1:10809
```

--------------------------------

### Configure Eclipse Keybindings in IntelliJ IDEA

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Customizes IntelliJ IDEA's keyboard shortcuts to match Eclipse keybindings, enhancing familiarity for developers transitioning between IDEs. This includes settings for running to cursor, find/replace, closing tabs, and code folding.

```JSON
{
  "keybindings": {
    "runToCursor": "F9",
    "find": "ctrl+f",
    "replace": "alt+f",
    "closeTab": "ctrl+w",
    "expandAll": "ctrl+=",
    "collapseAll": "ctrl-"
  },
  "inputMethod": {
    "toggleTraditionalSimplified": "ctrl+f",
    "toggleEngChin": "ctrl+space"
  }
}
```

--------------------------------

### ZooKeeper Distributed Election Algorithm (Java)

Source: https://github.com/zfoo-project/zfoo/blob/main/net/README_CN.md

Presents an example of implementing a distributed election algorithm using ZooKeeper in Java. This is used to select a leader among multiple nodes in a distributed system.

```java
```java
// src/test/java/com/zfoo/net/zookeeper/recipes/mastersel
// (Code snippet not provided in the input text, but path indicates content)
```
```

--------------------------------

### Cron Expression Scheduling in Java

Source: https://github.com/zfoo-project/zfoo/blob/main/README.md

Illustrates the usage of the scheduler module in zfoo, which provides scheduling capabilities based on cron expressions. The example shows how to define a method that will be executed periodically according to a specified cron pattern.

```java
@Scheduler(cron = "0/1 * * * * ?")
public void cronSchedulerPerSecond() {
    // do something
}
```

--------------------------------

### ORM Configuration (XML)

Source: https://github.com/zfoo-project/zfoo/blob/main/orm/README.md

Provides an example of the XML configuration for the ZFoo ORM framework. This includes setting the entity package, database connection details (host, user, password, URL), and defining caching and persistence policies with various strategies and configurations.

```XML
<orm:config id="config" entity-package="com.zfoo.orm.**.entity">

    <orm:host database="${mongodb.database}" user="${mongodb.user}" password="${mongodb.password}">
        <orm:address name="${mongodb.address.name}" url="${mongodb.address.url}"/>
    </orm:host>

    <!-- Caching policy -->
    <orm:caches>
        <orm:cache strategy="default" size="6000" expire-millisecond="600000"/>
        <orm:cache strategy="thousand" size="1000" expire-millisecond="600000"/>
        <orm:cache strategy="threeThousand" size="3000" expire-millisecond="600000"/>
    </orm:caches>

    <!-- Persistence policy -->
    <orm:persisters>
        <orm:persister strategy="default" type="time" config="600000"/>
        <orm:persister strategy="cron30s" type="cron" config="0/30 * * * * ?"/>
        <orm:persister strategy="time30s" type="time" config="30000"/>
    </orm:persisters>
</orm:config>
```

--------------------------------

### Get System Uptime (Java)

Source: https://github.com/zfoo-project/zfoo/blob/main/monitor/README.md

Retrieves the system uptime, similar to the Linux 'uptime' command, to monitor CPU load. This function is part of the OSUtils class.

```Java
UptimeVO uptime = OSUtils.uptime();
```

--------------------------------

### zfoo RPC Framework Usage (Java)

Source: https://github.com/zfoo-project/zfoo/blob/main/README.md

This Java code illustrates the usage of the zfoo RPC framework for building service providers and consumers. It supports TCP, UDP, WebSocket, and HTTP protocols. The examples show how to register packet receivers and make synchronous or asynchronous remote calls.

```java
// 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
          );
```

--------------------------------

### Get Disk File System Usage (Java)

Source: https://github.com/zfoo-project/zfoo/blob/main/monitor/README.md

Fetches disk file system usage information, analogous to the Linux 'df' command. It returns a list of DiskFileSystemVO objects.

```Java
List<DiskFileSystemVO> df = OSUtils.df();
```

--------------------------------

### MongoDB Performance Monitoring Commands

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/mongodb/mongodb.md

Provides examples of essential MongoDB commands for monitoring database performance and server status. These include commands to view database statistics, server command-line options, server status details, and dynamic monitoring output.

```javascript
db.stats()
```

```javascript
db.serverCmdLineOpts()
```

```javascript
db.serverStatus().host
```

```javascript
db.serverStatus().locks
```

```javascript
db.serverStatus().globalLock
```

```javascript
db.serverStatus().mem
```

```javascript
db.serverStatus().connections
```

```javascript
db.serverStatus().extra_info
```

```javascript
db.serverStatus().indexCounters
```

```javascript
db.serverStatus().backgroundFlushing
```

```javascript
db.serverStatus().cursors
```

```javascript
db.serverStatus().network
```

```javascript
db.serverStatus().repl
```

```javascript
db.serverStatus().opcountersRepl
```

```javascript
db.serverStatus().opcounters
```

```javascript
db.serverStatus().asserts
```

```javascript
db.serverStatus().writeBacksQueued
```

```javascript
db.serverStatus().dur
```

```javascript
db.serverStatus().recordStats
```

```javascript
db.serverStatus( { workingSet: 1 } ).workingSet
```

```javascript
db.serverStatus().metrics
```

--------------------------------

### Configure IntelliJ IDEA Line Separator

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Standardizes the line separator character used in IntelliJ IDEA to Unix-style newlines (LF). This ensures consistent line endings across all files within the project, regardless of the operating system.

```INI
[CodeStyle]
LineSeparator=\n
```

--------------------------------

### Cron Expression Examples for Task Scheduling

Source: https://github.com/zfoo-project/zfoo/blob/main/scheduler/README.md

This snippet provides various examples of cron expressions used to define the timing of scheduled tasks. These expressions cover triggering tasks at specific seconds, minutes, hours, days, months, and years, including complex patterns like intervals, ranges, and last day/working day triggers.

```cron
30 * * * * ?           Task is triggered every half minute
30 10 * * * ?          Trigger tasks every hour at 10 minutes and 30 seconds
30 10 1 * * ?          Task is triggered every day at 1:10:30 seconds
30 10 1 20 * ?         Task is triggered at 1:10:30 on the 20th of each month
30 10 1 20 10 ? *      Task is triggered every year on October 20 at 1:10:30 seconds
30 10 1 20 10 ? 2018   Task is triggered on October 20, 2018 at 1:10:30 a.m
30 10 1 ? 10 * 2018    Task is triggered every day on the 20th at 1:10:30 seconds In October 2018
30 10 1 ? 10 SUN 2018  Task is triggered every Sunday in October 2018 at 1:10:30 seconds 
15,30,45 * * * * ?     Task is triggered every 15, 30, 45 seconds per minute
15-45 * * * * ?        Task is triggered every second from 15 seconds to 45 seconds per minute
15/5 * * * * ?         Triggers start at 15 seconds per minute and trigger every 5 seconds
15-30/5 * * * * ?      Triggers start between 15 and 30 seconds per minute and trigger every 5 seconds
0 0/3 * * * ?          It starts at 0:0 every hour and triggers every three minutes
0 15 10 ? * MON-FRI    Triggered once a day from Monday to Friday at 10:15:00 seconds
0 15 10 L * ?          Task is triggered at 10:15:00 on the last day of each month
0 15 10 LW * ?         Task is triggered at 10:15:00 on the last working day of each month
0 15 10 ? * 5L         Task is triggered at 10:15:00 on the last Thursday of every month
0 15 10 ? * 5#3        Task is triggered on the Thursday of the third week of every month at 10:15:00
```

--------------------------------

### Configure Git Line Endings

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Configures Git to convert line endings to LF on commit and not to convert them on checkout. This setting is highly recommended to prevent inconsistencies in line endings across different operating systems and development environments.

```Shell
git config --global core.autocrlf input
```

--------------------------------

### Get Memory Usage (Java)

Source: https://github.com/zfoo-project/zfoo/blob/main/monitor/README.md

Retrieves detailed memory usage statistics, mimicking the Linux 'free' command. The result is encapsulated in a MemoryVO object.

```Java
MemoryVO free = OSUtils.free();
```

--------------------------------

### Get Network IO Statistics (Java)

Source: https://github.com/zfoo-project/zfoo/blob/main/monitor/README.md

Collects network input/output statistics, similar to the Linux 'sar' command. It returns a list of SarVO objects representing network data.

```Java
List<SarVO> sar = OSUtils.sar();
```

--------------------------------

### Configure IntelliJ IDEA Custom VM Options

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/idea/idea-set-up.md

Sets custom Java Virtual Machine (JVM) parameters for IntelliJ IDEA. This includes memory allocation (-Xms, -Xmx), code cache size, and file encoding. Proper JVM settings can significantly impact IDEA's performance.

```Java
-Xms1024m
-Xmx8192m
-XX:ReservedCodeCacheSize=512m

-Dfile.encoding=UTF-8
-Duser.name=jaysunxiao
```

--------------------------------

### Zookeeper Heartbeat Detection Example

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/zookeeper/zookeeper.md

Demonstrates how Zookeeper can be used for heartbeat detection between systems. Instead of traditional ping mechanisms, one system registers a temporary node in Zookeeper, and another system listens to changes on this node to determine connectivity, thereby decoupling the systems.

```plaintext
传统的方案是一段时间A通ping到B，来判断A和B是否相连。
基于Zookeeper的心跳检测，A可以在Zookeeper注册一个临时节点，B监听这个节点的变化判断是否相连，这样可以极大的解耦合
```

--------------------------------

### Filter Aggregation in Elasticsearch

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/elastic/elastic-search-command.md

This snippet demonstrates how to use the 'filter' aggregation in Elasticsearch to group documents that match a specific term and then calculate the average of the 'id' field for those documents. It's useful for isolating and analyzing subsets of data.

```json
{
  "size": 0,
  "aggs": {
    "avg_id_demo": {
      "filter": {
        "term": {
          "content": "前端"
        }
      },
      "aggs": {
        "avg_id_test": {
          "avg": {
            "field": "id"
          }
        }
      }
    }
  }
}
```

--------------------------------

### Filters Aggregation in Elasticsearch

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/elastic/elastic-search-command.md

This snippet shows the 'filters' aggregation in Elasticsearch, which allows for creating multiple filter buckets based on different matching conditions. It then calculates the average 'id' for documents within each filter bucket. This is effective for comparing distinct segments of data.

```json
{
  "size": 0,
  "aggs": {
    "avg_id_demo": {
      "filters": {
        "filters": [
          {
            "match": {
              "id": 1
            }
          },
          {
            "match": {
              "id": 2
            }
          },
          {
            "match": {
              "id": 3
            }
          }
        ]
      },
      "aggs": {
        "avg_id_test": {
          "avg": {
            "field": "id"
          }
        }
      }
    }
  }
}
```

--------------------------------

### Date Range Aggregation in Elasticsearch

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/elastic/elastic-search-command.md

This snippet demonstrates a date range aggregation in Elasticsearch using 'date_range'. It defines specific date intervals for the 'postTime' field, allowing for analysis of data distribution across different time periods. The 'format' parameter ensures correct date parsing.

```json
{
  "size": 0,
  "aggs": {
    "range_date_demo": {
      "date_range": {
        "field": "postTime",
        "format": "yyyy-MM-dd HH:mm:ss",
        "ranges": [
          {
            "to": "2018-01-01 16:00:00"
          },
          {
            "from": "2018-01-01 16:00:00",
            "to": "2019-01-01 16:00:00"
          },
          {
            "from": "2019-01-01 16:00:00"
          }
        ]
      }
    }
  }
}
```

--------------------------------

### Range Aggregation for Numerical Data in Elasticsearch

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/elastic/elastic-search-command.md

This snippet illustrates a numerical range aggregation in Elasticsearch using the 'range' type. It defines custom ranges for the 'id' field to analyze data distribution across different numerical intervals. This is useful for understanding how data is spread across specific numerical boundaries.

```json
{
    "size": 0,
    "aggs": {
        "range_id_demo": {
            "range": {
                "field": "id",
                "ranges": [
                    {
                        "to": 2
                    },
                    {
                        "from": 2,
                        "to": 3
                    },
                    {
                        "from": 3
                    }
                ]
            }
        }
    }
}
```

--------------------------------

### Serialization and Networking with Netty

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/video-tutorial.md

Covers Netty's ByteBuf, Java serialization/deserialization, Kryo, Protobuf, and efficient serialization techniques using Javassist for bytecode enhancement.

```text
netty's ByteBuf
java's serialization and deserialization
use of kryo, note that it is not thread-safe
use of protobuf
juc's CountDownLatch
Zigzag algorithm compression, varint data compression algorithm, priority kryo implementation
Javassist bytecode enhancement serialization function is much faster than reflection
```

--------------------------------

### Netty NIO, Asynchronous Operations, and Load Balancing

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/video-tutorial.md

Explains Netty's NIO and epoll mechanisms, how asynchronous operations are implemented using CompletableFuture, and load balancing with consistent hashing.

```text
netty's nio, epoll
synchronous and asynchronous implemented through CompletableFuture
consistent hashing algorithm load balancing
usage of zookeeper
```

--------------------------------

### ProtoBuf: 协议定义

Source: https://github.com/zfoo-project/zfoo/blob/main/protocol/README_CN.md

使用 .proto 文件定义协议结构，类似于 Protobuf。其中 'syntax = "proto3";' 指定了 Protobuf 版本。字段标签（tag）超过 1000 时，被视为需要兼容的协议字段。

```protobuf
syntax = "proto3";
package test.message;

message SimpleObject {
    int64 aa = 1;
}

// 如果字段的tag超过1000，则视这个字段为需要兼容的协议字段
message OneMessage {
    // 这是属性的注释
    int64 id = 1;
    // 等于给这个字段加上了 @Compatible 注解
    string name = 1001;
}
```

--------------------------------

### Initialize and Use zfoo Serialization Library (Java)

Source: https://github.com/zfoo-project/zfoo/blob/main/protocol/README.md

This snippet demonstrates how to initialize the zfoo protocol manager with a set of classes and then perform serialization and deserialization operations. It requires the `ProtocolManager` class and assumes the existence of `byteBuf` and `buffer` objects for I/O. The initialization should only be performed once.

```java
import java.util.Set;
import com.zfoo.protocol.ProtocolManager;

// The zfoo protocol is registered and 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(buffer);
```

--------------------------------

### Server Deployment Commands

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/video-tutorial.md

Provides shell commands for deploying and managing Java applications using Maven, including setting heap size, active profiles, and using custom deployment scripts.

```shell
nohup java -XX:InitialHeapSize=300m -XX:MaxHeapSize=300m -XX:+HeapDumpOnOutOfMemoryError -Djdk.attach.allowAttachSelf=true -Dspring.profiles.active=pro -Dfile.encoding=UTF-8 -jar home-1.0.jar >/dev/null 2>&1 &

```

```shell
sh /deploy.sh stopUpdateStart /usr/local/tank/admin/admin-1.0.jar /usr/local/tank/admin

```

```shell
sh /deploy.sh stopUpdateStart /usr/local/tank/single/single-1.0.jar /usr/local/tank/single

```

```shell
sh /deploy.sh stopUpdateStart /usr/local/tank/cache/cache-1.0.jar /usr/local/tank/cache

```

```shell
sh /deploy.sh stopUpdateStart /usr/local/tank/gateway/gateway-1.0.jar /usr/local/tank/gateway

```

```shell
sh /deploy.sh stopUpdateStart /usr/local/tank/home/home-1.0.jar /usr/local/tank/home
```

--------------------------------

### XML: 协议注册配置

Source: https://github.com/zfoo-project/zfoo/blob/main/protocol/README_CN.md

通过 ProtocolManager.initProtocol(xmlProtocols) 注册协议，将协议号与类路径关联。支持按模块配置协议，并可指定包路径自动扫描协议类。

```xml
<protocols>
    <!-- 使用类路径 -->
    <module id="1" name="common">
        <protocol id="100" location="com.zfoo.protocol.packet.ComplexObject"/>
        <protocol id="101" location="com.zfoo.protocol.packet.NormalObject"/>
        <protocol id="102" location="com.zfoo.protocol.packet.ObjectA"/>
        <protocol id="103" location="com.zfoo.protocol.packet.ObjectB"/>
        <protocol id="104" location="com.zfoo.protocol.packet.SimpleObject"/>
        <protocol id="105" location="com.zfoo.protocol.packet.VeryBigObject"/>
        <protocol id="106" location="com.zfoo.protocol.packet.EmptyObject"/>
    </module>
    <!-- 使用包名会扫描该包路径下的所有协议类 -->
    <module id="2" name="native">
        <protocol location="com.zfoo.net.packet.common"/>
        <protocol location="com.zfoo.tank.common.protocol.common"/>
    </module>
</protocols>
```

--------------------------------

### Maven and Spring Concepts

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/video-tutorial.md

Explains Maven repository concepts and Spring framework features like custom tags, lifecycle, and event handling. It also touches upon bytecode enhancement technologies.

```text
maven local repository, maven remote repository, idea's project management
spring custom tag
spring lifecycle, corresponding events
spring built-in event priority specified by Ordered interface
javassist bytecode enhancement, asm, cglib, ByteBuddy, understand
```

--------------------------------

### Cron Expression and Scheduling

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/video-tutorial.md

Explains the usage of cron expressions, compares Spring's built-in scheduler with zfoo's Scheduler, and details Java's thread pool usage for scheduling tasks.

```text
cron expression usage
spring built-in Scheduled and zfoo's Scheduler
java's thread pool, SingleThreadScheduledExecutor, SingleThreadExecutor
Use spring's built-in CronExpression to calculate the next execution time of the cron expression
```

--------------------------------

### Event Handling with Observer Pattern in Java

Source: https://github.com/zfoo-project/zfoo/blob/main/README.md

Demonstrates how to use the event module in zfoo, which implements the observer design pattern. It shows how to register event receivers using annotations and how to post events to the event bus. This decouples modules and enhances code quality.

```java
@EventReceiver
public void onMyNoticeEvent(MyNoticeEvent event) {
    // do something
}

// fire an event
EventBus.post(MyNoticeEvent.valueOf("My event"));
```

--------------------------------

### Java: 协议类定义 - 自动注册

Source: https://github.com/zfoo-project/zfoo/blob/main/protocol/README_CN.md

当使用 ProtocolManager.initProtocolAuto() 注册协议时，协议类可以不显式标注协议号。此类必须是简单的 Java Bean。

```java
package com.zfoo.protocol.packet;

public class SimpleObject {

    public int c;

    public boolean g;

}
```

--------------------------------

### Spring Resource Scanning and Excel Parsing

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/video-tutorial.md

Details how to scan Excel files using Spring's PathMatchingResourcePatternResolver and parse their content using Apache POI and Spring's ConversionService.

```text
Use spring's PathMatchingResourcePatternResolver to scan excel file location, there are methods to directly get Resource
spring's Resource abstraction, spring's abstraction of files
apache's poi, poi can parse excel
Use spring's ConversionService to parse the content of excel cells, customize parsing rules through ConditionalGenericConverter, Converter interface
```

--------------------------------

### Configure C++ Project with CMake

Source: https://github.com/zfoo-project/zfoo/blob/main/protocol/src/test/cpp/CMakeLists.txt

This snippet defines the C++ standard, identifies source and header files using GLOB_RECURSE, and adds an executable target. It assumes a project structure with 'zfoocpp/' and 'test/' directories. It sets the C++ standard to 17.

```cmake
cmake_minimum_required(VERSION 3.23)
project(cpp)

set(CMAKE_CXX_STANDARD 17)

set(PROJECT_MAIN cpp)

# main
file(GLOB_RECURSE MAIN_SOURCES zfoocpp/*.c**)
file(GLOB_RECURSE MAIN_HEADERS zfoocpp/*.h**)

# test
file(GLOB_RECURSE TEST_SOURCES test/*.c**)
file(GLOB_RECURSE TEST_HEADERS test/*.h**)

add_executable(${PROJECT_MAIN}
        main.cpp
        ${TEST_SOURCES} ${TEST_HEADERS}
        ${MAIN_SOURCES} ${MAIN_HEADERS})

target_include_directories(${PROJECT_NAME} SYSTEM PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
```

--------------------------------

### zfoo Protocol Serialization and Deserialization

Source: https://github.com/zfoo-project/zfoo/blob/main/README.md

This Java code demonstrates how to use the zfoo protocol module for efficient serialization and deserialization of complex objects. It involves initializing the protocol manager with your classes, writing objects to a byte buffer, and reading them back.

```java
// protocol registration
ProtocolManager.initProtocol(Set.of(ComplexObject.class, ObjectA.class, ObjectB.class));

// serialization
ProtocolManager.write(byteBuf, complexObject);

// deserialization
var packet = ProtocolManager.read(byteBuf);
```

--------------------------------

### MongoDB Profiling and Process Monitoring

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/mongodb/mongodb.md

Shows how to enable and view database profiling to understand query performance and execute operations. It also includes commands to view currently executing processes.

```javascript
db.setProfilingLevel(2)
```

```javascript
db.system.profile.find()
```

```javascript
show profile
```

```javascript
db.setProfilingLevel(0)
```

```javascript
db.system.profile.drop()
```

```javascript
db.createCollection("system.profile", { capped: true, size:4000000 } )
```

```javascript
db.setProfilingLevel(1)
```

```javascript
db.currentOP()
```

--------------------------------

### zfoo Protocol Serialization and Deserialization

Source: https://github.com/zfoo-project/zfoo/blob/main/README_CN.md

This code demonstrates the basic usage of the zfoo protocol module for serializing and deserializing complex objects. It involves registering protocols and then using the ProtocolManager to write to and read from a byte buffer.

```java
// 协议注册
ProtocolManager.initProtocol(Set.of(ComplexObject.class, ObjectA.class, ObjectB.class));

// 序列化
ProtocolManager.write(byteBuf, complexObject);

// 反序列化
var packet = ProtocolManager.read(byteBuf);
```

--------------------------------

### Protobuf Protocol Definition

Source: https://github.com/zfoo-project/zfoo/blob/main/protocol/README.md

This method defines protocols using '.proto' files, leveraging the Protocol Buffers (protobuf) syntax. It allows for explicit message definitions with fields and their types, and supports version compatibility through field tag numbering. This is suitable for complex data structures and cross-language compatibility.

```protobuf
syntax = "proto3";
package test.message;

message SimpleObject {
    int64 aa = 1;
}

// If the tag of a field exceeds 1000, the field is considered to be a compatible protocol field
message OneMessage {
    // This is a comment on the field
    int64 id = 1;
    // This is equivalent to adding a @Compatible annotation to this field
    string name = 1001;
}
```

--------------------------------

### MongoDB Concepts and Distributed Unique IDs

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/video-tutorial.md

Provides an overview of MongoDB concepts (database, collection, document) and contrasts them with MySQL. It also discusses various methods for generating distributed unique IDs.

```text
In Mysql, database, table, a piece of data, are called database, collection, document in Mongodb respectively
Elastic Search's full-text search engine
mongodb's map reduce operation
Distributed unique ID, Java's built-in UUID, Snowflake algorithm (SnowFlake), Redis distributed unique ID implementation, Mongodb distributed unique ID implementation, Zookeeper distributed unique ID implementation
```

--------------------------------

### zfoo Event Bus - Post Event

Source: https://github.com/zfoo-project/zfoo/blob/main/README_CN.md

This Java snippet demonstrates how to publish an event using the zfoo Event Bus. The `EventBus.post()` method is used to dispatch an event, which will then be delivered to all registered listeners.

```java
// 抛出一个事件
EventBus.post(MyNoticeEvent.valueOf("我的事件"));
```

--------------------------------

### XML Protocol Configuration

Source: https://github.com/zfoo-project/zfoo/blob/main/protocol/README.md

This method configures protocols using an XML file, 'protocol.xml'. It allows grouping protocols into modules and specifying their class paths or package names for automatic scanning. This approach is useful for managing a large number of protocols centrally.

```xml
<protocols>
    <!-- Use class path -->
    <module id="1" name="common">
        <protocol id="100" location="com.zfoo.protocol.packet.ComplexObject"/>
        <protocol id="101" location="com.zfoo.protocol.packet.NormalObject"/>
        <protocol id="102" location="com.zfoo.protocol.packet.ObjectA"/>
        <protocol id="103" location="com.zfoo.protocol.packet.ObjectB"/>
        <protocol id="104" location="com.zfoo.protocol.packet.SimpleObject"/>
        <protocol id="105" location="com.zfoo.protocol.packet.VeryBigObject"/>
        <protocol id="106" location="com.zfoo.protocol.packet.EmptyObject"/>
    </module>
    <!-- Use a package name scans all protocol classes under the package path -->
    <module id="2" name="native">
        <protocol location="com.zfoo.net.packet.common"/>
        <protocol location="com.zfoo.tank.common.protocol.common"/>
    </module>
</protocols>
```

--------------------------------

### ZooKeeper Data Publish/Subscribe (Java)

Source: https://github.com/zfoo-project/zfoo/blob/main/net/README_CN.md

Demonstrates the publish-subscribe pattern for data distribution using ZooKeeper's NodeCache in Java. This allows clients to subscribe to changes in ZooKeeper nodes.

```java
```java
// src/test/java/com/zfoo/net/zookeeper/recipes/nodecache
// (Code snippet not provided in the input text, but path indicates content)
```
```

--------------------------------

### Excel to Class Mapping for Storage in Java

Source: https://github.com/zfoo-project/zfoo/blob/main/README.md

Explains the storage module in zfoo, a framework that automatically maps Excel data to Java classes. Users only need to define a class corresponding to the Excel structure, and the framework handles the parsing. Annotations like @Id and @Index can be used to define primary keys and indexes.

```java
@Storage
public class StudentResource {
    @Id
    private int id;
    @Index
    private String name;
    private int age;
}
```

--------------------------------

### zfoo Net RPC Framework - Consumer Asynchronous Request

Source: https://github.com/zfoo-project/zfoo/blob/main/README_CN.md

This Java snippet demonstrates an asynchronous RPC call using the zfoo Net framework. The consumer sends a request and continues execution without blocking. A callback using `whenComplete` handles the response when it arrives.

```java
// 消费者，异步请求远程用户信息，不会柱塞当前的线程，异步请求成功过后依然会在当前线程执行逻辑
NetContext.getCosumer().asyncAsk(userInfoAsk, UserInfoAnswer.class, userId)
          .whenComplete(sm -> {
              // do something
          );
```

--------------------------------

### Java: 协议类定义 - 注解方式

Source: https://github.com/zfoo-project/zfoo/blob/main/protocol/README_CN.md

使用 @Protocol 注解为协议类定义协议号。此类必须是简单的 Java Bean，不能继承其他类，但可以实现接口。

```java
package com.zfoo.protocol.packet;

import com.zfoo.protocol.anno.Protocol;

@Protocol(id = 104)
public class SimpleObject {

    public int c;
    public boolean g;

}
```

--------------------------------

### Conventional Commit Message Types (Text)

Source: https://github.com/zfoo-project/zfoo/blob/main/README_CN.md

Provides a list of conventional commit message types and their descriptions, used for standardizing code commits. These types help categorize changes like features, performance improvements, bug fixes, tests, deletions, refactoring, and documentation updates.

```text
feat[module]: 新增某一项功能
perf[module]: 优化了模块代码或者优化了什么功能
fix[module]: 修改了什么bug
test[module]: 测试了什么东西
del[module]: 删除了某些功能或者无用代码
ref[module]: 重命名或者重构了模块
doc[module]: 增加了什么文档
```

--------------------------------

### Protobuf Syntax Limitations

Source: https://github.com/zfoo-project/zfoo/blob/main/protocol/README.md

This describes a limitation in Protobuf's syntax, specifically its lack of support for collection nesting. This contrasts with zfoo, which allows for such structures.

```plaintext
Collection nesting syntax is not supported
```

--------------------------------

### zfoo Event Bus - Event Receiver

Source: https://github.com/zfoo-project/zfoo/blob/main/README_CN.md

This Java snippet shows how to register an event listener using the zfoo Event Bus. By annotating a method with @EventReceiver, it automatically subscribes to and receives instances of the specified event type, promoting loose coupling between modules.

```java
// 接收一个事件，只需要在需要接收事件的方法上加一个注解就会自动监听这个事件
@EventReceiver
public void onMyNoticeEvent(MyNoticeEvent event) {
    // do something
}
```

--------------------------------

### zfoo Net RPC Framework - Service Provider

Source: https://github.com/zfoo-project/zfoo/blob/main/README_CN.md

This Java snippet illustrates how to implement a service provider in the zfoo Net RPC framework. By annotating a method with @PacketReceiver, it automatically registers the method to handle incoming requests for the specified packet type.

```java
// 服务提供者，只需要在方法上加个注解，则自动注册接口
@PacketReceiver
public void atUserInfoAsk(Session session, UserInfoAsk ask) {
}
```

--------------------------------

### zfoo Protocol Implementation Principle

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/FAQ.md

The protocol implementation works by recursively parsing an object's structure. It then uses bytecode enhancement to generate sequential serialization and deserialization functions. This process can generate C# protocols, allowing observation of the structures generated by Javassist.

```text
Through recursive parsing of the object's structure, bytecode enhancement is used to generate sequential serialization and deserialization functions. You can generate C# protocols yourself to see what structures Javassist generates.
```

--------------------------------

### Maven Dependency for zfoo Protocol

Source: https://github.com/zfoo-project/zfoo/blob/main/README.md

This snippet demonstrates how to add the zfoo protocol module as a Maven dependency. This module is for serialization and deserialization. It's useful if you only need protocol features without the entire zfoo framework.

```xml
<dependency>
    <groupId>com.zfoo</groupId>
    <artifactId>protocol</artifactId>
    <version>4.1.0</version>
</dependency>
```

--------------------------------

### zfoo Syntax Features

Source: https://github.com/zfoo-project/zfoo/blob/main/protocol/README.md

This highlights a feature of zfoo's syntax: the support for nested collection syntax. This capability offers more flexibility in data structuring compared to Protobuf.

```plaintext
Supports nested collection syntax
```

--------------------------------

### zfoo Hotswap Class Update

Source: https://github.com/zfoo-project/zfoo/blob/main/README_CN.md

This Java snippet shows how to perform a hot-swap update of class bytecode using zfoo's HotSwapUtils. This allows for code changes to be applied to a running server without requiring a restart or complex configuration.

```java
// 传入需要更新的class文件
HotSwapUtils.hotswapClass(bytes);
```

--------------------------------

### MongoDB Aggregation with Match, Sort, Limit, and Group

Source: https://github.com/zfoo-project/zfoo/blob/main/doc/mongodb/mongodb.md

Demonstrates MongoDB's aggregation framework by matching documents based on age, sorting them, limiting the results, and then grouping them to count the number of students per age. The order of pipeline stages is crucial for the final output.

```javascript
db.student.aggregate(
    [
        { $match: { age:{"$gt":13} } },
        { $sort: { age: 1 } },
        { $limit: 2 },
        { $group: { _id: "$age", "人数": { $sum: 1 } } } 
   ]
)
```

```javascript
db.student.aggregate(
    [
        { $match: { age:{"$gt":13} } },
        { $sort: { age: 1 } },
        { $limit: 2 },
        { $group: { _id: "$age", "人数": { $sum: 1 } } }     
   ]
)
```

```javascript
db.student.aggregate(
    [
        { $match: { age:{"$gt":13} } },    
        { $group: { _id: "$age", "人数": { $sum: 1 } } },  
        { $sort: { _id: 1 } },
        { $limit: 2 }  
   ]
)
```

--------------------------------

### Protobuf Supported Data Types

Source: https://github.com/zfoo-project/zfoo/blob/main/protocol/README.md

This list details the data types supported by Protobuf. It includes various integer and floating-point types, booleans, strings, and bytes. Note the repetition of 'bytes'.

```plaintext
double
float
int32
int64
uint32
uint64
sint32
sint64
fixed32
fixed64
sfixed32
sfixed64
bool
string
bytes
bytes
```

--------------------------------

### Java POJO to Excel/JSON/CSV Mapping with zfoo Storage

Source: https://github.com/zfoo-project/zfoo/blob/main/storage/README.md

The zfoo storage module automatically maps Java POJOs to Excel, JSON, and CSV formats. It leverages Java's reflection capabilities, eliminating the need for manual code generation. It supports null-safe arrays/collections and handles empty strings/objects gracefully. Data can be exported from Excel to JSON and CSV.

```java
@Component
public class StudentManager {

 @ResInjection
 private IStorage<Integer, StudentResource> studentResources;

 }
```

```java
IStorage<Integer, StudentResource> studentResources = StorageContext.getStorageManager().getStorage(StudentResource.class);
```

```java
var studentResource = studentResources.get(1000);
```

```java
var resource = StorageContext.get(StudentResource.class, 1001);
```

```java
var students = studentResources.getIndex(StudentResource::getName, "james0");
```

```java
var students = studentStorage.getIndexes(StudentResource::name, "james0");
```

```java
StudentResource student = storage.getUniqueIndex(StudentResource::idCard, "110101200007281903");
```

--------------------------------

### ZooKeeper Basic CRUD Operations (Java)

Source: https://github.com/zfoo-project/zfoo/blob/main/net/README_CN.md

Shows basic Create, Read, Update, and Delete (CRUD) operations for ZooKeeper using Java. This is fundamental for understanding ZooKeeper's interaction patterns.

```java
```java
// src/test/java/com/zfoo/net/zookeeper/base
// (Code snippet not provided in the input text, but path indicates content)
```
```

--------------------------------

### zfoo ORM for MongoDB (Java)

Source: https://github.com/zfoo-project/zfoo/blob/main/README.md

This Java code demonstrates the zfoo ORM framework for MongoDB, which allows automatic mapping of entities to database collections. You define your entities using annotations like `@EntityCache` and `@Id`, and zfoo handles the database operations like updates.

```java
// 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);
```
Tokens:
Raw