ionet

https://iohao.github.io/ionet
Admin
ionet is an open-source, lightweight distributed network programming framework designed for...
Tokens:63,156
Snippets:708
Trust Score:8.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Generate Code Example in Java

Source: https://iohao.github.io/ionet/docs/examples/code_generate

This Java code demonstrates the setup and execution of code generation for various client SDKs, including C# and GDScript. It configures global settings, authentication, loads game logic servers, and initiates the generation of actions, broadcasts, error codes, and .proto files.

```java
public final class GenerateTest {
  
    ...  

    static void main() {

        // i18n: CHINA or US  

        Locale.setDefault(Locale.US);

        CoreGlobalConfig.setting.parseDoc = true;

  

        /*  

         * ExternalServer accessAuthentication  

         * cn: 对外服访问权限，不生成权限控制的 action  

         */  

        SdkApplication.extractedAccess();  

        DocumentAccessAuthentication reject = ExternalGlobalConfig.accessAuthenticationHook::reject;

        DocumentHelper.setDocumentAccessAuthentication(reject);

  

        // Load the business framework of each gameLogicServer  

        // cn: 加载业务逻辑服  

        SdkApplication.listLogic().forEach(logicServer -> {

            var builder = BarSkeleton.builder();

            logicServer.settingBarSkeletonBuilder(builder);

            builder.build();

        });

  

        /*  

         * Generate actions, broadcasts, and error codes.  

         * cn: 生成 action、广播、错误码  

         */  

  

        // ----- About generating TypeScript code -----  

        // generateCodeVue();  

        // generateCocosCreator();  

  

        // ----- About generating C# code -----  

        // generateCodeCsharpGodot();  

        // generateCodeCsharpUnity();  

  

        // ----- About generating GDScript code -----  

        generateCodeGDScriptGodot();

  

        // Added an enumeration error code class to generate error code related information  

        DocumentHelper.addErrorCodeClass(ErrorCode.class);

        // Generate document  

        DocumentHelper.generateDocument();

        // Generate .proto  

        generateProtoFile();

    }

  

    static void generateProtoFile() {

        // By default, it will be generated in the target/proto directory  

        // .proto 默认生成的目录为 target/proto  

  

        // The package name to be scanned  

        String packagePath = "com.iohao.example.sdk.data";

        GenerateFileKit.generate(packagePath);

    }

}

```

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

### Start Logic Server Processes

Source: https://iohao.github.io/ionet/docs/manual_high/deploy-multi-process

These commands launch individual logic server processes, such as the book library and author services. The order of starting these logic servers does not matter, but they must be started after the aggregation process.

```bash
# 图书馆逻辑服  
java --add-opens java.base/jdk.internal.misc=ALL-UNNAMED \
     --enable-native-access=ALL-UNNAMED \
     -jar logic-book-library/target/logic-book-library.jar  

# 作者逻辑服  
java --add-opens java.base/jdk.internal.misc=ALL-UNNAMED \
     --enable-native-access=ALL-UNNAMED \
     -jar logic-author/target/logic-author.jar
```

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

### Build and Install ionet Framework Locally

Source: https://iohao.github.io/ionet/docs/installation

After cloning the ionet framework source code, navigate into the directory and run this command to compile and install the framework locally. If 'mvnd' is not installed, use 'mvn' instead.

```bash
mvnd install
```

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

### Startup Logic Server with RunOne

Source: https://iohao.github.io/ionet/docs/manual/logic_intro

Configure and start the Logic Server using the RunOne class. This involves setting the list of LogicServers to be started and then calling the startup method.

```java
final class TestOneApplication {

    static void main() {

        new RunOne()

                ...

                .setLogicServerList(listLogic())

                .startup();

    }



    static List<LogicServer> listLogic() {

        return List.of(new DemoLogicServer());

    }

}
```

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

### Install Project with Bash Script

Source: https://iohao.github.io/ionet-ai/README_CN.md

Run this bash script from the repository root to install the project. It copies knowledge sources, writes MCP configuration, generates a local startup script, and updates project documentation files.

```bash
bash scripts/install-project.sh --project /path/to/your-project
```

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

### Add Room Example

Source: https://iohao.github.io/ionet/docs/extension_module/room

Demonstrates how to add a new room using the RoomService.

```java
RoomService roomService = new MyRoomService();

var room = new MyRoom();
roomService.addRoom(room);
```

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

### List All Rooms Example

Source: https://iohao.github.io/ionet/docs/extension_module/room

Demonstrates how to retrieve a list of all available rooms using the RoomService.

```java
var roomList = roomService.listRoom();
```

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

### Start Client Verification Process

Source: https://iohao.github.io/ionet/docs/manual_high/deploy-multi-process

This command starts the client process to verify the multi-process communication. The client will send requests to test the connectivity and functionality of the deployed services.

