Flutter网页渲染插件dart_webcore的使用

dart_webcore 处理高级路由、HttpServers、网站托管、静态文件托管等。其中最重要的是个性化中间件，你可以在单个处理器、路由器甚至整个管道中设置中间件。

功能

1. 允许添加路由系统。
2. 托管静态文件夹或网站。
3. 预编程的代码用于一些工具（如HTML响应、JSON响应）。

教程

- 路由 ( 请求处理器 )

dart_webcore 由不同类型的 RequestProcessor 组成，这些处理器可以处理传入的请求。

1. 处理器：是请求在服务器生命周期中的最后阶段，处理器必须向客户端返回一个响应（API消费者）。处理器可以有一个仅对其有效的本地中间件。处理器需要路径模板、方法和处理器函数。

Handler handler = Handler('/hello', HttpMethods.get,
      (request, response, pathArgs) => response.write('Hello world!'));

1. 中间件：是一组介于处理器和客户端之间的函数，用于对请求进行一些身份验证或验证。中间件可以返回一个请求以让请求传递到下一个中间件或处理器，也可以返回一个响应以阻止请求传递到管道中的下一个实体。中间件可以添加到单个处理器、路由器，或者整个管道，甚至是每个传入请求，这些称为全局中间件。

Middleware middleware =
      Middleware('/hello', HttpMethods.get, (request, response, pathArgs) {
    print('new request');
    return request;
  });

1. 路由器：路由器是处理器的父级，你可以将多个处理器添加到路由器，并且路由器负责选择正确的处理器来执行。你还可以为路由器添加中间件，这些中间件仅在此路由器中执行。

Router router = Router()
    ..get('/hello',
        (request, response, pathArgs) => response.write('Hello world!'))
    ..post('/register',
        (request, response, pathArgs) => response.write('user registered!'));

1. 管道：管道是所有前述实体的管理者，你可以将多个路由器和单独的处理器添加到管道中，它会为每个传入请求选择正确的中间件和处理器。

Pipeline pipeline = Pipeline().addRouter(router);

- 服务器 ( 接收请求的实际服务器 )

ServerHolder 类负责创建和关闭服务器，它需要一个来自上述的请求处理器来处理运行正确的处理器和正确的中间件集，你可以在同一个服务器持有者中运行多个服务器。

// 你可以将 'pipeline' 替换为任何其他处理器，如路由器或处理器
ServerHolder serverHolder = ServerHolder(pipeline);
serverHolder.bind(InternetAddress.anyIPv4, 3000);

- 请求处理器参数

1. 路径模板：是要与传入请求路径比较的路径模板，每个处理器应该具有唯一的路径模板，并遵循以下公式：

e.g: /login  
     /register  
     /users/list  
     /users/<user_id>/getData  
     /users/<users_id>/deleteUser  
     /files/*<file_path>

• 正常路径模板类似于 /login、/register 或 /users/list，如果任何请求具有相同的路径，则将选择相应的处理器来运行。
• 包含路径参数的路径模板类似于 /users/<user_id>/getData 和 /users/<user_id>/deleteUser，任何请求的路径如 /users/the_actual_user_id/deleteUser 将触发此处理器，并且可以访问路径参数，形式为 {'user_id':'the_actual_user_id'}。
• 最终路径模板示例是用于包含多个斜杠的路径参数，例如，任何请求的路径如 /files/path/to/file 将被重定向到路径模板为 /files/*<file_path> 的处理器，并且将提供路径参数映射为 {'file_path':'path/to/file'}。

Handler pathArgHandler = Handler(
      '/getUser/<user_id>',
      HttpMethods.get,
      (request, response, pathArgs) => response
          .write('you requested the user with id ${pathArgs['user_id']}'));

1. 方法：是此处理器或中间件的方法（get、post、put…）。对于处理器，你可以指定 HttpMethods.all 以使此中间件适用于特定路径模板的所有方法。最好将此类处理器（带有 HttpMethods.all）放在管道的末尾。对于中间件，你可以将路径模板设置为 null 以使其适用于所有路径，也可以将中间件的方法设置为 HttpMethods.all 以作为特定请求处理器（如路由器或管道）的全局中间件。

2. 处理器：是中间件或处理器的实际代码。其形式为：

(RequestHolder, ResponseHolder, Map<String, dynamic>){
    return PassedHttpEntity(either a RequestHolder or ResponseHolder)
  }

如果返回类型为 ResponseHolder，这意味着响应已发送并且管道已关闭；否则，如果返回类型为 RequestHolder，这意味着它将继续且响应尚未关闭，并且将返回的请求传递给管道中的下一个实体。

- 网站托管

使用 dart_webcore，你可以托管整个文件夹及其所有内容，无论是网站文件夹还是普通静态文件夹。只需为该文件夹路径设置别名即可保护系统路径，使其对API消费者隐藏。

Router router = Router()
    ..get(
      /* 总是最好将文件路径模板设置为这样，因为它将接受所有请求路径，并且路径参数将获取路径作为参数 {'path':'all the path will be here'} */
      '/*<path>',
      (request, response, pathArgs) {
        return response.serveFolders(
          [
            FolderHost(path: './bin/website', alias: 'website'),
          ],
          pathArgs['path'],
          allowServingFoldersContent: true,
          autoViewIndexTextFiles: true,
          allowViewingEntityPath: true,
          viewTextBasedFiles: true,
        );
      },
    );

- 单个文件下载/流式传输

你可以流式传输文件或将其提供下载。

router
..get(
        '/downloadImage',
        (request, response, pathArgs) =>
            response.writeFile('./bin/website/images/img.jpg'))