> For the complete documentation index, see [llms.txt](https://www.socketio4j.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.socketio4j.org/home/home-zh/home.md).
# Socketio4j 文档
欢迎来到您团队的开发者平台
Socketio4j 项目
在 Java 上实现的 Socket.IO 服务器。实时 Java 框架
### 5 分钟入门
你的第一个服务器应该是最简单的步骤。使用明确定义的端点和可复制粘贴的示例，设置快速且可预测。\
从零到可工作的连接只需几分钟。
开始使用 API 参考
### 服务器
{% tabs %}
{% tab title="核心 Java" %}
{% code title="Server.java" overflow="wrap" expandable="true" %}
```java
//package com.socketio4j.examples.core;
import com.socketio4j.socketio.Configuration;
import com.socketio4j.socketio.SocketIOServer;
import com.socketio4j.socketio.SocketIOClient;
public final class BasicServer {
public static void main(String[] args) {
Configuration config = new Configuration();
config.setHostname("0.0.0.0");
config.setPort(9092);
SocketIOServer server = new SocketIOServer(config);
server.addConnectListener(client -> {
System.out.println("Connected: " + client.getSessionId());
// 通过查询参数加入房间：?room=room1，如有需要可验证房间成员资格
String room = client.getHandshakeData()
.getSingleUrlParam("room");
if (room != null) {
client.joinRoom(room);
System.out.println("Joined room: " + room);
}
});
server.addDisconnectListener(client ->
System.out.println("Disconnected: " + client.getSessionId())
);
server.addEventListener(
"message",
String.class,
(SocketIOClient client, String data, var ack) -> {
System.out.println("Received: " + data);
// 广播给所有客户端
server.getBroadcastOperations()
.sendEvent("message", data);
ack.sendAckData("ok");
}
);
server.start();
System.out.println("SocketIO4J server started on :9092");
Runtime.getRuntime().addShutdownHook(
new Thread(server::stop)
);
}
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
### 客户端
{% tabs %}
{% tab title="Java" %}
{% code title="Client.java
" overflow="wrap" expandable="true" %}
```java
//package com.socketio4j.examples.core;
import io.socket.client.IO;
import io.socket.client.Socket;
import java.net.URISyntaxException;
import java.util.Collections;
public class SocketIoClient {
public static void main(String[] args) throws URISyntaxException {
IO.Options options = new IO.Options();
options.query = "room=room1";
options.forceNew = true;
Socket socket = IO.socket("http://localhost:9092", options);
socket.on(Socket.EVENT_CONNECT, args1 -> {
System.out.println("Connected: " + socket.id());
socket.emit("message", "Hello from Java");
});
socket.on("message", args1 ->
System.out.println("Received: " + args1[0])
);
socket.connect();
}
}
```
{% endcode %}
{% endtab %}
{% tab title="node.js" %}
{% code title="client.js" overflow="wrap" expandable="true" %}
```javascript
import { io } from "socket.io-client";
const socket = io("http://localhost:9092", {
query: { room: "room1" }
});
socket.on("connect", () => {
console.log("Connected:", socket.id);
socket.emit("message", "Hello from Node.js");
});
socket.on("message", (data) => {
console.log("Received:", data);
});
```
{% endcode %}
{% endtab %}
{% tab title="Dart / Flutter" %}
{% code overflow="wrap" expandable="true" %}
```dart
import 'package:socket_io_client/socket_io_client.dart' as IO;
void main() {
IO.Socket socket = IO.io(
'http://localhost:9092',
IO.OptionBuilder()
.setQuery({'room': 'room1'})
.setTransports(['websocket'])
.build(),
);
socket.onConnect((_) {
print('Connected: ${socket.id}');
socket.emit('message', 'Hello from Dart');
});
socket.on('message', (data) {
print('Received: $data');
});
}
```
{% endcode %}
{% endtab %}
{% tab title="Swift (iOS)" %}
{% code overflow="wrap" expandable="true" %}
```swift
import SocketIO
let manager = SocketManager(
socketURL: URL(string: "http://localhost:9092")!,
config: [.log(true), .connectParams(["room": "room1"])]
)
let socket = manager.defaultSocket
socket.on(clientEvent: .connect) { _, _ in
print("Connected:", socket.sid ?? "")
socket.emit("message", "Hello from Swift")
}
socket.on("message") { data, _ in
print("Received:", data[0])
}
socket.connect()
```
{% endcode %}
{% endtab %}
{% tab title="浏览器 - 原生 JS" %}
{% code overflow="wrap" expandable="true" %}
```html
```
{% endcode %}
{% endtab %}
{% tab title="Python" %}
{% code title="client.py" overflow="wrap" expandable="true" %}
```py
import socketio
sio = socketio.Client()
@sio.event
def connect():
print("Connected:", sio.sid)
sio.emit("message", "Hello from Python")
@sio.on("message")
def on_message(data):
print("Received:", data)
sio.connect("http://localhost:9092?room=room1")
sio.wait()
```
{% endcode %}
{% endtab %}
{% tab title="C#（.NET）" %}
{% code overflow="wrap" expandable="true" %}
```csharp
using SocketIOClient;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
class Program
{
static async Task Main()
{
var client = new SocketIO("http://localhost:9092", new SocketIOOptions
{
Query = new[] {
new KeyValuePair("room", "room1")
}
});
client.OnConnected += async (sender, e) =>
{
Console.WriteLine($"Connected: {client.Id}");
await client.EmitAsync("message", "Hello from C#");
};
client.On("message", response =>
{
Console.WriteLine("Received: " + response.GetValue());
});
await client.ConnectAsync();
await Task.Delay(-1);
}
}
```
{% endcode %}
{% endtab %}
{% tab title="Go" %}
{% code overflow="wrap" expandable="true" %}
```go
package main
import (
"fmt"
socketio "github.com/zhouhui8915/go-socket.io-client"
)
func main() {
opts := &socketio.Options{
Query: map[string]string{
"room": "room1",
},
}
client, err := socketio.NewClient("http://localhost:9092", opts)
if err != nil {
panic(err)
}
client.On("connect", func() {
fmt.Println("Connected")
client.Emit("message", "Hello from Go")
})
client.On("message", func(msg string) {
fmt.Println("Received:", msg)
})
select {}
}
```
{% endcode %}
{% endtab %}
{% tab title="Rust" %}
{% code overflow="wrap" expandable="true" %}
```rs
use rust_socketio::{ClientBuilder, Payload};
fn main() {
let client = ClientBuilder::new("http://localhost:9092")
.query("room", "room1")
.on("connect", |_, _| {
println!("Connected");
})
.on("message", |payload, _| {
if let Payload::String(msg) = payload {
println!("Received: {}", msg);
}
})
.connect()
.expect("Connection failed");
client.emit("message", "Hello from Rust").unwrap();
loop {}
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
加入一个不断壮大的社区，建立在受信赖的基础上 超过 7,000 名开发者
加入我们的 Discord 社区或仅需几步就创建你的第一个 PR。
| | | | 封面图片 |
|---|
:discord: | Discord 社区 | 加入我们的 Discord 社区，与超过 7,000 名志同道合、充满好奇心的开发者一起发布问题、寻求帮助并分享资源。 | 加入 Discord | |
:github: | GitHub | 我们的产品是 100% 开源的，由像你一样的开发者构建。前往我们的 GitHub 仓库，了解如何提交你的第一个 PR。 | 提交 PR | |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://www.socketio4j.org/home/home-zh/home.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