```bash
java -jar one-client/target/one-client.jar
```

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

### Start Aggregation Process (one-application)

Source: https://iohao.github.io/ionet/docs/manual_high/deploy-multi-process

This command starts the main aggregation process, which includes the MediaDriver, CenterServer, and WebSocket external service. Ensure this process is started first. The default WebSocket port is 10100.

```bash
java --add-opens java.base/jdk.internal.misc=ALL-UNNAMED \
     --enable-native-access=ALL-UNNAMED \
     -jar one-application/target/one-application.jar
```

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

### Install iohao-sdk

Source: https://iohao.github.io/ionet/docs/examples/sdk_ts

Install the iohao-sdk package using npm. This is the first step to using the SDK in your TypeScript project.

```bash
npm i iohao-sdk  
```

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

### Verify Maven Installation

Source: https://iohao.github.io/ionet/docs/installation

After installing Maven, run this command in your terminal to verify the installation and check the Maven version, Java version, and operating system details.

```bash
Apache Maven 3.9.11 (3e54c93a704957b63ee3494413a2b544fd3d825b)  

Maven home: /usr/local/Cellar/maven/3.9.11/libexec  

Java version: 25, vendor: Oracle Corporation, runtime: /Library/Java/JavaVirtualMachines/jdk-25.jdk/Contents/Home  

Default locale: zh_CN_#Hans, platform encoding: UTF-8  

OS name: "mac os x", version: "26.0.1", arch: "x86_64", family: "mac"  
```

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

### Clone and Install ionet-ai Repository

Source: https://iohao.github.io/ionet/docs/ionet-ai

Clone the ionet-ai repository and install its dependencies using uv. This is the initial step for both Codex CLI and Claude Code CLI.

```bash
git clone https://github.com/iohao/ionet-ai.git  

cd ionet-ai  

uv sync --extra mcp  
```

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

### Associate Player with Room Example

Source: https://iohao.github.io/ionet/docs/extension_module/room

Demonstrates how to associate a player with a room using the RoomService.

```java
var player = new MyPlayer();
roomService.addPlayer(room, player);
```

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

### Application Startup with Access Control

Source: https://iohao.github.io/ionet/docs/manual/access_authentication

Integrate the access control setup into the application's startup process. Ensure that route permission code is placed in the external server for proper enforcement.

```java
class OneApplication {

    static void main() {

        extractedAccess();

        ...

        new RunOne()

                ...

                .startup();

    }

}
```

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

### Find Room by ID Example

Source: https://iohao.github.io/ionet/docs/extension_module/room

Demonstrates how to find a room by its ID using the RoomService.

```java
var room = roomService.getRoom(roomId);
```

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

### MyNetConfig GDScript Class

Source: https://iohao.github.io/ionet/docs/examples/example_sdk_godot_gds

This class handles the initialization and configuration of the IoGame SDK, including network channel setup, message callbacks, and starting the SDK. It also includes functions for polling network status and sending heartbeat messages.

