Angel 框架入门教程

Angel 框架入门教程

angel[ARCHIVED] A polished, production-ready backend framework in Dart for the VM, AOT, and Flutter.项目地址:https://gitcode.com/gh_mirrors/ange/angel

1. 项目目录结构及介绍

在 angel-dart 的项目中，目录结构通常如下所示：

angel-dart/
│
├── bin/            # 存放可执行脚本，如服务器启动文件
│   └── server.dart  # 主启动文件
│
├── lib/             # 应用的核心代码库
│   ├── config/      # 配置相关代码
│   │   └── my_config.dart
│   ├── models/      # 数据模型定义
│   ├── services/    # 服务层逻辑
│   └── routes/      # 路由处理
│       └── api_routes.dart
│
├── test/            # 单元测试
│
└── pubspec.yaml     # 项目依赖文件

• bin: 包含应用程序的启动脚本。
• lib: 项目的主要源码目录，通常有config(配置), models(数据模型), services(服务) 和 routes(路由) 子目录。
• test: 测试文件存放的地方，用于编写单元测试。
• pubspec.yaml: 项目的配置文件，记录了 Dart 包的依赖和项目信息。

2. 项目启动文件介绍

bin/server.dart 是项目的主启动文件，它负责初始化框架并设置应用程序的基本配置。通常包括以下步骤：

import 'package:angel_framework/http.dart';
import 'package:angel_framework/angel.dart';

void main() async {
  var app = Angel();
  
  // 加载配置
  await app.configure(withConfigFile('config/my_config.yaml'));
  
  // 注册路由和服务
  await configureRoutes(app);
  await configureServices(app);
  
  // 启动HTTP服务器
  var server = await app.listen(port: 3000);
  print('Server listening on port ${server.port}...');
}

在这个示例中，Angel 对象被创建并用于加载配置文件，注册路由和服务，最后监听指定端口启动 HTTP 服务器。

3. 项目的配置文件介绍

lib/config/my_config.yaml 是一个示例配置文件，用来存储应用程序的参数和设置。它可以包括数据库连接字符串、API 密钥等敏感信息：

# lib/config/my_config.yaml

database:
  url: mongodb://localhost/my_db
  user: my_user
  password: my_secret_password

api_key: abc123

logging:
  level: info

在 server.dart 中，我们可以使用 configure 方法来加载这个配置文件：

await app.configure(withConfigFile('config/my_config.yaml'));

然后在应用的其他部分，我们可以使用 app.config 访问这些配置值，例如：

var dbUrl = app.config['database']['url'];

通过这种方式，配置文件使得我们可以在不修改代码的情况下轻松地更改应用程序的行为。

angel[ARCHIVED] A polished, production-ready backend framework in Dart for the VM, AOT, and Flutter.项目地址:https://gitcode.com/gh_mirrors/ange/angel