Flutter服务器交互插件get_server的使用

GetServer 是一个允许你使用Flutter编写后端应用程序的插件。从Widgets到setState、initState和dispose方法，再到使用GetX管理项目的控制器和绑定，一切都非常熟悉。如果你了解Flutter，就可以使用它来编写API。

安装

首先在你的pubspec.yaml文件中添加get_server依赖：

dependencies:
  get_server: ^latest_version

然后在需要使用的文件中导入get_server包：

import 'package:get_server/get_server.dart';

创建基本服务器

简单文本响应

以下是如何创建一个简单的服务器并发送纯文本响应的示例：

void main() {
  runApp(
    GetServerApp(
      home: Home(),
    ),
  );
}

class Home extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Text('Welcome to GetX!');
  }
}

使用命名路由

如果你需要定义多个URL路径，可以使用命名路由：

void main() {
  runApp(GetServerApp(
    getPages: [
      GetPage(name: '/', page: () => Home()),
    ],
  ));
}

class Home extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Text("Welcome to GetX");
  }
}

返回JSON数据

如果你想返回JSON数据，可以这样做：

class Home extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Json({
      "fruits": ["banana", "apple", "orange"]
    });
  }
}

文件上传

以下是一个处理文件上传的示例：

class UploadPage extends GetView {
  [@override](/user/override)
  build(Context context) async {
    final upload = await context.file('file');
    final data = {
      "nameFile": upload.name,
      "mimeType": upload.mimeType,
      "fileBase64": "${base64Encode(upload.data)}",
    };
    return context.sendJson(data);
  }
}

WebSocket支持

GetServer还支持WebSocket通信，以下是创建一个简单聊天室的示例：

class SocketPage extends GetView {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Socket(builder: (socket) {
      socket.onOpen((ws) {
        ws.send('socket ${ws.id} connected');
      });

      socket.on('join', (val) {
        final join = socket.join(val);
        if (join) {
          socket.sendToRoom(val, 'socket: ${socket.hashCode} join to room');
        }
      });
      socket.onMessage((data) {
        print('data: $data');
        socket.send(data);
      });

      socket.onClose((close) {
        print('socket has closed. Reason: ${close.message}');
      });
    });
  }
}

认证支持

你可以使用JWT进行认证，以下是一个简单的示例：

定义JWT密钥

void main() {
  runApp(
   GetServerApp(
    jwtKey: 'your key here',
   ),
  );
}

生成Token

final claimSet = JwtClaim(
  expiry: DateTime.now().add(Duration(days: 3)),
  issuer: 'get is awesome',
  issuedAt: DateTime.now(),
);

var token = TokenUtil.generateToken(claim: claimSet);

标记需要认证的路由

GetPage(
  name: '/awesome-route',
  method: Method.get,
  page: () => YourPage(),
  needAuth: true,
),

多线程支持

如果你有一个多核服务器，并希望充分利用它，可以通过以下方式启动多线程服务器：

void main() {
  runIsolate(init);
}

void init(_) {
  runApp(
    GetServerApp(
      home: Home(),
    ),
  );
}

示例项目

以下是一个完整的示例项目，展示了如何使用GetServer实现多种功能：

import 'dart:convert';
import 'dart:io';
import 'package:get_server/get_server.dart';

void main() {
  runApp(GetServer(getPages: [
    GetPage(name: '/', page: HomePage()),
    GetPage(name: '/user', page: UserPage()),
    GetPage(name: '/fruits', page: JsonPage()),
    GetPage(name: '/upload', page: UploadPage(), method: Method.post),
    GetPage(name: '/socket', page: SocketPage(), method: Method.ws),
  ]));
}

class HomePage extends GetView {
  [@override](/user/override)
  build(Context context) {
    return context.send('Hello, you are on home');
  }
}

class UserPage extends GetView {
  [@override](/user/override)
  build(Context context) {
    return context.send('Welcome, ${context.param('name')} !');
  }
}

class JsonPage extends GetView {
  [@override](/user/override)
  build(Context context) {
    return context.sendJson({
      "fruits": ["banana", "apple", "orange"]
    });
  }
}

class SocketPage extends GetView {
  [@override](/user/override)
  build(Context context) {
    context.ws.listen((socket) {
      socket.onMessage.listen((data) {
        print('data: $data');
        socket.send(data);
      });

      socket.onOpen.listen((ws) {
        print('new socket opened');
      });

      socket.onClose.listen((ws) {
        print('socket has been closed');
      });
    });
    return null;
  }
}

class UploadPage extends GetView {
  [@override](/user/override)
  build(Context context) async {
    final upload = await context.file('file');
    final data = {
      "nameFile": upload.name,
      "mimeType": upload.mimeType,
      "fileBase64": "${base64Encode(upload.data)}",
    };
    return context.sendJson(data);
  }
}