```gdscript
class_name MyNetConfig  

extends RefCounted  

  

static var _socket: MyNetChannel = MyNetChannel.new()  

static var current_time_millis: int = 0  

  

static func start_net():  

    # biz code init  

    GameCode.init()  

    Listener.listener_all()  

  

    # --------- IoGameSetting ---------  

    var setting := IoGame.IoGameSetting  

    setting.enable_dev_mode = true  

    setting.set_language(IoGame.IoGameLanguage.Us)  

    # message callback. cn: 回调监听  

    setting.listen_message_callback = MyListenMessageCallback.new()  

    # set socket. cn: 设置网络连接  

    setting.net_channel = _socket  

  

    socket_init()  

    setting.start_net()  

  

  

static func poll():  

    _socket.poll()  

  

const Common = preload("res://gen/common.gd")  

  

static func socket_init():  

    _socket.on_open = func():  

        var verify_message := Common.LoginVerifyMessage.new()  

        verify_message.set_jwt("1")  

  

        SdkAction.of_login_verify(verify_message, func(result: IoGame.ResponseResult):  

                var value := result.get_value(Common.UserMessage) as Common.UserMessage  

                print("user: ", value)  

        )  

  

  

static var _heartbeat_message_bytes := IoGame.Proto.ExternalMessage.new().to_bytes()  

static var _heartbeat_counter: int = 1  

  

static func send_idle() -> void:  

    _heartbeat_counter += 1  

    #print("-------- ..HeartbeatMessage {\%s}" % [_heartbeat_counter])  

    IoGame.IoGameSetting.net_channel.write_and_flush_byte(_heartbeat_message_bytes)  

  

  

class MyListenMessageCallback extends IoGame.ListenMessageCallback:  

    func on_idle_callback(message: Proto.ExternalMessage):  

        var data_bytes := message.get_data()  

        var long_value := IoGame.Proto.LongValue.new()  

        long_value.from_bytes(data_bytes)  

        # Synchronize the time of each heartbeat with that of the server.  

        # cn: 每次心跳与服务器的时间同步  

        MyNetConfig.current_time_millis = long_value.get_value()  

  

  

class MyNetChannel extends IoGame.SimpleNetChannel:  

    var _last_state: WebSocketPeer.State = WebSocketPeer.State.STATE_CLOSED  

    var _socket: WebSocketPeer = WebSocketPeer.new()  

    var _url: String = "ws://127.0.0.1:10100/websocket"  

  

    var on_open: Callable = func():  

        print("on_open")  

  

    var on_connecting: Callable = func():  

        print("on_connecting")  

  

    var on_connect_error: Callable = func(error: int):  

        print("on_connect_error:", error)  

  

    var on_closing: Callable = func():  

        print("on_closing")  

  

    var on_closed: Callable = func():  

        print("on_closed")  

  

    func prepare() -> void:  

        if _url == null or _url.is_empty():  

            _url = IoGame.IoGameSetting.url  

  

        var error: int = _socket.connect_to_url(_url)  

  

        if error != 0:  

            on_connect_error.call(error)  

            return  

  

        _last_state = _socket.get_ready_state()  

  

    func write_and_flush_byte(bytes: PackedByteArray) -> void:  

        _socket.send(bytes)  

  

    func poll() -> void:  

        if _socket.get_ready_state() != WebSocketPeer.State.STATE_CLOSED:  

            _socket.poll()  

  

        while _socket.get_available_packet_count() > 0:  

            var packet := _socket.get_packet()  

            var message := IoGame.Proto.ExternalMessage.new()  

            message.from_bytes(packet)  

            self.accept_message(message)  

  

        var state: WebSocketPeer.State = _socket.get_ready_state()  

        if _last_state == state:  

            return  

  

        _last_state = state  

  

        match state:  

            WebSocketPeer.State.STATE_OPEN:  

                on_open.call()  

            WebSocketPeer.State.STATE_CONNECTING:  

                on_connecting.call()  

            WebSocketPeer.State.STATE_CLOSING:  

                on_closing.call()  

            WebSocketPeer.State.STATE_CLOSED:  

                on_closed.call()  

            _:  

                printerr("Socket Unknown Status.")  
```

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

### Example URL Structure

Source: https://iohao.github.io/ionet/docs/manual/cmd

Illustrates how a URL maps to the framework's routing concepts, where the module corresponds to the @ActionController and the method corresponds to the @ActionMethod.

```plaintext
URL: https://ip:port/user/hello  
```

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

### Remove Room Example

Source: https://iohao.github.io/ionet/docs/extension_module/room

Demonstrates how to remove a room using the RoomService.

```java
roomService.removeRoom(room);
```

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

### Implement startupSuccess Method

Source: https://iohao.github.io/ionet/docs/manual/logic_intro

Optionally override the startupSuccess method to perform actions after the Logic Server has successfully started, such as storing references to the business framework or EventBus.

```java
public class DemoLogicServer implements LogicServer {

    ... 

    @Override

    public void startupSuccess(BarSkeleton barSkeleton) { { 

        // Server server = barSkeleton.server; 

        // EventBus eventBus = barSkeleton.eventBus; 

    }

}
```

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

### Find Room by User ID Example

Source: https://iohao.github.io/ionet/docs/extension_module/room

Demonstrates how to find a room associated with a specific user ID using the RoomService.

```java
var room = roomService.getRoomByUserId(userId);
```

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

### Install ionet-ai into Project for Codex CLI

Source: https://iohao.github.io/ionet/docs/ionet-ai

Execute the installation script from the ionet-ai root directory to integrate the knowledge base into your target ionet project. This generates or updates Codex-related entries within the project.

```bash
bash scripts/install-project.sh --project /path/to/your-project  
```

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

### Dynamic Binding Logic Server Example

Source: https://iohao.github.io/ionet/docs/manual/binding_logic_server

Construct dynamic binding information and execute the binding. Ensure user IDs and logic server IDs are correctly provided. The framework handles the assignment but not the existence check of logic servers.

```java
long[] userIds = {1L, flowContext.getUserId()};

int[] logicServerIds = {1, 2, 3};

var message = BindingLogicServerMessage.builder(BindingEnum.COVER)
        .addLogicServerId(logicServerIds)
        .addUserId(userIds)
        .build();

var response = communication().bindingLogicServer(message);
```

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

### Comprehensive Delay Task Example

Source: https://iohao.github.io/ionet/docs/kit/delay_task

