Flutter轻量级服务器插件server_nano的使用

server_nano 是一个用Dart编写的轻量、非常快速且友好的HTTP/WebSocket服务器。它具有以下特点：

• 轻量：最小的占用空间，以实现最佳效率。
• 快速：在各个方面都优先考虑性能。
• 友好：为新手和专家量身定制的直观API。

🚀 快速开始

安装

要将 server_nano 集成到你的Dart项目中，请运行以下命令：

dart pub add server_nano

基本使用

下面是一个基本示例，帮助你快速上手：

import 'package:server_nano/server_nano.dart';

void main() {
  final server = Server();

  // 同步请求
  server.get('/', (req, res) {
    res.send('Hello World!');
  });

  // 异步请求
  server.get('/user/:id', (req, res) async {
    // 模拟数据库查询延迟
    await Future.delayed(Duration(seconds: 2));
    res.send('Hello User ${req.params['id']}!');
  });

  // WebSocket支持
  server.ws('/socket', (socket) {
    socket.onMessage((message) {
      print(message);
    });

    // 房间支持
    socket.join('dev-group');

    socket.emitToRoom(
        'connected', 'dev-group', 'User ${socket.id} connected to dev-group');
  });

  server.listen(port: 3000);
}

性能如何？

server_nano 的设计目标是尽可能快。以下是在MacBook Pro M1上的性能测试结果：

@MacBook-Pro ~ % wrk -t 6 -c 120 -d 10s --latency http://localhost:3000/
Running 10s test @ http://localhost:3000/
  6 threads and 120 connections
  Thread Stats   Avg      Stdev     Max   +/- Stdev
    Latency     1.83ms    4.60ms  93.28ms   96.85%
    Req/Sec    17.12k     3.03k   20.57k    90.17%
  Latency Distribution
     50%    1.02ms
     75%    1.38ms
     90%    2.01ms
     99%   28.34ms
  1022096 requests in 10.00s, 212.49MB read
Requests/sec: 102164.16
Transfer/sec:     21.24MB

为什么选择 server_nano？

• 性能：server_nano 设计为尽可能快。
• 友好的API：server_nano 提供了易于使用的直观API，类似于Express.js但更快。
• WebSocket支持：server_nano 支持开箱即用的WebSocket。
• 中间件：server_nano 支持中间件来帮助你操作请求和响应对象。
• 静态文件服务：server_nano 支持开箱即用的服务静态文件。
• 安全性：server_nano 支持HTTPS，并有一个头盔中间件来缓解常见的Web漏洞。
• 跨平台：server_nano 是跨平台的，可以在任何东西上运行。
• 开源：server_nano 是开源的，免费使用。
• 最小占用空间：server_nano 具有最小的占用空间，以实现最佳效率。你可以在几分钟内阅读整个源代码。

示例Demo

以下是一个完整的示例，展示了如何使用 server_nano 创建一个简单的服务器，包括HTTP路由、WebSocket支持和静态文件服务：

import 'package:server_nano/server_nano.dart';

void main() {
  final server = Server();

  // HTTP GET 路由
  server.get('/', (req, res) {
    res.sendJson({'Hello': 'World!'});
  });

  server.get('/user/:id', (req, res) async {
    await Future.delayed(Duration(seconds: 2));
    res.send('Hello User ${req.params['id']}!');
  });

  // WebSocket 路由
  server.ws('/socket', (socket) {
    socket.onMessage((message) {
      print(message);
    });

    socket.join('tech-group');

    socket.emitToRoom(
        'connected', 'tech-group', 'User connected to tech-group');
  });

  // 服务静态文件
  server.static('/path/to/static/files', listing: true, links: true, jail: true);

  // 监听端口
  server.listen(port: 3000, wsPort: 3001);
}

中间件示例

以下是使用Helmet中间件保护应用程序免受常见Web漏洞的示例：

server.use(Helmet());

HTTPS支持

你可以通过提供SSL/TLS证书详细信息使服务器通过HTTPS服务：

server.listen(
  host: '0.0.0.0',
  port: 8080,
  certificateChain: 'path_to_certificate_chain.pem',
  privateKey: 'path_to_private_key.pem',
  password: 'optional_password_for_key',
);

希望这些示例能帮助你更好地理解和使用 server_nano！如果你有任何问题或需要进一步的帮助，请随时提问。