Flutter网络请求插件utopia_http的使用

Flutter网络请求插件utopia_http的使用

Utopia HTTP Server

Utopia HTTP是一个轻量级且快速的Dart HTTP库，用于构建优秀的Dart服务器端应用程序。它受到了Utopia PHP生态系统的启发。

Getting Started

首先，在在pubspec.yaml中添加依赖项：

dependencies:
  utopia_http: ^0.1.0

然后，在main.dart文件中进行如下操作：

import 'dart:io';
import 'package:utopia_http/utopia_http.dart';

void main() async {
  final address = InternetAddress.anyIPv4;
  final port = Http.getEnv('PORT', 8000);
  final app = Http(ShelfServer(address, port), threads: 8);

  app.get('/').inject('request').inject('response').action(
    (Request request, Response response) {
      response.text('Hello world');
      return response;
    },
  );

  await app.start();
}

Features

• Parameters: 参数用于接收HTTP请求中的输入。参数可以是URL参数或以JSON结构的形式存在。

  定义一个带有参数的端点：

  app
    .get('/hello-world')
    .param('name', 'World', Text(255), 'Name to greet. Optional', true)
    .inject('response').action((String name, Response response) {
      response.text('Hello $name');
      return response;
    });
  

  使用curl命令测试：

  curl http://localhost:8000/hello-world
  curl http://localhost:8000/hello-world?name=Utopia
  curl http://localhost:8000/hello-world?name=Appwrite
  

• Hooks: 钩子分为三种类型：

  • Init hooks：执行在路由动作执行之前
  • Shutdown hooks：执行在路由动作完成之后，但在应用关闭之前
  • Error hooks：执行在应用生命周期中的任何错误时

  提供多个钩子给每个阶段。如果没有为钩子分配组，则默认情况下该钩子将应用于所有路由。如果定义了组，则仅在属于同一组的请求期间运行。

  app
    .init()
    .inject('request')
    .action((Request request) {
      print('Received: ${request.method} ${request.url}');
    });
  
  app
    .shutdown()
    .inject('response')
    .action((Response response) {
      print('Responding with status code: ${response.status}');
    });
  
  app
    .error()
    .inject('error')
    .inject('response')
    .action((Exception error, Response response) {
      response.text(error.toString(), status: HttpStatus.internalServerError);
    });
  

• Groups: 组允许您为多个端点定义共同行为。

  app
    .get('/login')
    .group(['api', 'public'])
    .inject('response')
    .action((Response response) {
      response.text('OK');
      return response;
    });
  

• Resources: 资源允许您为请求准备依赖项，如数据库连接或发送请求的用户。为每个请求创建新的资源实例。

  app.resource('timestamp', () {
    return DateTime.now().millisecondsSinceEpoch;
  });
  
  app
    .get('/')
    .inject('timestamp')
    .inject('response')
    .action((int timestamp) {
      final diff = DateTime.now().millisecondsSinceEpoch - timestamp;
      print('Request took: $diff');
    });
  

示例代码

完整的示例代码如下：

import 'dart:io';
import 'package:utopia_http/utopia_http.dart';

void main() async {
  final address = InternetAddress.anyIPv4;
  final port = Http.getEnv('PORT', 8080);
  final app = Http(ShelfServer(address, port), threads: 8);

  app.get('/').inject('request').inject('response').action(
    (Request request, Response response) {
      response.text('Hello world');
      return response;
    },
  );
  app
    .get('/hello-world')
    .inject('request')
    .inject('response')
    .action((Request request, Response response) {
    response.text('Hello world');
    return response;
  });

  app
    .get('/users/:userId')
    .param(key: 'userId', defaultValue: '', description: 'Users unique ID')
    .inject('response')
    .action((String userId, Response response) {
    response.text(userId);
    return response;
  });

  app
    .get('/users/:userId/jhyap/:messing')
    .param(key: 'userId', defaultValue: '', description: 'Users unique ID')
    .param(key: 'messing', defaultValue: 'messing')
    .inject('response')
    .action((String userId, String messing, Response response) {
    response.text('tap tap');
    return response;
  });

  app
    .post('/users')
    .param(key: 'userId')
    .param(key: 'name')
    .param(key: 'email')
    .inject('response')
    .inject('request')
    .action((
    String userId,
    String name,
    String email,
    Response response,
    Request request,
  ) {
    response.json({
      'userId': userId,
      'name': name,
      'email': email,
    });
    return response;
  });

  app
    .get('/users/:userId/jhyap')
    .param(key: 'userId', defaultValue: '', description: 'Users unique ID')
    .inject('response')
    .action((String userId, Response response) {
    print(userId);
    response.text('Jhyap');
    return response;
  });

  await app.start();
  print("server started at http://${address.address}:${port}");
}