This example demonstrates a comprehensive use case involving a player's enhanced abilities during an attack. It simulates using an item that reduces cooldown and increases luck, affecting the attack's outcome. The task is scheduled to trigger after 1.5 seconds, with a chance to modify the attack listener's properties.

```java
public void example() {

    DelayTask delayTask = DelayTaskKit.of(new ShootTaskListener("Enemy"))

            .plusTimeMillis(1500)

            .task();

    if (RandomKit.randomBoolean()) {

        delayTask.minusTime(Duration.ofMillis(500));

        ShootTaskListener shootTaskListener = delayTask.getTaskListener();

        shootTaskListener.setLuck(true);

    }

}

@Slf4j
final class ShootTaskListener implements TaskListener {

    final String targetEntity;

    boolean luck;

    int attack = 10;

    ShootTaskListener(String targetEntity) {

        this.targetEntity = targetEntity;

    }

    @Override

    public void onUpdate() {

        int value = luck ? attack * 2 : attack;

        log.info("value", value);

    }

}
```

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

### Add run-one Dependency to pom.xml

Source: https://iohao.github.io/ionet/docs/manual/external_intro

Include the run-one dependency in your pom.xml for quick setup, which bundles both external and logic servers.

```xml
<dependency>
  <groupId>com.iohao.net</groupId>
  <artifactId>run-one</artifactId>
  <version>${ionet.version}</version>
</dependency>
```

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

### Clone ionet Framework Source Code

Source: https://iohao.github.io/ionet/docs/installation

Download the ionet framework's source code from GitHub using Git. This is the first step to locally building and installing the framework.

```bash
git clone https://github.com/iohao/ionet.git
```

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

### Verify Codex CLI Availability

Source: https://iohao.github.io/ionet/docs/ionet-ai

Confirm that the ionet-ai CLI is accessible after installation by running the help command.

```bash
uv run ionet-ai --help  
```

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

### Remove Player from Room Example

Source: https://iohao.github.io/ionet/docs/extension_module/room

Demonstrates how to remove a player from a room and their association using the RoomService.

```java
roomService.removePlayer(room, userId);
```

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

### Add run-one Dependency for Logic Server

Source: https://iohao.github.io/ionet/docs/manual/logic_intro

Include this dependency in your pom.xml for a quick setup that bundles both the External Server and Logic Server.

```xml
<dependency>

    <groupId>com.iohao.net</groupId>

    <artifactId>run-one</artifactId>

    <version>${ionet.version}</version>

</dependency>
```

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

### ionet-ai CLI Search Command

Source: https://iohao.github.io/ionet-ai/README_CN.md

Use the uv run command to execute the ionet-ai CLI for searching knowledge base content, for example, searching for 'FlowContext'.

```bash
uv run ionet-ai kb search "FlowContext"
```

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

### Sync MCP Dependencies

Source: https://iohao.github.io/ionet-ai/README_CN.md

Run uv sync with the '--extra mcp' flag to ensure all necessary dependencies for MCP runtime are installed.

```bash
uv sync --extra mcp
```

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

### Start Claude Code CLI

Source: https://iohao.github.io/ionet/docs/ionet-ai

Initiate the Claude Code CLI from your target project's root directory. It will automatically read project-specific configurations, including the ionet-ai MCP service.

```bash
claude  
```

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

### Java Action Controller Example

Source: https://iohao.github.io/ionet/docs/manual/external_message

Demonstrates how an action method within a Java controller would handle incoming messages and return responses, with the framework automatically mapping return objects to the ExternalMessage.data field.

```java
@ActionController(1)  

public class DemoAction {  

    @ActionMethod(0)  

    public HelloMessage here(HelloMessage message) {  

        HelloMessage newHelloMessage = ...  

        return newHelloMessage;  

    }  

}
```

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

### Action Java Code Example

Source: https://iohao.github.io/ionet/docs/examples/code_generate

This Java code demonstrates how to define actions with comments for method descriptions, parameter descriptions, and return value descriptions. These comments are used by the framework to generate frontend interaction code.

```java
/**
 * Method description
 */
public class MyAction {

    /**
     * Method description
     * @param param1 Parameter description
     * @return Return value description
     */
    public String doSomething(int param1) {
        // Method implementation
        return "Result";
    }
}
```

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

### Logic Server Action for Processing Requests

Source: https://iohao.github.io/ionet/docs/communication/request_multiple_response

This is an example of a logic server's action that processes incoming requests. It increments a value for each call, demonstrating how a server might handle requests from the communication model.

```java
@ActionController(InternalCmd.cmd)

public class InternalAction {

    AtomicInteger inc = new AtomicInteger(1);

  

    @ActionMethod(InternalCmd.intAction)

    private int intAction(int value) {

        return value + inc.getAndIncrement();

    }

}

```

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

### Example Thread Monitor Output

Source: https://iohao.github.io/ionet/docs/core_plugin/action_thread_monitor

This output shows the status of various business threads, including their execution count, average time, and remaining tasks. It's useful for a quick overview of thread performance.

```text
业务线程[User-8-1] 共执行了 1 次业务，平均耗时 1 ms, 剩余 91 个任务未执行  

业务线程[User-8-2] 共执行了 1 次业务，平均耗时 1 ms, 剩余 0 个任务未执行  

业务线程[User-8-3] 共执行了 1 次业务，平均耗时 1 ms, 剩余 36 个任务未执行  

业务线程[User-8-4] 共执行了 1 次业务，平均耗时 1 ms, 剩余 0 个任务未执行  

业务线程[User-8-5] 共执行了 1 次业务，平均耗时 1 ms, 剩余 88 个任务未执行  

业务线程[User-8-6] 共执行了 1 次业务，平均耗时 1 ms, 剩余 0 个任务未执行  

业务线程[User-8-7] 共执行了 7 次业务，平均耗时 1 ms, 剩余 56 个任务未执行  

业务线程[User-8-8] 共执行了 1 次业务，平均耗时 1 ms, 剩余 0 个任务未执行  
```

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

### Listen to Specific Minutes with TimeRangeInOut

Source: https://iohao.github.io/ionet/docs/core_plugin/action_time_range

Configure TimeRangeInOut to listen for action calls at specific minutes (0, 1, and 59) within an hour. This example demonstrates precise minute-level monitoring.

```java
private void setListener(TimeRangeInOut inOut) {

    inOut.setListener(new TimeRangeInOut.ChangeListener() {

        @Override

        public List<TimeRangeInOut.TimeRangeMinute> createListenerTimeRangeMinuteList() {

            return List.of(

                    TimeRangeInOut.TimeRangeMinute.create(0, 0),

                    TimeRangeInOut.TimeRangeMinute.create(1, 1),

                    TimeRangeInOut.TimeRangeMinute.create(59, 59)

            );

        }

    });

}

```

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

### Generated TypeScript Code (Callback Style)

Source: https://iohao.github.io/ionet/docs/examples/code_generate

This TypeScript code is generated based on the Java action code. It uses a callback style for asynchronous operations, indicated by method names starting with 'of'. It includes method descriptions, parameter types, return types, and usage examples.

```typescript
// Generated TypeScript code (callback style)

/**
 * Method description
 * @param param1 Parameter description
 * @returns Return value description
 */
export function ofDoSomething(param1: number): Promise<string> {
    // Example usage: 
    // ionet.send('MyAction.doSomething', param1).then(result => {
    //     console.log(result);
    // }).catch(error => {
    //     console.error(error);
    // });
    return new Promise((resolve, reject) => {
        // Actual implementation would involve sending a request via ionet
        console.log(`Calling MyAction.doSomething with param1: ${param1}`);
        // Simulate a successful response
        setTimeout(() => resolve("Simulated Result"), 100);
    });
}
```

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

### Generated TypeScript Code (Async/Await Style)

Source: https://iohao.github.io/ionet/docs/examples/code_generate

This TypeScript code is generated based on the Java action code. It uses the async/await style for asynchronous operations, indicated by method names starting with 'ofAwait'. This style helps avoid callback hell and includes method descriptions, parameter types, return types, and usage examples.

```typescript
// Generated TypeScript code (async/await style)

/**
 * Method description
 * @param param1 Parameter description
 * @returns Return value description
 */
export async function ofAwaitDoSomething(param1: number): Promise<string> {
    // Example usage: 
    // try {
    //     const result = await ionet.sendAwait('MyAction.doSomething', param1);
    //     console.log(result);
    // } catch (error) {
    //     console.error(error);
    // }
    console.log(`Calling MyAction.doSomething with param1: ${param1}`);
    // Simulate a successful response
    await new Promise(resolve => setTimeout(resolve, 100));
    return "Simulated Result";
}
```

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

### Initialize and Configure StatActionInOut

Source: https://iohao.github.io/ionet/docs/core_plugin/action_stat

Demonstrates how to initialize the StatActionInOut plugin and add it to a builder. It also shows how to set a listener to process statistics updates.

```java
BarSkeletonBuilder builder = ...;
var statActionInOut = new StatActionInOut();
builder.addInOut(statActionInOut);

statActionInOut.setListener((statAction, time, flowContext) -> {
    System.out.println(statAction);
});
```

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

### 启动模拟客户端

Source: https://iohao.github.io/ionet/docs/extension_module/simulation_client

使用 ClientRunOne 类启动模拟客户端。通过 setInputCommandRegions 方法添加自定义的 InputCommandRegion，然后调用 startup() 方法启动客户端。

```java
public class DemoClient {

    static void main() {

        // US or CHINA

        Locale.setDefault(Locale.US);


        // closeLog. cn: 关闭模拟请求相关日志

        ClientUserConfigs.closeLog();

        // Startup Client. cn: 启动模拟客户端

        new ClientRunOne()

                .setInputCommandRegions(List.of(new DemoRegion()))

                .startup();

    }


    static class DemoRegion extends AbstractInputCommandRegion {

        @Override

        public void initInputCommand() {

            ...

        }

    }

}
```

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

### Project Directory Structure

Source: https://iohao.github.io/ionet/docs/manual_high/code_organization

Illustrates a typical project directory structure, highlighting key directories for external dependencies, logic modules, application entry points, client simulations, and shared provide modules.

```bash
├── external
│   ├── pom.xml
│   └── src
├── logic
│   ├── email-logic
│   └── user-logic
├── one-application
│   ├── pom.xml
│   └── src
├── one-client
│   ├── pom.xml
│   └── src
└── provide
    ├── common-provide
    ├── email-provide
    └── user-provide
```

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

### 逻辑服进程启动配置

Source: https://iohao.github.io/ionet/docs/manual_high/deploy-multi-process

每个逻辑服都可以单独启动，只需将自身的 `LogicServer` 注册到 `RunOne` 中即可。这意味着每个逻辑模块可以独立成进程、独立发布并按业务压力单独扩容。

```java
public final class BookLibraryApplication {

    static void main() {
        CoreGlobalConfig.setting.parseDoc = true;
        var aeron = LogicAeronClientFactory.create();

        new RunOne()
                .setAeron(aeron)
                .setLogicServerList(List.of(new BookLibraryLogicServer()))
                .startup();

    }

}
```

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

### 打包命令

Source: https://iohao.github.io/ionet/docs/manual_high/deploy-multi-process

在示例根目录执行此命令进行打包，会生成各模块的可执行 jar 文件。

```bash
mvn clean package
```

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

### Add DebugInOut Plugin

Source: https://iohao.github.io/ionet/docs/core_plugin/action_debug

Add the DebugInOut plugin to the BarSkeletonBuilder. This is the minimal setup required to enable the plugin.

```java
BarSkeletonBuilder builder = ...;

builder.addInOut(new DebugInOut());  

```

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

### Int Action Examples: Primitive vs. Wrapper Style

Source: https://iohao.github.io/ionet/docs/manual_high/protocol_fragment

Demonstrates equivalent functionalities for integer types using both direct primitive int parameters and the IntValue wrapper class. This highlights the framework's support for automatic boxing and unboxing.

```java
@ActionController(6)  

public class IntAction {
  @ActionMethod(10)  
  public int int2int(int value) {
    return value + 1;
  }

  @ActionMethod(12)  
  public List<Integer> intList2intList(List<Integer> intList) {
    return List.of(1, 2);
  }
}
```

```java
@ActionController(6)  

public class IntAction {
  @ActionMethod(11)  
  public IntValue intValue2intValue(IntValue intValue) {
    IntValue newIntValue = new IntValue();
    newIntValue.value = intValue.value + 1;
    return newIntValue;
  }

  @ActionMethod(13)  
  public IntValueList intValueList2intValueList(IntValueList intValueList) {
    List<Integer> list = new ArrayList<>();
    list.add(1);
    list.add(2);

    IntValueList newIntValueList = new IntValueList();
    newIntValueList.values = list;

    return newIntValueList;
  }
}
```

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

### Usage of IgnoreDebugInout Annotation

Source: https://iohao.github.io/ionet/docs/core_plugin/action_debug

Example of how to use the @IgnoreDebugInout annotation on an action method to prevent DebugInOut logging for that specific method.

```java
@ActionController(1)  

public class DemoAction {  

    @ActionMethod(3)  

    @IgnoreDebugInout  

    public String hello() {  

        return "hello";  

    }  

}  

```

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

### AbstractSocketMicroBootstrapFlow Channel Initializer

Source: https://iohao.github.io/ionet/docs/manual_high/external_design

This code initializes the Netty ChannelInitializer for socket-based connections. It delegates the pipeline setup to the pipelineFlow method.

```java
abstract class AbstractSocketMicroBootstrapFlow implements MicroBootstrapFlow<ServerBootstrap> {

    ...

    @Override

    public void channelInitializer(ServerBootstrap bootstrap) {

        bootstrap.childHandler(new ChannelInitializer<SocketChannel>() {

            @Override

            protected void initChannel(SocketChannel ch) {

                pipelineFlow(new DefaultPipelineContext(ch, setting));

            }

        });

    }

}
```

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

### Implement LogicServer Interface

Source: https://iohao.github.io/ionet/docs/manual/logic_intro

Create a class that implements the LogicServer interface. You must implement settingBarSkeletonBuilder to configure the business framework and settingServerBuilder to define server information.

```java
public class DemoLogicServer implements LogicServer {

    @Override

    public void settingBarSkeletonBuilder(BarSkeletonBuilder builder) {

        // Scan the package where the action classes are located

        builder.scanActionPackage(DemoAction.class);

        // Add console output plugin

        builder.addInOut(new DebugInOut());

    }



    @Override

    public void settingServerBuilder(ServerBuilder builder) {

        builder.setName("DemoLogicServer");

    }

}
```

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

### 配置模拟客户端请求和广播监听

Source: https://iohao.github.io/ionet/docs/extension_module/simulation_client

继承 AbstractInputCommandRegion 并重写 initInputCommand 方法来配置模拟请求和广播监听。 设置主路由和标题，并定义请求命令的子路由、标题、请求数据和回调。 广播监听则配置子路由、标题和回调来接收服务器广播数据。

```java
public class DemoRegion extends AbstractInputCommandRegion {

    ...

    @Override

    public void initInputCommand() {

        // Setting cmd. cn:设置主路由

        this.setCmd(DemoCmd.cmd, "TestDemo");


        // ---------------- request 1-0 ----------------

        ofCommand(DemoCmd.here).setTitle("here").setRequestData(() -> {

            HelloMessage helloMessage = new HelloMessage();

            helloMessage.name = "1";

            return helloMessage;

        }).callback(result -> {

            HelloMessage value = result.getValue(HelloMessage.class);

            log.info("{}", value);

        });


        ...


        // ---------------- Broadcast Listener. cn: 广播监听 ----------------

        ofListen(result -> {

            List<HelloMessage> helloMessageList = result.listValue(HelloMessage.class);

            log.info("{}", helloMessageList);

        }, DemoCmd.listenList, "listenList");

    }

}
```

```java
public interface DemoCmd {

    int cmd = 1;


    int here = 0;

    int jackson = 1;

    int list = 2;


    int triggerBroadcast = 3;


    AtomicInteger broadcastIndex = new AtomicInteger(20);

    CmdInfo listenData = CmdInfo.of(cmd, broadcastIndex.getAndIncrement());

    CmdInfo listenList = CmdInfo.of(cmd, broadcastIndex.getAndIncrement());

}
```

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

### Start Multiple External Servers with Different Connection Types

Source: https://iohao.github.io/ionet/docs/manual/external_intro

Demonstrates how to run multiple external servers within the same process, each supporting a different connection type (WEBSOCKET, TCP, UDP). This utilizes the cocPort method to assign unique ports based on the connection protocol.

```java
final class TestOneApplication {
    static void main() {
        new EnterpriseRunOne()
                .setExternalServer(externalServerList)
                ...
                .startup();
    }

    static List<ExternalServer> listExternalServer() {
        return List.of(
                ofExternalServer(ExternalJoinEnum.WEBSOCKET)
                , ofExternalServer(ExternalJoinEnum.TCP)
                , ofExternalServer(ExternalJoinEnum.UDP)
        );
    }

    static ExternalServer ofExternalServer(ExternalJoinEnum join) {
        int port = join.cocPort(ExternalGlobalConfig.externalPort);
        var externalServerBuilder = MyExternalServer.builder(port, join);
        return externalServerBuilder.build();
    }
}
```

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

### Get UserId from FlowContext

Source: https://iohao.github.io/ionet/docs/manual/user_login

Retrieves the user ID from the FlowContext after a successful login. This allows access to user-specific information for subsequent requests.

```java
public long hello(FlowContext flowContext) {  

    return flowContext.getUserId();  

}  
```

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

### Action Controller with JSON Message

Source: https://iohao.github.io/ionet/docs/manual_high/data_protocol

Example of an ActionController that processes a HelloMessage object. The ProtobufClass annotation on HelloMessage is ignored when using the JSON codec.

```java
@ActionController(19)
public class JsonAction {

    @ActionMethod(1)
    public HelloMessage hello(HelloMessage message) {

        message.name = message.name + "，hello json";

        return message;

    }

}

@ProtobufClass
@FieldDefaults(level = AccessLevel.PUBLIC)
public class HelloMessage {

    public String name;

}
```

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

### 聚合进程启动配置

Source: https://iohao.github.io/ionet/docs/manual_high/deploy-multi-process

聚合进程负责启动 `Aeron MediaDriver`、`CenterServer` 和对外服。对外服只在这里启动，逻辑服进程不直接暴露给客户端。

```java
public final class OneApplication {

    static void main() {
        var aeron = new EmbeddedAeronRuntime().getAeron();

        new RunOne()
                .setAeron(aeron)
                .enableCenterServer()
                .setExternalServer(
                        ExternalMapper.builder(ExternalGlobalConfig.externalPort).build()
                )
                .startup();

    }

}
```

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

### Generate .proto Files Using Tool Kit

Source: https://iohao.github.io/ionet/docs/extension_module/jprotobuf

Use the GenerateFileKit to automatically generate .proto files by specifying the Java package to scan. The .proto files will be placed in the 'target/proto' directory by default.

```java
void test1() {
    GenerateFileKit.generate("com.iohao.example.sdk.logic.data");
}
```

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

### Define Custom Message Structure with Protobuf

Source: https://iohao.github.io/ionet/docs/manual/external_message_custom

Define the structure of your custom external message using Protocol Buffers. This example defines 'MyExternalMessage' with an integer command and byte data.

```protobuf
syntax = "proto3";  

package com.your.message;  

  

message MyExternalMessage {  

  int32 cmd_merge = 1;  

  bytes data = 2;  

}
```

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

### Start Codex CLI with ionet-ai Integration

Source: https://iohao.github.io/ionet/docs/ionet-ai

Launch the Codex CLI using the provided script within your target project's root directory. This script mounts the ionet-ai MCP service for the current Codex process without global configuration changes.

```bash
./codex-ionet.sh  
```

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

### Assertion Example with ErrorCode

Source: https://iohao.github.io/ionet/docs/manual/assert_error_code

Use the ErrorCode enum's assertTrue method to validate conditions within an action method. If the condition is false, an exception is thrown and sent to the requestor.

```java
@ActionController(DemoCmd.cmd)  

public class DemoAction {  

    @ActionMethod(DemoCmd.jackson)  

    private HelloMessage jackson(HelloMessage helloMessage) {  

        // Example exception mechanism demonstration  

        // cn: 示例 异常机制演示  

        ErrorCode.nameChecked.assertTrue("Jackson".equals(helloMessage.name));  

  

        // custom error info. cn: 自定义错误信息  

        // ErrorCode.nameChecked.assertTrue("Jackson".equals(helloMessage.name), "This name is wrong!");  

  

        helloMessage.name = "Hello, " + helloMessage.name;

        return helloMessage;

    }

}  

  

@ProtobufClass  

public class HelloMessage {  

    public String name;

}  
```

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

### 引入 extension-client 依赖

Source: https://iohao.github.io/ionet/docs/extension_module/simulation_client

在 pom.xml 文件中引入 extension-client 依赖以使用模拟客户端功能。

```xml
<dependency>

    <groupId>com.iohao.net</groupId>

    <artifactId>extension-client</artifactId>

    <version>${ionet.version}</version>

</dependency>
```

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

### Receive and Set Attachment in OnExternal

Source: https://iohao.github.io/ionet/docs/communication/on_external

An example of an OnExternal implementation that receives a payload, extracts it as an attachment, and sets it on the user session. Handles cases where the user session might not exist.

```java
public final class AttachmentUpdateOnExternal implements OnExternal {
    @Override
    public void process(byte[] payload, int payloadLength, OnExternalContext context) {
        var userSession = context.getUserSession();
        if (userSession != null) {
            userSession.setAttachment(ByteKit.getPayload(payload, payloadLength));
        } else {
            context.response().setError(ActionErrorEnum.dataNotExist);
        }
    }
    ...
}
```

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

### Add Built-in Plugins to Business Framework

Source: https://iohao.github.io/ionet/docs/manual/plugin_intro

Add instances of built-in plugins to the BarSkeletonBuilder to enable their functionality during action processing. This setup is typically done within the LogicServer implementation.

```java
public class MyLogicServer implements LogicServer {

    @Override
    public void settingBarSkeletonBuilder(BarSkeletonBuilder builder) {

        builder.addInOut(new DebugInOut());

        builder.addInOut(new StatActionInOut());

        builder.addInOut(new ThreadMonitorInOut());

        builder.addInOut(new TimeRangeInOut());

    }

}
```

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

### Default Enum Definition in Java

Source: https://iohao.github.io/ionet/docs/extension_module/jprotobuf

Defines a Java enum 'AnimalType' with default values starting from 0. Also shows a Java class 'Animal' that uses this enum. These are mapped to a proto file.

```java
/**  
 * The AnimalType  
 */  
@ProtobufClass  
@ProtoFileMerge(fileName = MyProtoFile.fileName, filePackage = MyProtoFile.filePackage)  
public enum AnimalType {
    /** the bird */  
    BIRD,
    /** the cat */  
    CAT;
}

/**  
 * The Animal  
 */  
@ProtobufClass  
@FieldDefaults(level = AccessLevel.PUBLIC)  
@ProtoFileMerge(fileName = MyProtoFile.fileName, filePackage = MyProtoFile.filePackage)  
public class Animal {
    /** id */  
    int id;
    /** AnimalType */  
    AnimalType animalType;
}
```
Tokens:
Raw